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]

openfisca_core.types.BoolArray

Type alias for a boolean array.

alias of ndarray[Any, dtype[bool_]]

openfisca_core.types.BytesArray

Type alias for an array of bytes.

alias of ndarray[Any, dtype[bytes_]]

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

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.

openfisca_core.types.DateArray

Type alias for an array of dates.

alias of ndarray[Any, dtype[datetime64]]

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)

openfisca_core.types.FlatNodeMap

A type representing a mapping of flat traces.

alias of dict[NodeKey, FlatTraceMap]

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

class openfisca_core.types.FlatTraceMap

openfisca_core.types.FloatArray

Type alias for an array of floats.

alias of ndarray[Any, dtype[float32]]

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.FullTracer(*args, **kwargs)

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.ISOCalendarStr

class openfisca_core.types.ISOFormatStr

openfisca_core.types.IndexArray

Type alias for an array of enum indices.

alias of ndarray[Any, dtype[uint8]]

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

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

class openfisca_core.types.InstantInt

For example 2020.

alias of int

class openfisca_core.types.InstantStr

openfisca_core.types.IntArray

Type alias for an array of integers.

alias of ndarray[Any, dtype[int32]]

class openfisca_core.types.MemoryUsage

class openfisca_core.types.NodeKey

Key of a trace.

alias of str

openfisca_core.types.ObjArray

Type alias for an array of objects.

alias of ndarray[Any, dtype[object_]]

openfisca_core.types.ParameterNode

A type representing a node of parameters.

alias of ParameterNodeAtInstant | VectorialParameterNodeAtInstant

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

openfisca_core.types.ParameterNodeChild

A type representing a ???

alias of ParameterNodeAtInstant | VectorialParameterNodeAtInstant | Sequence[object]

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

__call__(instant, /)

Call self as a function.

Return type:

ParameterNodeAtInstant

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

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

class openfisca_core.types.PeriodInt

For example 2020.

alias of int

openfisca_core.types.PeriodLike

Type alias for a period-like object.

alias of Period | PeriodStr | PeriodInt

class openfisca_core.types.PeriodStr

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.SeqInt(iterable=(), /)

openfisca_core.types.SerializedNodeMap

A type representing a mapping of serialized traces.

alias of dict[NodeKey, SerializedTraceMap]

class openfisca_core.types.SerializedTraceMap

openfisca_core.types.SimpleStack

A stack of simple traces.

alias of list[SimpleTraceMap]

class openfisca_core.types.SimpleTraceMap

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

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

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

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

openfisca_core.types.StrArray

Type alias for an array of strings.

alias of ndarray[Any, dtype[str_]]

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

openfisca_core.types.Time

A type representing a unit time.

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

openfisca_core.types.VarArray

Type alias for an array of generic objects.

alias of ndarray[Any, dtype[generic]]

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

class openfisca_core.types.VariableName

For example “salary”.

alias of str

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

openfisca_core.types.iso_calendar = re.compile('^\\d{4}(-W(0[1-9]|[1-4][0-9]|5[0-3]))?(-[1-7])?$')

Matches “2015”, “2015-W01”, “2015-W53-1” but not “2015-W54”, “2015-W10-8”.

openfisca_core.types.iso_format = re.compile('^\\d{4}(-(?:0[1-9]|1[0-2])(-(?:0[1-9]|[12]\\d|3[01]))?)?$')

Matches “2015”, “2015-01”, “2015-01-01” but not “2015-13”, “2015-12-32”.