human-input-validator 0.1.2__tar.gz → 0.1.3__tar.gz

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: human-input-validator
-Version: 0.1.2
+Version: 0.1.3
 Summary: Small validators for common human-entered data.
 Author: Snorlena
 License-Expression: MIT
@@ -40,9 +40,13 @@ Each function returns a normalized value or raises `ValidationError` for
 invalid input.
 
 - `email(value)` — returns a trimmed, lower-cased email address.
-- `country(value)` — returns the official ISO 3166-1 country name, given a
-  name or code. Also accepts localized country names (e.g. "Deutschland",
-  "España") via pycountry's bundled translations.
+- `country(value, short=False)` — returns the common ISO 3166-1 country name
+  (e.g. "Tanzania" instead of "Tanzania, United Republic of"), given a name
+  or code. Also accepts localized country names (e.g. "Deutschland",
+  "España") via pycountry's bundled translations. Some countries have no
+  common name in pycountry's data (e.g. "Congo, The Democratic Republic of
+  the"); pass `short=True` to trim those at the first comma instead of
+  returning the full formal name.
 - `username(value, max_length=12)` — returns a lower-cased username, checking
   length and allowed characters.
 - `phonenumber(value, pattern)` — checks a phone number against one or more

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/README.md

@@ -30,9 +30,13 @@ Each function returns a normalized value or raises `ValidationError` for
 invalid input.
 
 - `email(value)` — returns a trimmed, lower-cased email address.
-- `country(value)` — returns the official ISO 3166-1 country name, given a
-  name or code. Also accepts localized country names (e.g. "Deutschland",
-  "España") via pycountry's bundled translations.
+- `country(value, short=False)` — returns the common ISO 3166-1 country name
+  (e.g. "Tanzania" instead of "Tanzania, United Republic of"), given a name
+  or code. Also accepts localized country names (e.g. "Deutschland",
+  "España") via pycountry's bundled translations. Some countries have no
+  common name in pycountry's data (e.g. "Congo, The Democratic Republic of
+  the"); pass `short=True` to trim those at the first comma instead of
+  returning the full formal name.
 - `username(value, max_length=12)` — returns a lower-cased username, checking
   length and allowed characters.
 - `phonenumber(value, pattern)` — checks a phone number against one or more

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "human-input-validator"
-version = "0.1.2"
+version = "0.1.3"
 description = "Small validators for common human-entered data."
 readme = "README.md"
 requires-python = ">=3.10"

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/src/human_input_validator/validators.py

@@ -54,19 +54,27 @@ def email(value: str) -> str:
 _FUZZY_MATCH_CUTOFF = 0.8
 
 
-def _display_name(entry: object) -> str:
+def _display_name(entry: object, short: bool = False) -> str:
     """Prefer the short common name (e.g. 'Tanzania') over the formal ISO name."""
     common_name: str | None = getattr(entry, "common_name", None)
     name: str = getattr(entry, "name")
-    return common_name or name
+    if common_name:
+        return common_name
+    # No common_name available (e.g. 'Congo, The Democratic Republic of the');
+    # trim at the comma as a best-effort shortening.
+    return name.split(",", 1)[0] if short else name
 
 
-def country(value: str) -> str:
-    """Return the common name of an ISO 3166-1 country, given its name or code in any supported language."""
+def country(value: str, short: bool = False) -> str:
+    """Return the common name of an ISO 3166-1 country, given its name or code in any supported language.
+
+    If ``short`` is True, names without a common_name (e.g. 'Congo, The Democratic
+    Republic of the') are trimmed at the first comma instead of returned in full.
+    """
     normalized = value.strip()
     try:
         result = pycountry.countries.lookup(normalized)
-        return _display_name(result)
+        return _display_name(result, short)
     except LookupError:
         pass
 
@@ -84,7 +92,7 @@ def country(value: str) -> str:
     result = pycountry.countries.get(alpha_2=alpha_2)
     if result is None:
         raise ValidationError("Please enter a valid country")
-    return _display_name(result)
+    return _display_name(result, short)
 
 
 def username(value: str, max_length: int = 12) -> str:

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/src/human_input_validator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: human-input-validator
-Version: 0.1.2
+Version: 0.1.3
 Summary: Small validators for common human-entered data.
 Author: Snorlena
 License-Expression: MIT
@@ -40,9 +40,13 @@ Each function returns a normalized value or raises `ValidationError` for
 invalid input.
 
 - `email(value)` — returns a trimmed, lower-cased email address.
-- `country(value)` — returns the official ISO 3166-1 country name, given a
-  name or code. Also accepts localized country names (e.g. "Deutschland",
-  "España") via pycountry's bundled translations.
+- `country(value, short=False)` — returns the common ISO 3166-1 country name
+  (e.g. "Tanzania" instead of "Tanzania, United Republic of"), given a name
+  or code. Also accepts localized country names (e.g. "Deutschland",
+  "España") via pycountry's bundled translations. Some countries have no
+  common name in pycountry's data (e.g. "Congo, The Democratic Republic of
+  the"); pass `short=True` to trim those at the first comma instead of
+  returning the full formal name.
 - `username(value, max_length=12)` — returns a lower-cased username, checking
   length and allowed characters.
 - `phonenumber(value, pattern)` — checks a phone number against one or more

{human_input_validator-0.1.2 → human_input_validator-0.1.3}/tests/test_validators.py

@@ -35,6 +35,20 @@ class CountryTests(unittest.TestCase):
         with self.assertRaises(ValidationError):
             country("Kolbäck")
 
+    def test_full_name_without_common_name_is_unchanged(self) -> None:
+        self.assertEqual(
+            country("Congo, The Democratic Republic of the"),
+            "Congo, The Democratic Republic of the",
+        )
+
+    def test_short_trims_name_without_common_name(self) -> None:
+        self.assertEqual(
+            country("Congo, The Democratic Republic of the", short=True), "Congo"
+        )
+
+    def test_short_does_not_affect_common_name(self) -> None:
+        self.assertEqual(country("Tanzania", short=True), "Tanzania")
+
 
 class UsernameTests(unittest.TestCase):
     def test_normalizes_username(self) -> None: