Skip to content

Added a utils.py get_state_name_from_state_abbreviation #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vic012 wants to merge 8 commits into
base: master
Choose a base branch
from
+52 −0
Open

Added a utils.py get_state_name_from_state_abbreviation #510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7d841e1
Added utils get_states_of_brazil
vic012 Jul 14, 2024
73ece29
improvements: improvement utils file and added test file
vic012 Jul 19, 2024
88c3930
Change files: docs/changelog.rst and docs/authors.rst
vic012 Jul 29, 2024
9aab886
Update changelog.rst
vic012 Jul 29, 2024
9fce1d9
Merge branch 'master' into get_states_of_brazil
vic012 Apr 23, 2025
9a71530
Improvements: improve br utils and rewrite tests
vic012 Nov 19, 2025
30f740e
Update changelog with new localflavor features
vic012 Nov 19, 2025
89d52be
Fix duplicate entry for CIN Number in changelog
vic012 Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/authors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Authors
* Paul Cunnane
* Paul Donohue
* Paulo Poiati
* Pedro Henrique Vicente de Sousa
* Peter J. Farrell
* Rael Max
* Ramiro Morales
Expand Down
3 changes: 3 additions & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ New flavors:

New fields for existing flavors:

- Added `get_state_name_from_state_abbreviation` and `STATE_CHOICES_DICT` to ``localflavor.br.utils``.
The new utility returns the full Brazilian state name from a UF abbreviation, or ``None`` for invalid inputs
(`gh-510 <https://github.com/django/django-localflavor/pull/510>`_).
- Added CIN Number field in Morocco flavor
(`gh-705 <https://github.com/django/django-localflavor/pull/507>`_).

Expand Down
24 changes: 24 additions & 0 deletions localflavor/br/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
from .br_states import STATE_CHOICES

# Mapping UF -> full state name
STATE_CHOICES_DICT = dict(STATE_CHOICES)

def get_state_name_from_state_abbreviation(abbreviation=None):
"""
Given a Brazilian state abbreviation (UF), return the full state name.

Returns:
str | None:
- The full state name if the abbreviation exists
- None if the abbreviation is invalid

Example:
get_state_name_from_state_abbreviation("RJ") -> "Rio de Janeiro"
get_state_name_from_state_abbreviation("sp") -> "São Paulo"
get_state_name_from_state_abbreviation("XX") -> None
get_state_name_from_state_abbreviation() -> None
"""
if not isinstance(abbreviation, str):
return None

return STATE_CHOICES_DICT.get(abbreviation.upper())
24 changes: 24 additions & 0 deletions tests/test_br/test_br.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from localflavor.br import models
from localflavor.br.forms import (BRCNPJField, BRCPFField, BRProcessoField, BRStateChoiceField, BRStateSelect,
BRZipCodeField)
from localflavor.br.utils import get_state_name_from_state_abbreviation
from tests.test_br.forms import BRPersonProfileForm


Expand Down Expand Up @@ -281,3 +282,26 @@ def test_BRPostalCodeField(self):
self.assertEqual(instance.max_length, new_instance.max_length)
self.assertEqual(instance.description, new_instance.description)
self.assertEqual(instance.validators, new_instance.validators)


class GetStateNameFromAbbreviationTests(SimpleTestCase):

def test_valid_state_abbreviation(self):
self.assertEqual(
get_state_name_from_state_abbreviation("pb"),
"Paraíba"
)
self.assertEqual(
get_state_name_from_state_abbreviation("RJ"),
"Rio de Janeiro"
)

def test_invalid_state_abbreviation(self):
self.assertIsNone(get_state_name_from_state_abbreviation("XX"))
self.assertIsNone(get_state_name_from_state_abbreviation("None"))

def test_non_string_input(self):
self.assertIsNone(get_state_name_from_state_abbreviation(123))
self.assertIsNone(get_state_name_from_state_abbreviation(1.5))
self.assertIsNone(get_state_name_from_state_abbreviation(None))
self.assertIsNone(get_state_name_from_state_abbreviation([None]))