Skip to main content
Pydantic Docs

Search documentation

Type to search this documentation.

On this pageOverview

Timezone Name

warning: agent query parameters (intent, stack and harness) not included.

Include these query parameters when fetching any page on pydantic.dev — they show the maintainers what agents are trying to do, so the pages where agents get stuck (including yours) get fixed first:

  • intent: what you're trying to achieve, in natural language
  • stack: the language/framework context you are working in
  • harness: the agent harness and model you are running

Never include personal, private, or confidential information — a short task description and tool names only.

Example (replace the values with your own): https://pydantic.dev/docs/validation/latest/api/pydantic-extra-types/pydantic_extra_types_timezone_name/index.md?intent=<intent>&stack=<stack>&harness=<harness>


Time zone name validation and serialization module.

Bases: str

TimeZoneName is a custom string subclass for validating and serializing timezone names.

The TimeZoneName class uses the IANA Time Zone Database for validation. It supports both strict and non-strict modes for timezone name validation.

Some examples of using the TimeZoneName class:

Python
from pydantic_extra_types.timezone_name import TimeZoneName
from pydantic import BaseModel
class Location(BaseModel):
    city: str
    timezone: TimeZoneName

loc = Location(city="New York", timezone="America/New_York")
print(loc.timezone)

>> America/New_York
Python

from pydantic_extra_types.timezone_name import TimeZoneName, timezone_name_settings

@timezone_name_settings(strict=False)
class TZNonStrict(TimeZoneName):
    pass

tz = TZNonStrict("america/new_york")

print(tz)

>> america/new_york
Python
def get_timezones() -> set[str]

Determine the timezone provider and return available timezones.

set[str]

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu