operate Package

operate Package

disable_builtins Module

disable_phases Module

class flexget.plugins.operate.disable_phases.PluginDisablePhases

Bases: object

Disables phases from task execution.

Mainly meant for advanced users and development.

Example:

disable_phases:

  • download

on_task_start(task, config)
property schema
flexget.plugins.operate.disable_phases.register_plugin()

task_execution Module

task_priority Module

free_space Module

class flexget.plugins.operate.free_space.PluginFreeSpace

Bases: object

Aborts a task if an entry is accepted and there is less than a certain amount of space free on a drive.

on_task_download(task, config)
static prepare_config(config, task)
schema = {'oneOf': [{'type': 'number'}, {'additionalProperties': False, 'dependencies': {'host': ['user', 'ssh_key_filepath', 'path']}, 'properties': {'abort_if': {'default': 'below', 'enum': ['below', 'above'], 'type': 'string'}, 'allotment': {'default': -1, 'type': 'number'}, 'host': {'type': 'string'}, 'path': {'type': 'string'}, 'port': {'default': 22, 'type': 'integer'}, 'space': {'oneOf': [{'type': 'number'}, {'format': 'size', 'type': 'string'}]}, 'ssh_key_filepath': {'type': 'string'}, 'user': {'type': 'string'}}, 'required': ['space'], 'type': 'object'}]}
flexget.plugins.operate.free_space.get_free_space(config, task)

Return folder/drive free space (in megabytes)

flexget.plugins.operate.free_space.register_plugin()

interval Module

class flexget.plugins.operate.interval.PluginInterval

Bases: object

Allows specifying minimum interval for task execution.

Format: [n] [minutes|hours|days|weeks]

Example:

interval: 7 days

on_task_start(task, config)
schema = {'format': 'interval', 'type': 'string'}
flexget.plugins.operate.interval.register_parser_arguments()
flexget.plugins.operate.interval.register_plugin()

max_reruns Module

class flexget.plugins.operate.max_reruns.MaxReRuns

Bases: object

Overrides the maximum amount of re-runs allowed by a task.

on_task_abort(task, config)
on_task_exit(task, config)
on_task_start(task, config)
reset(task)
schema = {'type': 'integer'}
flexget.plugins.operate.max_reruns.register_plugin()

sequence Module

class flexget.plugins.operate.sequence.PluginSequence

Bases: object

Allows the same plugin to be configured multiple times in a task.

Example: sequence:

schema = {'items': {'$ref': '/schema/plugins'}, 'type': 'array'}
flexget.plugins.operate.sequence.register_plugin()

sleep Module

class flexget.plugins.operate.sleep.PluginSleep

Bases: object

Causes a pause in execution to occur at the beginning of the specified phase of a task. The point at which the pause occurs can be adjusted using the plugin_priority plugin.

do_sleep(config, phase)
on_task_abort(task, config)
on_task_download(task, config)
on_task_exit(task, config)
on_task_filter(task, config)
on_task_input(task, config)
on_task_learn(task, config)
on_task_metainfo(task, config)
on_task_modify(task, config)
on_task_output(task, config)
on_task_start(task, config)
schema = {'oneOf': [{'additionalProperties': False, 'properties': {'phase': {'default': 'start', 'enum': ['start', 'input', 'metainfo', 'filter', 'download', 'modify', 'output', 'learn', 'abort', 'exit'], 'type': 'string'}, 'seconds': {'type': 'integer'}}, 'required': ['seconds'], 'type': 'object'}, {'type': 'integer'}]}
flexget.plugins.operate.sleep.register_plugin()