pytconf package

Submodules

pytconf.color_utils module

helpers to print stuff in color

pytconf.color_utils.color_hi(text)

pytconf.color_utils.color_ok(text)

pytconf.color_utils.color_warn(text)

pytconf.color_utils.identity(text)

pytconf.color_utils.print_error(text)

pytconf.color_utils.print_highlight(text)

pytconf.color_utils.print_title(text)

pytconf.color_utils.print_warn(text)

pytconf.config module

main configuration object for pytconf

class pytconf.config.Config

Bases: object

class pytconf.config.ConfigFormat(*values)

Bases: Enum

JSON = 1

YAML = 2

class pytconf.config.ConfigType(*values)

Bases: Enum

SYSTEM = 2

USER = 1

class pytconf.config.FunctionData(name: str, description: str, function: Callable, configs: List[pytconf.config.Config] = <factory>, suggest_configs: List[pytconf.config.Config] = <factory>, allow_free_args: bool = False, min_free_args: Optional[int] = None, max_free_args: Optional[int] = None, group: str = 'default')

Bases: object

allow_free_args: bool = False

configs: List[Config]

description: str

function: Callable

group: str = 'default'

max_free_args: int | None = None

min_free_args: int | None = None

name: str

suggest_configs: List[Config]

class pytconf.config.FunctionGroupData(name: str, description: str, show_meta: bool = False, show: bool = False, names: Set[str] = <factory>, list_names: List[str] = <factory>)

Bases: object

description: str

list_names: List[str]

name: str

names: Set[str]

show: bool = False

show_meta: bool = False

class pytconf.config.MetaConfig(name, bases, namespace)

Bases: type

class pytconf.config.PytconfConf

Bases: object

config_arg_parse_and_launch(args: List[str] | None = None, launch=True, do_exit=True) → None

static get_config(app_name: str, config_type: ConfigType, config_format: ConfigFormat)

get_function_selected(args: List[str], errors) → FunctionData | None

get_html() → str

classmethod get_html_for_config(config, html_gen)

get_html_for_function(name: str, html_gen)

has_function(function_name: str) → bool

launch(launch: bool, select: FunctionData | None, errors)

parse_args(args, errors, flags)

classmethod print_errors(errors: ErrorsCollector) → None

process_flags(select: FunctionData, flags: Dict[str, str], errors: ErrorsCollector) → None

static read_flags_from_config(app_name: str, config_type: ConfigType, config_format: ConfigFormat, flags: Dict[str, str]) → None

register_defaults()

register_function(data: FunctionData)

register_function_group(data: FunctionGroupData)

register_main(main_function: Callable, main_description: str, app_name: str, version: str)

classmethod rm_config_file(app_name: str, config_type: ConfigType, config_format: ConfigFormat) → None

show_help() → None

classmethod show_help_for_config(config)

show_help_for_function(name: str, show_help_full: bool = False, show_help_suggest: bool = False) → None

write_config(config_type: ConfigType, config_format: ConfigFormat) → None

classmethod write_config_file(filename: str, config_format: ConfigFormat) → None

pytconf.config.config_arg_parse_and_launch(args=None, launch=True, do_exit=True) → None

pytconf.config.get_free_args() → List[str]

pytconf.config.get_pytconf()

pytconf.config.register_endpoint(description: str, name: str | None = None, configs: List[Config] | None = None, suggest_configs: List[Config] | None = None, group: str = 'default', allow_free_args: bool = False, min_free_args: int | None = None, max_free_args: int | None = None) → Callable[[Any], Any]

pytconf.config.register_function(name: str, description: str, function: Callable, configs: List[Config] | None = None, suggest_configs: List[Config] | None = None, allow_free_args: bool = False, min_free_args: int | None = None, max_free_args: int | None = None, group: str = 'default')

pytconf.config.register_function_group(name: str, description: str, show_meta: bool, show: bool) → None

pytconf.config.register_main(main_description: str, app_name: str, version: str) → Callable[[Any], Any]

pytconf.config.rm_config_file(app_name: str, config_type: ConfigType, config_format: ConfigFormat) → None

pytconf.config.write_config(config_type: ConfigType, config_format: ConfigFormat) → None

pytconf.config.write_config_file(filename: str, config_format: ConfigFormat) → None

pytconf.convert module

pytconf conversion utils

pytconf.convert.convert_bool_to_str(b: bool) → str

pytconf.convert.convert_int_or_none_to_str(v: int | None) → str

pytconf.convert.convert_int_to_str(i: int) → str

pytconf.convert.convert_list_int_to_str(li: List[int]) → str

pytconf.convert.convert_list_str_to_str(li: List[str]) → str

pytconf.convert.convert_str_or_none_to_str(v: str | None) → str

pytconf.convert.convert_str_to_bool(s: str) → bool

pytconf.convert.convert_str_to_int(s: str) → int

pytconf.convert.convert_str_to_int_default(i: int, s: str) → int

pytconf.convert.convert_str_to_int_or_none(s: str) → int | None

pytconf.convert.convert_str_to_list_int(s: str) → List[int]

pytconf.convert.convert_str_to_list_str(s: str) → List[str]

pytconf.convert.convert_str_to_str(e: str) → str

pytconf.convert.convert_str_to_str_or_none(s: str) → str | None

pytconf.data module

data for this module

pytconf.enum_subset module

A subset of enum values

class pytconf.enum_subset.EnumSubset(enum_type: Enum, list_of_values: List[Enum])

Bases: object

add(enum_value)

delete(enum_value)

classmethod from_enum_all(e)

classmethod from_string(e, s)

has_value(item)

list_of_strings()

to_string()

values()

yield_values()

pytconf.enum_subset.enum_subset_to_str(e: EnumSubset) → str

pytconf.enum_subset.g_from_enum_all(e: ExtendedEnum) → EnumSubset

pytconf.enum_subset.g_from_string(e: Enum, s: str) → EnumSubset

pytconf.errors_collector module

A collection of errors module

class pytconf.errors_collector.ErrorsCollector

Bases: object

This collector support two types of error. Regular errors and special errors Regular errors are the ones to be printed and carry the error_type = false.

add_error(msg: str) → None

add an error

get_do_help() → bool

get_show_errors()

have_errors() → bool

do I have any erorrs

set_do_help() → None

set_force_show_errors() → None

unset_show_errors() → None

yield_errors() → Generator[str, None, None]

pytconf.extended_enum module

Pythons Enum plus several methods

class pytconf.extended_enum.ExtendedEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

classmethod from_string(s: str) → Enum

classmethod get_list_of_all_values()

pytconf.extended_enum.enum_int_to_name(i: int, e: Enum) → str

pytconf.extended_enum.enum_type_to_list_str(e: Enum) → List[str]

pytconf.extended_enum.enum_value_to_str(ev: Enum) → str

pytconf.extended_enum.str_to_enum_int(s: str, e: Enum) → int

pytconf.extended_enum.str_to_enum_value(s, e: Enum) → Enum

pytconf.param module

Pytconf param types

class pytconf.param.Param(help_string='No help for this configuration option', default: ~typing.Any = <pytconf.param.Unique object>, type_name: str | None = None)

Bases: ABC

Parent class of all parameters of configuration

collect()

collect the current object

get_type_name()

get the type name of the current object

more_help() → str | None

get more help

abstractmethod s2t(s: str) → object

translate string ot this type

s2t_generate_from_default(s: str) → object

generate object from default string

abstractmethod t2s(t: object) → str

translate self to string

class pytconf.param.ParamChoice(help_string='No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>, choice_list: ~typing.List[str] | None = None)

Bases: Param

more_help()

get more help

s2t(s: str) → Any

translate string ot this type

t2s(t: Any) → str

translate self to string

class pytconf.param.ParamCreator

Bases: object

Static namespace with all the param creation functions.

static create_bool(help_string: str = 'No help for this configuration option', default: bool | ~pytconf.param.Unique = <pytconf.param.Unique object>) → bool

Create a bool parameter :param help_string: :param default: :return:

static create_choice(choice_list: ~typing.List[str], help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>) → str

Create a choice config :param choice_list: :param help_string: :param default: :return:

static create_enum(enum_type: ~enum.Enum, help_string: str = 'No help for this configuration option', default: ~enum.Enum | ~pytconf.param.Unique = <pytconf.param.Unique object>) → Enum

Create an enum config :param enum_type: :param help_string: :param default: :return:

static create_enum_subset(enum_type: ~enum.Enum, help_string: str = 'No help for this configuration option', default: ~pytconf.enum_subset.EnumSubset | ~pytconf.param.Unique = <pytconf.param.Unique object>) → EnumSubset

Create an enum config :param enum_type: :param help_string: :param default: :return:

static create_existing_bucket(help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>) → str

Create a bucket name on gcp :param help_string: :param default: :return:

static create_existing_file(help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>, suffixes: ~typing.List[str] | None = None) → str

Create a new file parameter :param help_string: :param default: :param suffixes: :return:

static create_existing_folder(help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>, suffixes: ~typing.List[str] | None = None) → str

Create a new folder parameter :param help_string: :param default: :param suffixes: :return:

static create_int(help_string: str = 'No help for this configuration option', default: int | ~pytconf.param.Unique = <pytconf.param.Unique object>) → int

Create an int parameter :param help_string: :param default: :return:

static create_int_or_none(help_string: str = 'No help for this configuration option', default: int | None | ~pytconf.param.Unique = <pytconf.param.Unique object>) → int | None

Create an int parameter :param help_string: :param default: :return:

static create_list_int(help_string: str = 'No help for this configuration option', default: List[int] = []) → List[int]

Create a List[int] parameter :param help_string: :param default: :return:

static create_list_str(help_string: str = 'No help for this configuration option', default: List[str] = []) → List[str]

Create a List[str] parameter :param help_string: :param default: :return:

static create_new_file(help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>, suffixes: ~typing.List[str] | None = None) → str

Create a new file parameter :param help_string: :param default: :param suffixes: :return:

static create_str(help_string: str = 'No help for this configuration option', default: str | ~pytconf.param.Unique = <pytconf.param.Unique object>) → str

Create a string parameter :param help_string: :param default: :return:

static create_str_or_none(help_string: str = 'No help for this configuration option', default: str | None | ~pytconf.param.Unique = <pytconf.param.Unique object>) → str | None

Create a string parameter :param help_string: :param default: :return:

class pytconf.param.ParamEnum(enum_type: ~enum.Enum, help_string='No help for this configuration option', default: ~typing.Any = <pytconf.param.Unique object>)

Bases: Param

get_type_name()

get the type name of the current object

more_help()

get more help

s2t(s: str) → Any

translate string ot this type

t2s(t: Any) → str

translate self to string

class pytconf.param.ParamEnumSubset(help_string='No help for this configuration option', default: ~typing.Any = <pytconf.param.Unique object>, enum_type: ~enum.Enum | None = None)

Bases: Param

get_type_name()

get the type name of the current object

more_help()

get more help

s2t(s: str) → EnumSubset

translate string ot this type

s2t_generate_from_default(s: str) → EnumSubset | None

generate object from default string

t2s(t: Any) → str

translate self to string

class pytconf.param.ParamFilename(help_string: str = 'No help for this configuration option', default: ~pytconf.param.Unique | str = <pytconf.param.Unique object>, type_name=None, suffixes: ~typing.List[str] | None = None)

Bases: Param

more_help()

get more help

s2t(s)

translate string ot this type

t2s(t)

translate self to string

class pytconf.param.ParamFunctions(function_s2t: Callable, function_s2t_generate_from_default: Callable, function_t2s: Callable, help_string='No help for this configuration option', default=None, type_name=None)

Bases: Param

Parent class of all parameters of configuration

s2t(s: str) → Any

translate string ot this type

s2t_generate_from_default(s: str) → Any

generate object from default string

t2s(t: Any) → str

translate self to string

class pytconf.param.Unique

Bases: object

A object with a unique value

pytconf.param_collector module

A collector for all parameters

class pytconf.param_collector.ParamCollector

Bases: object

add_data(item)

clear()

get_item(i)

yield_items()

pytconf.pydoc module

Documentation functions

pytconf.pydoc.get_first_line(o, default_val: str) → str | None

Get first line for a pydoc string :param o: object which is documented (class or function) :param default_val: value to return if there is no documentation :return: the first line which is not whitespace

pytconf.registry module

registry of config names

class pytconf.registry.Registry

Bases: object

get_config_for_name(name)

get_data_for_name(name)

has_name(name)

register(config, name, data)

yield_configs()

yield_name_data_for_config(config)

yield_names_for_config(config)

pytconf.static module

version which can be consumed from within the module

pytconf.utils module

Utils module for the pytconf project

class pytconf.utils.HtmlGen

Bases: object

html generator

pytconf.utils.noun(name: str, num: int) → str

This function returns a noun in it’s right for a specific quantity :param name: :param num: :return:

Module contents

initialization of the condif module