DEV IN PROGRESS

Module pychrysalide

Documentation

PyChrysalide is a module containing Chrysalide's features and designed for Python users.

The whole API is defined in a single library named 'pychrysalide.so' and can be used in two ways:

  • either from the Chrysalide's GUI, by registering hooks or GLib signals;
  • or from a shell command line, by setting PYTHONPATH to point to the directory containing the library.

In both cases, this is a good start point to have a look at already existing plugins to quickly learn how the API works.

These plugins are located in the 'plugins/python' directory.

Sub modules

Classes

Methods

mod_version()

Provide the version number of Chrysalide module for Python.

The returned value is provided as a string, for instance: '0.1.0'.

revision()

Provide the revision number of Chrysalide.

The returned value is provided as a string, for instance: 'r1665'.

version()

Provide the version number of Chrysalide.

The returned value is provided as a string, for instance: '1.6.65'.

Class StringEnum

StringEnum provides dictionaries collecting string constants.

Such constants are mainly used as keywords for accessing configuration parameters.

Hierarchy

builtins.object
 ╰── builtins.dict
      ╰── pychrysalide.StringEnum

Class StructObject

StructObject is a sugar glue used to transmit C structures to Python.

For instance, let's consider the following C structure :

    struct _my_struct_t { int a; int b } var;

Such a structure will be translated into a Python dictionary.

Each previous field gets then accessible using :

  • a direct access: var.a;
  • an access by name thanks to the dictionary: var['b'].

Hierarchy

builtins.object
 ╰── builtins.dict
      ╰── pychrysalide.StructObject