pkglts.option_object module

Base class for options.

class pkglts.option_object.Option(name)

Bases: object

Base class to store information associated with an option

check(cfg)

Check validity of parameters for this option.

Parameters:

cfg (Config) – current package configuration

Returns:

list of failing params

Return type:

(list of str)

environment_extensions(cfg)

Get jinja2 environment extensions defined by this option.

Parameters:

cfg (Config) – current package configuration

Returns:

any): extensions defined by this option

Return type:

(dict of str

example_dir()

Directory containing option example files.

Returns:

(Path)

regenerate(*args, **kwds)

Call regenerate associated with this option.

Returns:

(any)

require(cfg)

Check dependencies for this option.

Parameters:

cfg (Config) – current package configuration

Returns:

list of packages this option require

Return type:

(list of Dependency)

require_option(cfg)

Names of other options required by this option.

Parameters:

cfg (Config) – current package configuration

Returns:

(list of str)

resource_dir()

Directory containing option resource files.

Returns:

(Path)

root_dir()

Base directory containing option definition files.

Returns:

(Path)

tools(cfg)

Iterate on tools defined by this option.

Parameters:

cfg (Config) – current package configuration

Returns:

cli parser

Return type:

(iter of func)

update_parameters(cfg)

Update configuration with option parameters.

Parameters:

cfg (Config) – current package configuration

Returns:

(Config)

version()

Current version of this option.

Returns:

X.X.X

Return type:

(str)