| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent e012cf7 commit 2928e5d
2 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -158,7 +158,7 @@ process a single source file, like this: | |||
| 158 | 158 | The CLI supports the following options: | |
| 159 | 159 | ||
| 160 | 160 | .. program:: ./Tools/clinic/clinic.py [-h] [-f] [-o OUTPUT] [-v] \ | |
| 161 | - [--converters] [--make] [--srcdir SRCDIR] [FILE ...] | ||
| 161 | + [--converters] [--make] [--srcdir SRCDIR] [--limited] [FILE ...] | ||
| 162 | 162 | ||
| 163 | 163 | .. option:: -h, --help | |
| 164 | 164 | ||
@@ -193,6 +193,11 @@ The CLI supports the following options: | |||
| 193 | 193 | A file to exclude in :option:`--make` mode. | |
| 194 | 194 | This option can be given multiple times. | |
| 195 | 195 | ||
| 196 | + .. option:: --limited | ||
| 197 | + | ||
| 198 | + Use the :ref:`Limited API <limited-c-api>` to parse arguments in the generated C code. | ||
| 199 | + See :ref:`clinic-howto-limited-capi`. | ||
| 200 | + | ||
| 196 | 201 | .. option:: FILE ... | |
| 197 | 202 | ||
| 198 | 203 | The list of files to process. | |
@@ -1905,6 +1910,22 @@ blocks embedded in Python files look slightly different. They look like this: | |||
| 1905 | 1910 | #/*[python checksum:...]*/ | |
| 1906 | 1911 | ||
| 1907 | 1912 | ||
| 1913 | + .. _clinic-howto-limited-capi: | ||
| 1914 | + | ||
| 1915 | + How to use the Limited C API | ||
| 1916 | + ---------------------------- | ||
| 1917 | + | ||
| 1918 | + If Argument Clinic :term:`input` is located within a C source file | ||
| 1919 | + that contains ``#define Py_LIMITED_API``, Argument Clinic will generate C code | ||
| 1920 | + that uses the :ref:`Limited API <limited-c-api>` to parse arguments. The | ||
| 1921 | + advantage of this is that the generated code will not use private functions. | ||
| 1922 | + However, this *can* result in Argument Clinic generating less efficient code | ||
| 1923 | + in some cases. The extent of the performance penalty will depend | ||
| 1924 | + on the parameters (types, number, etc.). | ||
| 1925 | + | ||
| 1926 | + .. versionadded:: 3.13 | ||
| 1927 | + | ||
| 1928 | + | ||
| 1908 | 1929 | .. _clinic-howto-override-signature: | |
| 1909 | 1930 | ||
| 1910 | 1931 | How to override the generated signature | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,2 +1,3 @@ | |||
| 1 | 1 | :ref:`Argument Clinic <howto-clinic>` now has a partial support of the | |
| 2 | - :ref:`Limited API <limited-c-api>`. Patch by Victor Stinner. | ||
| 2 | + :ref:`Limited API <limited-c-api>`: see :ref:`clinic-howto-limited-capi`. | ||
| 3 | + Patch by Victor Stinner. | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments