usage: cython [-h] [-V] [-l] [-I INCLUDE_PATH] [-o OUTPUT_FILE] [-t] [-f] [-v] [-p]
[--cleanup GENERATE_CLEANUP_CODE] [--cache] [-w WORKING_PATH] [--gdb]
[--gdb-outdir GDB_OUTDIR] [-D] [-a] [--annotate-fullc]
[--annotate-coverage ANNOTATE_COVERAGE_XML] [--line-directives] [-+] [--embed]
[--embed-modules EMBED_MODULES] [-2] [-3] [--3str] [--lenient]
[--capi-reexport-cincludes] [--fast-fail] [-Werror] [-Wextra] [-X NAME=VALUE,...]
[-E NAME=VALUE,...] [--module-name MODULE_NAME] [-M]
[--shared SHARED_UTILITY_QUALIFIED_NAME] [--generate-shared SHARED_C_FILE_PATH]
[sources ...]
Cython (https://cython.org/) is a compiler for code written in the Cython language. Cython is based on Pyrex by Greg Ewing.
positional arguments:
sources
options:
-h, --help show this help message and exit
-V, --version Display version number of cython compiler
-l, --create-listing Write error messages to a listing file
-I INCLUDE_PATH, --include-dir INCLUDE_PATH
Search for include files in named directory (multiple include directories
are allowed).
-o OUTPUT_FILE, --output-file OUTPUT_FILE
Specify name of generated C file
-t, --timestamps Only compile newer source files
-f, --force Compile all source files (overrides implied -t)
-v, --verbose Be verbose, print file names on multiple compilation
-p, --embed-positions
If specified, the positions in Cython files of each function definition is
embedded in its docstring.
--cleanup GENERATE_CLEANUP_CODE
Release interned objects on python exit, for memory debugging. Level
indicates aggressiveness, default 0 releases nothing.
--cache Enables Cython compilation cache.
-w WORKING_PATH, --working WORKING_PATH
Sets the working directory for Cython (the directory modules are searched
from)
--gdb Output debug information for cygdb
--gdb-outdir GDB_OUTDIR
Specify gdb debug information output directory. Implies --gdb.
-D, --no-docstrings Strip docstrings from the compiled module.
-a, --annotate Produce a colorized HTML version of the source.
--annotate-fullc Produce a colorized HTML version of the source which includes entire
generated C/C++-code.
--annotate-coverage ANNOTATE_COVERAGE_XML
Annotate and include coverage information from cov.xml.
--line-directives Produce #line directives pointing to the .pyx source
-+, --cplus Output a C++ rather than C file.
--embed Generate a main() function that embeds the Python interpreter. Pass
--embed=<method_name> for a name other than main().
--embed-modules EMBED_MODULES
-2 Compile based on Python-2 syntax and code semantics.
-3 Compile based on Python-3 syntax and code semantics.
--3str Compile based on Python-3 syntax and code semantics (same as -3 since
Cython 3.1).
--lenient Change some compile time errors to runtime errors to improve Python
compatibility
--capi-reexport-cincludes
Add cincluded headers to any auto-generated header files.
--fast-fail Abort the compilation on the first error
-Werror, --warning-errors
Make all warnings into errors
-Wextra, --warning-extra
Enable extra warnings
-X NAME=VALUE,..., --directive NAME=VALUE,...
Overrides a compiler directive
-E NAME=VALUE,..., --compile-time-env NAME=VALUE,...
Provides compile time env like DEF would do.
--module-name MODULE_NAME
Fully qualified module name. If not given, is deduced from the import path
if source file is in a package, or equals the filename otherwise.
-M, --depfile produce depfiles for the sources
--shared SHARED_UTILITY_QUALIFIED_NAME
Imports utility code from shared module specified by fully qualified
module name.
--generate-shared SHARED_C_FILE_PATH
Generates shared module with specified name.
Environment variables:
CYTHON_CACHE_DIR: the base directory containing Cython's caches.
Options (31)
| Option | Description | Source |
|---|
-h, --help | show this help message and exit | help |
-V, --version | Display version number of cython compiler | help |
-l, --create-listing | Write error messages to a listing file | help |
-t, --timestamps | Only compile newer source files | help |
-f, --force | Compile all source files (overrides implied -t) | help |
-v, --verbose | Be verbose, print file names on multiple compilation | help |
-p, --embed-positions | If specified, the positions in Cython files of each function definition is embedded in its docstring. | help |
--cleanup GENERATE_CLEANUP_CODE | Release interned objects on python exit, for memory debugging. | help |
--cache | Enables Cython compilation cache. | help |
--gdb | Output debug information for cygdb | help |
--gdb-outdir GDB_OUTDIR | Specify gdb debug information output directory. | help |
-D, --no-docstrings | Strip docstrings from the compiled module. | help |
-a, --annotate | Produce a colorized HTML version of the source. | help |
--annotate-fullc | Produce a colorized HTML version of the source which includes entire generated C/C++-code. | help |
--annotate-coverage ANNOTATE_COVERAGE_XML | Annotate and include coverage information from cov.xml. | help |
--line-directives | Produce #line directives pointing to the .pyx source | help |
--cplus | Output a C++ rather than C file. | help |
--embed | Generate a main() function that embeds the Python interpreter. | help |
--embed-modules EMBED_MODULES | | help |
-2 | Compile based on Python-2 syntax and code semantics. | help |
-3 | Compile based on Python-3 syntax and code semantics. | help |
--3str | Compile based on Python-3 syntax and code semantics (same as -3 since Cython 3.1). | help |
--lenient | Change some compile time errors to runtime errors to improve Python compatibility | help |
--capi-reexport-cincludes | Add cincluded headers to any auto-generated header files. | help |
--fast-fail | Abort the compilation on the first error | help |
-Werror, --warning-errors | Make all warnings into errors | help |
-Wextra, --warning-extra | Enable extra warnings | help |
--module-name MODULE_NAME | Fully qualified module name. | help |
-M, --depfile | produce depfiles for the sources | help |
--shared SHARED_UTILITY_QUALIFIED_NAME | Imports utility code from shared module specified by fully qualified module name. | help |
--generate-shared SHARED_C_FILE_PATH | Generates shared module with specified name. | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.