prelinger.prelinger_models¶
Attributes¶
Classes¶
Represents a single video item from the Prelinger Archives at the Internet Archive. |
|
Full response envelope returned by |
|
!!! abstract "Usage Documentation" |
|
Response from the Internet Archive advanced-search API used to discover |
|
A list of PrelingerItem objects, used for JSON serialisation of bulk imports. |
Functions¶
|
Normalize a string or list value to a flat list of strings. |
Module Contents¶
- prelinger.prelinger_models._coerce_to_list(item: str | list[str]) list[str]¶
Normalize a string or list value to a flat list of strings.
- class prelinger.prelinger_models.PrelingerItem(/, **data: Any)¶
Bases:
pydantic.BaseModelRepresents a single video item from the Prelinger Archives at the Internet Archive.
Fields map directly to the
metadataobject returned by the md-read API:GET https://archive.org/metadata/{identifier}Also used as the document type within
PrelingerSearchResponseInner.docssince the Advanced Search API returns the same fields.- identifier: str = ''¶
- title: str = ''¶
- description: str = ''¶
- creator: list[str] = None¶
- subject: list[str] = None¶
- date: str = ''¶
- licenseurl: str = ''¶
- mediatype: str = ''¶
- classmethod coerce_to_list(item: str | list[str]) list[str]¶
Normalize string values to a list of strings.
- class prelinger.prelinger_models.PrelingerMetadataResponse(/, **data: Any)¶
Bases:
pydantic.BaseModelFull response envelope returned by
GET https://archive.org/metadata/{identifier}.- metadata: PrelingerItem¶
- class prelinger.prelinger_models.PrelingerSearchResponseInner(/, **data: Any)¶
Bases:
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.
- model_config¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- num_found: int = None¶
- start: int = 0¶
- docs: list[PrelingerItem] = None¶
- class prelinger.prelinger_models.PrelingerSearchResponse(/, **data: Any)¶
Bases:
pydantic.BaseModelResponse from the Internet Archive advanced-search API used to discover Prelinger videos:
GET https://archive.org/advancedsearch.php?q=collection:prelinger+...&output=json- response: PrelingerSearchResponseInner¶
- class prelinger.prelinger_models.PrelingerModel¶
Bases:
pydantic.RootModel[list[PrelingerItem]]A list of PrelingerItem objects, used for JSON serialisation of bulk imports.
- prelinger.prelinger_models.here¶