Stein Ivar Berghei cccfd203f8 | ||
---|---|---|
.circleci | ||
.github | ||
examples | ||
script | ||
tests | ||
.gitignore | ||
CONTRIBUTING.md | ||
Gopkg.lock | ||
Gopkg.toml | ||
LICENSE | ||
LICENSE-3rdparty.csv | ||
README.md | ||
boolean.go | ||
boolean_test.go | ||
byte_array.go | ||
byte_array_test.go | ||
bytes.go | ||
bytes_test.go | ||
complex.go | ||
complex_test.go | ||
dict.go | ||
dict_test.go | ||
errors.go | ||
errors_nix.go | ||
errors_test.go | ||
exceptions.go | ||
exceptions_test.go | ||
float.go | ||
float_test.go | ||
helper.go | ||
high_level_layer.go | ||
high_level_layer_test.go | ||
import.go | ||
import_test.go | ||
integer.go | ||
integer_test.go | ||
lifecycle.go | ||
lifecycle_test.go | ||
list.go | ||
list_test.go | ||
macro.c | ||
macro.h | ||
module.go | ||
module_test.go | ||
object.go | ||
object_test.go | ||
recursion.go | ||
recursion_test.go | ||
reflection.go | ||
reflection_test.go | ||
sys.go | ||
sys_test.go | ||
thread.go | ||
thread_test.go | ||
tuple.go | ||
tuple_test.go | ||
type.go | ||
type_test.go | ||
unicode.go | ||
unicode_test.go | ||
variadic.c | ||
variadic.h | ||
warning.go | ||
warning_test.go |
README.md
Go bindings for the CPython-3 C-API
Currently supports python-3.7 only.
This package provides a go
package named "python" under which most of the
PyXYZ
functions and macros of the public C-API of CPython have been
exposed. Theoretically, you should be able use https://docs.python.org/3/c-api
and know what to type in your go
program.
relation to DataDog/go-python3
This project is a community maintained successor to DataDog/go-python3
, which will get archived in December 2021.
- If you use the Go package
github.com/DataDog/go-python3
in your code, you can usegithub.com/go-python/cpy3
as a drop-in replacement. We intend to not introduce breaking changes. - If you have unmerged PRs or open issues on
DataDog/go-python3
, please re-submit them here.
relation to sbinet/go-python
This project was inspired by sbinet/go-python
(Go bindings for the CPython-2 C-API).
Install
Deps
We will need pkg-config
and a working python3.7
environment to build these
bindings. Make sure you have Python libraries and header files installed as
well (python3.7-dev
on Debian or python3-devel
on Centos for example)..
By default pkg-config
will look at the python3
library so if you want to
choose a specific version just symlink python-X.Y.pc
to python3.pc
or use
the PKG_CONFIG_PATH
environment variable.
Go get
Then simply go get github.com/go-python/cpy3
API
Some functions mix go code and call to Python function. Those functions will
return and int
and error
type. The int
represent the Python result code
and the error
represent any issue from the Go layer.
Example:
func PyRun_AnyFile(filename string)
open filename
and then call CPython API
function int PyRun_AnyFile(FILE *fp, const char *filename)
.
Therefore its signature is func PyRun_AnyFile(filename string) (int, error)
,
the int
represent the error code from the CPython PyRun_AnyFile
function
and error will be set if we failed to open filename
.
If an error is raise before calling th CPython function int
default to -1
.
Take a look at some examples and this tutorial blogpost.
Contributing
Contributions are welcome! See details.
Community
Find us in #go-python
on Gophers Slack. (infos | invite)
This project follows the Go Community Code of Conduct.