nomenclator.config

class nomenclator.config.Config(descriptions, default_description, create_subfolders, comp_template_configs, project_template_configs, colorspace_aliases, tokens, max_locations, max_padding, default_padding, username, username_is_default)

Bases: tuple

Configuration Structure type.

__init__

Initialize self. See help(type(self)) for accurate signature.

colorspace_aliases

Alias for field number 5

comp_template_configs

Alias for field number 3

count()

Return number of occurrences of value.

create_subfolders

Alias for field number 2

default_description

Alias for field number 1

default_padding

Alias for field number 9

descriptions

Alias for field number 0

index()

Return first index of value.

Raises ValueError if the value is not present.

max_locations

Alias for field number 7

max_padding

Alias for field number 8

project_template_configs

Alias for field number 4

tokens

Alias for field number 6

username

Alias for field number 10

username_is_default

Alias for field number 11

class nomenclator.config.TemplateConfig(id, pattern_path, pattern_base, default_expression, match_start, match_end, append_username_to_name, outputs)

Bases: tuple

Template Structure type.

__init__

Initialize self. See help(type(self)) for accurate signature.

append_username_to_name

Alias for field number 6

count()

Return number of occurrences of value.

default_expression

Alias for field number 3

id

Alias for field number 0

index()

Return first index of value.

Raises ValueError if the value is not present.

match_end

Alias for field number 5

match_start

Alias for field number 4

outputs

Alias for field number 7

pattern_base

Alias for field number 2

pattern_path

Alias for field number 1

class nomenclator.config.OutputTemplateConfig(id, pattern_path, pattern_base, append_username_to_name, append_colorspace_to_name, append_passname_to_name, append_passname_to_subfolder)

Bases: tuple

Output Template Structure type.

__init__

Initialize self. See help(type(self)) for accurate signature.

append_colorspace_to_name

Alias for field number 4

append_passname_to_name

Alias for field number 5

append_passname_to_subfolder

Alias for field number 6

append_username_to_name

Alias for field number 3

count()

Return number of occurrences of value.

id

Alias for field number 0

index()

Return first index of value.

Raises ValueError if the value is not present.

pattern_base

Alias for field number 2

pattern_path

Alias for field number 1

nomenclator.config.path()

Return path to configuration file.

The configuration file is returned from the NOMENCLATOR_CONFIG_PATH environment variable, or from the ~/.nuke folder.

nomenclator.config.fetch()

Return configuration object.

nomenclator.config.save(config)

Save config as a configuration file.

nomenclator.config.dump(config)

Return data mapping from config object.

nomenclator.config.dump_template_configs(configs, include_outputs=False)

Return data mapping from list of template configs.

nomenclator.config.dump_output_template_configs(configs)

Return data mapping from list of output template configs.

nomenclator.config.load(data)

Return config object from data mapping.

nomenclator.config.load_template_configs(items, include_outputs=False)

Return list of template configs from items.

nomenclator.config.load_output_template_configs(items)

Return list of output template configs from items.