cup-check 0.2.0__py3-none-any.whl

cup_check/__init__.py

@@ -0,0 +1,14 @@
+"""Validazione formale locale dei Codici Unici di Progetto."""
+
+from cup_check.models import Outcome, Rule, ValidationResult, Warning
+from cup_check.validator import normalize_cup, validate_format, validate_many
+
+__all__ = [
+    "Outcome",
+    "Rule",
+    "ValidationResult",
+    "Warning",
+    "normalize_cup",
+    "validate_format",
+    "validate_many",
+]

cup_check/models.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import StrEnum
+
+
+class Outcome(StrEnum):
+    INVALIDO_FORMATO = "INVALIDO_FORMATO"
+    FORMATO_VALIDO_DA_VERIFICARE = "FORMATO_VALIDO_DA_VERIFICARE"
+
+
+class Rule(StrEnum):
+    R0 = "R0"
+    R1 = "R1"
+    R2 = "R2"
+    R3 = "R3"
+    R4 = "R4"
+    R5 = "R5"
+
+
+class Warning(StrEnum):
+    N1 = "N1"
+    N2 = "N2"
+
+
+@dataclass(frozen=True)
+class ValidationResult:
+    input_row: int | None
+    raw_value: str
+    normalized_value: str
+    outcome: Outcome
+    failed_rules: tuple[Rule, ...]
+    warnings: tuple[Warning, ...]

cup_check/validator.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+
+import re
+from collections.abc import Iterable
+from datetime import UTC, datetime
+
+from cup_check.models import Outcome, Rule, ValidationResult, Warning
+
+_ALLOWED_CHARS = re.compile(r"^[A-Z0-9]*$")
+_FIRST_POSITION = re.compile(r"^[A-Z]")
+_TWO_DIGIT_YEAR = re.compile(r"^\d{2}$")
+
+
+def normalize_cup(value: object) -> str:
+    return str("" if value is None else value).strip().upper()
+
+
+def validate_format(
+    value: object,
+    input_row: int | None = None,
+    *,
+    current_year: int | None = None,
+) -> ValidationResult:
+    raw_value = str("" if value is None else value)
+    trimmed_value = raw_value.strip()
+    normalized_value = normalize_cup(raw_value)
+    failed_rules: list[Rule] = []
+    warnings = _normalization_warnings(raw_value, trimmed_value, normalized_value)
+
+    if len(trimmed_value) == 0:
+        return ValidationResult(
+            input_row=input_row,
+            raw_value=raw_value,
+            normalized_value=normalized_value,
+            outcome=Outcome.INVALIDO_FORMATO,
+            failed_rules=(Rule.R0,),
+            warnings=warnings,
+        )
+
+    if len(normalized_value) != 15:
+        failed_rules.append(Rule.R1)
+
+    if _ALLOWED_CHARS.fullmatch(normalized_value) is None:
+        failed_rules.append(Rule.R2)
+
+    if _FIRST_POSITION.match(normalized_value) is None:
+        failed_rules.append(Rule.R3)
+
+    year_token = normalized_value[4:6]
+    two_digit_year = (current_year if current_year is not None else datetime.now(UTC).year) % 100
+    if _TWO_DIGIT_YEAR.fullmatch(year_token) is None or int(year_token) > two_digit_year:
+        failed_rules.append(Rule.R4)
+
+    if not (len(normalized_value) > 3 and "A" <= normalized_value[3] <= "Z"):
+        failed_rules.append(Rule.R5)
+
+    return ValidationResult(
+        input_row=input_row,
+        raw_value=raw_value,
+        normalized_value=normalized_value,
+        outcome=(
+            Outcome.FORMATO_VALIDO_DA_VERIFICARE
+            if len(failed_rules) == 0
+            else Outcome.INVALIDO_FORMATO
+        ),
+        failed_rules=tuple(failed_rules),
+        warnings=warnings,
+    )
+
+
+def validate_many(
+    values: Iterable[object],
+    *,
+    current_year: int | None = None,
+) -> tuple[ValidationResult, ...]:
+    return tuple(
+        validate_format(value, input_row=index, current_year=current_year)
+        for index, value in enumerate(values, start=1)
+    )
+
+
+def _normalization_warnings(
+    raw_value: str, trimmed_value: str, normalized_value: str
+) -> tuple[Warning, ...]:
+    warnings = []
+    if raw_value != trimmed_value:
+        warnings.append(Warning.N1)
+    if trimmed_value != normalized_value:
+        warnings.append(Warning.N2)
+    return tuple(warnings)

cup_check-0.2.0.dist-info/METADATA

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: cup-check
+Version: 0.2.0
+Summary: Validazione formale locale dei Codici Unici di Progetto (CUP).
+Project-URL: Homepage, https://github.com/ale-saglia/cup-check
+Project-URL: Repository, https://github.com/ale-saglia/cup-check
+Project-URL: Issues, https://github.com/ale-saglia/cup-check/issues
+Author: Alessandro Saglia
+License-Expression: EUPL-1.2
+Keywords: codice unico progetto,cup,opencup,validazione
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# cup-check
+
+Libreria Python per validare localmente il formato dei Codici Unici di Progetto (CUP).
+
+La verifica e solo formale: un CUP con formato valido viene restituito come
+`FORMATO_VALIDO_DA_VERIFICARE`, non come CUP esistente.
+
+```python
+from cup_check import validate_format
+
+result = validate_format("G17H03000130001")
+
+print(result.outcome)
+print(result.failed_rules)
+```
+
+Per validare piu valori:
+
+```python
+from cup_check import validate_many
+
+results = validate_many(["G17H03000130001", "117H03000130001"])
+```

cup_check-0.2.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+cup_check/__init__.py,sha256=ZkUNNXOVt7d6edAt1zKUrpxQNAbnmirRsPpaIM7Rtio,358
+cup_check/models.py,sha256=T-uZUTMh95gyqYmTWNjr7Ah0dhq1fPElIuVazziBkOE,601
+cup_check/validator.py,sha256=IPmmEaynv2oBGki6jTHiI3BVMUdd-xrNkkPujZmT5b4,2729
+cup_check-0.2.0.dist-info/METADATA,sha256=l5szInRdZTlvHcfQ7BkwgciR-Sb3Zjj3c0UFx9sxCl4,1364
+cup_check-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+cup_check-0.2.0.dist-info/RECORD,,

cup_check-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any