@@ -31,8 +31,9 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
3131 +====================+================================+=============================================================+
3232 | *name * | The name of the package | a string |
3333 +--------------------+--------------------------------+-------------------------------------------------------------+
34- | *version * | The version number of the | See :mod: `distutils.version ` |
35- | | package | |
34+ | *version * | The version number of the | a string |
35+ | | package; see | |
36+ | | :mod: `distutils.version ` | |
3637 +--------------------+--------------------------------+-------------------------------------------------------------+
3738 | *description * | A single line describing the | a string |
3839 | | package | |
@@ -49,14 +50,14 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
4950 | | maintainer, if different from | |
5051 | | the author | |
5152 +--------------------+--------------------------------+-------------------------------------------------------------+
52- | *maintainer_email * | The email address of the | |
53+ | *maintainer_email * | The email address of the | a string |
5354 | | current maintainer, if | |
5455 | | different from the author | |
5556 +--------------------+--------------------------------+-------------------------------------------------------------+
56- | *url * | A URL for the package | a URL |
57+ | *url * | A URL for the package | a string |
5758 | | (homepage) | |
5859 +--------------------+--------------------------------+-------------------------------------------------------------+
59- | *download_url * | A URL to download the package | a URL |
60+ | *download_url * | A URL to download the package | a string |
6061 +--------------------+--------------------------------+-------------------------------------------------------------+
6162 | *packages * | A list of Python packages that | a list of strings |
6263 | | distutils will manipulate | |
@@ -68,14 +69,13 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
6869 | | files to be built and | |
6970 | | installed | |
7071 +--------------------+--------------------------------+-------------------------------------------------------------+
71- | *ext_modules * | A list of Python extensions to | A list of instances of |
72+ | *ext_modules * | A list of Python extensions to | a list of instances of |
7273 | | be built | :class: `distutils.core.Extension ` |
7374 +--------------------+--------------------------------+-------------------------------------------------------------+
74- | *classifiers * | A list of categories for the | The list of available |
75- | | package | categorizations is available on `PyPI |
76- | | | <http://pypi.python.org/pypi?:action=list_classifiers>`_. |
75+ | *classifiers * | A list of categories for the | a list of strings; valid classifiers are listed on `PyPI |
76+ | | package | <http://pypi.python.org/pypi?:action=list_classifiers>`_. |
7777 +--------------------+--------------------------------+-------------------------------------------------------------+
78- | *distclass * | the :class: `Distribution ` | A subclass of |
78+ | *distclass * | the :class: `Distribution ` | a subclass of |
7979 | | class to use | :class: `distutils.core.Distribution ` |
8080 +--------------------+--------------------------------+-------------------------------------------------------------+
8181 | *script_name * | The name of the setup.py | a string |
@@ -85,15 +85,15 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
8585 | *script_args * | Arguments to supply to the | a list of strings |
8686 | | setup script | |
8787 +--------------------+--------------------------------+-------------------------------------------------------------+
88- | *options * | default options for the setup | a string |
88+ | *options * | default options for the setup | a dictionary |
8989 | | script | |
9090 +--------------------+--------------------------------+-------------------------------------------------------------+
9191 | *license * | The license for the package | a string |
9292 +--------------------+--------------------------------+-------------------------------------------------------------+
93- | *keywords * | Descriptive meta-data, see | |
93+ | *keywords * | Descriptive meta-data, see | a list of strings or a comma-separated string |
9494 | | :pep: `314 ` | |
9595 +--------------------+--------------------------------+-------------------------------------------------------------+
96- | *platforms * | | |
96+ | *platforms * | | a list of strings or a comma-separated string |
9797 +--------------------+--------------------------------+-------------------------------------------------------------+
9898 | *cmdclass * | A mapping of command names to | a dictionary |
9999 | | :class: `Command ` subclasses | |
@@ -165,13 +165,13 @@ the full reference.
165165 +------------------------+--------------------------------+---------------------------+
166166 | argument name | value | type |
167167 +========================+================================+===========================+
168- | *name * | the full name of the | string |
168+ | *name * | the full name of the | a string |
169169 | | extension, including any | |
170170 | | packages --- ie. *not * a | |
171171 | | filename or pathname, but | |
172172 | | Python dotted name | |
173173 +------------------------+--------------------------------+---------------------------+
174- | *sources * | list of source filenames, | string |
174+ | *sources * | list of source filenames, | a list of strings |
175175 | | relative to the distribution | |
176176 | | root (where the setup script | |
177177 | | lives), in Unix form (slash- | |
@@ -184,12 +184,12 @@ the full reference.
184184 | | as source for a Python | |
185185 | | extension. | |
186186 +------------------------+--------------------------------+---------------------------+
187- | *include_dirs * | list of directories to search | string |
187+ | *include_dirs * | list of directories to search | a list of strings |
188188 | | for C/C++ header files (in | |
189189 | | Unix form for portability) | |
190190 +------------------------+--------------------------------+---------------------------+
191- | *define_macros * | list of macros to define; each | (string, string) tuple or |
192- | | macro is defined using a | (name, `` None ``) |
191+ | *define_macros * | list of macros to define; each | a list of tuples |
192+ | | macro is defined using a | |
193193 | | 2-tuple ``(name, value) ``, | |
194194 | | where *value * is | |
195195 | | either the string to define it | |
@@ -200,31 +200,31 @@ the full reference.
200200 | | on Unix C compiler command | |
201201 | | line) | |
202202 +------------------------+--------------------------------+---------------------------+
203- | *undef_macros * | list of macros to undefine | string |
203+ | *undef_macros * | list of macros to undefine | a list of strings |
204204 | | explicitly | |
205205 +------------------------+--------------------------------+---------------------------+
206- | *library_dirs * | list of directories to search | string |
206+ | *library_dirs * | list of directories to search | a list of strings |
207207 | | for C/C++ libraries at link | |
208208 | | time | |
209209 +------------------------+--------------------------------+---------------------------+
210- | *libraries * | list of library names (not | string |
210+ | *libraries * | list of library names (not | a list of strings |
211211 | | filenames or paths) to link | |
212212 | | against | |
213213 +------------------------+--------------------------------+---------------------------+
214- | *runtime_library_dirs * | list of directories to search | string |
214+ | *runtime_library_dirs * | list of directories to search | a list of strings |
215215 | | for C/C++ libraries at run | |
216216 | | time (for shared extensions, | |
217217 | | this is when the extension is | |
218218 | | loaded) | |
219219 +------------------------+--------------------------------+---------------------------+
220- | *extra_objects * | list of extra files to link | string |
220+ | *extra_objects * | list of extra files to link | a list of strings |
221221 | | with (eg. object files not | |
222222 | | implied by 'sources', static | |
223223 | | library that must be | |
224224 | | explicitly specified, binary | |
225225 | | resource files, etc.) | |
226226 +------------------------+--------------------------------+---------------------------+
227- | *extra_compile_args * | any extra platform- and | string |
227+ | *extra_compile_args * | any extra platform- and | a list of strings |
228228 | | compiler-specific information | |
229229 | | to use when compiling the | |
230230 | | source files in 'sources'. For | |
@@ -235,7 +235,7 @@ the full reference.
235235 | | for other platforms it could | |
236236 | | be anything. | |
237237 +------------------------+--------------------------------+---------------------------+
238- | *extra_link_args * | any extra platform- and | string |
238+ | *extra_link_args * | any extra platform- and | a list of strings |
239239 | | compiler-specific information | |
240240 | | to use when linking object | |
241241 | | files together to create the | |
@@ -244,23 +244,28 @@ the full reference.
244244 | | Similar interpretation as for | |
245245 | | 'extra_compile_args'. | |
246246 +------------------------+--------------------------------+---------------------------+
247- | *export_symbols * | list of symbols to be exported | string |
247+ | *export_symbols * | list of symbols to be exported | a list of strings |
248248 | | from a shared extension. Not | |
249249 | | used on all platforms, and not | |
250250 | | generally necessary for Python | |
251251 | | extensions, which typically | |
252252 | | export exactly one symbol: | |
253253 | | ``init `` + extension_name. | |
254254 +------------------------+--------------------------------+---------------------------+
255- | *depends * | list of files that the | string |
255+ | *depends * | list of files that the | a list of strings |
256256 | | extension depends on | |
257257 +------------------------+--------------------------------+---------------------------+
258- | *language * | extension language (i.e. | string |
258+ | *language * | extension language (i.e. | a string |
259259 | | ``'c' ``, ``'c++' ``, | |
260260 | | ``'objc' ``). Will be detected | |
261261 | | from the source extensions if | |
262262 | | not provided. | |
263263 +------------------------+--------------------------------+---------------------------+
264+ | *optional * | specifies that a build failure | a boolean |
265+ | | in the extension should not | |
266+ | | abort the build process, but | |
267+ | | simply skip the extension. | |
268+ +------------------------+--------------------------------+---------------------------+
264269
265270
266271.. class :: Distribution
0 commit comments