Types

Data types and protocols used by OpenFisca Core.

The type definitions included in this sub-package are intended for contributors, to help them better understand and document contracts and expected behaviours.

Official Public API:

• Array

• ArrayLike

• Cache

• Entity

• Formula

• Holder

• Instant

• ParameterNodeAtInstant

• Params

• Period

• Population

• Role,

• Simulation,

• TaxBenefitSystem

• Variable

Note

How imports are being used today:

from openfisca_core.types import *  # Bad
from openfisca_core.types.data_types.arrays import ArrayLike  # Bad

The previous examples provoke cyclic dependency problems, that prevents us from modularizing the different components of the library, so as to make them easier to test and to maintain.

How could them be used after the next major release:

from openfisca_core.types import ArrayLike

ArrayLike # Good: import types as publicly exposed

See also

PEP8#Imports and OpenFisca’s Styleguide.

openfisca_core.types.Array

alias of nptyping.types._ndarray.NDArray

class openfisca_core.types.Entity(*args, **kwargs)

Entity protocol.

abstract check_role_validity(role)

Abstract method.

Return type

None

abstract check_variable_defined_for_entity(variable_name)

Abstract method.

Return type

None

abstract get_variable(variable_name, check_existence=Ellipsis)

Abstract method.

Return type

Optional[Any]

class openfisca_core.types.Formula(*args, **kwargs)

Formula protocol.

abstract __call__(population, instant, params)

Abstract method.

Return type

ndarray

class openfisca_core.types.Holder(*args, **kwargs)

Holder protocol.

abstract clone(population)

Abstract method.

Return type

Holder

abstract get_memory_usage()

Abstract method.

Return type

Any

class openfisca_core.types.Instant(*args, **kwargs)

Instant protocol.

class openfisca_core.types.ParameterNodeAtInstant(*args, **kwargs)

ParameterNodeAtInstant protocol.

class openfisca_core.types.Params(*args, **kwargs)

Params protocol.

abstract __call__(instant)

Abstract method.

Return type

ParameterNodeAtInstant

class openfisca_core.types.Period(*args, **kwargs)

Period protocol.

abstract property start: Any

Abstract method.

Return type

Any

abstract property unit: Any

Abstract method.

Return type

Any

class openfisca_core.types.Population(*args, **kwargs)

Population protocol.

abstract get_holder(variable_name)

Abstract method.

Return type

Any

class openfisca_core.types.Role(*args, **kwargs)

Role protocol.

class openfisca_core.types.Simulation(*args, **kwargs)

Simulation protocol.

abstract calculate(variable_name, period)

Abstract method.

Return type

Any

abstract calculate_add(variable_name, period)

Abstract method.

Return type

Any

abstract calculate_divide(variable_name, period)

Abstract method.

Return type

Any

abstract get_population(plural)

Abstract method.

Return type

Any

class openfisca_core.types.TaxBenefitSystem(*args, **kwargs)

TaxBenefitSystem protocol.

abstract get_variable(variable_name, check_existence=Ellipsis)

Abstract method.

Return type

Optional[Any]

class openfisca_core.types.Variable(*args, **kwargs)

Variable protocol.