Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# `validate_pyproject.types`

validate_pyproject.types.FormatValidationFn

  Should return `True` when the input string satisfies the format

  alias of `Callable`[[`str`], `bool`]

validate_pyproject.types.Plugin

  A plugin is something that receives the name of a tool sub-table (as defined in PEPPEP621) and returns a `Schema`.

  For example `plugin("setuptools")` should return the JSON schema for the `[tool.setuptools]` table of a `pyproject.toml` file.

  alias of `Callable`[[`str`], `Schema`]

class validate_pyproject.types.Schema

  JSON Schema represented as a Python dict

  alias of `Mapping`

validate_pyproject.types.ValidationFn

  Custom validation function. It should receive as input a mapping corresponding to the whole `pyproject.toml` file and raise a `fastjsonschema.JsonSchemaValueException` if it is not valid.

  alias of `Callable`[[`T`], `T`]