summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/arg.rst
Commit message (Collapse)AuthorAgeFilesLines
* bpo-36346: Document removal schedule of deprecate APIs (GH-20879) (#24626)Miss Islington (bot)2021-03-011-4/+4
| | | | | | | | We will remove wstr cache in Python 3.12. See PEP 623. (cherry picked from commit 2d6f2eed14ff5d89155b52771cc8ef957e8145b4) Co-authored-by: Inada Naoki <songofacandy@gmail.com> Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-13/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a) (cherry picked from commit 8f88190af529543c84d5dc78f19abbfd73335cf4)
* Doc: int -> int or Py_ssize_t (GH-18663)Miss Islington (bot)2020-02-261-11/+11
| | | | | (cherry picked from commit 57c7a0bdf4f7da8cf47f797f075950f6b8c98b99) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003)Serhiy Storchaka2019-10-301-1/+1
| | | | | Also fix some other formatting. (cherry picked from commit e835b31d2b212c3c7820364398979cae2a9740b2)
* [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. ↵Serhiy Storchaka2019-10-301-24/+24
| | | | | | | (GH-16950) (GH-16999) Replace all *NULL* with ``NULL``. (cherry picked from commit 25fc088607c855060ed142296dc1bd0125fad1af)
* Doc: Replace the deprecated highlightlang directive by highlight. (#13377)Stéphane Wirtel2019-05-171-1/+1
| | | | highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
* bpo-33195: Doc: Deprecate Py_UNICODE in c-api/arg (GH-6329)INADA Naoki2018-04-041-5/+22
| | | | Py_UNICODE is deprecated since Python 3.3. But the deprecation is missed in the c-api/arg document.
* bpo-29918: Add missed "const" modifiers in C API documentation. (#846)Serhiy Storchaka2017-03-301-14/+14
|
* Issue #28496: Mark up constants 0, 1 and -1 that denote return values orSerhiy Storchaka2016-10-271-1/+1
|\ | | | | | | special input values as literal text.
| * Issue #28496: Mark up constants 0, 1 and -1 that denote return values orSerhiy Storchaka2016-10-271-1/+1
| | | | | | | | special input values as literal text.
* | more PY_LONG_LONG to long longBenjamin Peterson2016-09-081-15/+8
| |
* | Issue #24278: Merge argument parsing docs from 3.5Martin Panter2016-08-041-14/+19
|\ \ | |/
| * Issue #24278: Explain how argument parsing output buffers are managedMartin Panter2016-08-031-14/+19
| |
* | Issue #27481: Docummented that ValueError is now raised instead of TypeErrorSerhiy Storchaka2016-07-121-5/+17
|\ \ | |/ | | | | in case of embedded null characters/bytes. Patch by Xiang Zhang.
| * Issue #27481: Docummented that ValueError is now raised instead of TypeErrorSerhiy Storchaka2016-07-121-5/+17
| | | | | | | | in case of embedded null characters/bytes. Patch by Xiang Zhang.
* | Issue #26282: PyArg_ParseTupleAndKeywords() and Argument Clinic now supportSerhiy Storchaka2016-06-091-2/+9
| | | | | | | | positional-only and keyword parameters in the same function.
* | Issue #26304: Merge doc wording from 3.5Martin Panter2016-02-101-1/+1
|\ \ | |/
| * Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similarMartin Panter2016-02-101-1/+1
| | | | | | | | | | The original form is incorrect grammar and feels awkward, even though the meaning is clear.
| * Issue #26198: Fixed error messages for some argument parsing errors.Serhiy Storchaka2016-02-071-1/+2
|/ | | | | Fixed the documented about buffer overflow error for "es#" and "et#" format units.
* Issue #25706: Fixed markup in the documentation.Serhiy Storchaka2015-11-231-1/+1
|\
| * Issue #25706: Fixed markup in the documentation.Serhiy Storchaka2015-11-231-1/+1
| |
* | Doc clarification / edification on the semantics of the 'w*' format unit.Larry Hastings2015-04-131-1/+1
|/
* Issue #22581: Use more "bytes-like object" throughout the docs and comments.Serhiy Storchaka2014-12-051-13/+14
|
* #22613: remaining corrections in extending/reference docs (thanks Jacques ↵Georg Brandl2014-10-311-4/+5
| | | | Ducasse)
* Merge in all documentation changes since branching 3.4.0rc1.Larry Hastings2014-03-161-0/+1
|
* Issue #20460: Merge with 3.3Zachary Ware2014-01-311-1/+1
|\
| * Issue #20460: Render 'bytes' as a class, not a function.Zachary Ware2014-01-311-1/+1
| | | | | | | | Patch by OSAMU NAKAMURA.
* | Issue #20226: Major improvements to Argument Clinic.Larry Hastings2014-01-161-0/+2
|/ | | | | | | | | | | | | | | | | | | | | | | * You may now specify an expression as the default value for a parameter! Example: "sys.maxsize - 1". This support is intentionally quite limited; you may only use values that can be represented as static C values. * Removed "doc_default", simplified support for "c_default" and "py_default". (I'm not sure we still even need "py_default", but I'm leaving it in for now in case a use presents itself.) * Parameter lines support a trailing '\\' as a line continuation character, allowing you to break up long lines. * The argument parsing code generated when supporting optional groups now uses PyTuple_GET_SIZE instead of PyTuple_GetSize, leading to a 850% speedup in parsing. (Just kidding, this is an unmeasurable difference.) * A bugfix for the recent regression where the generated prototype from pydoc for builtins would be littered with unreadable "=<object ...>"" default values for parameters that had no default value. * Converted some asserts into proper failure messages. * Many doc improvements and fixes.
* #16518: use "bytes-like object" throughout the docs.Ezio Melotti2013-05-041-7/+6
|
* Fix a couple of versionadded/versionchanged related markup errors.Georg Brandl2012-06-241-2/+3
|
* Issue #14705: Add 'p' format character to PyArg_ParseTuple* for bool support.Larry Hastings2012-05-051-0/+9
|
* Issue #14328: Add keyword-only parameters to PyArg_ParseTupleAndKeywords.Larry Hastings2012-03-201-0/+9
| | | | | | They're optional-only for now (unlike in pure Python) but that's all I needed. The syntax can easily be relaxed if we want to support required keyword-only arguments for extension types in the future.
* c-api: Replace PyUnicodeObject* by PyObject* in "U" format docVictor Stinner2011-12-011-1/+1
|
* Issue #12380: PyArg_ParseTuple now accepts a bytearray for the 'c' format.Eli Bendersky2011-07-291-3/+5
| | | | | | | As a side effect, this now allows the rjust, ljust and center methods of bytes and bytearray to accept a bytearray argument. Patch by Petri Lehtinen
* Issue #10840: make it explicit that "s*" and friends provide contiguous memory.Antoine Pitrou2011-01-061-3/+4
|
* Migrate to Sphinx 1.0 C language constructs.Georg Brandl2010-10-061-99/+99
|
* #9911: doc copyedits.Georg Brandl2010-09-211-1/+1
|
* Consistency check for versionadded/changed directives.Georg Brandl2010-08-171-5/+6
|
* #9158: Fix y* format of PyArg_Parse*() functions documentationVictor Stinner2010-07-051-1/+1
|
* Issue #8850: Remove "w" and "w#" formats from PyArg_Parse*() functions, useVictor Stinner2010-06-251-14/+4
| | | | "w*" format instead. Add tests for "w*" format.
* Issue #8939: Improve arg.rstVictor Stinner2010-06-181-5/+5
| | | | | | * Add :ctype: to Py_BEGIN_ALLOW_THREADS and int * "s" and "s#" formats of Py_BuildValue(): specify that the Python object type is str in the description
* Issue #8592: PyArg_Parse*() functions raise a TypeError for "y", "u" and "Z"Victor Stinner2010-06-131-0/+2
| | | | | formats if the string contains a null byte/character. Write unit tests for string formats.
* Fix some bugs in c-api/arg.rst documentationVictor Stinner2010-06-111-16/+15
| | | | | | | | | | | | | | | | * replace "the default encoding" by "'utf-8' encoding" * fix "w" / "w*" / "w#" doc: similar to "y" / "y*" / "y#" and not "s" / "s*" / "s#" * "u#": remove "Non-Unicode objects are handled by interpreting their read-buffer pointer ...", it's no more true * "es", "es#": remove "... and objects convertible to Unicode into a character buffer", it's no more true * Py_BuildValue(), "K" and "L" formats: specify the name of the C type on Windows (_int64 / unsigned _int64) as done for PyArg_Parse*() long long types --CETTE ligne, et les suivantes ci-dessous, seront ignorées-- M Doc/c-api/arg.rst
* Issue #8838, #8339: Remove codecs.charbuffer_encode() and "t#" parsing formatVictor Stinner2010-06-081-7/+0
| | | | | Remove last references to the "char buffer" of the buffer protocol from Python3.
* Issue #8925: fix types of Py_Parse*() and Py_BuildValue() functionsVictor Stinner2010-06-071-89/+91
| | | | | | | | | * Add links to Python types * Replace "string" by bytes or str * Replace "long" by "int" * Specify the default encoding * Fix reST syntax ("..note ::") * etc.
* Issue #8848: U / U# formats of Py_BuildValue() are just alias to s / s#Victor Stinner2010-06-071-4/+2
|
* Issue #8593: Fix, reorder and improve the documentation for argument parsingAntoine Pitrou2010-05-031-97/+142
|
* add versionaddedBenjamin Peterson2010-04-251-0/+2
|
* prevent the dict constructor from accepting non-string keyword args #8419Benjamin Peterson2010-04-241-0/+7
| | | | | This adds PyArg_ValidateKeywordArguments, which checks that keyword arguments are all strings, using an optimized method if possible.
* Merged revisions 77242 via svnmerge fromGregory P. Smith2010-01-021-3/+3
| | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r77242 | gregory.p.smith | 2010-01-02 13:29:54 -0800 (Sat, 02 Jan 2010) | 3 lines Correct documentation for s* z* and w*, the argument that should be passed is the address of a Py_buffer, not a Py_buffer *. ........
generated by cgit v0.12 at 2024-11-11 15:36:26 (GMT)