Framework for Python

Workflow

spec_resolve()

Merge layers over Python's package defaults into one complete project spec.

The project type comes from the last layer that sets type (default "project"). It is a label: Framework's five structures have package defaults, and any other lowercase id starts like bare with core files. The language from the last layer that sets language (default "r", as in R). This package builds Python projects only, so the language must resolve to "python".

Usage

spec_resolve(
    layers: Sequence[Any] = (),
    name: str = '',
    author: Mapping[str, Any] | None = None,
    check: bool = True,
) -> ResolvedSpec

Arguments

Name Type Default Description
layers Sequence[Any] ()

Layers, bottom to top. Each is a layer in spec shape, or an envelope {kind, key, version, layer} as in a layers file.

name str ''

The project name. It overrides any name in the layers.

author Mapping[str, Any] | None None

Non-empty fields override the layers' author.

check bool True

Raise SpecError when the result is invalid.