Skip to content

Models

Overview

The models module standardizes data structures with base entities, DTOs, errors, and types, ensuring consistency across the application.

Data Transfer Objects (DTOs)

Note: For practical examples of using DTOs with utilities, see the Utils Examples.

Base DTOs

Documentation for archipy.models.dtos.base_dtos. Includes all members, undocumented members, and shows inheritance.

Email DTOs

Documentation for archipy.models.dtos.email_dtos. Includes all members, undocumented members, and shows inheritance.

Error DTO

Documentation for archipy.models.dtos.error_dto. Includes all members, undocumented members, and shows inheritance.

Pagination DTO

Documentation for archipy.models.dtos.pagination_dto. Includes all members, undocumented members, and shows inheritance.

Range DTOs

Documentation for archipy.models.dtos.range_dtos. Includes all members, undocumented members, and shows inheritance.

Search Input DTO

Documentation for archipy.models.dtos.search_input_dto. Includes all members, undocumented members, and shows inheritance.

Sort DTO

Documentation for archipy.models.dtos.sort_dto. Includes all members, undocumented members, and shows inheritance.

Entities

SQLAlchemy Base Entities

Documentation for archipy.models.entities.sqlalchemy.base_entities. Includes all members, undocumented members, and shows inheritance.

Errors

Custom Errors

Documentation for archipy.models.errors.custom_errors. Includes all members, undocumented members, and shows inheritance.

Types

Base Types

Documentation for archipy.models.types.base_types. Includes all members, undocumented members, and shows inheritance.

Email Types

Documentation for archipy.models.types.email_types. Includes all members, undocumented members, and shows inheritance.

Exception Message Types

Documentation for archipy.models.types.exception_message_types. Includes all members, undocumented members, and shows inheritance.

Language Type

Documentation for archipy.models.types.language_type. Includes all members, undocumented members, and shows inheritance.

Sort Order Type

Documentation for archipy.models.types.sort_order_type. Includes all members, undocumented members, and shows inheritance.

Key Classes

BaseDTO

Class: archipy.models.dtos.base_dtos.BaseDTO Includes all members, undocumented members, and shows inheritance.

BaseEntity

Class: archipy.models.entities.sqlalchemy.base_entities.BaseEntity Includes all members, undocumented members, and shows inheritance.

BaseError

Class: archipy.models.errors.custom_errors.BaseError Includes all members, undocumented members, and shows inheritance.