632524a5cb
gh-132987: Support __index__() for "k" and "K" formats in PyArg_Parse (GH-132988)
2025-04-26 17:14:18 +03:00
3fa024dec3
gh-132909: handle overflow for `'K'` format in `do_mkvalue` ( #132911 )
2025-04-25 11:02:57 +00:00
f5f1ac84b3
gh-112068: C API: Add support of nullable arguments in PyArg_Parse (GH-121303)
2025-04-08 22:08:00 +03:00
0e4cf9ce7c
gh-50333: Deprecate support of non-tuple sequences in PyArg_ParseTuple() (GH-128374)
...
Non-tuple sequences are deprecated as argument for the "(items)" format unit
in PyArg_ParseTuple() and other argument parsing functions if items contains
format units which store borrowed buffer or reference (e.g. "s" and "O").
str and bytearray are no longer accepted as valid sequences.
2025-04-08 14:26:32 +03:00
37145cb89f
Fix grammar typo in `Doc/c-api/arg.rst` ( #130741 )
2025-03-02 10:24:34 +01:00
51d4bf1e0e
bpo-45325: Add a new 'p' parameter to Py_BuildValue to convert an integer into a Python bool ( #28634 )
2025-02-18 17:14:11 +00:00
657d7b77e5
gh-90241: Clarify documentation for PyUnicode_FSConverter and PyUnicode_FSDecoder (GH-128451)
...
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2025-01-06 13:28:50 +01:00
8d15058d61
gh-77214: Update outdated documentation for numeric PyArg_Parse formats (GH-128454)
2025-01-06 12:50:28 +02:00
1a0c7b9ba4
gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907)
2024-07-19 08:06:02 +00:00
da6760bdf5
gh-65210: Add const qualifiers in PyArg_VaParseTupleAndKeywords() (GH-105958)
...
Change the declaration of the keywords parameter in functions
PyArg_ParseTupleAndKeywords() and PyArg_VaParseTupleAndKeywords() from `char **`
to `char * const *` in C and `const char * const *` in C++.
It makes these functions compatible with argument of type `const char * const *`,
`const char **` or `char * const *` in C++ and `char * const *` in C
without explicit type cast.
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-12-04 13:14:56 +02:00
7284e0ef84
gh-110815: Support non-ASCII keyword names in PyArg_ParseTupleAndKeywords() (GH-110816)
...
It already mostly worked, except in the case when invalid keyword
argument with non-ASCII name was passed to function with non-ASCII
parameter names. Then it crashed in the debug mode.
2023-10-14 08:50:03 +03:00
5dc825d504
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)
...
PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.
This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
87b39028e5
gh-107298: Fix doc references to undocumented modules ( #107300 )
...
Update also Doc/tools/.nitignore.
2023-07-26 18:59:06 +02:00
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
2023-07-22 21:35:22 +03:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
d0f1afd942
gh-105373: Remove PyArg_Parse() deprecation ( #105394 )
...
There is no plan to deprecate PyArg_Parse().
The deprecation was added as a comment in the C API documentation in
2007 by commit 85eb8c103c
2023-06-13 13:49:36 +02:00
adccff3b3f
gh-104922: Make `PY_SSIZE_T_CLEAN` not mandatory again ( #105051 )
2023-05-31 18:38:55 +09:00
49f6ff719c
gh-98712: Clarify "readonly bytes-like object" semantics in C arg-parsing docs ( #98710 )
2022-12-23 07:00:21 -08:00
0031e62973
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) ( #97768 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-05 11:01:14 -07:00
0e72606dd4
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) ( #97774 )
2022-10-05 08:22:28 -07:00
0bf6a617ed
gh-93738: Documentation C syntax (:c:type:`PyObject` -> :c:expr:`PyObject`) ( #97776 )
...
:c:type:`PyObject` -> :c:expr:`PyObject`
2022-10-04 16:13:03 -07:00
664aa94b57
Document Py_ssize_t. (GH-92512)
...
It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But
there's 8182 errors left.
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-13 14:10:16 +02:00
e371d5d5d1
gh-92536: Doc update about Py_UNICODE removal (GH-92756)
2022-05-13 13:15:41 +09:00
f9c9354a7a
gh-92536: PEP 623: Remove wstr and legacy APIs from Unicode (GH-92537)
2022-05-12 14:48:38 +09:00
2d6f2eed14
bpo-36346: Document removal schedule of deprecate APIs (GH-20879)
...
We will remove wstr cache in Python 3.12. See PEP 623.
2021-02-23 08:06:51 +09:00
23c5f93b83
bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206)
...
Add "borrowed reference" and "strong reference" to the documentation
glossary.
Enhance also Py_INCREF() and Py_NewRef() documentation.
2020-11-09 13:40:47 +01:00
474652fe93
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.
2020-08-13 22:11:50 +02:00
37bb289556
bpo-40943: PY_SSIZE_T_CLEAN required for '#' formats (GH-20784)
...
The PY_SSIZE_T_CLEAN macro must now be defined to use
PyArg_ParseTuple() and Py_BuildValue() "#" formats: "es#", "et#",
"s#", "u#", "y#", "z#", "U#" and "Z#". See the PEP 353.
Update _testcapi.test_buildvalue_issue38913().
2020-06-19 11:45:31 +02:00
57c7a0bdf4
Doc: int -> int or Py_ssize_t (GH-18663)
2020-02-26 15:04:39 +09:00
e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
...
Also fix some other formatting.
2019-10-30 21:37:16 +02:00
25fc088607
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950)
...
Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
cbb6484573
Doc: Replace the deprecated highlightlang directive by highlight. ( #13377 )
...
highlightlang is deprecated since April 2018 in Sphinx.
See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 15:25:34 +05:30
42ec190761
bpo-33195: Doc: Deprecate Py_UNICODE in c-api/arg (GH-6329)
...
Py_UNICODE is deprecated since Python 3.3.
But the deprecation is missed in the c-api/arg document.
2018-04-04 13:59:08 +09:00
84b8e92e46
bpo-29918: Add missed "const" modifiers in C API documentation. ( #846 )
2017-03-30 10:01:03 +03:00
159f97b2d7
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:42:15 +03:00
1ecf7d204d
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:41:19 +03:00
47ff0734b8
more PY_LONG_LONG to long long
2016-09-08 09:15:54 -07:00
0de01c4b30
Issue #24278 : Merge argument parsing docs from 3.5
2016-08-04 01:51:32 +00:00
6c7d5a2553
Issue #24278 : Explain how argument parsing output buffers are managed
2016-08-03 14:35:05 +00:00
b133bb4977
Issue #27481 : Docummented that ValueError is now raised instead of TypeError
...
in case of embedded null characters/bytes. Patch by Xiang Zhang.
2016-07-12 09:15:00 +03:00
6f379f4886
Issue #27481 : Docummented that ValueError is now raised instead of TypeError
...
in case of embedded null characters/bytes. Patch by Xiang Zhang.
2016-07-12 09:14:15 +03:00
f41b82fb19
Issue #26282 : PyArg_ParseTupleAndKeywords() and Argument Clinic now support
...
positional-only and keyword parameters in the same function.
2016-06-09 16:30:29 +03:00
3008b1c4bb
Issue #26304 : Merge doc wording from 3.5
2016-02-10 05:44:56 +00:00
c04fb56e36
Issue #26304 : Change "allows to <verb>" to "allows <verb>ing" or similar
...
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
c4b813d05d
Issue #26198 : Fixed error messages for some argument parsing errors.
...
Fixed the documented about buffer overflow error for "es#" and "et#" format
units.
2016-02-08 01:06:11 +02:00
1f847659f3
Issue #25706 : Fixed markup in the documentation.
2015-11-23 16:43:54 +02:00
bf7b9ede1a
Issue #25706 : Fixed markup in the documentation.
2015-11-23 16:43:05 +02:00
ab792ac704
Doc clarification / edification on the semantics of the 'w*' format unit.
2015-04-13 11:30:56 -04:00
b757c83ec6
Issue #22581 : Use more "bytes-like object" throughout the docs and comments.
2014-12-05 22:25:22 +02:00
a4c8c47961
#22613 : remaining corrections in extending/reference docs (thanks Jacques Ducasse)
2014-10-31 10:38:49 +01:00
Serhiy Storchaka