diff options
author | alexv-smirnov <alex@ydb.tech> | 2023-06-13 11:05:01 +0300 |
---|---|---|
committer | alexv-smirnov <alex@ydb.tech> | 2023-06-13 11:05:01 +0300 |
commit | bf0f13dd39ee3e65092ba3572bb5b1fcd125dcd0 (patch) | |
tree | 1d1df72c0541a59a81439842f46d95396d3e7189 /contrib/tools/cython/USAGE.txt | |
parent | 8bfdfa9a9bd19bddbc58d888e180fbd1218681be (diff) | |
download | ydb-bf0f13dd39ee3e65092ba3572bb5b1fcd125dcd0.tar.gz |
add ymake export to ydb
Diffstat (limited to 'contrib/tools/cython/USAGE.txt')
-rw-r--r-- | contrib/tools/cython/USAGE.txt | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/contrib/tools/cython/USAGE.txt b/contrib/tools/cython/USAGE.txt new file mode 100644 index 0000000000..13d07ad7e1 --- /dev/null +++ b/contrib/tools/cython/USAGE.txt @@ -0,0 +1,75 @@ +Cython - Usage Instructions +========================== + +Building Cython extensions using distutils +----------------------------------------- + +Cython comes with an experimental distutils extension for compiling +Cython modules, contributed by Graham Fawcett of the University of +Windsor (fawcett@uwindsor.ca). + +The Demos directory contains a setup.py file demonstrating its use. To +compile the demos: + +(1) cd Demos + +(2) python setup.py build_ext --inplace + + or + + python setup.py build --build-lib=. + +(You may get a screed of warnings from the C compiler, but you can +ignore these -- as long as there are no actual errors, things are +probably okay.) + +Try out the extensions with: + + python run_primes.py + python run_spam.py + python run_numeric_demo.py + + +Building Cython extensions by hand +--------------------------------- + +You can also invoke the Cython compiler on its own to translate a .pyx +file to a .c file. On Unix, + + cython filename.pyx + +On other platforms, + + python cython.py filename.pyx + +It's then up to you to compile and link the .c file using whatever +procedure is appropriate for your platform. The file +Makefile.nodistutils in the Demos directory shows how to do this for +one particular Unix system. + + +Command line options +-------------------- + +The cython command supports the following options: + + Short Long Argument Description + ----------------------------------------------------------------------------- + -v --version Display version number of cython compiler + -l --create-listing Write error messages to a .lis file + -I --include-dir <directory> Search for include files in named + directory (may be repeated) + -o --output-file <filename> Specify name of generated C file (only + one source file allowed if this is used) + -p, --embed-positions If specified, the positions in Cython files of each + function definition is embedded in its docstring. + -z, --pre-import <module> If specified, assume undeclared names in this + module. Emulates the behavior of putting + "from <module> import *" at the top of the file. + + +Anything else is taken as the name of a Cython source file and compiled +to a C source file. Multiple Cython source files can be specified +(unless -o is used), in which case each source file is treated as the +source of a distinct extension module and compiled separately to +produce its own C file. |