e3_build_tools.module

Core objects for interfacing e3 modules.

Attributes

logger

Classes

ModuleSource	Class for e3 modules.
EPICSBaseSource	Class for e3 base.
RequireSource	Class for e3 require.

Module Contents

e3_build_tools.module.logger

class e3_build_tools.module.ModuleSource(name: str, *, versions: List[str], dependencies: List[str] | None = None)

Class for e3 modules.

install_config_file = 'configure/RELEASE'

install_config_var = 'EPICS_BASE'

version_config_file = 'configure/CONFIG_MODULE'

version_config_var = 'E3_MODULE_VERSION'

validate_build_number = True

name

versions: Dict[str, Dict]

dependencies

targets = ['init', 'clean', 'patch', 'build', 'install']

property project: gitlab.v4.objects.Project

Return the module’s remote repository.

property repo: git.Repo

Return the module’s local repository.

__str__() → str

Return the module’s name.

__repr__() → str

Return serialized object.

remove_version(version: str) → Dict[str, Dict]

Remove version.

fetch_remote_data(registry: e3_build_tools.git.registry.WrapperRegistry) → None

Fetch all of the module’s config data.

Raises:

FetchDataException: If data was not fetched.

set_config_data(config_content: Dict[str, str], version: str) → None

Write config data for the specified version.

update_deps(ref: str) → None

Extract dependencies from parsed config data.

Updates the set of dependencies from the configuration data.

class e3_build_tools.module.EPICSBaseSource(*, version: str)

Bases: ModuleSource

Class for e3 base.

install_config_file = 'configure/CONFIG_BASE'

install_config_var = 'E3_EPICS_PATH'

version_config_file = 'configure/CONFIG_BASE'

version_config_var = 'E3_BASE_VERSION'

validate_build_number = False

property version: str | None

Return version.

__repr__() → str

Return serialised object.

class e3_build_tools.module.RequireSource(*, version: str)

Bases: ModuleSource

Class for e3 require.

version_config_file = 'configure/RELEASE'

version_config_var = 'E3_REQUIRE_VERSION'

validate_build_number = False

property version: str | None

Return version.

__repr__() → str

Return serialised object.