Configuration Loader

Module used for loading and storing configuration options

Exposed Functions

kodiRename.config.parseConfig(configIO: BinaryIO) → ConfigSpec

Parse Configuration Options from Binary I/O

Parameters:

configIO – Readable Binary I/O Object

Returns:

Configuration Specification parsed from

Internal Functions

kodiRename.config.config_load.parseGeneralConfig(data: dict) → generalConfig

Parse General Configuration from Dictionary

Parameters:

data – Dictionary to parse

Returns:

General Configuration

kodiRename.config.config_load.parseKodiConfig(data: dict) → kodiConfig

Parse Kodi Config from Dictionary

Parameters:

data – Dictionary to parse

Returns:

Kodi Configuration

kodiRename.config.config_load.parseMovieConfig(data: dict) → movieConfig

Parse Movie Configuration from Dictionary

Parameters:

data – Dictionary to parse

Returns:

Movie Configuration

kodiRename.config.config_load.parseTvConfig(data: dict) → tvConfig

Parse TV configuration from Dictionary

Parameters:

data – Dictionary to parse

Returns:

TV Configuration

kodiRename.config.config_load.parseDriveMappingConfig(data: dict) → driveMappingConfig

Parse Drive Mapping configuration from Dictionary

Parameters:

data – Dictionary to parse

Returns:

Drive mapping configuration

Data Classes

Data classes used to store configuration options

class kodiRename.config.ConfigSpec(general: ~kodiRename.config.config_load.generalConfig = <factory>, log: ~logging.Logger = <Logger kodiRename.config.config_load (WARNING)>, kodi: ~kodiRename.config.config_load.kodiConfig = <factory>, movie_config: ~kodiRename.config.config_load.movieConfig = <factory>, tv_config: ~kodiRename.config.config_load.tvConfig = <factory>, driveMapping: ~typing.List[~kodiRename.config.config_load.driveMappingConfig] = <factory>)

Configurations Options

driveMapping: List[driveMappingConfig]

List of Drive mapping configurations

general: generalConfig

General configuration options

kodi: kodiConfig

Kodi configuration options

log: Logger = <Logger kodiRename.config.config_load (WARNING)>

Application Logger

movie_config: movieConfig

Movie configuration options

tv_config: tvConfig

TV configuration options

class kodiRename.config.generalConfig(logFile: str = 'kodiRename.log', dataDirectory: str = 'data', mode: Literal['copy', 'move'] = 'copy')

General configuration options

dataDirectory: str = 'data'

Directory to output collected information to

logFile: str = 'kodiRename.log'

Log file location

mode: Literal['copy', 'move'] = 'copy'

Mode of operation

Choice of:

• copy: Copy media items when processing

• move: Move media items when processing

class kodiRename.config.kodiConfig(host: str = 'localhost', host_port: int = 8080, use_https: bool = False, ignore_ssl: bool = True)

Kodi configuration options Used when interacting with the Kodi JSONRPC

host: str = 'localhost'

Hostname of IP address of Kodi host to connect to

host_port: int = 8080

Kodi JSONRPC port

ignore_ssl: bool = True

Ignore SSL when connecting to Kodi host

use_https: bool = False

Use HTTPS when connecting to Kodi host

class kodiRename.config.movieConfig(basePath: str = '', outputDirectory: str | None = None, parentFormat: str = '{TITLE} ({YEAR})', fileFormat: str = '{TITLE} [{FORMAT}] ({YEAR})')

Movie Configuration Used for processing parsed movies

basePath: str = ''

Base path of Movie Directory as defined in the Kodi Video Library

fileFormat: str = '{TITLE} [{FORMAT}] ({YEAR})'

Format map string for generating the output filename

outputDirectory: str | None = None

Optional Output directory

parentFormat: str = '{TITLE} ({YEAR})'

Format map string for generating the output directory name

class kodiRename.config.tvConfig(basePath: str = '', outputDirectory: str | None = None, parentFormat: str = '{TITLE}', seasonFormat: str = 'Season {SEASON}', fileFormat: str = '{SHOW_TITLE} S{SEASON:02}E{EPISODE:02}')

TV Configuration Used for processing parsed TV and Episodes

basePath: str = ''

Base path of TV Directory as defined in the Kodi Video Library

fileFormat: str = '{SHOW_TITLE} S{SEASON:02}E{EPISODE:02}'

Format map string for generating the output filename

outputDirectory: str | None = None

parentFormat: str = '{TITLE}'

Format map string for generating the output directory name

seasonFormat: str = 'Season {SEASON}'

Format map string for generating the season output directory name

class kodiRename.config.driveMappingConfig(src: str, dest: str)

Drive Mapping Configuration Used for replacing path strings for local mappings

dest: str

Destination path

src: str

Source Path string to be replace