Defines base models for Pydantic that enforce strict validation rules to ensure data integrity and consistency when interacting with APIs.

The NoExtraFieldsBaseModel class is designed to prevent the inclusion of extra fields during model instantiation. This is crucial for avoiding issues where changes in the API could lead to unknown or unexpected data being accepted by the models. By forbidding extra fields, we ensure that only explicitly defined attributes are allowed, which helps maintain the integrity of the data being processed and reduces the risk of errors due to unexpected input.

The HeadersModel class extends NoExtraFieldsBaseModel and is specifically tailored for HTTP headers. By setting populate_by_name=True and by_alias=True, we ensure that the header names match the exact HTTP header names required by the API. This configuration allows for more flexible handling of header names, ensuring that they are correctly mapped to the expected HTTP header names, thus preventing potential issues when making requests.

Classes

class BaseRequestModel (**data: Any)

A base model that forbids extra fields during instantiation.

This class extends Pydantic's BaseModel and configures it to raise validation errors when extra fields are provided during object creation. This helps ensure that only explicitly defined fields are allowed in model instances.

Attributes

model_config : ConfigDict

Configuration dictionary for the model, set to forbid extra fields.

Example

class User(NoExtraFieldsBaseModel): name: str age: int

This will work:

user = User(name="Alice", age=30)

This will raise a validation error:

user = User(name="Bob", age=25, extra_field="Not allowed")

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.

Expand source code

class BaseRequestModel(BaseModel):
    """
    A base model that forbids extra fields during instantiation.

    This class extends Pydantic's BaseModel and configures it to raise
    validation errors when extra fields are provided during object creation.
    This helps ensure that only explicitly defined fields are allowed in
    model instances.

    Attributes:
        model_config (ConfigDict): Configuration dictionary for the model,
            set to forbid extra fields.

    Example:
        class User(NoExtraFieldsBaseModel):
            name: str
            age: int

        # This will work:
        user = User(name="Alice", age=30)

        # This will raise a validation error:
        # user = User(name="Bob", age=25, extra_field="Not allowed")
    """

    model_config: ConfigDict = ConfigDict(extra="forbid")

    class HeadersModel(AuthorizationHeaderModel):
        """
        Model for request headers specific to user data requests.

        Attributes:
            content_type (str): The content type of the request, defaulting to "application/json".
        """

        model_config: ConfigDict = ConfigDict(populate_by_name=True)
        content_type: str = Field(default="application/json", alias="Content-Type")

Ancestors

• pydantic.main.BaseModel

Subclasses

• ResponseErrorModel
• InfoRequestModel
• ResponseDataModel
• APIEndpoints
• BaseUserInfoRequestModel
• VideoCommentRequestModel
• VideoQueryRequestModel

Class variables

var HeadersModel

Model for request headers specific to user data requests.

Attributes

content_type : str

The content type of the request, defaulting to "application/json".

var model_config : pydantic.config.ConfigDict

class ResponseErrorModel (**data: Any)

Model for error information in the API response.

Attributes

code : str

Error code.

message : str

Error message.

log_id : str

Log identifier for the error.

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.

Expand source code

class ResponseErrorModel(BaseRequestModel):
    """
    Model for error information in the API response.

    Attributes:
        code (str): Error code.
        message (str): Error message.
        log_id (str): Log identifier for the error.
    """

    code: str | None = Field(default=None)
    message: str | None = Field(default=None)
    log_id: str | None = Field(default=None)

Ancestors

• BaseRequestModel
• pydantic.main.BaseModel

Class variables

var code : str | None

var log_id : str | None

var message : str | None

var model_config : pydantic.config.ConfigDict

Inherited members

• BaseRequestModel:
  • HeadersModel