tempest-fastapi-sdk 0.52.0__tar.gz → 0.53.0__tar.gz

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to **tempest-fastapi-sdk** are listed below.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.53.0] — 2026-06-13
+
+### Added
+
+- **Brazilian states & municipalities dataset** — an offline,
+  dependency-free table of every federative unit and its cities, plus
+  Pydantic building blocks. No network calls, no external API.
+    - **`UF`** — a `StrEnum` with the 27 federative unit acronyms
+      (`UF.SP`, `UF.RJ`, …).
+    - **`Region`** — the five official IBGE macro-regions
+      (`Norte`, `Nordeste`, `Centro-Oeste`, `Sudeste`, `Sul`).
+      Every UF is statically mapped to its region.
+    - **`StateBR`** / **`CityBR`** — schemas for a state (acronym +
+      full name + region + alphabetically sorted municipalities) and a
+      single city (name + UF).
+    - **Query helpers** — `list_states()`, `get_state(uf)`,
+      `cities_by_uf(uf)`, `states_by_region(region)`. The single-UF
+      lookups accept any-case acronyms or a `UF` member.
+    - **Validators/normalizers** — `is_valid_uf` / `normalize_uf`
+      (case- and whitespace-insensitive), `is_valid_city` /
+      `normalize_city` (also accent-insensitive, returning the
+      canonical proper-case name).
+    - **Annotated types** — `UFField` (coerces any-case acronyms to a
+      `UF`) and `CityNameField` (trims a city name) ready to drop into
+      schema fields.
+    - Dataset bundled as `utils/data/br_locations.json` (27 states,
+      5606 entries) and loaded lazily on first access. Municipality
+      names come from the official IBGE list (current spellings,
+      including post-2005 municipalities); the Distrito Federal is
+      represented by its 36 administrative regions rather than a single
+      Brasília row, for address-form use. All symbols are exported at
+      the package top level.
+
 ## [0.52.0] — 2026-06-12
 
 ### Added

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tempest-fastapi-sdk
-Version: 0.52.0
+Version: 0.53.0
 Summary: Shared FastAPI building blocks: base schemas, ORM model, async repository, exceptions, pagination and settings — the conventions used across Tempest projects.
 Project-URL: Homepage, https://github.com/mauriciobenjamin700/tempest-fastapi-sdk
 Project-URL: Repository, https://github.com/mauriciobenjamin700/tempest-fastapi-sdk
@@ -255,7 +255,7 @@ Since `0.7.1` every optional dependency is imported lazily at first instantiatio
 | `tempest_fastapi_sdk.utils.http_client` *(extra: `[http]`)* | `HTTPClient`, `RetryPolicy`, `CircuitOpenError`, `REQUEST_ID_HEADER` — typed httpx wrapper |
 | `tempest_fastapi_sdk.utils.storage_backends` *(extra: `[upload]`)* | `UploadStorage` protocol, `LocalUploadStorage`, `MinIOUploadStorage`, `UploadResult`, `ContentValidator` |
 | `tempest_fastapi_sdk.tasks` *(extra: `[tasks]`)* | `AsyncTaskBrokerManager` (TaskIQ lifecycle wrapper), `AsyncTaskScheduler` (periodic / cron tasks) |
-| `tempest_fastapi_sdk.utils` | `to_utc`, `utcnow`, `modify_dict`, `LogUtils`, `AttemptThrottle`/`ThrottleBackend`/`ThrottleStatus`, `generate_opaque_token`/`hash_opaque_token`/`verify_opaque_token`, `get_client_ip`/`get_client_ip_from_scope`, `PasswordUtils` *(extra: `[auth]`)*, `JWTUtils` *(extra: `[auth]`)*, `TOTPHelper` *(extra: `[mfa]`)*, `EmailUtils` *(extra: `[email]`)*, `UploadUtils`/`sniff_mime` *(extra: `[upload]`)*, `DownloadUtils`/`build_content_disposition` *(no extra)*, `MetricsUtils`/`CPUMetrics`/`MemoryMetrics`/`DiskMetrics`/`GPUMetrics`/`SystemMetrics` *(extra: `[metrics]`)*, BR regex helpers (`CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `CEP`, `is_valid_*`, `normalize_*`, `only_digits`, `*_PATTERN`) |
+| `tempest_fastapi_sdk.utils` | `to_utc`, `utcnow`, `modify_dict`, `LogUtils`, `AttemptThrottle`/`ThrottleBackend`/`ThrottleStatus`, `generate_opaque_token`/`hash_opaque_token`/`verify_opaque_token`, `get_client_ip`/`get_client_ip_from_scope`, `PasswordUtils` *(extra: `[auth]`)*, `JWTUtils` *(extra: `[auth]`)*, `TOTPHelper` *(extra: `[mfa]`)*, `EmailUtils` *(extra: `[email]`)*, `UploadUtils`/`sniff_mime` *(extra: `[upload]`)*, `DownloadUtils`/`build_content_disposition` *(no extra)*, `MetricsUtils`/`CPUMetrics`/`MemoryMetrics`/`DiskMetrics`/`GPUMetrics`/`SystemMetrics` *(extra: `[metrics]`)*, BR regex helpers (`CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `CEP`, `is_valid_*`, `normalize_*`, `only_digits`, `*_PATTERN`), BR states/cities (`UF`, `Region`, `StateBR`, `CityBR`, `UFField`, `CityNameField`, `list_states`, `get_state`, `cities_by_uf`, `states_by_region`, `is_valid_uf`/`normalize_uf`, `is_valid_city`/`normalize_city`) |
 | `tempest_fastapi_sdk.cli` | `tempest` console script — `new <name>` (scaffold layered service), `lint` / `format` / `fmt-check` / `type` / `test` / `check` (run preferred quality gates), `version` / `--version` |
 
 Core primitives are re-exported from `tempest_fastapi_sdk` at the top level — `from tempest_fastapi_sdk import BaseModel, BaseRepository, AppException` always works. The extras-gated managers in `tempest_fastapi_sdk.cache`, `tempest_fastapi_sdk.queue` and `tempest_fastapi_sdk.tasks` must be imported from their own submodule (`from tempest_fastapi_sdk.queue import AsyncBrokerManager`).

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/README.md

@@ -153,7 +153,7 @@ Since `0.7.1` every optional dependency is imported lazily at first instantiatio
 | `tempest_fastapi_sdk.utils.http_client` *(extra: `[http]`)* | `HTTPClient`, `RetryPolicy`, `CircuitOpenError`, `REQUEST_ID_HEADER` — typed httpx wrapper |
 | `tempest_fastapi_sdk.utils.storage_backends` *(extra: `[upload]`)* | `UploadStorage` protocol, `LocalUploadStorage`, `MinIOUploadStorage`, `UploadResult`, `ContentValidator` |
 | `tempest_fastapi_sdk.tasks` *(extra: `[tasks]`)* | `AsyncTaskBrokerManager` (TaskIQ lifecycle wrapper), `AsyncTaskScheduler` (periodic / cron tasks) |
-| `tempest_fastapi_sdk.utils` | `to_utc`, `utcnow`, `modify_dict`, `LogUtils`, `AttemptThrottle`/`ThrottleBackend`/`ThrottleStatus`, `generate_opaque_token`/`hash_opaque_token`/`verify_opaque_token`, `get_client_ip`/`get_client_ip_from_scope`, `PasswordUtils` *(extra: `[auth]`)*, `JWTUtils` *(extra: `[auth]`)*, `TOTPHelper` *(extra: `[mfa]`)*, `EmailUtils` *(extra: `[email]`)*, `UploadUtils`/`sniff_mime` *(extra: `[upload]`)*, `DownloadUtils`/`build_content_disposition` *(no extra)*, `MetricsUtils`/`CPUMetrics`/`MemoryMetrics`/`DiskMetrics`/`GPUMetrics`/`SystemMetrics` *(extra: `[metrics]`)*, BR regex helpers (`CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `CEP`, `is_valid_*`, `normalize_*`, `only_digits`, `*_PATTERN`) |
+| `tempest_fastapi_sdk.utils` | `to_utc`, `utcnow`, `modify_dict`, `LogUtils`, `AttemptThrottle`/`ThrottleBackend`/`ThrottleStatus`, `generate_opaque_token`/`hash_opaque_token`/`verify_opaque_token`, `get_client_ip`/`get_client_ip_from_scope`, `PasswordUtils` *(extra: `[auth]`)*, `JWTUtils` *(extra: `[auth]`)*, `TOTPHelper` *(extra: `[mfa]`)*, `EmailUtils` *(extra: `[email]`)*, `UploadUtils`/`sniff_mime` *(extra: `[upload]`)*, `DownloadUtils`/`build_content_disposition` *(no extra)*, `MetricsUtils`/`CPUMetrics`/`MemoryMetrics`/`DiskMetrics`/`GPUMetrics`/`SystemMetrics` *(extra: `[metrics]`)*, BR regex helpers (`CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `CEP`, `is_valid_*`, `normalize_*`, `only_digits`, `*_PATTERN`), BR states/cities (`UF`, `Region`, `StateBR`, `CityBR`, `UFField`, `CityNameField`, `list_states`, `get_state`, `cities_by_uf`, `states_by_region`, `is_valid_uf`/`normalize_uf`, `is_valid_city`/`normalize_city`) |
 | `tempest_fastapi_sdk.cli` | `tempest` console script — `new <name>` (scaffold layered service), `lint` / `format` / `fmt-check` / `type` / `test` / `check` (run preferred quality gates), `version` / `--version` |
 
 Core primitives are re-exported from `tempest_fastapi_sdk` at the top level — `from tempest_fastapi_sdk import BaseModel, BaseRepository, AppException` always works. The extras-gated managers in `tempest_fastapi_sdk.cache`, `tempest_fastapi_sdk.queue` and `tempest_fastapi_sdk.tasks` must be imported from their own submodule (`from tempest_fastapi_sdk.queue import AsyncBrokerManager`).

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/docs/recipes/br-helpers.en.md

@@ -103,6 +103,98 @@ class AddressCreateSchema(BaseSchema):
 Imperative variants: `is_valid_cep(value)`, `normalize_cep(value)`, plus `CEP_PATTERN` for raw regex use. Use them inside services / queue handlers where you don't want a Pydantic round-trip.
 
 
+## States and municipalities
+
+Every Brazilian app eventually needs a state/city `<select>`, or to validate that the UF and municipality in a payload actually exist. The SDK bundles that table — **27 states and 5606 municipalities** — so you don't have to call the IBGE API or version a JSON per service.
+
+!!! info "Offline and dependency-free"
+    The data lives in `tempest_fastapi_sdk/utils/data/br_locations.json` and is loaded on first use, then cached for the whole process. Zero network, nothing extra to install.
+
+The UF is a `StrEnum`, and every state knows its official IBGE macro-region:
+
+```python
+from tempest_fastapi_sdk import UF, Region, list_states, get_state, states_by_region
+
+
+# All 27 states, ordered by acronym.
+states = list_states()
+print(len(states))  # 27
+
+# A single state (acronym in any case, or a UF member).
+sp = get_state("sp")
+print(sp.uf, sp.name, sp.region)        # UF.SP São Paulo Region.SOUTHEAST
+print(len(sp.cities), sp.cities[:2])    # 645 ['Adamantina', 'Adolfo']
+
+# Grouping by region.
+southeast = states_by_region(Region.SOUTHEAST)
+print([state.uf.value for state in southeast])  # ['ES', 'MG', 'RJ', 'SP']
+```
+
+Each item is a `StateBR` (`uf: UF`, `name: str`, `region: Region`, `cities: list[str]`), ready to return straight from an endpoint.
+
+### Validating UF and city in a schema
+
+`UFField` accepts the acronym in any case (`"sp"`, `" RJ "`) and yields a `UF` member. `CityNameField` only trims whitespace — the cross-field "does this city exist in this UF" check is business logic, so it runs in the service with `is_valid_city` / `normalize_city`:
+
+```python
+from tempest_fastapi_sdk import BaseSchema
+from tempest_fastapi_sdk.utils import UFField, CityNameField
+
+
+class AddressCreateSchema(BaseSchema):
+    uf: UFField
+    city: CityNameField
+    street: str
+    number: str
+```
+
+```python
+from tempest_fastapi_sdk import UF, is_valid_city, normalize_city
+from tempest_fastapi_sdk.exceptions import ValidationException
+
+
+def validate_address(uf: UF, city: str) -> str:
+    """Ensure the city belongs to the UF and return its canonical name.
+
+    Args:
+        uf (UF): The federative unit of the address.
+        city (str): The city name coming from the payload.
+
+    Returns:
+        str: The municipality name in canonical case (e.g. "São Paulo").
+
+    Raises:
+        ValidationException: If the city does not exist in the given UF.
+    """
+    if not is_valid_city(uf, city):
+        raise ValidationException(f"city {city!r} not found in {uf.value}")
+    return normalize_city(uf, city)
+```
+
+!!! tip "City lookup ignores accents and case"
+    `is_valid_city("SP", "sao paulo")` and `normalize_city("rj", "RIO DE JANEIRO")` both work — the comparison strips accents, case and surrounding whitespace. `normalize_city` always returns the canonical proper-case name (`"São Paulo"`, `"Rio de Janeiro"`).
+
+### Imperative variants
+
+| Function | What it does |
+| --- | --- |
+| `is_valid_uf(value)` | `True` when the acronym exists (any case/whitespace). |
+| `normalize_uf(value)` | Returns the `UF`; raises `ValueError` when invalid. |
+| `cities_by_uf(uf)` | Sorted list of the state's municipalities. |
+| `is_valid_city(uf, city)` | `True` when the city belongs to the UF (accent/case-insensitive). |
+| `normalize_city(uf, city)` | Canonical municipality name; raises `ValueError` when unknown. |
+
+!!! note "A states/cities endpoint for the frontend"
+    To populate state and city `<select>`s, return `list_states()` directly (each `StateBR` already carries `cities`), or a lean `GET /states/{uf}/cities` endpoint returning `cities_by_uf(uf)`. Since it's in-memory data, it never touches the database.
+
+#### Recap
+
+- `UF` (StrEnum, 27 acronyms) + `Region` (5 IBGE macro-regions).
+- `StateBR` / `CityBR` for typed responses.
+- `list_states`, `get_state`, `cities_by_uf`, `states_by_region` to query the bundled table.
+- `UFField` / `CityNameField` for schema fields; `is_valid_*` / `normalize_*` for imperative validation in the service.
+
+
 ## Utility helpers (utcnow, to_utc, modify_dict)
 
 
@@ -176,4 +268,5 @@ Every helper has its own recipe — this section is the quick map:
 | `LogUtils` + `configure_logging` | [Structured logging & request IDs recipe](logging.md) |
 | `MetricsUtils` (CPU/memory/disk/GPU) | [System metrics recipe](metrics.md) |
 | `CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `is_valid_*`, `normalize_*`, `only_digits` | [CPF / CNPJ / phone](#cpf-cnpj-phone) |
+| `UF`, `Region`, `StateBR`, `CityBR`, `UFField`, `CityNameField`, `list_states`, `get_state`, `cities_by_uf`, `states_by_region`, `is_valid_uf`, `normalize_uf`, `is_valid_city`, `normalize_city` | [States and municipalities](#states-and-municipalities) |
 

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/docs/recipes/br-helpers.md

@@ -103,6 +103,98 @@ class AddressCreateSchema(BaseSchema):
 Variantes imperativas: `is_valid_cep(value)`, `normalize_cep(value)`, mais `CEP_PATTERN` para uso de regex cru. Use-os dentro de services / handlers de fila onde você não quer um round-trip Pydantic.
 
 
+## Estados e municípios
+
+Toda aplicação brasileira acaba precisando de um `<select>` de estado e cidade, ou de validar que a UF e o município que chegaram no payload existem de verdade. O SDK embute essa tabela — **27 estados e 5606 municípios** — então você não precisa chamar a API do IBGE nem versionar um JSON por serviço.
+
+!!! info "Offline e sem dependências"
+    Os dados moram em `tempest_fastapi_sdk/utils/data/br_locations.json` e são carregados sob demanda na primeira chamada, depois ficam em cache pelo processo todo. Zero rede, zero extra a instalar.
+
+A UF é uma `StrEnum` e cada estado conhece sua macro-região oficial do IBGE:
+
+```python
+from tempest_fastapi_sdk import UF, Region, list_states, get_state, states_by_region
+
+
+# Todos os 27 estados, ordenados pela sigla.
+states = list_states()
+print(len(states))  # 27
+
+# Um estado específico (sigla em qualquer caixa, ou um membro de UF).
+sp = get_state("sp")
+print(sp.uf, sp.name, sp.region)        # UF.SP São Paulo Region.SOUTHEAST
+print(len(sp.cities), sp.cities[:2])    # 645 ['Adamantina', 'Adolfo']
+
+# Agrupando por região.
+sudeste = states_by_region(Region.SOUTHEAST)
+print([state.uf.value for state in sudeste])  # ['ES', 'MG', 'RJ', 'SP']
+```
+
+Cada item é um `StateBR` (`uf: UF`, `name: str`, `region: Region`, `cities: list[str]`), pronto pra retornar direto de um endpoint.
+
+### Validando UF e cidade em um schema
+
+`UFField` aceita a sigla em qualquer caixa (`"sp"`, `" RJ "`) e devolve um membro de `UF`. `CityNameField` só apara espaços — a validação cruzada "esta cidade existe nesta UF" é regra de negócio, então roda no service com `is_valid_city` / `normalize_city`:
+
+```python
+from tempest_fastapi_sdk import BaseSchema
+from tempest_fastapi_sdk.utils import UFField, CityNameField
+
+
+class AddressCreateSchema(BaseSchema):
+    uf: UFField
+    city: CityNameField
+    street: str
+    number: str
+```
+
+```python
+from tempest_fastapi_sdk import UF, is_valid_city, normalize_city
+from tempest_fastapi_sdk.exceptions import ValidationException
+
+
+def validate_address(uf: UF, city: str) -> str:
+    """Garante que a cidade pertence à UF e devolve o nome canônico.
+
+    Args:
+        uf (UF): A unidade federativa do endereço.
+        city (str): O nome da cidade vindo do payload.
+
+    Returns:
+        str: O nome do município em caixa canônica (ex.: "São Paulo").
+
+    Raises:
+        ValidationException: Se a cidade não existe na UF informada.
+    """
+    if not is_valid_city(uf, city):
+        raise ValidationException(f"city {city!r} not found in {uf.value}")
+    return normalize_city(uf, city)
+```
+
+!!! tip "A busca de cidade ignora acentos e caixa"
+    `is_valid_city("SP", "sao paulo")` e `normalize_city("rj", "RIO DE JANEIRO")` funcionam — a comparação derruba acentos, caixa e espaços nas pontas. `normalize_city` sempre devolve o nome canônico em caixa correta (`"São Paulo"`, `"Rio de Janeiro"`).
+
+### Variantes imperativas
+
+| Função | O que faz |
+| --- | --- |
+| `is_valid_uf(value)` | `True` se a sigla existe (qualquer caixa/espaço). |
+| `normalize_uf(value)` | Devolve o `UF`; levanta `ValueError` se inválido. |
+| `cities_by_uf(uf)` | Lista de municípios da UF, ordenada. |
+| `is_valid_city(uf, city)` | `True` se a cidade pertence à UF (ignora acentos/caixa). |
+| `normalize_city(uf, city)` | Nome canônico do município; levanta `ValueError` se não existe. |
+
+!!! note "Endpoint de estados/cidades para o frontend"
+    Para popular `<select>` de estado e cidade, devolva `list_states()` direto (cada `StateBR` já traz `cities`), ou um endpoint enxuto `GET /estados/{uf}/cidades` que retorna `cities_by_uf(uf)`. Como é dado em memória, não precisa tocar o banco.
+
+#### Recapitulando
+
+- `UF` (StrEnum, 27 siglas) + `Region` (5 macro-regiões do IBGE).
+- `StateBR` / `CityBR` para respostas tipadas.
+- `list_states`, `get_state`, `cities_by_uf`, `states_by_region` para consultar a tabela embutida.
+- `UFField` / `CityNameField` para campos de schema; `is_valid_*` / `normalize_*` para validação imperativa no service.
+
+
 ## Helpers utilitários (utcnow, to_utc, modify_dict)
 
 
@@ -176,3 +268,4 @@ Todo helper tem sua própria receita — esta seção é o mapa rápido:
 | `LogUtils` + `configure_logging` | [Receita de logging estruturado & request IDs](logging.md) |
 | `MetricsUtils` (CPU/memória/disco/GPU) | [Receita de métricas do sistema](metrics.md) |
 | `CPF`, `CNPJ`, `CPFOrCNPJ`, `PhoneBR`, `is_valid_*`, `normalize_*`, `only_digits` | [CPF / CNPJ / telefone](#cpf-cnpj-telefone) |
+| `UF`, `Region`, `StateBR`, `CityBR`, `UFField`, `CityNameField`, `list_states`, `get_state`, `cities_by_uf`, `states_by_region`, `is_valid_uf`, `normalize_uf`, `is_valid_city`, `normalize_city` | [Estados e municípios](#estados-e-municipios) |

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/docs/reference.md

@@ -236,3 +236,15 @@ Gerada automaticamente a partir das docstrings do SDK via [`mkdocstrings`](https
 ::: tempest_fastapi_sdk.utils.metrics.MetricsUtils
 ::: tempest_fastapi_sdk.utils.log.LogUtils
 ::: tempest_fastapi_sdk.utils.throttle.AttemptThrottle
+::: tempest_fastapi_sdk.utils.locations.UF
+::: tempest_fastapi_sdk.utils.locations.Region
+::: tempest_fastapi_sdk.utils.locations.StateBR
+::: tempest_fastapi_sdk.utils.locations.CityBR
+::: tempest_fastapi_sdk.utils.locations.list_states
+::: tempest_fastapi_sdk.utils.locations.get_state
+::: tempest_fastapi_sdk.utils.locations.cities_by_uf
+::: tempest_fastapi_sdk.utils.locations.states_by_region
+::: tempest_fastapi_sdk.utils.locations.is_valid_uf
+::: tempest_fastapi_sdk.utils.locations.normalize_uf
+::: tempest_fastapi_sdk.utils.locations.is_valid_city
+::: tempest_fastapi_sdk.utils.locations.normalize_city

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tempest-fastapi-sdk"
-version = "0.52.0"
+version = "0.53.0"
 description = "Shared FastAPI building blocks: base schemas, ORM model, async repository, exceptions, pagination and settings — the conventions used across Tempest projects."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -154,6 +154,7 @@ packages = ["tempest_fastapi_sdk"]
 "tempest_fastapi_sdk/auth/templates/password_reset_form.html" = "tempest_fastapi_sdk/auth/templates/password_reset_form.html"
 "tempest_fastapi_sdk/auth/templates/password_reset_success.html" = "tempest_fastapi_sdk/auth/templates/password_reset_success.html"
 "tempest_fastapi_sdk/auth/templates/password_reset_error.html" = "tempest_fastapi_sdk/auth/templates/password_reset_error.html"
+"tempest_fastapi_sdk/utils/data/br_locations.json" = "tempest_fastapi_sdk/utils/data/br_locations.json"
 
 [dependency-groups]
 dev = [

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/tempest_fastapi_sdk/__init__.py

@@ -193,8 +193,11 @@ from tempest_fastapi_sdk.utils import (
     CPF_PATTERN,
     PHONE_BR_PATTERN,
     REQUEST_ID_HEADER,
+    UF,
     AttemptThrottle,
     CircuitOpenError,
+    CityBR,
+    CityNameField,
     CPFOrCNPJ,
     CPUMetrics,
     DiskMetrics,
@@ -210,32 +213,43 @@ from tempest_fastapi_sdk.utils import (
     MinIOUploadStorage,
     PasswordUtils,
     PhoneBR,
+    Region,
     RetryPolicy,
+    StateBR,
     SystemMetrics,
     ThrottleBackend,
     ThrottleStatus,
     TOTPHelper,
+    UFField,
     UploadResult,
     UploadStorage,
     UploadUtils,
     build_content_disposition,
+    cities_by_uf,
     generate_opaque_token,
     get_client_ip,
     get_client_ip_from_scope,
+    get_state,
     hash_opaque_token,
     is_valid_cep,
+    is_valid_city,
     is_valid_cnpj,
     is_valid_cpf,
     is_valid_cpf_cnpj,
     is_valid_phone_br,
+    is_valid_uf,
+    list_states,
     modify_dict,
     normalize_cep,
+    normalize_city,
     normalize_cnpj,
     normalize_cpf,
     normalize_cpf_cnpj,
     normalize_phone_br,
+    normalize_uf,
     only_digits,
     sniff_mime,
+    states_by_region,
     to_utc,
     utcnow,
     verify_opaque_token,
@@ -255,7 +269,7 @@ from tempest_fastapi_sdk.websockets import (
     make_websocket_router,
 )
 
-__version__: str = "0.52.0"
+__version__: str = "0.53.0"
 
 __all__: list[str] = [
     "BASE_COLUMN_ORDER",
@@ -274,6 +288,7 @@ __all__: list[str] = [
     "NAMING_CONVENTION",
     "PHONE_BR_PATTERN",
     "REQUEST_ID_HEADER",
+    "UF",
     "ActivationResponseSchema",
     "ActivationToken",
     "AdminAuthBackend",
@@ -309,6 +324,8 @@ __all__: list[str] = [
     "CSRFMiddleware",
     "CachedResponse",
     "CircuitOpenError",
+    "CityBR",
+    "CityNameField",
     "ConflictException",
     "CursorPaginationFilterSchema",
     "CursorPaginationSchema",
@@ -377,6 +394,7 @@ __all__: list[str] = [
     "RedisIdempotencyStore",
     "RedisSessionStore",
     "RedisSettings",
+    "Region",
     "RequestIDMiddleware",
     "RetryPolicy",
     "SameSite",
@@ -394,6 +412,7 @@ __all__: list[str] = [
     "SignupSchema",
     "SlowQueryLogger",
     "SoftDeleteMixin",
+    "StateBR",
     "SyncFilterSchema",
     "SyncPaginationSchema",
     "SystemMetrics",
@@ -404,6 +423,7 @@ __all__: list[str] = [
     "ThrottleStatus",
     "TokenSettings",
     "TooManyRequestsException",
+    "UFField",
     "UnauthorizedException",
     "UploadResult",
     "UploadSettings",
@@ -430,6 +450,7 @@ __all__: list[str] = [
     "apply_cors",
     "build_content_disposition",
     "build_pagination_link_header",
+    "cities_by_uf",
     "clear_cookie",
     "clear_request_id",
     "compose_hooks",
@@ -442,12 +463,16 @@ __all__: list[str] = [
     "get_client_ip",
     "get_client_ip_from_scope",
     "get_request_id",
+    "get_state",
     "hash_opaque_token",
     "is_valid_cep",
+    "is_valid_city",
     "is_valid_cnpj",
     "is_valid_cpf",
     "is_valid_cpf_cnpj",
     "is_valid_phone_br",
+    "is_valid_uf",
+    "list_states",
     "make_admin_router",
     "make_app_exception_handler",
     "make_auth_router",
@@ -471,10 +496,12 @@ __all__: list[str] = [
     "make_websocket_router",
     "modify_dict",
     "normalize_cep",
+    "normalize_city",
     "normalize_cnpj",
     "normalize_cpf",
     "normalize_cpf_cnpj",
     "normalize_phone_br",
+    "normalize_uf",
     "only_digits",
     "register_exception_handlers",
     "reorder_base_columns_first",
@@ -489,6 +516,7 @@ __all__: list[str] = [
     "setup_tracing",
     "sniff_mime",
     "sse_response",
+    "states_by_region",
     "to_utc",
     "utcnow",
     "verify_opaque_token",

{tempest_fastapi_sdk-0.52.0 → tempest_fastapi_sdk-0.53.0}/tempest_fastapi_sdk/utils/__init__.py

@@ -28,6 +28,22 @@ from tempest_fastapi_sdk.utils.http_client import (
     RetryPolicy,
 )
 from tempest_fastapi_sdk.utils.jwt import JWTUtils
+from tempest_fastapi_sdk.utils.locations import (
+    UF,
+    CityBR,
+    CityNameField,
+    Region,
+    StateBR,
+    UFField,
+    cities_by_uf,
+    get_state,
+    is_valid_city,
+    is_valid_uf,
+    list_states,
+    normalize_city,
+    normalize_uf,
+    states_by_region,
+)
 from tempest_fastapi_sdk.utils.log import LogUtils
 from tempest_fastapi_sdk.utils.metrics import (
     CPUMetrics,
@@ -90,10 +106,13 @@ __all__: list[str] = [
     "CPF_PATTERN",
     "PHONE_BR_PATTERN",
     "REQUEST_ID_HEADER",
+    "UF",
     "AttemptThrottle",
     "CPFOrCNPJ",
     "CPUMetrics",
     "CircuitOpenError",
+    "CityBR",
+    "CityNameField",
     "DiskMetrics",
     "DownloadUtils",
     "EmailUtils",
@@ -107,32 +126,43 @@ __all__: list[str] = [
     "MinIOUploadStorage",
     "PasswordUtils",
     "PhoneBR",
+    "Region",
     "RetryPolicy",
+    "StateBR",
     "SystemMetrics",
     "TOTPHelper",
     "ThrottleBackend",
     "ThrottleStatus",
+    "UFField",
     "UploadResult",
     "UploadStorage",
     "UploadUtils",
     "build_content_disposition",
+    "cities_by_uf",
     "generate_opaque_token",
     "get_client_ip",
     "get_client_ip_from_scope",
+    "get_state",
     "hash_opaque_token",
     "is_valid_cep",
+    "is_valid_city",
     "is_valid_cnpj",
     "is_valid_cpf",
     "is_valid_cpf_cnpj",
     "is_valid_phone_br",
+    "is_valid_uf",
+    "list_states",
     "modify_dict",
     "normalize_cep",
+    "normalize_city",
     "normalize_cnpj",
     "normalize_cpf",
     "normalize_cpf_cnpj",
     "normalize_phone_br",
+    "normalize_uf",
     "only_digits",
     "sniff_mime",
+    "states_by_region",
     "to_utc",
     "utcnow",
     "verify_opaque_token",