cadrumo.domain.calculations.registry.ccaa_catalogue module¶

Typed projection of the Spanish CCAA tax-residence catalogue.

class CcaaDefinition(token, member_name)[source]¶

Bases: object

One registry-declared common-regime autonomous community.

Parameters:

token (CCAA)
member_name (str)

token: CCAA¶

member_name: str¶

class CcaaCatalogue(definitions, default_token, iso_aliases, foral_aliases, foral_cli_aliases, excluded_territories)[source]¶

Bases: object

Complete typed projection of the dated CCAA residence catalogue.

Parameters:

definitions (tuple[CcaaDefinition, ...])
default_token (CCAA)
iso_aliases (Mapping[str, CCAA])
foral_aliases (frozenset[str])
foral_cli_aliases (tuple[str, ...])
excluded_territories (frozenset[str])

definitions: tuple[CcaaDefinition, ...]¶

default_token: CCAA¶

iso_aliases: Mapping[str, CCAA]¶

foral_aliases: frozenset[str]¶

foral_cli_aliases: tuple[str, ...]¶

excluded_territories: frozenset[str]¶

property choices: tuple[CCAA, ...]¶: Return CCAA tokens in registry-authored order.

property tokens: frozenset[CCAA]¶: Return the set of CCAA tokens declared by the catalogue.

require(value)[source]¶

Project one token only when it is declared by the selected fact.

Return type:: CCAA
Parameters:: value (object)

require_member_name(name)[source]¶

Project a historical enum-style member name from the catalogue.

Return type:: CCAA
Parameters:: name (str)

from_iso_code(code)[source]¶

Resolve a declared three-letter ISO-like alias.

Return type:: CCAA
Parameters:: code (str)

from_label(label)[source]¶

Resolve a normalized common-regime label or ISO alias.

Return type:: CCAA
Parameters:: label (str)

is_foral_alias(normalized)[source]¶

Return whether a normalized input is a declared foral redirect.

Return type:: bool
Parameters:: normalized (str)

resolve_ccaa_catalogue(*, effective_date=None, authority=None)[source]¶

Resolve the selected dated CCAA tax-residence fact.

Return type:

CcaaCatalogue

Parameters:

effective_date (date | None)
authority (GovernedFactSource | None)

require_ccaa(value, *, effective_date=None, authority=None)[source]¶

Project a common-regime CCAA token through the selected facts.

Return type:

CCAA

Parameters:

value (object)
effective_date (date | None)
authority (GovernedFactSource | None)

ccaa_choices(*, effective_date=None, authority=None)[source]¶

Return the registry-authored CCAA choices in authored order.

Return type:

tuple[CCAA, ...]

Parameters:

effective_date (date | None)
authority (GovernedFactSource | None)

default_ccaa(*, effective_date=None, authority=None)[source]¶

Return the profile default declared by the CCAA catalogue.

Return type:

CCAA

Parameters:

effective_date (date | None)
authority (GovernedFactSource | None)