------------
The pysigrok API provides an object-oriented Python interface to the
-functionality in libsigrok. It is built on top of the sigrok++ C++ API.
+functionality in libsigrok. It is built on top of the libsigrokcxx C++ API.
Getting started
---------------
%module(docstring=DOCSTRING) classes
%{
+#include "config.h"
+
+#include <stdio.h>
#include <pygobject.h>
+#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION
+#include <numpy/arrayobject.h>
+PyObject *PyGObject_lib;
PyObject *GLib;
-PyTypeObject *IOChannel;
-PyTypeObject *PollFD;
-
-#include "../../../../config.h"
#if PYGOBJECT_FLAGS_SIGNED
typedef gint pyg_flags_type;
typedef guint pyg_flags_type;
#endif
+#if PY_VERSION_HEX >= 0x03000000
+#define string_check PyUnicode_Check
+#define string_from_python PyUnicode_AsUTF8
+#define string_to_python PyUnicode_FromString
+#else
+#define string_check PyString_Check
+#define string_from_python PyString_AsString
+#define string_to_python PyString_FromString
+#endif
+
%}
%init %{
- pygobject_init(-1, -1, -1);
+ PyGObject_lib = pygobject_init(-1, -1, -1);
+ if (!PyGObject_lib)
+ fprintf(stderr, "pygobject initialization failed.\n");
GLib = PyImport_ImportModule("gi.repository.GLib");
- IOChannel = (PyTypeObject *) PyObject_GetAttrString(GLib, "IOChannel");
- PollFD = (PyTypeObject *) PyObject_GetAttrString(GLib, "PollFD");
+ /*
+ * This check can't save us if the import fails, but at least it gives us
+ * a starting point to trace the issue versus straight out crashing.
+ */
+ if (!GLib) {
+ fprintf(stderr, "Import of gi.repository.GLib failed.\n");
+#if PY_VERSION_HEX >= 0x03000000
+ return nullptr;
+#else
+ return;
+#endif
+ }
+ import_array();
%}
+%include "../../../swig/templates.i"
+
/* Map file objects to file descriptors. */
%typecheck(SWIG_TYPECHECK_POINTER) int fd {
$1 = (PyObject_AsFileDescriptor($input) != -1);
}
-%typemap(in) int fd {
- int fd = PyObject_AsFileDescriptor($input);
- if (fd == -1)
- SWIG_exception(SWIG_TypeError,
- "Expected file object or integer file descriptor");
- else
- $1 = fd;
-}
-
/* Map from Glib::Variant to native Python types. */
%typemap(out) Glib::VariantBase {
GValue *value = g_new0(GValue, 1);
g_value_set_variant(value, $1.gobj());
PyObject *variant = pyg_value_as_pyobject(value, true);
$result = PyObject_CallMethod(variant,
- const_cast<char *>("unpack"),
- const_cast<char *>(""), NULL);
+ const_cast<char *>("unpack"), nullptr);
Py_XDECREF(variant);
g_free(value);
}
-/* Map from Glib::IOCondition to GLib.IOCondition. */
-%typecheck(SWIG_TYPECHECK_POINTER) Glib::IOCondition {
- pyg_flags_type flags;
- $1 = pygobject_check($input, &PyGFlags_Type) &&
- (pyg_flags_get_value(G_TYPE_IO_CONDITION, $input, &flags) != -1);
-}
-
-%typemap(in) Glib::IOCondition {
- if (!pygobject_check($input, &PyGFlags_Type))
- SWIG_exception(SWIG_TypeError, "Expected GLib.IOCondition value");
- pyg_flags_type flags;
- if (pyg_flags_get_value(G_TYPE_IO_CONDITION, $input, &flags) == -1)
- SWIG_exception(SWIG_TypeError, "Not a valid Glib.IOCondition value");
- $1 = (Glib::IOCondition) flags;
-}
-
-/* And back */
-%typemap(out) Glib::IOCondition {
- GValue *value = g_new0(GValue, 1);
- g_value_init(value, G_TYPE_IO_CONDITION);
- g_value_set_flags(value, &$1);
- $result = pyg_value_as_pyobject(value, true);
- g_free(value);
-}
-
-/* Map from GLib.PollFD to Glib::PollFD *. */
-%typecheck(SWIG_TYPECHECK_POINTER) Glib::PollFD {
- $1 = pygobject_check($input, PollFD);
-}
-
-%typemap(in) Glib::PollFD {
- if (!pygobject_check($input, PollFD))
- SWIG_exception(SWIG_TypeError, "Expected GLib.PollFD");
- PyObject *fd_obj = PyObject_GetAttrString($input, "fd");
- PyObject *events_obj = PyObject_GetAttrString($input, "events");
- pyg_flags_type flags;
- pyg_flags_get_value(G_TYPE_IO_CONDITION, events_obj, &flags);
- int fd = PyInt_AsLong(fd_obj);
- Glib::IOCondition events = (Glib::IOCondition) flags;
- $1 = Glib::PollFD(fd, events);
-}
-
-/* Map from GLib.IOChannel to Glib::IOChannel *. */
-%typecheck(SWIG_TYPECHECK_POINTER) Glib::RefPtr<Glib::IOChannel> {
- $1 = pygobject_check($input, IOChannel);
-}
-
-%typemap(in) Glib::RefPtr<Glib::IOChannel> {
- if (!pygobject_check($input, IOChannel))
- SWIG_exception(SWIG_TypeError, "Expected GLib.IOChannel");
- $1 = Glib::wrap((GIOChannel *) PyObject_Hash($input), true);
-}
+/* Use the same typemap above for Glib::VariantContainerBase */
+%apply Glib::VariantBase { Glib::VariantContainerBase }
-/* Map from callable PyObject to SourceCallbackFunction. */
-%typecheck(SWIG_TYPECHECK_POINTER) sigrok::SourceCallbackFunction {
+/* Map from callable PyObject to LogCallbackFunction */
+%typecheck(SWIG_TYPECHECK_POINTER) sigrok::LogCallbackFunction {
$1 = PyCallable_Check($input);
}
-%typemap(in) sigrok::SourceCallbackFunction {
+%typemap(in) sigrok::LogCallbackFunction {
if (!PyCallable_Check($input))
SWIG_exception(SWIG_TypeError, "Expected a callable Python object");
- $1 = [=] (Glib::IOCondition revents) {
+ $1 = [=] (const sigrok::LogLevel *loglevel, std::string message) {
auto gstate = PyGILState_Ensure();
- GValue *value = g_new0(GValue, 1);
- g_value_init(value, G_TYPE_IO_CONDITION);
- g_value_set_flags(value, revents);
- auto revents_obj = pyg_value_as_pyobject(value, true);
- g_free(value);
+ auto log_obj = SWIG_NewPointerObj(
+ SWIG_as_voidptr(loglevel), SWIGTYPE_p_sigrok__LogLevel, 0);
- auto arglist = Py_BuildValue("(O)", revents_obj);
+ auto string_obj = string_to_python(message.c_str());
+
+ auto arglist = Py_BuildValue("(OO)", log_obj, string_obj);
auto result = PyEval_CallObject($input, arglist);
Py_XDECREF(arglist);
- Py_XDECREF(revents_obj);
+ Py_XDECREF(log_obj);
+ Py_XDECREF(string_obj);
- if (PyErr_Occurred() || !PyBool_Check(result))
- throw sigrok::Error(SR_ERR);
+ bool completed = !PyErr_Occurred();
+
+ if (!completed)
+ PyErr_Print();
- bool retval = (result == Py_True);
+ bool valid_result = (completed && result == Py_None);
Py_XDECREF(result);
+ if (completed && !valid_result)
+ {
+ PyErr_SetString(PyExc_TypeError,
+ "Log callback did not return None");
+ PyErr_Print();
+ }
+
PyGILState_Release(gstate);
- return retval;
+ if (!valid_result)
+ throw sigrok::Error(SR_ERR);
};
Py_XINCREF($input);
}
-/* Map from callable PyObject to LogCallbackFunction */
-%typecheck(SWIG_TYPECHECK_POINTER) sigrok::LogCallbackFunction {
+/* Map from callable PyObject to SessionStoppedCallback */
+%typecheck(SWIG_TYPECHECK_POINTER) sigrok::SessionStoppedCallback {
$1 = PyCallable_Check($input);
}
-%typemap(in) sigrok::LogCallbackFunction {
+%typemap(in) sigrok::SessionStoppedCallback {
if (!PyCallable_Check($input))
SWIG_exception(SWIG_TypeError, "Expected a callable Python object");
- $1 = [=] (const sigrok::LogLevel *loglevel, string message) {
- auto gstate = PyGILState_Ensure();
+ $1 = [=] () {
+ const auto gstate = PyGILState_Ensure();
- auto log_obj = SWIG_NewPointerObj(
- SWIG_as_voidptr(loglevel), SWIGTYPE_p_sigrok__LogLevel, 0);
+ const auto result = PyEval_CallObject($input, nullptr);
+ const bool completed = !PyErr_Occurred();
+ const bool valid_result = (completed && result == Py_None);
- auto string_obj = PyString_FromString(message.c_str());
-
- auto arglist = Py_BuildValue("(OO)", log_obj, string_obj);
-
- auto result = PyEval_CallObject($input, arglist);
+ if (completed && !valid_result) {
+ PyErr_SetString(PyExc_TypeError,
+ "Session stop callback did not return None");
+ }
+ if (!valid_result)
+ PyErr_Print();
- Py_XDECREF(arglist);
- Py_XDECREF(log_obj);
- Py_XDECREF(string_obj);
Py_XDECREF(result);
-
PyGILState_Release(gstate);
+
+ if (!valid_result)
+ throw sigrok::Error(SR_ERR);
};
Py_XINCREF($input);
Py_XDECREF(arglist);
Py_XDECREF(device_obj);
Py_XDECREF(packet_obj);
+
+ bool completed = !PyErr_Occurred();
+
+ if (!completed)
+ PyErr_Print();
+
+ bool valid_result = (completed && result == Py_None);
+
Py_XDECREF(result);
+ if (completed && !valid_result)
+ {
+ PyErr_SetString(PyExc_TypeError,
+ "Datafeed callback did not return None");
+ PyErr_Print();
+ }
+
PyGILState_Release(gstate);
+
+ if (!valid_result)
+ throw sigrok::Error(SR_ERR);
};
Py_XINCREF($input);
}
+/* Cast PacketPayload pointers to correct subclass type. */
+%ignore sigrok::Packet::payload;
+
+%extend sigrok::Packet
+{
+ std::shared_ptr<sigrok::Header> _payload_header()
+ {
+ return dynamic_pointer_cast<sigrok::Header>($self->payload());
+ }
+ std::shared_ptr<sigrok::Meta> _payload_meta()
+ {
+ return dynamic_pointer_cast<sigrok::Meta>($self->payload());
+ }
+ std::shared_ptr<sigrok::Analog> _payload_analog()
+ {
+ return dynamic_pointer_cast<sigrok::Analog>($self->payload());
+ }
+ std::shared_ptr<sigrok::Logic> _payload_logic()
+ {
+ return dynamic_pointer_cast<sigrok::Logic>($self->payload());
+ }
+}
+
+%extend sigrok::Packet
+{
+%pythoncode
+{
+ def _payload(self):
+ if self.type == PacketType.HEADER:
+ return self._payload_header()
+ elif self.type == PacketType.META:
+ return self._payload_meta()
+ elif self.type == PacketType.LOGIC:
+ return self._payload_logic()
+ elif self.type == PacketType.ANALOG:
+ return self._payload_analog()
+ else:
+ return None
+
+ payload = property(_payload)
+}
+}
+
%{
-#include "libsigrok/libsigrok.hpp"
+#include "libsigrokcxx/libsigrokcxx.hpp"
/* Convert from a Python dict to a std::map<std::string, std::string> */
std::map<std::string, std::string> dict_to_map_string(PyObject *dict)
Py_ssize_t pos = 0;
while (PyDict_Next(dict, &pos, &py_key, &py_value)) {
- if (!PyString_Check(py_key))
+ if (!string_check(py_key))
throw sigrok::Error(SR_ERR_ARG);
- if (!PyString_Check(py_value))
+ if (!string_check(py_value))
throw sigrok::Error(SR_ERR_ARG);
- auto key = PyString_AsString(py_key);
- auto value = PyString_AsString(py_value);
+ auto key = string_from_python(py_key);
+ auto value = string_from_python(py_value);
output[key] = value;
}
/* Convert from a Python type to Glib::Variant, according to config key data type. */
Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::ConfigKey *key)
{
- enum sr_datatype type = key->get_data_type()->get_id();
+ enum sr_datatype type = (enum sr_datatype) key->data_type()->id();
if (type == SR_T_UINT64 && PyInt_Check(input))
return Glib::Variant<guint64>::create(PyInt_AsLong(input));
if (type == SR_T_UINT64 && PyLong_Check(input))
return Glib::Variant<guint64>::create(PyLong_AsLong(input));
- else if (type == SR_T_STRING && PyString_Check(input))
- return Glib::Variant<std::string>::create(PyString_AsString(input));
+ else if (type == SR_T_STRING && string_check(input))
+ return Glib::Variant<Glib::ustring>::create(string_from_python(input));
else if (type == SR_T_BOOL && PyBool_Check(input))
return Glib::Variant<bool>::create(input == Py_True);
else if (type == SR_T_FLOAT && PyFloat_Check(input))
return Glib::Variant<double>::create(PyFloat_AsDouble(input));
else if (type == SR_T_INT32 && PyInt_Check(input))
return Glib::Variant<gint32>::create(PyInt_AsLong(input));
- else
- throw sigrok::Error(SR_ERR_ARG);
+ else if ((type == SR_T_RATIONAL_VOLT) && PyTuple_Check(input) && (PyTuple_Size(input) == 2)) {
+ PyObject *numObj = PyTuple_GetItem(input, 0);
+ PyObject *denomObj = PyTuple_GetItem(input, 1);
+ if ((PyInt_Check(numObj) || PyLong_Check(numObj)) && (PyInt_Check(denomObj) || PyLong_Check(denomObj))) {
+ std::tuple<guint64, guint64> tpl = {PyInt_AsLong(numObj), PyInt_AsLong(denomObj)};
+ return Glib::Variant< std::tuple<guint64,guint64> >::Variant::create(tpl);
+ }
+ }
+ throw sigrok::Error(SR_ERR_ARG);
}
/* Convert from a Python type to Glib::Variant, according to Option data type. */
Glib::VariantBase python_to_variant_by_option(PyObject *input,
std::shared_ptr<sigrok::Option> option)
{
- GVariantType *type = option->get_default_value().get_type().gobj();
+ GVariantType *type = option->default_value().get_type().gobj();
if (type == G_VARIANT_TYPE_UINT64 && PyInt_Check(input))
return Glib::Variant<guint64>::create(PyInt_AsLong(input));
if (type == G_VARIANT_TYPE_UINT64 && PyLong_Check(input))
return Glib::Variant<guint64>::create(PyLong_AsLong(input));
- else if (type == G_VARIANT_TYPE_STRING && PyString_Check(input))
- return Glib::Variant<std::string>::create(PyString_AsString(input));
+ else if (type == G_VARIANT_TYPE_STRING && string_check(input))
+ return Glib::Variant<Glib::ustring>::create(string_from_python(input));
else if (type == G_VARIANT_TYPE_BOOLEAN && PyBool_Check(input))
return Glib::Variant<bool>::create(input == Py_True);
else if (type == G_VARIANT_TYPE_DOUBLE && PyFloat_Check(input))
Py_ssize_t pos = 0;
while (PyDict_Next(dict, &pos, &py_key, &py_value)) {
- if (!PyString_Check(py_key))
+ if (!string_check(py_key))
throw sigrok::Error(SR_ERR_ARG);
- auto key = PyString_AsString(py_key);
+ auto key = string_from_python(py_key);
auto value = python_to_variant_by_option(py_value, options[key]);
output[key] = value;
}
%}
/* Ignore these methods, we will override them below. */
+%ignore sigrok::Analog::data;
+%ignore sigrok::Logic::data;
%ignore sigrok::Driver::scan;
-%ignore sigrok::InputFormat::open_file;
+%ignore sigrok::InputFormat::create_input;
%ignore sigrok::OutputFormat::create_output;
-%include "doc.i"
+%include "doc_start.i"
+
+%define %attributevector(Class, Type, Name, Get)
+%rename(_ ## Get) sigrok::Class::Get;
+%extend sigrok::Class
+{
+%pythoncode
+{
+ Name = property(_ ## Get)
+}
+}
+%enddef
+
+%define %attributemap(Class, Type, Name, Get)
+%rename(_ ## Get) sigrok::Class::Get;
+%extend sigrok::Class
+{
+%pythoncode
+{
+ Name = property(fget = lambda x: x._ ## Get().asdict(), doc=_ ## Get.__doc__)
+}
+}
+%enddef
+
+%define %enumextras(Class)
+%extend sigrok::Class
+{
+ long __hash__()
+ {
+ return (long) $self;
+ }
+
+ std::string __str__()
+ {
+ return $self->name();
+ }
+
+ std::string __repr__()
+ {
+ return "Class." + $self->name();
+ }
+
+%pythoncode
+{
+ def __eq__(self, other):
+ return (type(self) is type(other) and hash(self) == hash(other))
+
+ def __ne__(self, other):
+ return (type(self) is not type(other) or hash(self) != hash(other))
+}
+}
+%enddef
%include "../../../swig/classes.i"
while (PyDict_Next(dict, &pos, &py_key, &py_value))
{
- if (!PyString_Check(py_key))
+ if (!string_check(py_key))
throw sigrok::Error(SR_ERR_ARG);
- auto key = sigrok::ConfigKey::get(PyString_AsString(py_key));
+ auto key = sigrok::ConfigKey::get_by_identifier(string_from_python(py_key));
auto value = python_to_variant_by_key(py_value, key);
options[key] = value;
}
Driver.scan = _Driver_scan
}
-/* Support InputFormat.open_file() with keyword arguments. */
+/* Support InputFormat.create_input() with keyword arguments. */
%extend sigrok::InputFormat
{
- std::shared_ptr<sigrok::InputFileDevice> _open_file_kwargs(std::string filename, PyObject *dict)
+ std::shared_ptr<sigrok::Input> _create_input_kwargs(PyObject *dict)
{
- return $self->open_file(filename, dict_to_map_string(dict));
+ return $self->create_input(
+ dict_to_map_options(dict, $self->options()));
}
}
%pythoncode
{
- def _InputFormat_open_file(self, filename, **kwargs):
- return self._open_file_kwargs(filename, kwargs)
+ def _InputFormat_create_input(self, **kwargs):
+ return self._create_input(kwargs)
- InputFormat.open_file = _InputFormat_open_file
+ InputFormat.create_input = _InputFormat_create_input
}
/* Support OutputFormat.create_output() with keyword arguments. */
std::shared_ptr<sigrok::Device> device, PyObject *dict)
{
return $self->create_output(device,
- dict_to_map_options(dict, $self->get_options()));
+ dict_to_map_options(dict, $self->options()));
}
}
$self->config_set(key, python_to_variant_by_key(input, key));
}
}
+
+/* Return NumPy array from Analog::data(). */
+%extend sigrok::Analog
+{
+ PyObject * _data()
+ {
+ int nd = 2;
+ npy_intp dims[2];
+ dims[0] = $self->channels().size();
+ dims[1] = $self->num_samples();
+ int typenum = NPY_FLOAT;
+ void *data = $self->data_pointer();
+ return PyArray_SimpleNewFromData(nd, dims, typenum, data);
+ }
+
+%pythoncode
+{
+ data = property(_data)
+}
+}
+
+/* Return NumPy array from Logic::data(). */
+%extend sigrok::Logic
+{
+ PyObject * _data()
+ {
+ npy_intp dims[2];
+ dims[0] = $self->data_length() / $self->unit_size();
+ dims[1] = $self->unit_size();
+ int typenum = NPY_UINT8;
+ void *data = $self->data_pointer();
+ return PyArray_SimpleNewFromData(2, dims, typenum, data);
+ }
+
+%pythoncode
+{
+ data = property(_data)
+}
+}
+
+/* Create logic packet from Python buffer. */
+%extend sigrok::Context
+{
+ std::shared_ptr<Packet> _create_logic_packet_buf(PyObject *buf, unsigned int unit_size)
+ {
+ Py_buffer view;
+ PyObject_GetBuffer(buf, &view, PyBUF_SIMPLE);
+ return $self->create_logic_packet(view.buf, view.len, unit_size);
+ }
+}
+
+%pythoncode
+{
+ def _Context_create_logic_packet(self, buf, unit_size):
+ return self._create_logic_packet_buf(buf, unit_size)
+
+ Context.create_logic_packet = _Context_create_logic_packet
+}
+
+%include "doc_end.i"
projects / libsigrok.git / blobdiff