hdf5storage.plugins

Module for finding plugins and indicating supported API versions

find_thirdparty_marshaller_plugins()

Find, but don’t load, all third party marshaller plugins.

supported_marshaller_api_versions()

Get the Marshaller API versions that are supported.

find_thirdparty_marshaller_plugins

hdf5storage.plugins.find_thirdparty_marshaller_plugins()[source]

Find, but don’t load, all third party marshaller plugins.

Third party marshaller plugins declare the entry point 'hdf5storage.marshallers.plugins' with the name being the Marshaller API version and the target being a callable that returns a tuple or list of all the marshallers provided by that plugin when given the hdf5storage version (str) as its only argument.

New in version 0.2.

Returns

plugins – The marshaller obtaining entry points from third party plugins. The keys are the Marshaller API versions (str) and the values are dict of the entry points, with the module names as the keys (str) and the values being the entry points (pkg_resources.EntryPoint).

Return type

dict

supported_marshaller_api_versions

hdf5storage.plugins.supported_marshaller_api_versions()[source]

Get the Marshaller API versions that are supported.

Gets the different Marshaller API versions that this version of hdf5storage supports.

New in version 0.2.

Returns

versions – The different versions of marshallers that are supported. Each element is a version that is supported. The versions are specified in standard major, minor, etc. format as str (e.g. '1.0'). They are in descending order (highest version first, lowest version last).

Return type

tuple