Types

openfisca_core.types.Array

Type representing an numpy array.

alias of ndarray[Any, dtype[_N_co]]

openfisca_core.types.ArrayLike

Type representing an array-like object.

alias of Sequence[_L]

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

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

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

openfisca_core.types.DTypeBool

Type for bool arrays.

openfisca_core.types.DTypeBytes

Type for bytes arrays.

openfisca_core.types.DTypeDate

Type for date arrays.

openfisca_core.types.DTypeEnum

Type for Enum arrays.

openfisca_core.types.DTypeFloat

Type for float arrays.

openfisca_core.types.DTypeGeneric

Type for “generic” arrays.

openfisca_core.types.DTypeInt

Type for int arrays.

openfisca_core.types.DTypeObject

Type for “object” arrays.

openfisca_core.types.DTypeStr

Type for string arrays.

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

class openfisca_core.types.EntityKey

For example “person”.

alias of str

class openfisca_core.types.EntityPlural

For example “persons”.

alias of str

class openfisca_core.types.Enum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class openfisca_core.types.EnumArray(input_array: ndarray[Any, dtype[uint8]], possible_values: type[Enum])

class openfisca_core.types.EnumType(cls, bases, classdict, *, boundary=None, _simple=False, **kwds)

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

__call__(population, instant, params, /)

Call self as a function.

Return type:

ndarray[Any, dtype[generic]]

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

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

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

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

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

class openfisca_core.types.InstantStr

For example “2000-01”.

alias of str

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

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

__call__(instant, /)

Call self as a function.

Return type:

ParameterNodeAtInstant

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

class openfisca_core.types.PeriodStr

For example “1:2000-01-01:day”.

alias of str

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

class openfisca_core.types.RoleKey

For example “principal”.

alias of str

class openfisca_core.types.RolePlural

For example “parents”.

alias of str

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

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

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

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

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

class openfisca_core.types.VariableName

For example “salary”.

alias of str