Mercurial > pub > dyncall > bindings
annotate python/pydc/README.txt @ 54:918dab7a6606
- added callback support (comes with some bigger refactoring)
- allow CPython's Py{CObject,Capsule} to be used as 'p'ointers
| author | Tassilo Philipp |
|---|---|
| date | Tue, 02 Feb 2021 20:42:02 +0100 |
| parents | c5ca08cd3e78 |
| children | 80b11152c659 |
| rev | line source |
|---|---|
| 0 | 1 dyncall python bindings |
| 28 | 2 Copyright 2007-2016 Daniel Adler |
| 3 2018-2020 Tassilo Philipp | |
| 4 | |
| 5 Dec 4, 2007: initial | |
| 6 Mar 22, 2016: update to dyncall 0.9, includes breaking sig char changes | |
| 7 Apr 19, 2018: update to dyncall 1.0 | |
| 8 Apr 7, 2020: update to dyncall 1.1, Python 3 support, using the Capsule | |
| 9 API, as well as support for python unicode strings | |
| 34 | 10 Apr 11, 2020: support for getting loaded library path |
| 11 Apr 12, 2020: breaking change: restrict 'Z' conversions to immutable types | |
| 12 and 'p' to mutable types (and handles) | |
| 37 | 13 Apr 13, 2020: added signature char support to specify calling conventions |
|
44
0f86a5ecfe61
- python: allow None to be passed for 'p'ointers, always passing NULL
Tassilo Philipp
parents:
37
diff
changeset
|
14 Oct 27, 2020: allowing 'None' for 'p' params, always passing NULL |
|
46
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
15 Nov 13, 2020: removed pydc.py wrapper overhead (which only called pydcext.so |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
16 functions; implies renaming pydcext.* to pydc.*), added type stub |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
17 as package_data |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
18 Feb 2, 2021: added callback support (comes with some bigger refactoring); |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
19 allow CPython's Py{CObject,Capsule} to be used as 'p'ointers |
| 5 | 20 |
| 0 | 21 |
| 7 | 22 BUILD/INSTALLATION |
|
16
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
23 ================== |
| 4 | 24 |
| 25 1) make sure dyncall is built and libraries/headers are in include paths or | |
| 26 CFLAGS points to them, etc. | |
| 27 | |
| 10 | 28 2) Build and install this extension with: |
|
16
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
29 |
|
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
30 python setup.py install |
|
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
31 |
| 28 | 32 Building a wheel package isn't supported, currently. |
| 4 | 33 |
| 34 | |
| 0 | 35 API |
|
16
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
36 === |
| 0 | 37 |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
38 In a nutshell for all calls: |
|
46
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
39 |
| 37 | 40 libhandle = load(libpath) # if path == None => handle to running process |
| 41 libpath = get_path(libhandle) # if handle == None => path to executable | |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
42 funcptr = find(libhandle, symbolname) # lookup symbol by name |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
43 call(funcptr, signature, ...) # call C func w/ signature and corresponding args |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
44 free(libhandle) # free library |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
45 |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
46 For callback objects to be passed as 'p'ointer args: |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
47 |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
48 cbhandle = new_callback(signature, pyfunc) # signature reflecting C func ptr |
|
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
49 free_callback(cbhandle) # release callback object |
| 0 | 50 |
|
46
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
51 Notes: |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
52 - a pydc.pyi stub file with the precise interface description is available |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
53 - there are no functions to set the calling convention mode, however, it can be |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
54 set using the signature |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
55 - not specifying any calling convention in the signature string will use the |
|
c21d1c2c84e1
- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents:
44
diff
changeset
|
56 platform's default one |
| 37 | 57 |
| 7 | 58 |
| 0 | 59 SIGNATURE FORMAT |
|
16
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
60 ================ |
| 0 | 61 |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
62 ignoring calling convention mode switching for simplicity, the signature is |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
63 a string with the following format (using * as regex-like repetition): |
| 0 | 64 |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
65 "x*)y" |
| 0 | 66 |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
67 where x is positional parameter-type charcode (per argument), y is result-type charcode |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
68 |
| 0 | 69 |
| 34 | 70 SIG | FROM PYTHON 2 | FROM PYTHON 3 | C/C++ | TO PYTHON 2 | TO PYTHON 3 |
| 71 ----+---------------------------------+---------------------------------+---------------------------------+--------------------------------------+--------------------------------------- | |
| 72 'v' | | | void | None (Py_None) (e.g. ret of "...)v") | None (Py_None) (e.g. ret of "...)v") | |
| 73 'B' | bool (PyBool) | bool (PyBool) # | int/bool | bool (PyBool) | bool (PyBool) @ | |
| 74 'c' | int (PyInt) % | int (PyLong) % | char | int (PyInt) | int (PyLong) | |
| 75 | str (with only a single char) % | str (with only a single char) % | char | int (PyInt) | int (PyLong) | |
| 76 'C' | int (PyInt) % | int (PyLong) % | unsigned char | int (PyInt) | int (PyLong) | |
| 77 | str (with only a single char) % | str (with only a single char) % | unsigned char | int (PyInt) | int (PyLong) | |
| 78 's' | int (PyInt) % | int (PyLong) % | short | int (PyInt) | int (PyLong) | |
| 79 'S' | int (PyInt) % | int (PyLong) % | unsigned short | int (PyInt) | int (PyLong) | |
| 80 'i' | int (PyInt) | int (PyLong) | int | int (PyInt) | int (PyLong) | |
| 81 'I' | int (PyInt) | int (PyLong) | unsigned int | int (PyInt) | int (PyLong) | |
| 82 'j' | int (PyInt) | int (PyLong) | long | int (PyInt) | int (PyLong) | |
| 83 'J' | int (PyInt) | int (PyLong) | unsigned long | int (PyInt) | int (PyLong) | |
| 84 'l' | int (PyInt) | int (PyLongLong) | long long | long (PyLong) | int (PyLong) | |
| 85 | long (PyLong) | - | long long | long (PyLong) | int (PyLong) | |
| 86 'L' | int (PyInt) | int (PyLongLong) | unsigned long long | long (PyLong) | int (PyLong) | |
| 87 | long (PyLong) | - | unsigned long long | long (PyLong) | int (PyLong) | |
| 88 'f' | float (PyFloat) $ | float (PyFloat) $ | float | float (PyFloat) ^ | float (PyFloat) ^ | |
| 89 'd' | float (PyFloat) | float (PyFloat) | double | float (PyFloat) | float (PyFloat) | |
| 90 'p' | bytearray (PyByteArray) & | bytearray (PyByteArray) & | void* | int,long (Py_ssize_t) | int (Py_ssize_t) | |
| 91 | int (PyInt) | int (PyLong) | void* | int,long (Py_ssize_t) | int (Py_ssize_t) | |
| 92 | long (PyLong) | - | void* | int,long (Py_ssize_t) | int (Py_ssize_t) | |
|
44
0f86a5ecfe61
- python: allow None to be passed for 'p'ointers, always passing NULL
Tassilo Philipp
parents:
37
diff
changeset
|
93 | None (Py_None) | None (Py_None) | void* (always NULL) | int,long (Py_ssize_t) | int (Py_ssize_t) |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
94 | (PyCObject,PyCapsule) | (PyCObject,PyCapsule) | void* | int,long (Py_ssize_t) | int (Py_ssize_t) @@@ test |
| 52 | 95 'Z' | str (PyString) ! | str (PyUnicode) ! | const char* (UTF-8 for unicode) | str (PyString) | str (PyUnicode) |
| 96 | unicode (PyUnicode) ! | - | const char* (UTF-8 for unicode) | str (PyString) | str (PyUnicode) | |
| 97 | - | bytes (PyBytes) ! | const char* (UTF-8 for unicode) | str (PyString) | str (PyUnicode) | |
| 98 | bytearray (PyByteArray) ! | bytearray (PyByteArray) ! | const char* (UTF-8 for unicode) | str (PyString) | str (PyUnicode) | |
| 0 | 99 |
| 37 | 100 Annotations: |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
101 # converted to 1 if True and 0 otherwise |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
102 @ converted to False if 0 and True otherwise |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
103 % range/length checked |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
104 $ cast to single precision |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
105 ^ cast to double precision |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
106 & mutable buffer when passed to C |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
107 ! immutable buffer when passed to C, as strings (in any form) are considered objects, not buffers; also, not allowed as return type in callback signatures |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
108 |
|
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
109 |
| 37 | 110 Also supported are specifying calling convention switches using '_'-prefixed |
| 111 signature characters: | |
| 112 | |
| 113 SIG | DESCRIPTION | |
| 114 ----+----------------------------------------------------------------------------------------------------------- | |
| 115 '_' | prefix indicating that next signature character specifies calling convention; char is one of the following | |
| 116 ':' | platform's default calling convention | |
| 117 'e' | vararg function | |
| 118 '.' | vararg function's variadic/ellipsis part (...), to be specified before first vararg | |
| 119 'c' | only on x86: cdecl | |
| 120 's' | only on x86: stdcall | |
| 121 'F' | only on x86: fastcall (MS) | |
| 122 'f' | only on x86: fastcall (GNU) | |
| 123 '+' | only on x86: thiscall (MS) | |
| 124 '#' | only on x86: thiscall (GNU) | |
| 125 'A' | only on ARM: ARM mode | |
| 126 'a' | only on ARM: THUMB mode | |
| 127 '$' | syscall | |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
128 |
|
16
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
129 |
|
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
130 TODO |
|
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
131 ==== |
|
a40084782546
- added support for more return values to python binding
cslag
parents:
10
diff
changeset
|
132 |
|
54
918dab7a6606
- added callback support (comes with some bigger refactoring)
Tassilo Philipp
parents:
52
diff
changeset
|
133 - calling convention mode handling for callbacks (not sure if ever needed?) |
|
50
edf5c85de5ac
put pyi next to so for mypy to pick it up, directly
Tassilo Philipp
parents:
46
diff
changeset
|
134 - pydoc "man page" |
|
edf5c85de5ac
put pyi next to so for mypy to pick it up, directly
Tassilo Philipp
parents:
46
diff
changeset
|
135 - stub location: the pydc-stubs folder isn't picked up by mypy, so I question why this is the suggested way |
|
edf5c85de5ac
put pyi next to so for mypy to pick it up, directly
Tassilo Philipp
parents:
46
diff
changeset
|
136 - get into freebsd ports |
| 5 | 137 |
|
35
75fe1dec0eb4
- added support for signature-based calling convention switch
Tassilo Philipp
parents:
34
diff
changeset
|
138 |
| 30 | 139 BUGS |
| 140 ==== | |
| 141 | |
| 142 - when using Python 2, the dyncall call vm object is never dcFree'd, as there | |
| 143 is no way to call a "freefunc" as introduced with Python 3 module definitions | |
| 144 (see PEP 3121 for details) | |
| 145 |