API reference
python:arxpy:arxpy
module arxpy
arxpy
Source: packages/arxpy/src/arxpy/__init__.py:1
Top-level package for ArxPy.
Modules
-
compiler — Typed programmatic facade for the Arx compiler pipeline.
-
diagnostics — Structured diagnostic records for the ArxPy public API.
-
errors — Public exception hierarchy for the ArxPy API.
-
typecheck — Runtime type-checking helpers for ArxPy.
Classes
-
ArtifactKind — Kind of output requested from the compiler.
-
ArxError — Base class for every error raised by the ArxPy API.
-
CheckedProgram — Program that completed semantic analysis successfully.
-
CompilationArtifact — Materialized compiler output.
-
CompileError — Raised when semantic analysis, lowering, native compile, or linking fails.
-
Compiler — Reusable facade for parse, check, compile, and run operations.
-
Diagnostic — One structured diagnostic exposed by the ArxPy API.
-
DiagnosticSeverity — Severity level of a diagnostic.
-
ExecutionError — Raised when running a compiled Arx program fails to execute.
-
ExecutionResult — Captured result of running an executable artifact.
-
ParseError — Raised when lexing or parsing Arx source fails.
-
ParsedProgram — Parsed Arx source plus stable source attribution.
Functions
- get_version — Return the program version.