inspect

Platypush documentation

`inspect`#

Description#

This plugin can be used to inspect platypush plugins and backends

Configuration#

inspect:
    # No configuration required

Actions#

inspect.get_all_backends

inspect.get_all_events

inspect.get_all_plugins

inspect.get_all_responses

inspect.get_config

inspect.get_enabled_backends

inspect.get_enabled_plugins

inspect.get_pkg_managers

inspect.get_procedures

Module reference#

class platypush.plugins.inspect.InspectPlugin(**kwargs)[source]#

Bases: Plugin

This plugin can be used to inspect platypush plugins and backends

__init__(**kwargs)[source]#

property cache_file: str#

Returns:: The path to the components cache file.

get_all_backends()[source]#: Get information about all the available backends.

get_all_events()[source]#: Get information about all the available events.

get_all_plugins()[source]#: Get information about all the available plugins.

get_all_responses()[source]#: Get information about all the available responses.

get_config(entry: str | None = None) → dict | None[source]#

Return the configuration of the application or of a section.

Parameters:: entry – [Optional] configuration entry name to retrieve (e.g. workdir or backend.http).
Returns:: The requested configuration object.

get_enabled_backends() → List[str][source]#: Get the list of enabled backends.

get_enabled_plugins() → List[str][source]#: Get the list of enabled plugins.

get_pkg_managers() → dict[source]#: Get the list of supported package managers. This is supposed to be an internal-only method, only used by the UI to populate the install commands.

get_procedures() → dict[source]#: Get the list of procedures installed on the device.

refresh_cache(force: bool = False)[source]#: Refreshes the components cache.