bindings: Remove 'get_' prefix from all accessors.

[libsigrok.git] / bindings / python / sigrok / core / classes.i

diff --git a/bindings/python/sigrok/core/classes.i b/bindings/python/sigrok/core/classes.i
index ba70d2249c8f104eb5a9f7a9d9f6b513ca5cd688..a01d18afd373f7b36e8ce607bbafcc1cab6e11e6 100644 (file)
--- a/bindings/python/sigrok/core/classes.i
+++ b/bindings/python/sigrok/core/classes.i
@@ -17,7 +17,32 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-%module classes
+%define DOCSTRING
+"@mainpage API Reference
+
+Introduction
+------------
+
+The pysigrok API provides an object-oriented Python interface to the
+functionality in libsigrok. It is built on top of the sigrok++ C++ API.
+
+Getting started
+---------------
+
+Usage of the pysigrok API needs to begin with a call to Context.create().
+This will create the global libsigrok context and returns a Context object.
+Methods on this object provide access to the hardware drivers, input and output
+formats supported by the library, as well as means of creating other objects
+such as sessions and triggers.
+
+Error handling
+--------------
+
+When any libsigrok C API call returns an error, an Error exception is raised,
+which provides access to the error code and description."
+%enddef
+
+%module(docstring=DOCSTRING) classes
 
 %{
 #include <pygobject.h>
@@ -26,7 +51,7 @@ PyObject *GLib;
 PyTypeObject *IOChannel;
 PyTypeObject *PollFD;
 
-#include "../../../../config.h"
+#include "config.h"
 
 #if PYGOBJECT_FLAGS_SIGNED
 typedef gint pyg_flags_type;
@@ -262,7 +287,7 @@ std::map<std::string, std::string> dict_to_map_string(PyObject *dict)
 /* 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 = key->data_type()->id();
 
     if (type == SR_T_UINT64 && PyInt_Check(input))
         return Glib::Variant<guint64>::create(PyInt_AsLong(input));
@@ -284,7 +309,7 @@ Glib::VariantBase python_to_variant_by_key(PyObject *input, const sigrok::Config
 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));
@@ -329,7 +354,7 @@ std::map<std::string, Glib::VariantBase> dict_to_map_options(PyObject *dict,
 
 /* Ignore these methods, we will override them below. */
 %ignore sigrok::Driver::scan;
-%ignore sigrok::InputFormat::open_file;
+%ignore sigrok::InputFormat::create_input;
 %ignore sigrok::OutputFormat::create_output;
 
 %include "doc.i"
@@ -369,21 +394,22 @@ std::map<std::string, Glib::VariantBase> dict_to_map_options(PyObject *dict,
     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. */
@@ -393,7 +419,7 @@ std::map<std::string, Glib::VariantBase> dict_to_map_options(PyObject *dict,
         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()));
     }
 }