orchestro.orche package#

Subpackages#

Submodules#

orchestro.orche.common module#

orchestro.orche.config module#

class orchestro.orche.config.OrcheConfig(sargs: dict[str, Any] | None = None, files: str | Path | list[str | Path] | list[str] | list[Path] | tuple[str | Path, ...] | set[str] | None = None, paths: str | Path | list[str | Path] | list[str] | list[Path] | tuple[str | Path, ...] | set[str] | None = None, cargs: dict[str, Any] | None = None)[source]#

Bases: Config

Contain the configurations from the arguments and files.

Parameters:

  • sargs – Additional arguments on the command line.

  • files – Complete or relative path to config files.

  • paths – Complete or relative path to config paths.

  • cargs – Configuration arguments in dictionary form, which will override contents from the config files.

property params: OrcheParams#

Return the Pydantic model containing the configuration.

Warning

This method completely overrides the parent but is based on that code, would be unfortunate if upstream changes meant this breaks or breaks something else.

Returns:

Pydantic model containing the configuration.

merge_params() → None[source]#

Update the Pydantic model containing the configuration.

Note

Inheritance routine has inspired other projects.

orchestro.orche.config.inheritance(dumped: dict[str, Any]) → None[source]#

Perform the inheritance after resolving the inheritance.

Note

Inheritance routine has inspired other projects.

Parameters:

dumped – Source contents which will be processed.

orchestro.orche.models module#

Functions and routines associated with Enasis Network Orche Automate.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.models.OrcheModels[source]#

Bases: object

Return the class object that was imported within method.

classmethod orche() → Type[OrcheParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod child() → Type[OrcheChildParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod system() → Type[OrcheSystemParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod person() → Type[OrchePersonParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod subnet() → Type[OrcheSubnetParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod group() → Type[OrcheGroupParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

orchestro.orche.orche module#

class orchestro.orche.orche.Orche(config: OrcheConfig)[source]#

Bases: object

Interact with chat networks and integrate using plugins.

Parameters:

config – Primary class instance for configuration.

property config: OrcheConfig#

Return the Config instance containing the configuration.

Returns:

Config instance containing the configuration.

property logger: OrcheLogger#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property jinja2: OrcheJinja2#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property childs: OrcheChilds#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property console: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property debug: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dryrun: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kvparsed: dict[str, Any]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kvopaque: dict[str, Any]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]#

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

j2parse(value: Any, statics: dict[str, Any] | None = None, literal: bool = True) → Any[source]#

Return the provided input using the Jinja2 environment.

Parameters:

  • value – Input that will be processed and returned.

  • statics – Additional values available for parsing.

  • literal – Determine if Python objects are evaled.

Returns:

Provided input using the Jinja2 environment.

Module contents#

class orchestro.orche.Orche(config: OrcheConfig)[source]#

Bases: object

Interact with chat networks and integrate using plugins.

Parameters:

config – Primary class instance for configuration.

property config: OrcheConfig#

Return the Config instance containing the configuration.

Returns:

Config instance containing the configuration.

property logger: OrcheLogger#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property jinja2: OrcheJinja2#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property childs: OrcheChilds#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property console: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property debug: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dryrun: bool#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kvparsed: dict[str, Any]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kvopaque: dict[str, Any]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]#

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

j2parse(value: Any, statics: dict[str, Any] | None = None, literal: bool = True) → Any[source]#

Return the provided input using the Jinja2 environment.

Parameters:

  • value – Input that will be processed and returned.

  • statics – Additional values available for parsing.

  • literal – Determine if Python objects are evaled.

Returns:

Provided input using the Jinja2 environment.

class orchestro.orche.OrcheConfig(sargs: dict[str, Any] | None = None, files: str | Path | list[str | Path] | list[str] | list[Path] | tuple[str | Path, ...] | set[str] | None = None, paths: str | Path | list[str | Path] | list[str] | list[Path] | tuple[str | Path, ...] | set[str] | None = None, cargs: dict[str, Any] | None = None)[source]#

Bases: Config

Contain the configurations from the arguments and files.

Parameters:

  • sargs – Additional arguments on the command line.

  • files – Complete or relative path to config files.

  • paths – Complete or relative path to config paths.

  • cargs – Configuration arguments in dictionary form, which will override contents from the config files.

property params: OrcheParams#

Return the Pydantic model containing the configuration.

Warning

This method completely overrides the parent but is based on that code, would be unfortunate if upstream changes meant this breaks or breaks something else.

Returns:

Pydantic model containing the configuration.

merge_params() → None[source]#

Update the Pydantic model containing the configuration.

Note

Inheritance routine has inspired other projects.

class orchestro.orche.OrcheModels[source]#

Bases: object

Return the class object that was imported within method.

classmethod orche() → Type[OrcheParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod child() → Type[OrcheChildParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod system() → Type[OrcheSystemParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod person() → Type[OrchePersonParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod subnet() → Type[OrcheSubnetParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod group() → Type[OrcheGroupParams][source]#

Return the class object that was imported within method.

Returns:

Class object that was imported within method.