flexget.api.core.server module

class flexget.api.core.server.LogParser(query)

Bases: object

Filter log file.

Supports

• ‘and’, ‘or’ and implicit ‘and’ operators;

• parentheses;

• quoted strings;

Parameters:

query (str | None)

evaluate(argument)

evaluate_and(argument)

evaluate_not(argument)

evaluate_or(argument)

evaluate_parenthesis(argument)

evaluate_quotes(argument)

evaluate_word(argument)

json_string(line)

matches(line)

class flexget.api.core.server.ObjectsContainer

Bases: object

config_validation_error = {'properties': {'config_path': {'type': 'string'}, 'error': {'type': 'string'}, 'message': {'type': 'string'}, 'status': {'type': 'string'}, 'status_code': {'type': 'integer'}}, 'required': ['status_code', 'message', 'status'], 'type': 'object'}

crash_logs = {'items': {'properties': {'content': {'items': {'type': 'string'}, 'type': 'array'}, 'name': {'type': 'string'}}, 'type': 'object'}, 'type': 'array'}

dump_threads_object = {'properties': {'threads': {'items': {'properties': {'dump': {'items': {'type': 'string'}, 'type': 'array'}, 'id': {'type': 'string'}, 'name': {'type': 'string'}}, 'type': 'object'}, 'type': 'array'}}, 'type': 'object'}

pid_object = {'properties': {'pid': {'type': 'integer'}}, 'type': 'object'}

raw_config_object = {'properties': {'raw_config': {'type': 'string'}}, 'type': 'object'}

server_manage = {'additionalProperties': False, 'properties': {'force': {'type': 'boolean'}, 'operation': {'enum': ['reload', 'shutdown'], 'type': 'string'}}, 'required': ['operation'], 'type': 'object'}

version_object = {'properties': {'api_version': {'type': 'string'}, 'flexget_version': {'type': 'string'}, 'latest_version': {'type': ['string', 'null']}}, 'type': 'object'}

yaml_error_response = {'properties': {'column': {'type': 'integer'}, 'line': {'type': 'integer'}, 'message': {'type': 'string'}, 'reason': {'type': 'string'}, 'status': {'type': 'string'}, 'status_code': {'type': 'integer'}}, 'required': ['status_code', 'message', 'status'], 'type': 'object'}

class flexget.api.core.server.ServerConfigAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Get Flexget Config in JSON form.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'server_server_config_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.server.ServerCrashLogAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session)

Get Crash logs.

Parameters:

session (Session)

mediatypes()

endpoint = 'server_server_crash_log_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.server.ServerDumpThreads(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Dump Server threads for debugging.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'server_server_dump_threads'

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.server.ServerLogAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Stream Flexget log Streams as line delimited JSON.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'server_server_log_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.server.ServerPIDAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Get server PID.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'server_server_pidapi'

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.server.ServerRawConfigAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Get raw YAML config file.

Parameters:

session (Session)

Return type:

Response

mediatypes()

post(session=None)

Update config.

Parameters:

session (Session)

Return type:

Response

endpoint = 'server_server_raw_config_api'

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

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.server.ServerReloadAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

mediatypes()

post(session=None)

Manage server operations.

Parameters:

session (Session)

Return type:

Response

endpoint = 'server_server_reload_api'

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

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.server.ServerVersionAPI(api, *args, **kwargs)

Bases: APIResource

Parameters:

api (RestxAPI)

get(session=None)

Flexget Version.

Parameters:

session (Session)

Return type:

Response

mediatypes()

endpoint = 'server_server_version_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.server.file_inode(file)

Parameters:

file (Path)

Return type:

int

flexget.api.core.server.reverse_readline(fh, start_byte=0, buf_size=8192)

Return the lines of a file in reverse order.

Parameters:

• fh (IO)

• start_byte (int)

• buf_size (int)

Return type:

Generator[str, None, None]