| 1 | Help on class Extension in module distutils.extension: |
|---|
| 2 | |
|---|
| 3 | class Extension(builtins.object) |
|---|
| 4 | | Extension(name, sources, include_dirs=None, define_macros=None, undef_macros=None, library_dirs=None, libraries=None, runtime_library_dirs=None, extra_objects=None, extra_compile_args=None, extra_link_args=None, export_symbols=None, swig_opts=None, depends=None, language=None, optional=None, **kw) |
|---|
| 5 | | |
|---|
| 6 | | Just a collection of attributes that describes an extension |
|---|
| 7 | | module and everything needed to build it (hopefully in a portable |
|---|
| 8 | | way, but there are hooks that let you be as unportable as you need). |
|---|
| 9 | | |
|---|
| 10 | | Instance attributes: |
|---|
| 11 | | name : string |
|---|
| 12 | | the full name of the extension, including any packages -- ie. |
|---|
| 13 | | *not* a filename or pathname, but Python dotted name |
|---|
| 14 | | sources : [string] |
|---|
| 15 | | list of source filenames, relative to the distribution root |
|---|
| 16 | | (where the setup script lives), in Unix form (slash-separated) |
|---|
| 17 | | for portability. Source files may be C, C++, SWIG (.i), |
|---|
| 18 | | platform-specific resource files, or whatever else is recognized |
|---|
| 19 | | by the "build_ext" command as source for a Python extension. |
|---|
| 20 | | include_dirs : [string] |
|---|
| 21 | | list of directories to search for C/C++ header files (in Unix |
|---|
| 22 | | form for portability) |
|---|
| 23 | | define_macros : [(name : string, value : string|None)] |
|---|
| 24 | | list of macros to define; each macro is defined using a 2-tuple, |
|---|
| 25 | | where 'value' is either the string to define it to or None to |
|---|
| 26 | | define it without a particular value (equivalent of "#define |
|---|
| 27 | | FOO" in source or -DFOO on Unix C compiler command line) |
|---|
| 28 | | undef_macros : [string] |
|---|
| 29 | | list of macros to undefine explicitly |
|---|
| 30 | | library_dirs : [string] |
|---|
| 31 | | list of directories to search for C/C++ libraries at link time |
|---|
| 32 | | libraries : [string] |
|---|
| 33 | | list of library names (not filenames or paths) to link against |
|---|
| 34 | | runtime_library_dirs : [string] |
|---|
| 35 | | list of directories to search for C/C++ libraries at run time |
|---|
| 36 | | (for shared extensions, this is when the extension is loaded) |
|---|
| 37 | | extra_objects : [string] |
|---|
| 38 | | list of extra files to link with (eg. object files not implied |
|---|
| 39 | | by 'sources', static library that must be explicitly specified, |
|---|
| 40 | | binary resource files, etc.) |
|---|
| 41 | | extra_compile_args : [string] |
|---|
| 42 | | any extra platform- and compiler-specific information to use |
|---|
| 43 | | when compiling the source files in 'sources'. For platforms and |
|---|
| 44 | | compilers where "command line" makes sense, this is typically a |
|---|
| 45 | | list of command-line arguments, but for other platforms it could |
|---|
| 46 | | be anything. |
|---|
| 47 | | extra_link_args : [string] |
|---|
| 48 | | any extra platform- and compiler-specific information to use |
|---|
| 49 | | when linking object files together to create the extension (or |
|---|
| 50 | | to create a new static Python interpreter). Similar |
|---|
| 51 | | interpretation as for 'extra_compile_args'. |
|---|
| 52 | | export_symbols : [string] |
|---|
| 53 | | list of symbols to be exported from a shared extension. Not |
|---|
| 54 | | used on all platforms, and not generally necessary for Python |
|---|
| 55 | | extensions, which typically export exactly one symbol: "init" + |
|---|
| 56 | | extension_name. |
|---|
| 57 | | swig_opts : [string] |
|---|
| 58 | | any extra options to pass to SWIG if a source file has the .i |
|---|
| 59 | | extension. |
|---|
| 60 | | depends : [string] |
|---|
| 61 | | list of files that the extension depends on |
|---|
| 62 | | language : string |
|---|
| 63 | | extension language (i.e. "c", "c++", "objc"). Will be detected |
|---|
| 64 | | from the source extensions if not provided. |
|---|
| 65 | | optional : boolean |
|---|
| 66 | | specifies that a build failure in the extension should not abort the |
|---|
| 67 | | build process, but simply not install the failing extension. |
|---|
| 68 | | |
|---|
| 69 | | Methods defined here: |
|---|
| 70 | | |
|---|
| 71 | | __init__(self, name, sources, include_dirs=None, define_macros=None, undef_macros=None, library_dirs=None, libraries=None, runtime_library_dirs=None, extra_objects=None, extra_compile_args=None, extra_link_args=None, export_symbols=None, swig_opts=None, depends=None, language=None, optional=None, **kw) |
|---|
| 72 | | Initialize self. See help(type(self)) for accurate signature. |
|---|
| 73 | | |
|---|
| 74 | | __repr__(self) |
|---|
| 75 | | Return repr(self). |
|---|
| 76 | | |
|---|
| 77 | | ---------------------------------------------------------------------- |
|---|
| 78 | | Data descriptors defined here: |
|---|
| 79 | | |
|---|
| 80 | | __dict__ |
|---|
| 81 | | dictionary for instance variables (if defined) |
|---|
| 82 | | |
|---|
| 83 | | __weakref__ |
|---|
| 84 | | list of weak references to the object (if defined) |
|---|
| 85 | |
|---|