Skip to content
Back to top
View this page

# Module Reference

The public API of `validate-pyproject` is exposed in the `validate_pyproject.api` module. Users may also import `validate_pyproject.errors` and `validate_pyproject.types` when handling exceptions or specifying type hints.

In addition to that, special formats that can be used in the JSON Schema definitions are implemented in `validate_pyproject.formats`.

- `validate_pyproject.api`
  - `Validator`
- `validate_pyproject.errors`
  - `InvalidSchemaVersion`
  - `SchemaMissingId`
  - `SchemaWithDuplicatedId`
  - `ValidationError`
- `validate_pyproject.types`
  - `FormatValidationFn`
  - `Plugin`
  - `Schema`
  - `ValidationFn`
- `validate_pyproject.formats`
  - `SPDX()`
  - `import_name()`
  - `int()`
  - `int16()`
  - `int32()`
  - `int64()`
  - `int8()`
  - `pep440()`
  - `pep508()`
  - `pep508_identifier()`
  - `pep508_versionspec()`
  - `pep517_backend_reference()`
  - `pep561_stub_name()`
  - `python_entrypoint_group()`
  - `python_entrypoint_name()`
  - `python_entrypoint_reference()`
  - `python_identifier()`
  - `python_module_name()`
  - `python_module_name_relaxed()`
  - `python_qualified_identifier()`
  - `uint()`
  - `uint16()`
  - `uint32()`
  - `uint64()`
  - `uint8()`
  - `url()`