Benutzerdefinierte Datentypen und Einstellungen
Definieren Sie benutzerdefinierte Pydantic-Datentypen und verwalten Sie Anwendungseinstellungen mit Pydantics `BaseSettings`.
Benutzerdefinierte Datentypen und Einstellungen ist eine kostenlose FastAPI Backend Development Bootcamp-Lektion auf CoddyKit. Dies ist Lektion 2 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des FastAPI Backend Development Bootcamp-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der FastAPI Backend Development Bootcamp-Kurs umfasst insgesamt 4 Lektionen.
Teile dieser Lektion wurden noch nicht übersetzt und werden auf Englisch angezeigt.
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
.envfiles- 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:
- Environment variables (highest priority)
.envfile variables- Default values defined in the
BaseSettingsclass (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!
Häufig gestellte Fragen
Ist die Lektion „Benutzerdefinierte Datentypen und Einstellungen“ kostenlos?
Ja — der vollständige Text von „Benutzerdefinierte Datentypen und Einstellungen“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des FastAPI Backend Development Bootcamp-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der FastAPI Backend Development Bootcamp-Kurs umfasst insgesamt 4 Lektionen.
Was lerne ich in „Benutzerdefinierte Datentypen und Einstellungen“?
Definieren Sie benutzerdefinierte Pydantic-Datentypen und verwalten Sie Anwendungseinstellungen mit Pydantics `BaseSettings`. Du übst FastAPI Backend Development Bootcamp mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.
Brauche ich Erfahrung, um FastAPI Backend Development Bootcamp zu starten?
Keine Vorkenntnisse erforderlich. FastAPI Backend Development Bootcamp auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 2 von 4.
Wie lange dauert die Lektion „Benutzerdefinierte Datentypen und Einstellungen“?
Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.
Kann ich in dieser FastAPI Backend Development Bootcamp-Lektion Code schreiben und ausführen?
Ja. Jede FastAPI Backend Development Bootcamp-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.
Alle Lektionen in diesem Kurs
- Pydantic-Feldvalidierung und Validatoren
- Benutzerdefinierte Datentypen und Einstellungen
- Verschachtelte Modelle und rekursive Strukturen
- Serialisierung mit model_dump und Aliases