diff options
author | Larry Hastings <larry@hastings.org> | 2014-02-09 06:15:29 (GMT) |
---|---|---|
committer | Larry Hastings <larry@hastings.org> | 2014-02-09 06:15:29 (GMT) |
commit | 2623c8c23cead505a78ec416072223552e94727e (patch) | |
tree | 9ac129d693fd98eb33d548bc836d89e006bbb937 /Modules | |
parent | 09f08fe2483aaefba367c6b0b4654c3490a32c42 (diff) | |
download | cpython-2623c8c23cead505a78ec416072223552e94727e.zip cpython-2623c8c23cead505a78ec416072223552e94727e.tar.gz cpython-2623c8c23cead505a78ec416072223552e94727e.tar.bz2 |
Issue #20530: Argument Clinic's signature format has been revised again.
The new syntax is highly human readable while still preventing false
positives. The syntax also extends Python syntax to denote "self" and
positional-only parameters, allowing inspect.Signature objects to be
totally accurate for all supported builtins in Python 3.4.
Diffstat (limited to 'Modules')
-rw-r--r-- | Modules/_cryptmodule.c | 6 | ||||
-rw-r--r-- | Modules/_datetimemodule.c | 6 | ||||
-rw-r--r-- | Modules/_dbmmodule.c | 12 | ||||
-rw-r--r-- | Modules/_opcode.c | 6 | ||||
-rw-r--r-- | Modules/_sre.c | 6 | ||||
-rw-r--r-- | Modules/_testcapimodule.c | 27 | ||||
-rw-r--r-- | Modules/_weakref.c | 6 | ||||
-rw-r--r-- | Modules/clinic/_bz2module.c.h | 22 | ||||
-rw-r--r-- | Modules/clinic/_lzmamodule.c.h | 30 | ||||
-rw-r--r-- | Modules/clinic/_pickle.c.h | 68 | ||||
-rw-r--r-- | Modules/clinic/audioop.c.h | 107 | ||||
-rw-r--r-- | Modules/clinic/binascii.c.h | 58 | ||||
-rw-r--r-- | Modules/clinic/zlibmodule.c.h | 52 | ||||
-rw-r--r-- | Modules/posixmodule.c | 19 | ||||
-rw-r--r-- | Modules/unicodedata.c | 6 |
15 files changed, 318 insertions, 113 deletions
diff --git a/Modules/_cryptmodule.c b/Modules/_cryptmodule.c index 7531c2f..da44ef3 100644 --- a/Modules/_cryptmodule.c +++ b/Modules/_cryptmodule.c @@ -30,7 +30,9 @@ results for a given *word*. [clinic start generated code]*/ PyDoc_STRVAR(crypt_crypt__doc__, -"sig=($module, word, salt)\n" +"crypt($module, word, salt, /)\n" +"--\n" +"\n" "Hash a *word* with the given *salt* and return the hashed password.\n" "\n" "*word* will usually be a user\'s password. *salt* (either a random 2 or 16\n" @@ -63,7 +65,7 @@ exit: static PyObject * crypt_crypt_impl(PyModuleDef *module, const char *word, const char *salt) -/*[clinic end generated code: output=c7443257e03fca92 input=4d93b6d0f41fbf58]*/ +/*[clinic end generated code: output=3eaacdf994a6ff23 input=4d93b6d0f41fbf58]*/ { /* On some platforms (AtheOS) crypt returns NULL for an invalid salt. Return None in that case. XXX Maybe raise an exception? */ diff --git a/Modules/_datetimemodule.c b/Modules/_datetimemodule.c index 80fa497..fce6bbf 100644 --- a/Modules/_datetimemodule.c +++ b/Modules/_datetimemodule.c @@ -4159,7 +4159,9 @@ If no tz is specified, uses local timezone. [clinic start generated code]*/ PyDoc_STRVAR(datetime_datetime_now__doc__, -"sig=($type, tz=None)\n" +"now($type, /, tz=None)\n" +"--\n" +"\n" "Returns new datetime object representing current time local to tz.\n" "\n" " tz\n" @@ -4192,7 +4194,7 @@ exit: static PyObject * datetime_datetime_now_impl(PyTypeObject *type, PyObject *tz) -/*[clinic end generated code: output=c8a47308483e579a input=80d09869c5267d00]*/ +/*[clinic end generated code: output=583c5637e3c843fa input=80d09869c5267d00]*/ { PyObject *self; diff --git a/Modules/_dbmmodule.c b/Modules/_dbmmodule.c index abeb799..93ea416 100644 --- a/Modules/_dbmmodule.c +++ b/Modules/_dbmmodule.c @@ -278,7 +278,9 @@ Return the value for key if present, otherwise default. [clinic start generated code]*/ PyDoc_STRVAR(dbm_dbm_get__doc__, -"sig=($self, key, default=None)\n" +"get($self, key, default=None, /)\n" +"--\n" +"\n" "Return the value for key if present, otherwise default."); #define DBM_DBM_GET_METHODDEF \ @@ -307,7 +309,7 @@ exit: static PyObject * dbm_dbm_get_impl(dbmobject *dp, const char *key, Py_ssize_clean_t key_length, PyObject *default_value) -/*[clinic end generated code: output=2bbaf9a187f9b6bf input=aecf5efd2f2b1a3b]*/ +/*[clinic end generated code: output=452ea11394e7e92d input=aecf5efd2f2b1a3b]*/ { datum dbm_key, val; @@ -448,7 +450,9 @@ Return a database object. [clinic start generated code]*/ PyDoc_STRVAR(dbmopen__doc__, -"sig=($module, filename, flags=\'r\', mode=0o666)\n" +"open($module, filename, flags=\'r\', mode=0o666, /)\n" +"--\n" +"\n" "Return a database object.\n" "\n" " filename\n" @@ -485,7 +489,7 @@ exit: static PyObject * dbmopen_impl(PyModuleDef *module, const char *filename, const char *flags, int mode) -/*[clinic end generated code: output=a1da6a481d9d332b input=6499ab0fab1333ac]*/ +/*[clinic end generated code: output=9a7b725f9c4dcec2 input=6499ab0fab1333ac]*/ { int iflags; diff --git a/Modules/_opcode.c b/Modules/_opcode.c index 712e6eb..fee388f 100644 --- a/Modules/_opcode.c +++ b/Modules/_opcode.c @@ -18,7 +18,9 @@ Compute the stack effect of the opcode. [clinic start generated code]*/ PyDoc_STRVAR(_opcode_stack_effect__doc__, -"sig=($module, opcode, oparg=None)\n" +"stack_effect($module, opcode, oparg=None, /)\n" +"--\n" +"\n" "Compute the stack effect of the opcode."); #define _OPCODE_STACK_EFFECT_METHODDEF \ @@ -50,7 +52,7 @@ exit: static int _opcode_stack_effect_impl(PyModuleDef *module, int opcode, PyObject *oparg) -/*[clinic end generated code: output=4fe636f5db87c0a9 input=2d0a9ee53c0418f5]*/ +/*[clinic end generated code: output=9e1133f8d587bc67 input=2d0a9ee53c0418f5]*/ { int effect; int oparg_int = 0; diff --git a/Modules/_sre.c b/Modules/_sre.c index 4dcaec1..d4d1d9d 100644 --- a/Modules/_sre.c +++ b/Modules/_sre.c @@ -540,7 +540,9 @@ Matches zero or more characters at the beginning of the string. [clinic start generated code]*/ PyDoc_STRVAR(pattern_match__doc__, -"sig=($self, pattern, pos=0, endpos=sys.maxsize)\n" +"match($self, /, pattern, pos=0, endpos=sys.maxsize)\n" +"--\n" +"\n" "Matches zero or more characters at the beginning of the string."); #define PATTERN_MATCH_METHODDEF \ @@ -570,7 +572,7 @@ exit: static PyObject * pattern_match_impl(PatternObject *self, PyObject *pattern, Py_ssize_t pos, Py_ssize_t endpos) -/*[clinic end generated code: output=9f5b785661677848 input=26f9fd31befe46b9]*/ +/*[clinic end generated code: output=1528eafdb8b025ad input=26f9fd31befe46b9]*/ { SRE_STATE state; Py_ssize_t status; diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c index 260e53d..9e81787 100644 --- a/Modules/_testcapimodule.c +++ b/Modules/_testcapimodule.c @@ -2851,26 +2851,40 @@ PyDoc_STRVAR(docstring_no_signature, ); PyDoc_STRVAR(docstring_with_invalid_signature, -"sig= (module, boo)\n" +"docstring_with_invalid_signature($module, /, boo)\n" "\n" "This docstring has an invalid signature." ); +PyDoc_STRVAR(docstring_with_invalid_signature2, +"docstring_with_invalid_signature2($module, /, boo)\n" +"\n" +"--\n" +"\n" +"This docstring also has an invalid signature." +); + PyDoc_STRVAR(docstring_with_signature, -"sig=(module, sig)\n" +"docstring_with_signature($module, /, sig)\n" +"--\n" +"\n" "This docstring has a valid signature." ); PyDoc_STRVAR(docstring_with_signature_and_extra_newlines, -"sig=(module, parameter)\n" -"\n" +"docstring_with_signature_and_extra_newlines($module, /, parameter)\n" +"--\n" "\n" "\n" "This docstring has a valid signature and some extra newlines." ); PyDoc_STRVAR(docstring_with_signature_with_defaults, -"sig=(module, s='avocado', b=b'bytes', d=3.14, i=35, n=None, t=True, f=False, local=the_number_three, sys=sys.maxsize, exp=sys.maxsize - 1)\n" +"docstring_with_signature_with_defaults(module, s='avocado',\n" +" b=b'bytes', d=3.14, i=35, n=None, t=True, f=False,\n" +" local=the_number_three, sys=sys.maxsize,\n" +" exp=sys.maxsize - 1)\n" +"--\n" "\n" "\n" "\n" @@ -3090,6 +3104,9 @@ static PyMethodDef TestMethods[] = { {"docstring_with_invalid_signature", (PyCFunction)test_with_docstring, METH_NOARGS, docstring_with_invalid_signature}, + {"docstring_with_invalid_signature2", + (PyCFunction)test_with_docstring, METH_NOARGS, + docstring_with_invalid_signature2}, {"docstring_with_signature", (PyCFunction)test_with_docstring, METH_NOARGS, docstring_with_signature}, diff --git a/Modules/_weakref.c b/Modules/_weakref.c index 6451dba..da58931 100644 --- a/Modules/_weakref.c +++ b/Modules/_weakref.c @@ -20,7 +20,9 @@ Return the number of weak references to 'object'. [clinic start generated code]*/ PyDoc_STRVAR(_weakref_getweakrefcount__doc__, -"sig=($module, object)\n" +"getweakrefcount($module, object, /)\n" +"--\n" +"\n" "Return the number of weak references to \'object\'."); #define _WEAKREF_GETWEAKREFCOUNT_METHODDEF \ @@ -46,7 +48,7 @@ exit: static Py_ssize_t _weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object) -/*[clinic end generated code: output=ef51baac56180816 input=cedb69711b6a2507]*/ +/*[clinic end generated code: output=032eedbfd7d69e10 input=cedb69711b6a2507]*/ { PyWeakReference **list; diff --git a/Modules/clinic/_bz2module.c.h b/Modules/clinic/_bz2module.c.h index 98f9a1b..8a201a0 100644 --- a/Modules/clinic/_bz2module.c.h +++ b/Modules/clinic/_bz2module.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(_bz2_BZ2Compressor_compress__doc__, -"sig=($self, data)\n" +"compress($self, data, /)\n" +"--\n" +"\n" "Provide data to the compressor object.\n" "\n" "Returns a chunk of compressed data if possible, or b\'\' otherwise.\n" @@ -38,7 +40,9 @@ exit: } PyDoc_STRVAR(_bz2_BZ2Compressor_flush__doc__, -"sig=($self)\n" +"flush($self, /)\n" +"--\n" +"\n" "Finish the compression process.\n" "\n" "Returns the compressed data left in internal buffers.\n" @@ -58,7 +62,9 @@ _bz2_BZ2Compressor_flush(BZ2Compressor *self, PyObject *Py_UNUSED(ignored)) } PyDoc_STRVAR(_bz2_BZ2Compressor___init____doc__, -"sig=(compresslevel=9)\n" +"BZ2Compressor(compresslevel=9, /)\n" +"--\n" +"\n" "Create a compressor object for compressing data incrementally.\n" "\n" " compresslevel\n" @@ -89,7 +95,9 @@ exit: } PyDoc_STRVAR(_bz2_BZ2Decompressor_decompress__doc__, -"sig=($self, data)\n" +"decompress($self, data, /)\n" +"--\n" +"\n" "Provide data to the decompressor object.\n" "\n" "Returns a chunk of decompressed data if possible, or b\'\' otherwise.\n" @@ -125,7 +133,9 @@ exit: } PyDoc_STRVAR(_bz2_BZ2Decompressor___init____doc__, -"sig=()\n" +"BZ2Decompressor()\n" +"--\n" +"\n" "Create a decompressor object for decompressing data incrementally.\n" "\n" "For one-shot decompression, use the decompress() function instead."); @@ -149,4 +159,4 @@ _bz2_BZ2Decompressor___init__(PyObject *self, PyObject *args, PyObject *kwargs) exit: return return_value; } -/*[clinic end generated code: output=aca4f6329c1c773a input=a9049054013a1b77]*/ +/*[clinic end generated code: output=21ca4405519a0931 input=a9049054013a1b77]*/ diff --git a/Modules/clinic/_lzmamodule.c.h b/Modules/clinic/_lzmamodule.c.h index 1848891..c1ad882 100644 --- a/Modules/clinic/_lzmamodule.c.h +++ b/Modules/clinic/_lzmamodule.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(_lzma_LZMACompressor_compress__doc__, -"sig=($self, data)\n" +"compress($self, data, /)\n" +"--\n" +"\n" "Provide data to the compressor object.\n" "\n" "Returns a chunk of compressed data if possible, or b\'\' otherwise.\n" @@ -38,7 +40,9 @@ exit: } PyDoc_STRVAR(_lzma_LZMACompressor_flush__doc__, -"sig=($self)\n" +"flush($self, /)\n" +"--\n" +"\n" "Finish the compression process.\n" "\n" "Returns the compressed data left in internal buffers.\n" @@ -58,7 +62,9 @@ _lzma_LZMACompressor_flush(Compressor *self, PyObject *Py_UNUSED(ignored)) } PyDoc_STRVAR(_lzma_LZMADecompressor_decompress__doc__, -"sig=($self, data)\n" +"decompress($self, data, /)\n" +"--\n" +"\n" "Provide data to the decompressor object.\n" "\n" "Returns a chunk of decompressed data if possible, or b\'\' otherwise.\n" @@ -94,7 +100,9 @@ exit: } PyDoc_STRVAR(_lzma_LZMADecompressor___init____doc__, -"sig=(format=FORMAT_AUTO, memlimit=None, filters=None)\n" +"LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None)\n" +"--\n" +"\n" "Create a decompressor object for decompressing data incrementally.\n" "\n" " format\n" @@ -137,7 +145,9 @@ exit: } PyDoc_STRVAR(_lzma_is_check_supported__doc__, -"sig=($module, check_id)\n" +"is_check_supported($module, check_id, /)\n" +"--\n" +"\n" "Test whether the given integrity check is supported.\n" "\n" "Always returns True for CHECK_NONE and CHECK_CRC32."); @@ -165,7 +175,9 @@ exit: } PyDoc_STRVAR(_lzma__encode_filter_properties__doc__, -"sig=($module, filter)\n" +"_encode_filter_properties($module, filter, /)\n" +"--\n" +"\n" "Return a bytes object encoding the options (properties) of the filter specified by *filter* (a dict).\n" "\n" "The result does not include the filter ID itself, only the options."); @@ -197,7 +209,9 @@ exit: } PyDoc_STRVAR(_lzma__decode_filter_properties__doc__, -"sig=($module, filter_id, encoded_props)\n" +"_decode_filter_properties($module, filter_id, encoded_props, /)\n" +"--\n" +"\n" "Return a bytes object encoding the options (properties) of the filter specified by *filter* (a dict).\n" "\n" "The result does not include the filter ID itself, only the options."); @@ -228,4 +242,4 @@ exit: return return_value; } -/*[clinic end generated code: output=fe63bc798a5c5c55 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=808fec8216ac712b input=a9049054013a1b77]*/ diff --git a/Modules/clinic/_pickle.c.h b/Modules/clinic/_pickle.c.h index 9ef469d..a20a61e 100644 --- a/Modules/clinic/_pickle.c.h +++ b/Modules/clinic/_pickle.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(_pickle_Pickler_clear_memo__doc__, -"sig=($self)\n" +"clear_memo($self, /)\n" +"--\n" +"\n" "Clears the pickler\'s \"memo\".\n" "\n" "The memo is the data structure that remembers which objects the\n" @@ -24,14 +26,18 @@ _pickle_Pickler_clear_memo(PicklerObject *self, PyObject *Py_UNUSED(ignored)) } PyDoc_STRVAR(_pickle_Pickler_dump__doc__, -"sig=($self, obj)\n" +"dump($self, obj, /)\n" +"--\n" +"\n" "Write a pickled representation of the given object to the open file."); #define _PICKLE_PICKLER_DUMP_METHODDEF \ {"dump", (PyCFunction)_pickle_Pickler_dump, METH_O, _pickle_Pickler_dump__doc__}, PyDoc_STRVAR(_pickle_Pickler___init____doc__, -"sig=(file, protocol=None, fix_imports=True)\n" +"Pickler(file, protocol=None, fix_imports=True)\n" +"--\n" +"\n" "This takes a binary file for writing a pickle data stream.\n" "\n" "The optional *protocol* argument tells the pickler to use the given\n" @@ -74,7 +80,9 @@ exit: } PyDoc_STRVAR(_pickle_PicklerMemoProxy_clear__doc__, -"sig=($self)\n" +"clear($self, /)\n" +"--\n" +"\n" "Remove all items from memo."); #define _PICKLE_PICKLERMEMOPROXY_CLEAR_METHODDEF \ @@ -90,7 +98,9 @@ _pickle_PicklerMemoProxy_clear(PicklerMemoProxyObject *self, PyObject *Py_UNUSED } PyDoc_STRVAR(_pickle_PicklerMemoProxy_copy__doc__, -"sig=($self)\n" +"copy($self, /)\n" +"--\n" +"\n" "Copy the memo to a new object."); #define _PICKLE_PICKLERMEMOPROXY_COPY_METHODDEF \ @@ -106,7 +116,9 @@ _pickle_PicklerMemoProxy_copy(PicklerMemoProxyObject *self, PyObject *Py_UNUSED( } PyDoc_STRVAR(_pickle_PicklerMemoProxy___reduce____doc__, -"sig=($self)\n" +"__reduce__($self, /)\n" +"--\n" +"\n" "Implement pickle support."); #define _PICKLE_PICKLERMEMOPROXY___REDUCE___METHODDEF \ @@ -122,7 +134,9 @@ _pickle_PicklerMemoProxy___reduce__(PicklerMemoProxyObject *self, PyObject *Py_U } PyDoc_STRVAR(_pickle_Unpickler_load__doc__, -"sig=($self)\n" +"load($self, /)\n" +"--\n" +"\n" "Load a pickle.\n" "\n" "Read a pickled object representation from the open file object given\n" @@ -142,7 +156,9 @@ _pickle_Unpickler_load(UnpicklerObject *self, PyObject *Py_UNUSED(ignored)) } PyDoc_STRVAR(_pickle_Unpickler_find_class__doc__, -"sig=($self, module_name, global_name)\n" +"find_class($self, module_name, global_name, /)\n" +"--\n" +"\n" "Return an object from a specified module.\n" "\n" "If necessary, the module will be imported. Subclasses may override\n" @@ -176,7 +192,9 @@ exit: } PyDoc_STRVAR(_pickle_Unpickler___init____doc__, -"sig=(file, *, fix_imports=True, encoding=\'ASCII\', errors=\'strict\')\n" +"Unpickler(file, *, fix_imports=True, encoding=\'ASCII\', errors=\'strict\')\n" +"--\n" +"\n" "This takes a binary file for reading a pickle data stream.\n" "\n" "The protocol version of the pickle is detected automatically, so no\n" @@ -222,7 +240,9 @@ exit: } PyDoc_STRVAR(_pickle_UnpicklerMemoProxy_clear__doc__, -"sig=($self)\n" +"clear($self, /)\n" +"--\n" +"\n" "Remove all items from memo."); #define _PICKLE_UNPICKLERMEMOPROXY_CLEAR_METHODDEF \ @@ -238,7 +258,9 @@ _pickle_UnpicklerMemoProxy_clear(UnpicklerMemoProxyObject *self, PyObject *Py_UN } PyDoc_STRVAR(_pickle_UnpicklerMemoProxy_copy__doc__, -"sig=($self)\n" +"copy($self, /)\n" +"--\n" +"\n" "Copy the memo to a new object."); #define _PICKLE_UNPICKLERMEMOPROXY_COPY_METHODDEF \ @@ -254,7 +276,9 @@ _pickle_UnpicklerMemoProxy_copy(UnpicklerMemoProxyObject *self, PyObject *Py_UNU } PyDoc_STRVAR(_pickle_UnpicklerMemoProxy___reduce____doc__, -"sig=($self)\n" +"__reduce__($self, /)\n" +"--\n" +"\n" "Implement pickling support."); #define _PICKLE_UNPICKLERMEMOPROXY___REDUCE___METHODDEF \ @@ -270,7 +294,9 @@ _pickle_UnpicklerMemoProxy___reduce__(UnpicklerMemoProxyObject *self, PyObject * } PyDoc_STRVAR(_pickle_dump__doc__, -"sig=($module, obj, file, protocol=None, *, fix_imports=True)\n" +"dump($module, /, obj, file, protocol=None, *, fix_imports=True)\n" +"--\n" +"\n" "Write a pickled representation of obj to the open file object file.\n" "\n" "This is equivalent to ``Pickler(file, protocol).dump(obj)``, but may\n" @@ -320,7 +346,9 @@ exit: } PyDoc_STRVAR(_pickle_dumps__doc__, -"sig=($module, obj, protocol=None, *, fix_imports=True)\n" +"dumps($module, /, obj, protocol=None, *, fix_imports=True)\n" +"--\n" +"\n" "Return the pickled representation of the object as a bytes object.\n" "\n" "The optional *protocol* argument tells the pickler to use the given\n" @@ -361,7 +389,10 @@ exit: } PyDoc_STRVAR(_pickle_load__doc__, -"sig=($module, file, *, fix_imports=True, encoding=\'ASCII\', errors=\'strict\')\n" +"load($module, /, file, *, fix_imports=True, encoding=\'ASCII\',\n" +" errors=\'strict\')\n" +"--\n" +"\n" "Read and return an object from the pickle data stored in a file.\n" "\n" "This is equivalent to ``Unpickler(file).load()``, but may be more\n" @@ -413,7 +444,10 @@ exit: } PyDoc_STRVAR(_pickle_loads__doc__, -"sig=($module, data, *, fix_imports=True, encoding=\'ASCII\', errors=\'strict\')\n" +"loads($module, /, data, *, fix_imports=True, encoding=\'ASCII\',\n" +" errors=\'strict\')\n" +"--\n" +"\n" "Read and return an object from the given pickle data.\n" "\n" "The protocol version of the pickle is detected automatically, so no\n" @@ -454,4 +488,4 @@ _pickle_loads(PyModuleDef *module, PyObject *args, PyObject *kwargs) exit: return return_value; } -/*[clinic end generated code: output=c59d4dafc2646f11 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=f965b6c7018c898d input=a9049054013a1b77]*/ diff --git a/Modules/clinic/audioop.c.h b/Modules/clinic/audioop.c.h index 92d13b0..40ef5e2 100644 --- a/Modules/clinic/audioop.c.h +++ b/Modules/clinic/audioop.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(audioop_getsample__doc__, -"sig=($module, fragment, width, index)\n" +"getsample($module, fragment, width, index, /)\n" +"--\n" +"\n" "Return the value of sample index from the fragment."); #define AUDIOOP_GETSAMPLE_METHODDEF \ @@ -35,7 +37,9 @@ exit: } PyDoc_STRVAR(audioop_max__doc__, -"sig=($module, fragment, width)\n" +"max($module, fragment, width, /)\n" +"--\n" +"\n" "Return the maximum of the absolute value of all samples in a fragment."); #define AUDIOOP_MAX_METHODDEF \ @@ -66,7 +70,9 @@ exit: } PyDoc_STRVAR(audioop_minmax__doc__, -"sig=($module, fragment, width)\n" +"minmax($module, fragment, width, /)\n" +"--\n" +"\n" "Return the minimum and maximum values of all samples in the sound fragment."); #define AUDIOOP_MINMAX_METHODDEF \ @@ -97,7 +103,9 @@ exit: } PyDoc_STRVAR(audioop_avg__doc__, -"sig=($module, fragment, width)\n" +"avg($module, fragment, width, /)\n" +"--\n" +"\n" "Return the average over all samples in the fragment."); #define AUDIOOP_AVG_METHODDEF \ @@ -128,7 +136,9 @@ exit: } PyDoc_STRVAR(audioop_rms__doc__, -"sig=($module, fragment, width)\n" +"rms($module, fragment, width, /)\n" +"--\n" +"\n" "Return the root-mean-square of the fragment, i.e. sqrt(sum(S_i^2)/n)."); #define AUDIOOP_RMS_METHODDEF \ @@ -159,7 +169,9 @@ exit: } PyDoc_STRVAR(audioop_findfit__doc__, -"sig=($module, fragment, reference)\n" +"findfit($module, fragment, reference, /)\n" +"--\n" +"\n" "Try to match reference as well as possible to a portion of fragment."); #define AUDIOOP_FINDFIT_METHODDEF \ @@ -193,7 +205,9 @@ exit: } PyDoc_STRVAR(audioop_findfactor__doc__, -"sig=($module, fragment, reference)\n" +"findfactor($module, fragment, reference, /)\n" +"--\n" +"\n" "Return a factor F such that rms(add(fragment, mul(reference, -F))) is minimal."); #define AUDIOOP_FINDFACTOR_METHODDEF \ @@ -227,7 +241,9 @@ exit: } PyDoc_STRVAR(audioop_findmax__doc__, -"sig=($module, fragment, length)\n" +"findmax($module, fragment, length, /)\n" +"--\n" +"\n" "Search fragment for a slice of specified number of samples with maximum energy."); #define AUDIOOP_FINDMAX_METHODDEF \ @@ -258,7 +274,9 @@ exit: } PyDoc_STRVAR(audioop_avgpp__doc__, -"sig=($module, fragment, width)\n" +"avgpp($module, fragment, width, /)\n" +"--\n" +"\n" "Return the average peak-peak value over all samples in the fragment."); #define AUDIOOP_AVGPP_METHODDEF \ @@ -289,7 +307,9 @@ exit: } PyDoc_STRVAR(audioop_maxpp__doc__, -"sig=($module, fragment, width)\n" +"maxpp($module, fragment, width, /)\n" +"--\n" +"\n" "Return the maximum peak-peak value in the sound fragment."); #define AUDIOOP_MAXPP_METHODDEF \ @@ -320,7 +340,9 @@ exit: } PyDoc_STRVAR(audioop_cross__doc__, -"sig=($module, fragment, width)\n" +"cross($module, fragment, width, /)\n" +"--\n" +"\n" "Return the number of zero crossings in the fragment passed as an argument."); #define AUDIOOP_CROSS_METHODDEF \ @@ -351,7 +373,9 @@ exit: } PyDoc_STRVAR(audioop_mul__doc__, -"sig=($module, fragment, width, factor)\n" +"mul($module, fragment, width, factor, /)\n" +"--\n" +"\n" "Return a fragment that has all samples in the original fragment multiplied by the floating-point value factor."); #define AUDIOOP_MUL_METHODDEF \ @@ -383,7 +407,9 @@ exit: } PyDoc_STRVAR(audioop_tomono__doc__, -"sig=($module, fragment, width, lfactor, rfactor)\n" +"tomono($module, fragment, width, lfactor, rfactor, /)\n" +"--\n" +"\n" "Convert a stereo fragment to a mono fragment."); #define AUDIOOP_TOMONO_METHODDEF \ @@ -416,7 +442,9 @@ exit: } PyDoc_STRVAR(audioop_tostereo__doc__, -"sig=($module, fragment, width, lfactor, rfactor)\n" +"tostereo($module, fragment, width, lfactor, rfactor, /)\n" +"--\n" +"\n" "Generate a stereo fragment from a mono fragment."); #define AUDIOOP_TOSTEREO_METHODDEF \ @@ -449,7 +477,9 @@ exit: } PyDoc_STRVAR(audioop_add__doc__, -"sig=($module, fragment1, fragment2, width)\n" +"add($module, fragment1, fragment2, width, /)\n" +"--\n" +"\n" "Return a fragment which is the addition of the two samples passed as parameters."); #define AUDIOOP_ADD_METHODDEF \ @@ -484,7 +514,9 @@ exit: } PyDoc_STRVAR(audioop_bias__doc__, -"sig=($module, fragment, width, bias)\n" +"bias($module, fragment, width, bias, /)\n" +"--\n" +"\n" "Return a fragment that is the original fragment with a bias added to each sample."); #define AUDIOOP_BIAS_METHODDEF \ @@ -516,7 +548,9 @@ exit: } PyDoc_STRVAR(audioop_reverse__doc__, -"sig=($module, fragment, width)\n" +"reverse($module, fragment, width, /)\n" +"--\n" +"\n" "Reverse the samples in a fragment and returns the modified fragment."); #define AUDIOOP_REVERSE_METHODDEF \ @@ -547,7 +581,9 @@ exit: } PyDoc_STRVAR(audioop_byteswap__doc__, -"sig=($module, fragment, width)\n" +"byteswap($module, fragment, width, /)\n" +"--\n" +"\n" "Convert big-endian samples to little-endian and vice versa."); #define AUDIOOP_BYTESWAP_METHODDEF \ @@ -578,7 +614,9 @@ exit: } PyDoc_STRVAR(audioop_lin2lin__doc__, -"sig=($module, fragment, width, newwidth)\n" +"lin2lin($module, fragment, width, newwidth, /)\n" +"--\n" +"\n" "Convert samples between 1-, 2-, 3- and 4-byte formats."); #define AUDIOOP_LIN2LIN_METHODDEF \ @@ -610,7 +648,10 @@ exit: } PyDoc_STRVAR(audioop_ratecv__doc__, -"sig=($module, fragment, width, nchannels, inrate, outrate, state, weightA=1, weightB=0)\n" +"ratecv($module, fragment, width, nchannels, inrate, outrate, state,\n" +" weightA=1, weightB=0, /)\n" +"--\n" +"\n" "Convert the frame rate of the input fragment."); #define AUDIOOP_RATECV_METHODDEF \ @@ -647,7 +688,9 @@ exit: } PyDoc_STRVAR(audioop_lin2ulaw__doc__, -"sig=($module, fragment, width)\n" +"lin2ulaw($module, fragment, width, /)\n" +"--\n" +"\n" "Convert samples in the audio fragment to u-LAW encoding."); #define AUDIOOP_LIN2ULAW_METHODDEF \ @@ -678,7 +721,9 @@ exit: } PyDoc_STRVAR(audioop_ulaw2lin__doc__, -"sig=($module, fragment, width)\n" +"ulaw2lin($module, fragment, width, /)\n" +"--\n" +"\n" "Convert sound fragments in u-LAW encoding to linearly encoded sound fragments."); #define AUDIOOP_ULAW2LIN_METHODDEF \ @@ -709,7 +754,9 @@ exit: } PyDoc_STRVAR(audioop_lin2alaw__doc__, -"sig=($module, fragment, width)\n" +"lin2alaw($module, fragment, width, /)\n" +"--\n" +"\n" "Convert samples in the audio fragment to a-LAW encoding."); #define AUDIOOP_LIN2ALAW_METHODDEF \ @@ -740,7 +787,9 @@ exit: } PyDoc_STRVAR(audioop_alaw2lin__doc__, -"sig=($module, fragment, width)\n" +"alaw2lin($module, fragment, width, /)\n" +"--\n" +"\n" "Convert sound fragments in a-LAW encoding to linearly encoded sound fragments."); #define AUDIOOP_ALAW2LIN_METHODDEF \ @@ -771,7 +820,9 @@ exit: } PyDoc_STRVAR(audioop_lin2adpcm__doc__, -"sig=($module, fragment, width, state)\n" +"lin2adpcm($module, fragment, width, state, /)\n" +"--\n" +"\n" "Convert samples to 4 bit Intel/DVI ADPCM encoding."); #define AUDIOOP_LIN2ADPCM_METHODDEF \ @@ -803,7 +854,9 @@ exit: } PyDoc_STRVAR(audioop_adpcm2lin__doc__, -"sig=($module, fragment, width, state)\n" +"adpcm2lin($module, fragment, width, state, /)\n" +"--\n" +"\n" "Decode an Intel/DVI ADPCM coded fragment to a linear fragment."); #define AUDIOOP_ADPCM2LIN_METHODDEF \ @@ -833,4 +886,4 @@ exit: return return_value; } -/*[clinic end generated code: output=ee7e58cfd3d0d5a6 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=be840bba5d40c2ce input=a9049054013a1b77]*/ diff --git a/Modules/clinic/binascii.c.h b/Modules/clinic/binascii.c.h index e4ef36c..5247180 100644 --- a/Modules/clinic/binascii.c.h +++ b/Modules/clinic/binascii.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(binascii_a2b_uu__doc__, -"sig=($module, data)\n" +"a2b_uu($module, data, /)\n" +"--\n" +"\n" "Decode a line of uuencoded data."); #define BINASCII_A2B_UU_METHODDEF \ @@ -33,7 +35,9 @@ exit: } PyDoc_STRVAR(binascii_b2a_uu__doc__, -"sig=($module, data)\n" +"b2a_uu($module, data, /)\n" +"--\n" +"\n" "Uuencode line of data."); #define BINASCII_B2A_UU_METHODDEF \ @@ -63,7 +67,9 @@ exit: } PyDoc_STRVAR(binascii_a2b_base64__doc__, -"sig=($module, data)\n" +"a2b_base64($module, data, /)\n" +"--\n" +"\n" "Decode a line of base64 data."); #define BINASCII_A2B_BASE64_METHODDEF \ @@ -93,7 +99,9 @@ exit: } PyDoc_STRVAR(binascii_b2a_base64__doc__, -"sig=($module, data)\n" +"b2a_base64($module, data, /)\n" +"--\n" +"\n" "Base64-code line of data."); #define BINASCII_B2A_BASE64_METHODDEF \ @@ -123,7 +131,9 @@ exit: } PyDoc_STRVAR(binascii_a2b_hqx__doc__, -"sig=($module, data)\n" +"a2b_hqx($module, data, /)\n" +"--\n" +"\n" "Decode .hqx coding."); #define BINASCII_A2B_HQX_METHODDEF \ @@ -153,7 +163,9 @@ exit: } PyDoc_STRVAR(binascii_rlecode_hqx__doc__, -"sig=($module, data)\n" +"rlecode_hqx($module, data, /)\n" +"--\n" +"\n" "Binhex RLE-code binary data."); #define BINASCII_RLECODE_HQX_METHODDEF \ @@ -183,7 +195,9 @@ exit: } PyDoc_STRVAR(binascii_b2a_hqx__doc__, -"sig=($module, data)\n" +"b2a_hqx($module, data, /)\n" +"--\n" +"\n" "Encode .hqx data."); #define BINASCII_B2A_HQX_METHODDEF \ @@ -213,7 +227,9 @@ exit: } PyDoc_STRVAR(binascii_rledecode_hqx__doc__, -"sig=($module, data)\n" +"rledecode_hqx($module, data, /)\n" +"--\n" +"\n" "Decode hexbin RLE-coded string."); #define BINASCII_RLEDECODE_HQX_METHODDEF \ @@ -243,7 +259,9 @@ exit: } PyDoc_STRVAR(binascii_crc_hqx__doc__, -"sig=($module, data, crc)\n" +"crc_hqx($module, data, crc, /)\n" +"--\n" +"\n" "Compute hqx CRC incrementally."); #define BINASCII_CRC_HQX_METHODDEF \ @@ -278,7 +296,9 @@ exit: } PyDoc_STRVAR(binascii_crc32__doc__, -"sig=($module, data, crc=0)\n" +"crc32($module, data, crc=0, /)\n" +"--\n" +"\n" "Compute CRC-32 incrementally."); #define BINASCII_CRC32_METHODDEF \ @@ -313,7 +333,9 @@ exit: } PyDoc_STRVAR(binascii_b2a_hex__doc__, -"sig=($module, data)\n" +"b2a_hex($module, data, /)\n" +"--\n" +"\n" "Hexadecimal representation of binary data.\n" "\n" "The return value is a bytes object. This function is also\n" @@ -346,7 +368,9 @@ exit: } PyDoc_STRVAR(binascii_a2b_hex__doc__, -"sig=($module, hexstr)\n" +"a2b_hex($module, hexstr, /)\n" +"--\n" +"\n" "Binary data of hexadecimal representation.\n" "\n" "hexstr must contain an even number of hex digits (upper or lower case).\n" @@ -379,7 +403,9 @@ exit: } PyDoc_STRVAR(binascii_a2b_qp__doc__, -"sig=($module, data, header=False)\n" +"a2b_qp($module, /, data, header=False)\n" +"--\n" +"\n" "Decode a string of qp-encoded data."); #define BINASCII_A2B_QP_METHODDEF \ @@ -411,7 +437,9 @@ exit: } PyDoc_STRVAR(binascii_b2a_qp__doc__, -"sig=($module, data, quotetabs=False, istext=True, header=False)\n" +"b2a_qp($module, /, data, quotetabs=False, istext=True, header=False)\n" +"--\n" +"\n" "Encode a string using quoted-printable encoding.\n" "\n" "On encoding, when istext is set, newlines are not encoded, and white\n" @@ -447,4 +475,4 @@ exit: return return_value; } -/*[clinic end generated code: output=831a8ccc9f984001 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=68e2bcc6956b6213 input=a9049054013a1b77]*/ diff --git a/Modules/clinic/zlibmodule.c.h b/Modules/clinic/zlibmodule.c.h index f810fcf..f54a805 100644 --- a/Modules/clinic/zlibmodule.c.h +++ b/Modules/clinic/zlibmodule.c.h @@ -3,7 +3,9 @@ preserve [clinic start generated code]*/ PyDoc_STRVAR(zlib_compress__doc__, -"sig=($module, bytes, level=Z_DEFAULT_COMPRESSION)\n" +"compress($module, bytes, level=Z_DEFAULT_COMPRESSION, /)\n" +"--\n" +"\n" "Returns a bytes object containing compressed data.\n" "\n" " bytes\n" @@ -39,7 +41,9 @@ exit: } PyDoc_STRVAR(zlib_decompress__doc__, -"sig=($module, data, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)\n" +"decompress($module, data, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE, /)\n" +"--\n" +"\n" "Returns a bytes object containing the uncompressed data.\n" "\n" " data\n" @@ -78,7 +82,11 @@ exit: } PyDoc_STRVAR(zlib_compressobj__doc__, -"sig=($module, level=Z_DEFAULT_COMPRESSION, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY, zdict=None)\n" +"compressobj($module, /, level=Z_DEFAULT_COMPRESSION, method=DEFLATED,\n" +" wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL,\n" +" strategy=Z_DEFAULT_STRATEGY, zdict=None)\n" +"--\n" +"\n" "Return a compressor object.\n" "\n" " level\n" @@ -132,7 +140,9 @@ exit: } PyDoc_STRVAR(zlib_decompressobj__doc__, -"sig=($module, wbits=MAX_WBITS, zdict=b\'\')\n" +"decompressobj($module, /, wbits=MAX_WBITS, zdict=b\'\')\n" +"--\n" +"\n" "Return a decompressor object.\n" "\n" " wbits\n" @@ -166,7 +176,9 @@ exit: } PyDoc_STRVAR(zlib_Compress_compress__doc__, -"sig=($self, data)\n" +"compress($self, data, /)\n" +"--\n" +"\n" "Returns a bytes object containing compressed data.\n" "\n" " data\n" @@ -203,7 +215,9 @@ exit: } PyDoc_STRVAR(zlib_Decompress_decompress__doc__, -"sig=($self, data, max_length=0)\n" +"decompress($self, data, max_length=0, /)\n" +"--\n" +"\n" "Return a bytes object containing the decompressed version of the data.\n" "\n" " data\n" @@ -245,7 +259,9 @@ exit: } PyDoc_STRVAR(zlib_Compress_flush__doc__, -"sig=($self, mode=zlib.Z_FINISH)\n" +"flush($self, mode=zlib.Z_FINISH, /)\n" +"--\n" +"\n" "Return a bytes object containing any remaining compressed data.\n" "\n" " mode\n" @@ -279,7 +295,9 @@ exit: #if defined(HAVE_ZLIB_COPY) PyDoc_STRVAR(zlib_Compress_copy__doc__, -"sig=($self)\n" +"copy($self, /)\n" +"--\n" +"\n" "Return a copy of the compression object."); #define ZLIB_COMPRESS_COPY_METHODDEF \ @@ -303,7 +321,9 @@ zlib_Compress_copy(compobject *self, PyObject *Py_UNUSED(ignored)) #if defined(HAVE_ZLIB_COPY) PyDoc_STRVAR(zlib_Decompress_copy__doc__, -"sig=($self)\n" +"copy($self, /)\n" +"--\n" +"\n" "Return a copy of the decompression object."); #define ZLIB_DECOMPRESS_COPY_METHODDEF \ @@ -325,7 +345,9 @@ zlib_Decompress_copy(compobject *self, PyObject *Py_UNUSED(ignored)) #endif /* !defined(ZLIB_DECOMPRESS_COPY_METHODDEF) */ PyDoc_STRVAR(zlib_Decompress_flush__doc__, -"sig=($self, length=zlib.DEF_BUF_SIZE)\n" +"flush($self, length=zlib.DEF_BUF_SIZE, /)\n" +"--\n" +"\n" "Return a bytes object containing any remaining decompressed data.\n" "\n" " length\n" @@ -354,7 +376,9 @@ exit: } PyDoc_STRVAR(zlib_adler32__doc__, -"sig=($module, data, value=1)\n" +"adler32($module, data, value=1, /)\n" +"--\n" +"\n" "Compute an Adler-32 checksum of data.\n" "\n" " value\n" @@ -390,7 +414,9 @@ exit: } PyDoc_STRVAR(zlib_crc32__doc__, -"sig=($module, data, value=0)\n" +"crc32($module, data, value=0, /)\n" +"--\n" +"\n" "Compute a CRC-32 checksum of data.\n" "\n" " value\n" @@ -424,4 +450,4 @@ exit: return return_value; } -/*[clinic end generated code: output=67d3e81eafcfb982 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=bc9473721ca7c962 input=a9049054013a1b77]*/ diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c index 0646043f..1428220 100644 --- a/Modules/posixmodule.c +++ b/Modules/posixmodule.c @@ -2435,7 +2435,9 @@ It's an error to use dir_fd or follow_symlinks when specifying path as [clinic start generated code]*/ PyDoc_STRVAR(os_stat__doc__, -"sig=($module, path, *, dir_fd=None, follow_symlinks=True)\n" +"stat($module, /, path, *, dir_fd=None, follow_symlinks=True)\n" +"--\n" +"\n" "Perform a stat system call on the given path.\n" "\n" " path\n" @@ -2486,7 +2488,7 @@ exit: static PyObject * os_stat_impl(PyModuleDef *module, path_t *path, int dir_fd, int follow_symlinks) -/*[clinic end generated code: output=33b6ee92cd1b98de input=5ae155bd475fd20a]*/ +/*[clinic end generated code: output=f1dcaa5e24db9882 input=5ae155bd475fd20a]*/ { return posix_do_stat("stat", path, dir_fd, follow_symlinks); } @@ -2567,7 +2569,10 @@ Note that most operations will use the effective uid/gid, therefore this [clinic start generated code]*/ PyDoc_STRVAR(os_access__doc__, -"sig=($module, path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)\n" +"access($module, /, path, mode, *, dir_fd=None, effective_ids=False,\n" +" follow_symlinks=True)\n" +"--\n" +"\n" "Use the real uid/gid to test for access to a path.\n" "\n" " path\n" @@ -2627,7 +2632,7 @@ exit: static PyObject * os_access_impl(PyModuleDef *module, path_t *path, int mode, int dir_fd, int effective_ids, int follow_symlinks) -/*[clinic end generated code: output=33b3fafc61e778e1 input=2e2e7594371f5b7e]*/ +/*[clinic end generated code: output=a6ed4f151be9df0f input=2e2e7594371f5b7e]*/ { PyObject *return_value = NULL; @@ -2723,7 +2728,9 @@ Return the name of the terminal device connected to 'fd'. [clinic start generated code]*/ PyDoc_STRVAR(os_ttyname__doc__, -"sig=($module, fd)\n" +"ttyname($module, fd, /)\n" +"--\n" +"\n" "Return the name of the terminal device connected to \'fd\'.\n" "\n" " fd\n" @@ -2757,7 +2764,7 @@ exit: static char * os_ttyname_impl(PyModuleDef *module, int fd) -/*[clinic end generated code: output=c3083e665d4d11b9 input=5f72ca83e76b3b45]*/ +/*[clinic end generated code: output=cee7bc4cffec01a2 input=5f72ca83e76b3b45]*/ { char *ret; diff --git a/Modules/unicodedata.c b/Modules/unicodedata.c index c6c4ba2..3253db2 100644 --- a/Modules/unicodedata.c +++ b/Modules/unicodedata.c @@ -129,7 +129,9 @@ not given, ValueError is raised. [clinic start generated code]*/ PyDoc_STRVAR(unicodedata_UCD_decimal__doc__, -"sig=($self, unichr, default=None)\n" +"decimal($self, unichr, default=None, /)\n" +"--\n" +"\n" "Converts a Unicode character into its equivalent decimal value.\n" "\n" "Returns the decimal value assigned to the Unicode character unichr\n" @@ -161,7 +163,7 @@ exit: static PyObject * unicodedata_UCD_decimal_impl(PreviousDBVersion *self, PyUnicodeObject *unichr, PyObject *default_value) -/*[clinic end generated code: output=a3ad5de9393acb2f input=c25c9d2b4de076b1]*/ +/*[clinic end generated code: output=8689669896d293df input=c25c9d2b4de076b1]*/ { int have_old = 0; long rc; |