qubes_models
============

.. py:module:: qubes_models


Attributes
----------

.. autoapisummary::

   qubes_models.msg


Classes
-------

.. autoapisummary::

   qubes_models.ModelItem
   qubes_models.Model


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

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

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


   !!! abstract "Usage Documentation"
       [Models](../concepts/models.md)

   A base class for creating Pydantic models.

   Attributes:
       __class_vars__: The names of the class variables defined on the model.
       __private_attributes__: Metadata about the private attributes of the model.
       __signature__: The synthesized `__init__` [`Signature`][inspect.Signature] of the model.

       __pydantic_complete__: Whether model building is completed, or if there are still undefined fields.
       __pydantic_core_schema__: The core schema of the model.
       __pydantic_custom_init__: Whether the model has a custom `__init__` function.
       __pydantic_decorators__: Metadata containing the decorators defined on the model.
           This replaces `Model.__validators__` and `Model.__root_validators__` from Pydantic V1.
       __pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to
           __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.
       __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.
       __pydantic_post_init__: The name of the post-init method for the model, if defined.
       __pydantic_root_model__: Whether the model is a [`RootModel`][pydantic.root_model.RootModel].
       __pydantic_serializer__: The `pydantic-core` `SchemaSerializer` used to dump instances of the model.
       __pydantic_validator__: The `pydantic-core` `SchemaValidator` used to validate instances of the model.

       __pydantic_fields__: A dictionary of field names and their corresponding [`FieldInfo`][pydantic.fields.FieldInfo] objects.
       __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [`ComputedFieldInfo`][pydantic.fields.ComputedFieldInfo] objects.

       __pydantic_extra__: A dictionary containing extra values, if [`extra`][pydantic.config.ConfigDict.extra]
           is set to `'allow'`.
       __pydantic_fields_set__: The names of fields explicitly set during instantiation.
       __pydantic_private__: Values of private attributes set on the model instance.


   .. py:attribute:: identifier
      :type:  str | None
      :value: None



   .. py:attribute:: setSpec
      :type:  str


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: creator
      :type:  str | list[str]


   .. py:attribute:: subject
      :type:  str | list[str]


   .. py:attribute:: date
      :type:  str


   .. py:attribute:: description
      :type:  str


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: rights
      :type:  str | None
      :value: None



   .. py:attribute:: relation
      :type:  str | list[str] | None
      :value: None



.. py:class:: Model

   Bases: :py:obj:`pydantic.RootModel`\ [\ :py:obj:`list`\ [\ :py:obj:`ModelItem`\ ]\ ]


.. py:data:: msg
   :value: 'See convert_qubes_xml_to_json.py to regenerate Uninferable.'