hyrax.config_schemas.base
=========================

.. py:module:: hyrax.config_schemas.base

.. autoapi-nested-parse::

   Base classes for typed Hyrax configuration.

   This module introduces a minimal Pydantic model that future configuration
   schemas will inherit from. It intentionally contains no runtime logic or
   validation rules beyond what the Pydantic `BaseModel` provides by default.



Classes
-------

.. autoapisummary::

   hyrax.config_schemas.base.BaseConfigModel


Module Contents
---------------

.. py:class:: BaseConfigModel(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Base class for future Hyrax configuration schemas.

   Create a new model by parsing and validating input data from keyword arguments.

   Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
   validated to form a valid model.

   `self` is explicitly positional-only to allow `self` as a field name.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].


