Source code for aeat.application.user_profile._completeness

"""Conditional completeness rules for profile-level filing readiness."""

from __future__ import annotations

from collections.abc import Mapping

from ...domain.deadlines import EntityType, FiscalResidency, IrpfIncomeCategory, irnr_representante_fiscal_required

FISCAL_RESIDENCY_PATH = "taxpayer_type.fiscal_residency"
COUNTRY_OF_FISCAL_RESIDENCE_PATH = "taxpayer_type.country_of_fiscal_residence"
REPRESENTANTE_FISCAL_NIF_PATH = "taxpayer_type.representante_fiscal_nif"
REPRESENTANTE_FISCAL_NOMBRE_PATH = "taxpayer_type.representante_fiscal_nombre"
ENTITY_TYPE_PATH = "taxpayer_type.entity_type"
IRPF_INCOME_CATEGORIES_PATH = "taxpayer_type.irpf_income_categories"
IVA_REGIME_PATH = "iva.regime"




def conditional_profile_required_paths(values: Mapping[str, object]) -> tuple[str, ...]:
    """Return profile paths conditionally required by declared taxpayer facts.

    Static schema-required fields are handled by the schema validator and the
    compiled profile-key registry. This helper owns cross-field completeness:
    IRNR non-residents must declare their fiscal residence country, and
    non-EU/EEA IRNR residents must also declare both fiscal representative
    fields before any filing/modelo work can treat the profile as ready.
    """
    if _token(values.get(FISCAL_RESIDENCY_PATH)).lower() != FiscalResidency.NON_RESIDENT_IRNR.value:
        return ()

    country = _token(values.get(COUNTRY_OF_FISCAL_RESIDENCE_PATH)).upper()
    if not country:
        return (COUNTRY_OF_FISCAL_RESIDENCE_PATH,)

    required = [COUNTRY_OF_FISCAL_RESIDENCE_PATH]
    if irnr_representante_fiscal_required(country):
        required.extend((REPRESENTANTE_FISCAL_NIF_PATH, REPRESENTANTE_FISCAL_NOMBRE_PATH))
    return tuple(required)





def conditional_profile_missing_required(values: Mapping[str, object]) -> tuple[str, ...]:
    """Return conditionally required profile paths absent from ``values``."""
    return tuple(path for path in conditional_profile_required_paths(values) if not _has_value(values, path))





def iva_regime_required(values: Mapping[str, object]) -> bool:
    """Return whether the profile needs an explicit IVA regime fact.

    Legal entities and attribution entities keep the existing IVA-regime
    requirement. A natural-person profile only needs the IVA regime when
    it declares economic-activity income; a salaried-only, pensioner, or
    pure-landlord profile must not be forced into ``GENERAL`` just to pass
    profile persistence.
    """
    entity_type = _token(values.get(ENTITY_TYPE_PATH))
    if entity_type != EntityType.NATURAL_PERSON.value:
        return True
    categories = {
        token.strip() for token in _token(values.get(IRPF_INCOME_CATEGORIES_PATH)).split(",") if token.strip()
    }
    return IrpfIncomeCategory.ACTIVIDAD_ECONOMICA.value in categories



def _has_value(values: Mapping[str, object], path: str) -> bool:
    return bool(_token(values.get(path)))


def _token(value: object) -> str:
    if value is None:
        return ""
    return str(value).strip()


__all__ = [
    "COUNTRY_OF_FISCAL_RESIDENCE_PATH",
    "ENTITY_TYPE_PATH",
    "FISCAL_RESIDENCY_PATH",
    "IRPF_INCOME_CATEGORIES_PATH",
    "IVA_REGIME_PATH",
    "REPRESENTANTE_FISCAL_NIF_PATH",
    "REPRESENTANTE_FISCAL_NOMBRE_PATH",
    "conditional_profile_missing_required",
    "conditional_profile_required_paths",
    "iva_regime_required",
]