module settings

arx.settings

Source: packages/arx/src/arx/settings.py:1

Parse and validate .arxproject.toml project settings.

Classes

ArxProject — Full parsed ``.arxproject.toml`` document.
ArxProjectError — Raised when ``.arxproject.toml`` cannot be loaded or validated.
Arxpm — Legacy placeholder for the removed ``[arxpm]`` section.
ArxpmDependencyGroup — Legacy placeholder for removed ``[arxpm.*]`` sections.
Author — One author entry declared in ``[project].authors``.
Build — Parsed build section of .arxproject.toml.
BuildSystem — Parsed build-system section of .arxproject.toml.
DependencyGroupInclude — Include one named dependency group inside another group.
Environment — Parsed environment section of .arxproject.toml.
Project — Parsed project section of .arxproject.toml.
Tests — Parsed tests section of .arxproject.toml.

Functions

_append_build — Append the canonical ``[build]`` section when present.
_append_build_system — Append the canonical ``[build-system]`` section when needed.
_append_dependency_group_array — Append one dependency-group entry array to TOML output.
_append_dependency_groups — Append the canonical ``[dependency-groups]`` section.
_append_environment — Append the canonical ``[environment]`` section when present.
_append_project — Append the canonical ``[project]`` section.
_append_string_array — Append a canonical multiline string array to TOML output.
_append_tests — Append the canonical ``[tests]`` section when present.
_author_to_mapping — Convert one Author dataclass into a TOML-safe mapping.
_build_arx_project — Build the ArxProject dataclass from its validated mapping.
_build_author — Build one Author dataclass from its validated mapping.
_build_build_system — Build the BuildSystem dataclass with effective defaults.
_build_dependency_group_entry — Build one dependency-group entry from validated manifest data.
_build_dependency_groups — Build dependency groups from their validated mapping.
_build_project — Build the Project dataclass from its validated mapping.
_build_tests — Build the Tests dataclass from its validated mapping.
_default_build_system_dependency — Build the default Arx compiler dependency requirement.
_dependency_group_includes — Collect included group names from raw dependency-group entries.
_dependency_group_name_mapping — Map normalized dependency-group names to their declared names.
_detect_dependency_group_cycles — Reject dependency-group include cycles.
_format_toml_string — Quote one TOML basic string with JSON-compatible escapes.
_has_arxlang_dependency — Return whether dependencies already include ``arxlang``.
_normalize_build_system_dependencies — Ensure build-system dependencies include the Arx compiler package.
_normalize_dependency_group_name — Normalize one dependency-group name for semantic comparison.
_reject_arxpm_sections — Reject removed ``[arxpm]`` manifest sections with a clear error.
_reject_legacy_environment_kind — Reject removed environment kinds with a migration hint.
_reject_toolchain_sections — Reject removed ``[toolchain]`` manifest sections.
_requirement_name — Parse and return one requirement distribution name.
_resolved_src_dir — Resolve the effective source directory for one project.
_schema — Load and cache the ``.arxproject.toml`` JSON schema.
_settings_to_data — Convert settings dataclasses into raw manifest data.
_validate_build_system — Validate build-system-only settings after schema validation.
_validate_build_system_dependency — Validate one installable build-system dependency requirement.
_validate_data — Validate parsed ``.arxproject.toml`` data before building models.
_validate_dependency — Validate one dependency entry from ``.arxproject.toml``.
_validate_dependency_group_name — Validate one dependency-group name.
_validate_dependency_groups — Validate dependency-group rules after schema validation.
_validate_environment — Validate environment-only settings rules after schema validation.
_validate_project — Validate project-only settings rules after schema validation.
_validate_requires_arx — Validate a ``project.requires-arx`` version specifier.
dump_settings — Serialize settings into canonical ``.arxproject.toml`` text.
find_config_file — Walk upward from ``start`` to locate ``.arxproject.toml``.
load_settings — Load and validate ``.arxproject.toml`` into a typed dataclass.
load_settings_from_text — Parse and validate one ``.arxproject.toml`` string.
resolve_source_root — Resolve the effective source root from manifest defaults.
write_settings — Write canonical ``.arxproject.toml`` text to disk.

module settings

Classes

Functions

Attributes

Search documentation