diff python/pydc/README.txt @ 46:c21d1c2c84e1

- removed pydc.py wrapper overhead (which only called pydcext.so functions, directly, anyways) * implies renaming pydcext.* to pydc.* * while at it, iterate directly over args that are passed in (before we did extract fptr, sig and a tuple for the args and iterated over latter afterwards); we might have a tiny perf improvement now - added type stub as package_data
author Tassilo Philipp
date Fri, 13 Nov 2020 14:10:31 +0100
parents 0f86a5ecfe61
children edf5c85de5ac
line wrap: on
line diff
--- a/python/pydc/README.txt	Thu Nov 12 19:56:33 2020 +0100
+++ b/python/pydc/README.txt	Fri Nov 13 14:10:31 2020 +0100
@@ -12,6 +12,9 @@
               and 'p' to mutable types (and handles)
 Apr 13, 2020: added signature char support to specify calling conventions
 Oct 27, 2020: allowing 'None' for 'p' params, always passing NULL
+Nov 13, 2020: removed pydc.py wrapper overhead (which only called pydcext.so
+              functions; implies renaming pydcext.* to pydc.*), added type stub
+              as package_data
 
 
 BUILD/INSTALLATION
@@ -30,16 +33,20 @@
 API
 ===
 
+In a nutshell:
+
 libhandle = load(libpath)               # if path == None => handle to running process
 libpath   = get_path(libhandle)         # if handle == None => path to executable
 funcptr   = find(libhandle, symbolname)
 call(funcptr, signature, ...)
 free(libhandle)
 
-Note that there are no functions to set the calling convention mode. However,
-it can be set using the signature.
-Not specifying any calling convention in the signature string will use the
-platform's default one.
+Notes:
+- a pydc.pyi stub file with the precise interface description is available
+- there are no functions to set the calling convention mode, however, it can be
+  set using the signature
+- not specifying any calling convention in the signature string will use the
+  platform's default one
 
 
 SIGNATURE FORMAT