prelinger.prelinger_models
==========================

.. py:module:: prelinger.prelinger_models


Attributes
----------

.. autoapisummary::

   prelinger.prelinger_models.here


Classes
-------

.. autoapisummary::

   prelinger.prelinger_models.PrelingerItem
   prelinger.prelinger_models.PrelingerMetadataResponse
   prelinger.prelinger_models.PrelingerSearchResponseInner
   prelinger.prelinger_models.PrelingerSearchResponse
   prelinger.prelinger_models.PrelingerModel


Functions
---------

.. autoapisummary::

   prelinger.prelinger_models._coerce_to_list


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

.. py:function:: _coerce_to_list(item: str | list[str]) -> list[str]

   Normalize a string or list value to a flat list of strings.


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

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


   Represents a single video item from the Prelinger Archives at the Internet Archive.

   Fields map directly to the ``metadata`` object returned by the md-read API:
   ``GET https://archive.org/metadata/{identifier}``

   Also used as the document type within ``PrelingerSearchResponseInner.docs`` since
   the Advanced Search API returns the same fields.


   .. py:attribute:: identifier
      :type:  str
      :value: ''



   .. py:attribute:: title
      :type:  str
      :value: ''



   .. py:attribute:: description
      :type:  str
      :value: ''



   .. py:attribute:: creator
      :type:  list[str]
      :value: None



   .. py:attribute:: subject
      :type:  list[str]
      :value: None



   .. py:attribute:: date
      :type:  str
      :value: ''



   .. py:attribute:: licenseurl
      :type:  str
      :value: ''



   .. py:attribute:: mediatype
      :type:  str
      :value: ''



   .. py:method:: coerce_to_list(item: str | list[str]) -> list[str]
      :classmethod:


      Normalize string values to a list of strings.



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

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


   Full response envelope returned by ``GET https://archive.org/metadata/{identifier}``.


   .. py:attribute:: metadata
      :type:  PrelingerItem


.. py:class:: PrelingerSearchResponseInner(/, **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__: A dictionary containing metadata about generic Pydantic models.
           The `origin` and `args` items map to the [`__origin__`][genericalias.__origin__]
           and [`__args__`][genericalias.__args__] attributes of [generic aliases][types-genericalias],
           and the `parameter` item maps to the `__parameter__` attribute of generic classes.
       __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:: model_config

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



   .. py:attribute:: num_found
      :type:  int
      :value: None



   .. py:attribute:: start
      :type:  int
      :value: 0



   .. py:attribute:: docs
      :type:  list[PrelingerItem]
      :value: None



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

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


   Response from the Internet Archive advanced-search API used to discover
   Prelinger videos:
   ``GET https://archive.org/advancedsearch.php?q=collection:prelinger+...&output=json``


   .. py:attribute:: response
      :type:  PrelingerSearchResponseInner


.. py:class:: PrelingerModel

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


   A list of PrelingerItem objects, used for JSON serialisation of bulk imports.


.. py:data:: here