flexget.plugins.input.filesystem module

class flexget.plugins.input.filesystem.Filesystem

Bases: object

Use local path content as an input. Can use recursion if configured.

Recursion is False by default. Can be configured to true or get integer that will specify max depth in relation to base folder. All files/dir/symlinks are retrieved by default. Can be changed by using the retrieve property.

Example 1—Single path:

filesystem: /storage/movies/

Example 2—List of paths:

filesystem:
   - /storage/movies/
   - /storage/tv/

Example 3—Object with list of paths:

filesystem:
  path:
    - /storage/movies/
    - /storage/tv/
  mask: '*.mkv'

Example 4:

filesystem:
  path:
    - /storage/movies/
    - /storage/tv/
  recursive: 4  # 4 levels deep from each base folder
  retrieve: files  # Only files will be retrieved

Example 5:

filesystem:
  path:
    - /storage/movies/
    - /storage/tv/
  recursive: yes  # No limit to depth, all sub dirs will be accessed
  retrieve:  # Only files and dirs will be retrieved
    - files
    - dirs

static get_folder_objects(folder, recursion)

Parameters:

• folder (Path)

• recursion (bool)

create_entry(filepath, test_mode)

Create a single entry using a filepath and a type (file/dir).

Parameters:

filepath (Path)

get_entries_from_path(path_list, match, recursion, test_mode, get_files, get_dirs, get_symlinks)

get_max_depth(recursion, base_depth)

on_task_input(task, config)

prepare_config(config)

paths = {'oneOf': [{'items': {'format': 'path', 'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': True}, {'format': 'path', 'title': 'single value', 'type': 'string'}]}

retrieval_options = ['files', 'dirs', 'symlinks']

schema = {'oneOf': [{'oneOf': [{'items': {'format': 'path', 'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': True}, {'format': 'path', 'title': 'single value', 'type': 'string'}]}, {'additionalProperties': False, 'properties': {'mask': {'type': 'string'}, 'path': {'oneOf': [{'items': {'format': 'path', 'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': True}, {'format': 'path', 'title': 'single value', 'type': 'string'}]}, 'recursive': {'oneOf': [{'minimum': 2, 'type': 'integer'}, {'type': 'boolean'}]}, 'regexp': {'format': 'regex', 'type': 'string'}, 'retrieve': {'oneOf': [{'items': {'enum': ['files', 'dirs', 'symlinks'], 'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': True}, {'enum': ['files', 'dirs', 'symlinks'], 'title': 'single value', 'type': 'string'}]}}, 'required': ['path'], 'type': 'object'}]}

flexget.plugins.input.filesystem.register_plugin()