from pydantic import field_validator, Field
from pydantic_settings import BaseSettings, SettingsConfigDict
[docs]
class AutoModuleSettings(BaseSettings):
"""Document your project settings very conveniently. Applies like wise
to pydantic models.
"""
field_without_default: str
"""Shows the *[Required]* marker in the signature."""
field_plain_with_validator: int = 100
"""Show standard field with type annotation."""
field_with_validator_and_alias: str = Field('FooBar', alias='BarFoo')
"""Shows corresponding validator with link/anchor."""
field_with_constraints_and_description: int = Field(
default=5, ge=0, le=100, description='Shows constraints within doc string.'
)
[docs]
@field_validator('field_with_validator_and_alias', 'field_plain_with_validator')
def check_max_length_ten(cls, v):
"""Show corresponding field with link/anchor."""
if len(v) >= 10:
raise ValueError('No more than 10 characters allowed')
return v
model_config = SettingsConfigDict(env_prefix='foo_', frozen=False)