flexget.api.core.plugins module

class flexget.api.core.plugins.ObjectsContainer

Bases: object

phase_object = {'properties': {'phase': {'type': 'string'}, 'priority': {'type': 'integer'}}, 'type': 'object'}

plugin_list_reply = {'items': {'properties': {'api_ver': {'type': 'integer'}, 'builtin': {'type': 'boolean'}, 'category': {'type': ['string', 'null']}, 'contexts': {'items': {'type': 'string'}, 'type': 'array'}, 'debug': {'type': 'boolean'}, 'interfaces': {'items': {'type': 'string'}, 'type': 'array'}, 'name': {'type': 'string'}, 'phase_handlers': {'items': {'properties': {'phase': {'type': 'string'}, 'priority': {'type': 'integer'}}, 'type': 'object'}, 'type': 'array'}}, 'type': 'object'}, 'type': 'array'}

plugin_object = {'properties': {'api_ver': {'type': 'integer'}, 'builtin': {'type': 'boolean'}, 'category': {'type': ['string', 'null']}, 'contexts': {'items': {'type': 'string'}, 'type': 'array'}, 'debug': {'type': 'boolean'}, 'interfaces': {'items': {'type': 'string'}, 'type': 'array'}, 'name': {'type': 'string'}, 'phase_handlers': {'items': {'properties': {'phase': {'type': 'string'}, 'priority': {'type': 'integer'}}, 'type': 'object'}, 'type': 'array'}}, 'type': 'object'}

class flexget.api.core.plugins.PluginAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(plugin_name, session=None)

Return plugin data by name.

Parameters:

plugin_name (str)

mediatypes()

endpoint = 'plugins_plugin_api'

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.api.core.plugins.PluginsAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Get list of registered plugins.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'plugins_plugins_api'

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

flexget.api.core.plugins.plugin_to_dict(plugin)

Return type:

PluginDict