For bug fixes or new features, please file an issue before submitting a pull request. If the change isn't trivial, it may be best to wait for feedback.
This project targets Python 3.7 or later.
Python objects should be typed; since it is not supported by Cython,
you must manually declare types in type stubs (.pyi files). In Python
files, you can add type annotations to function signatures (supported in
Python 3.5) and in variable assignments (supported only from Python
3.6 onward).
When interfacing with C, and in particular with pointers, use assertions everywhere you assume the pointer to be non-NULL. Also consider using assertions when accessing raw C arrays, if applicable.
The CRef and CConstRef smart pointers from the C++ Toolkit actually do not
need to be checked, as the GetObject and GetNonNullPointer will raise an
exception on attempts of NULL pointer dereference.
Make sure you clone the repository in recursive mode, so you also get the
wrapped code of Prodigal which is exposed as a git submodule:
$ git clone --recursive https://github.com/althonos/pyncbitkTests are written as usual Python unit tests with the unittest module of
the standard library. Running them requires the extension to be built
locally:
$ python -m pip install -v -e . --no-build-isolation
$ python -m unittest -vv tests