Mercurial > pub > dyncall > bindings

annotate python/pydc/README.txt @ 51:03b6934cdd63

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
typo
author Tassilo Philipp
date Wed, 09 Dec 2020 15:56:13 +0100
parents edf5c85de5ac
children c5ca08cd3e78
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 dyncall python bindings
28
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
2 Copyright 2007-2016 Daniel Adler
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
3 2018-2020 Tassilo Philipp
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
4
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
5 Dec 4, 2007: initial
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
6 Mar 22, 2016: update to dyncall 0.9, includes breaking sig char changes
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
7 Apr 19, 2018: update to dyncall 1.0
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
8 Apr 7, 2020: update to dyncall 1.1, Python 3 support, using the Capsule
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
9 API, as well as support for python unicode strings
34
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
10 Apr 11, 2020: support for getting loaded library path
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
11 Apr 12, 2020: breaking change: restrict 'Z' conversions to immutable types
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
12 and 'p' to mutable types (and handles)
37
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
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
5
bf5625bb6f05 - brought python binding up to dc v0.9
cslag
parents: 4
diff changeset
18
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19
7
4fd959b3df78 - python binding readme clarifications
cslag
parents: 5
diff changeset
20 BUILD/INSTALLATION
16
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
21 ==================
4
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
22
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
23 1) make sure dyncall is built and libraries/headers are in include paths or
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
24 CFLAGS points to them, etc.
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
25
10
6493c9ed4b33 - ruby and python binding readme updates
cslag
parents: 7
diff changeset
26 2) Build and install this extension with:
16
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
27
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
28 python setup.py install
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
29
28
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
30 Building a wheel package isn't supported, currently.
4
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
31
4c5019f00f5b - python binding cleanup
cslag
parents: 0
diff changeset
32
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 API
16
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
34 ===
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35
46
c21d1c2c84e1 - removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents: 44
diff changeset
36 In a nutshell:
c21d1c2c84e1 - removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents: 44
diff changeset
37
37
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
38 libhandle = load(libpath) # if path == None => handle to running process
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
39 libpath = get_path(libhandle) # if handle == None => path to executable
5
bf5625bb6f05 - brought python binding up to dc v0.9
cslag
parents: 4
diff changeset
40 funcptr = find(libhandle, symbolname)
bf5625bb6f05 - brought python binding up to dc v0.9
cslag
parents: 4
diff changeset
41 call(funcptr, signature, ...)
29
6cc2b7fc7ea2 bigger pydc update:
Tassilo Philipp
parents: 28
diff changeset
42 free(libhandle)
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43
46
c21d1c2c84e1 - removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents: 44
diff changeset
44 Notes:
c21d1c2c84e1 - removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents: 44
diff changeset
45 - 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
46 - 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
47 set using the signature
c21d1c2c84e1 - removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways)
Tassilo Philipp
parents: 44
diff changeset
48 - 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
49 platform's default one
37
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
50
7
4fd959b3df78 - python binding readme clarifications
cslag
parents: 5
diff changeset
51
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52 SIGNATURE FORMAT
16
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
53 ================
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
55 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
56 a string with the following format (using * as regex-like repetition):
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
57
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
58 "x*)y"
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
59
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
60 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
61
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
62
34
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
63 SIG | FROM PYTHON 2 | FROM PYTHON 3 | C/C++ | TO PYTHON 2 | TO PYTHON 3
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
64 ----+---------------------------------+---------------------------------+---------------------------------+--------------------------------------+---------------------------------------
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
65 'v' | | | void | None (Py_None) (e.g. ret of "...)v") | None (Py_None) (e.g. ret of "...)v")
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
66 'B' | bool (PyBool) | bool (PyBool) # | int/bool | bool (PyBool) | bool (PyBool) @
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
67 'c' | int (PyInt) % | int (PyLong) % | char | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
68 | str (with only a single char) % | str (with only a single char) % | char | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
69 'C' | int (PyInt) % | int (PyLong) % | unsigned char | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
70 | str (with only a single char) % | str (with only a single char) % | unsigned char | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
71 's' | int (PyInt) % | int (PyLong) % | short | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
72 'S' | int (PyInt) % | int (PyLong) % | unsigned short | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
73 'i' | int (PyInt) | int (PyLong) | int | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
74 'I' | int (PyInt) | int (PyLong) | unsigned int | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
75 'j' | int (PyInt) | int (PyLong) | long | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
76 'J' | int (PyInt) | int (PyLong) | unsigned long | int (PyInt) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
77 'l' | int (PyInt) | int (PyLongLong) | long long | long (PyLong) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
78 | long (PyLong) | - | long long | long (PyLong) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
79 'L' | int (PyInt) | int (PyLongLong) | unsigned long long | long (PyLong) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
80 | long (PyLong) | - | unsigned long long | long (PyLong) | int (PyLong)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
81 'f' | float (PyFloat) $ | float (PyFloat) $ | float | float (PyFloat) ^ | float (PyFloat) ^
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
82 'd' | float (PyFloat) | float (PyFloat) | double | float (PyFloat) | float (PyFloat)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
83 'p' | bytearray (PyByteArray) & | bytearray (PyByteArray) & | void* | int,long (Py_ssize_t) | int (Py_ssize_t)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
84 | int (PyInt) | int (PyLong) | void* | int,long (Py_ssize_t) | int (Py_ssize_t)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
85 | 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
86 | None (Py_None) | None (Py_None) | void* (always NULL) | int,long (Py_ssize_t) | int (Py_ssize_t)
34
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
87 'Z' | str (PyString) ! | str (PyUnicode) ! | const char* (UTF-8 for unicode) | int (PyString) | str (PyUnicode)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
88 | unicode (PyUnicode) ! | - | const char* (UTF-8 for unicode) | int (PyString) | str (PyUnicode)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
89 | - | bytes (PyBytes) ! | const char* (UTF-8 for unicode) | int (PyString) | str (PyUnicode)
2682a627168c - breaking changes:
Tassilo Philipp
parents: 30
diff changeset
90 | bytearray (PyByteArray) ! | bytearray (PyByteArray) ! | const char* (UTF-8 for unicode) | int (PyString) | str (PyUnicode)
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
91
37
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
92 Annotations:
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
93 # converted to 1 if True and 0 otherwise
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
94 @ converted to False if 0 and True otherwise
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
95 % range/length checked
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
96 $ cast to single precision
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
97 ^ cast to double precision
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
98 & mutable buffer when passed to C
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
99 ! immutable buffer when passed to C, as strings (in any form) are considered objects, not buffers
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
100
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
101
37
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
102 Also supported are specifying calling convention switches using '_'-prefixed
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
103 signature characters:
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
104
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
105 SIG | DESCRIPTION
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
106 ----+-----------------------------------------------------------------------------------------------------------
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
107 '_' | prefix indicating that next signature character specifies calling convention; char is one of the following
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
108 ':' | platform's default calling convention
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
109 'e' | vararg function
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
110 '.' | vararg function's variadic/ellipsis part (...), to be specified before first vararg
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
111 'c' | only on x86: cdecl
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
112 's' | only on x86: stdcall
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
113 'F' | only on x86: fastcall (MS)
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
114 'f' | only on x86: fastcall (GNU)
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
115 '+' | only on x86: thiscall (MS)
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
116 '#' | only on x86: thiscall (GNU)
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
117 'A' | only on ARM: ARM mode
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
118 'a' | only on ARM: THUMB mode
8c8f848131c6 - version bump
Tassilo Philipp
parents: 35
diff changeset
119 '$' | syscall
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
120
16
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
121
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
122 TODO
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
123 ====
a40084782546 - added support for more return values to python binding
cslag
parents: 10
diff changeset
124
28
edbbd467f50a python binding:
Tassilo Philipp
parents: 24
diff changeset
125 - callback support
50
edf5c85de5ac put pyi next to so for mypy to pick it up, directly
Tassilo Philipp
parents: 46
diff changeset
126 - pydoc "man page"
edf5c85de5ac put pyi next to so for mypy to pick it up, directly
Tassilo Philipp
parents: 46
diff changeset
127 - 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
128 - get into freebsd ports
5
bf5625bb6f05 - brought python binding up to dc v0.9
cslag
parents: 4
diff changeset
129
35
75fe1dec0eb4 - added support for signature-based calling convention switch
Tassilo Philipp
parents: 34
diff changeset
130
30
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
131 BUGS
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
132 ====
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
133
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
134 - when using Python 2, the dyncall call vm object is never dcFree'd, as there
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
135 is no way to call a "freefunc" as introduced with Python 3 module definitions
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
136 (see PEP 3121 for details)
baf087cf5971 - fixed two ref counting problems
Tassilo Philipp
parents: 29
diff changeset
137