0Pricing
FastAPI Backend Development Bootcamp · Урок

Пользовательские типы данных и настройки

Определяйте пользовательские типы данных Pydantic и управляйте настройками приложения с помощью `BaseSettings` Pydantic.

«Пользовательские типы данных и настройки» — бесплатный урок FastAPI Backend Development Bootcamp на CoddyKit. Это урок 2 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения FastAPI Backend Development Bootcamp, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс FastAPI Backend Development Bootcamp содержит 4 уроков всего.

Части этого урока еще не переведены и отображаются на английском.

Welcome to Custom Types!

Pydantic is great for validating data, but sometimes you need validation beyond its built-in types.

  • Custom Data Types let you define your own rules for data.
  • This ensures your data adheres to specific formats or business logic.
  • Think of it as extending Pydantic's power for unique needs.

`Annotated` for Custom Validation

Pydantic v2 uses Python's typing.Annotated alongside validator functions to create custom types.

  • Annotated: Adds metadata to a type hint.
  • BeforeValidator: Runs a function before Pydantic's standard validation.
  • This allows you to transform or validate input data before it's assigned.

Crafting a `CapitalizedString`

Let's create a custom type called CapitalizedString that ensures the first letter of a string is always uppercase.

Our validator function will check this rule. If the string isn't capitalized, it will raise an error.

Using Your Custom Type

Here's how to define and use our new CapitalizedString type in a Pydantic model. Try changing the name to start with a lowercase letter to see the validation error!

from typing import Annotated
from pydantic import BaseModel, BeforeValidator, ValidationError

def validate_capitalized(v: str) -> str:
    if not isinstance(v, str):
        raise TypeError("String required")
    if v and not v[0].isupper():
        raise ValueError("Must start with uppercase")
    return v

CapitalizedString = Annotated[str, BeforeValidator(validate_capitalized)]

class Product(BaseModel):
    name: CapitalizedString
    price: float

if __name__ == "__main__":
    try:
        product1 = Product(name="Laptop", price=1200.50)
        print(f"Product: {product1.name}")

        # This will raise a ValidationError
        # product2 = Product(name="keyboard", price=75.00)
    except ValidationError as e:
        print(f"Validation Error: {e}")

Manage Settings with `BaseSettings`

Application settings (like database URLs, API keys) often change between development and production environments.

BaseSettings, from pydantic-settings, is designed to manage these configurations easily. It automatically loads settings from:

  • Environment variables
  • .env files
  • Default values

Default Settings in Action

Define your settings as attributes in a class inheriting from BaseSettings. Pydantic handles the rest, providing default values if nothing else is specified.

from pydantic_settings import BaseSettings

class AppConfig(BaseSettings):
    app_name: str = "My FastAPI App"
    debug_mode: bool = False
    version: str = "1.0.0"

if __name__ == "__main__":
    settings = AppConfig()
    print(f"App Name: {settings.app_name}")
    print(f"Debug Mode: {settings.debug_mode}")
    print(f"Version: {settings.version}")

Loading from Environment Variables

BaseSettings automatically looks for environment variables that match your setting names (case-insensitive).

In this example, we temporarily set an environment variable to demonstrate how Pydantic picks it up, overriding the default.

import os
from pydantic_settings import BaseSettings

class AppConfig(BaseSettings):
    app_name: str = "Default App"
    database_url: str = "sqlite:///./test.db"

if __name__ == "__main__":
    print("--- Without env var ---")
    settings_default = AppConfig()
    print(f"App Name: {settings_default.app_name}")

    # Simulate setting an environment variable
    os.environ["APP_NAME"] = "Production App"
    os.environ["DATABASE_URL"] = "postgresql://user:pass@host:5432/db"

    print("\n--- With env var ---")
    settings_env = AppConfig()
    print(f"App Name: {settings_env.app_name}")
    print(f"DB URL: {settings_env.database_url}")

    # Clean up the environment variable for subsequent runs
    del os.environ["APP_NAME"]
    del os.environ["DATABASE_URL"]

Leveraging `.env` Files

For local development, it's common to store settings in a .env file (e.g., .env) in your project root.

You can configure BaseSettings to load from this file using SettingsConfigDict(env_file='.env') in your settings class.

Example .env content:
APP_NAME="Dev App"
API_KEY="your_dev_api_key"

from pydantic_settings import BaseSettings, SettingsConfigDict

class ProjectSettings(BaseSettings):
    model_config = SettingsConfigDict(env_file='.env', extra='ignore')

    app_name: str = "Default Project"
    api_key: str = "default_key"

# To make this runnable, you would need python-dotenv installed
# and an actual .env file in the same directory as the script.
# For this lesson, we show the setup.

# Example usage (if .env existed and python-dotenv was active):
# if __name__ == "__main__":
#     settings = ProjectSettings()
#     print(f"App Name: {settings.app_name}")
#     print(f"API Key: {settings.api_key}")

Understanding Settings Priority

When BaseSettings looks for a value, it follows a specific order of precedence:

  1. Environment variables (highest priority)
  2. .env file variables
  3. Default values defined in the BaseSettings class (lowest priority)

This ensures that environment variables can always override local .env files and class defaults, which is crucial for deployment.

Test Your Knowledge!

Which of the following are true about Pydantic's BaseSettings and custom types?

Recap: Custom Types & Settings

Great job! You've learned how to create powerful custom data types with Annotated and BeforeValidator, extending Pydantic's validation.

You also mastered BaseSettings for robust application configuration, understanding how it loads values from defaults, .env files, and environment variables with clear priority rules.

These tools are essential for building flexible and maintainable FastAPI applications!

Часто задаваемые вопросы

Урок «Пользовательские типы данных и настройки» бесплатный?

Да — полный текст урока «Пользовательские типы данных и настройки» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс FastAPI Backend Development Bootcamp, подпишись на CoddyKit PRO. Курс FastAPI Backend Development Bootcamp содержит 4 уроков всего.

Чему я научусь в уроке «Пользовательские типы данных и настройки»?

Определяйте пользовательские типы данных Pydantic и управляйте настройками приложения с помощью `BaseSettings` Pydantic. Ты практикуешь FastAPI Backend Development Bootcamp с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.

Нужен ли мне опыт, чтобы начать FastAPI Backend Development Bootcamp?

Предыдущий опыт не требуется. FastAPI Backend Development Bootcamp на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 2 из 4.

Сколько времени занимает урок «Пользовательские типы данных и настройки»?

Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.

Можно ли писать и запускать код в этом уроке FastAPI Backend Development Bootcamp?

Да. Каждый урок FastAPI Backend Development Bootcamp включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.

Все уроки этого курса

  1. Проверка полей Pydantic и валидаторы
  2. Пользовательские типы данных и настройки
  3. Вложенные модели и рекурсивные структуры
  4. Сериализация с model_dump и псевдонимами
← Назад к FastAPI Backend Development Bootcamp