yambs.dependency package

Subpackages

• yambs.dependency.handlers package
  • Subpackages
    • yambs.dependency.handlers.yambs package
      • Submodules
      • yambs.dependency.handlers.yambs.config module
      • yambs.dependency.handlers.yambs.github module
      • Module contents
  • Submodules
  • yambs.dependency.handlers.types module
    • DependencyTask
      • DependencyTask.build_commands
      • DependencyTask.compile_flags
      • DependencyTask.current
      • DependencyTask.data
      • DependencyTask.dep
      • DependencyTask.include
      • DependencyTask.link_flags
      • DependencyTask.nested
      • DependencyTask.project_root
      • DependencyTask.root
      • DependencyTask.source_dirs
      • DependencyTask.static
  • Module contents

Submodules

yambs.dependency.config module

A module for working with dependency configurations.

class yambs.dependency.config.Dependency(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)

Bases: YambsDictCodec, BasicDictCodec

A class for describing project dependencies.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None

Initialize this instance.

class yambs.dependency.config.DependencyKind(*values)

Bases: StrEnum

All dependency kind options.

YAMBS = 'yambs'

class yambs.dependency.config.DependencySource(*values)

Bases: StrEnum

All dependency source options.

DIRECTORY = 'directory'

GITHUB = 'github'

yambs.dependency.github module

A module implementing GitHub dependency interactions.

class yambs.dependency.github.GithubDependency(owner: str, repo: str, *args, version: str = 'latest', data: Dict[str, Any] = None, **kwargs)

Bases: LoggerMixin

A class for managing GitHub dependencies.

download_release_assets(filt: Callable[[dict[str, Any]], Path | None], extract: bool = True, strict: bool = True) → None

Ensure release assets are downloaded.

yambs.dependency.github.default_filt(output: Path, pattern: str = '.*', mkdir: bool = True) → Callable[[dict[str, Any]], Path | None]

Create a default release-asset filter method.

yambs.dependency.github.download_file_if_missing(uri: str, dest: Path, timeout: float = 10.0, chunk_size: int = 4096) → None

Download a file if necessary.

yambs.dependency.github.ensure_extracted(path: Path, strict: bool = True, logger: Logger | LoggerAdapter[Any] = None) → None

Ensure that all archive files in a directory are extracted.

yambs.dependency.manager module

A module implementing a dependency manager.

class yambs.dependency.manager.DependencyManager(root: Path, project_root: Path)

Bases: object

A class for managing project dependencies.

audit(dep: Dependency) → DependencyState

Interact with a dependency if needed.

info(logger: Logger | LoggerAdapter[Any]) → None

Log some information.

save(script: Path, logger: Logger | LoggerAdapter[Any] = None) → None

Save state data and create the third-party build script.

yambs.dependency.manager.write_third_party_script(path: Path, commands: List[List[str]] = None) → None

Create a simple shell script normally containing instructions to build third-party commands.

yambs.dependency.state module

A module implementing interfaces for working with dependency states.

class yambs.dependency.state.DependencyState(*values)

Bases: StrEnum

States that a dependency can be in.

INIT = 'init'

Module contents