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)
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)
prepare_config(config)
schema = {u'oneOf': [{u'type': u'number'}, {u'additionalProperties': False, u'required': [u'space'], u'type': u'object', u'properties': {u'path': {u'type': u'string', u'format': u'path'}, u'space': {u'type': u'number'}}}]}
flexget.plugins.operate.free_space.get_free_space(folder)

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 = {u'type': u'string', u'format': u'interval'}
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)
schema = {u'type': u'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 = {u'items': {u'$ref': u'/schema/plugins'}, u'type': u'array'}
flexget.plugins.operate.sequence.register_plugin()

sleep Module

class flexget.plugins.operate.sleep.PluginSleep

Bases: object

Causes a pause to occur during the specified phase of a task

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 = {u'oneOf': [{u'additionalProperties': False, u'required': [u'seconds'], u'type': u'object', u'properties': {u'seconds': {u'type': u'integer'}, u'phase': {u'default': u'start', u'enum': [u'start', u'input', u'metainfo', u'filter', u'download', u'modify', u'output', u'learn', u'abort', u'exit'], u'type': u'string'}}}, {u'type': u'integer'}]}
flexget.plugins.operate.sleep.register_plugin()