Composite Types

class typerighter.types.composites.Container(*a, **kw)

NATIVE

alias of builtins.object

is_coercible(value)

Checks a value for whether or not it can be converted to the correct type. Falls back to the stricter is_type_match if self.strict is True.

Parameters

value (object) – The value to inspect

is_falsy(value)

Checks a value and responds saying whether the Type considers it falsy.

Parameters

value (object) – The value to inspect

Returns

True or False

is_type_match(value)

Checks if a value is an instance of this Type’s native type. :param object value: The value to inspect

to_native(value)

Converts a value to the native form of this type

Parameters

value (object) – The value to convert

to_primitive(value)

Converts a value to the primitive form of this type

Parameters

value (object) – The value to convert

to_schematic()

Returns a Type’s Schematic

validate(value)

This validation function is the primary function responsible for calling all associated validators and for managing any details related to aggregation of validation results.

Parameters

value (object) – The value to convert

class typerighter.types.composites.ListType(*a, **kw)

NATIVE

alias of builtins.list

is_coercible(value)

Checks a value for whether or not it can be converted to the correct type. Falls back to the stricter is_type_match if self.strict is True.

Parameters

value (object) – The value to inspect

is_falsy(value)

Checks a value and responds saying whether the Type considers it falsy.

Parameters

value (object) – The value to inspect

Returns

True or False

is_type_match(value)

Checks if a value is an instance of this Type’s native type. :param object value: The value to inspect

to_native(value)

Converts a value to the native form of this type

Parameters

value (object) – The value to convert

to_primitive(value)

Converts a value to the primitive form of this type

Parameters

value (object) – The value to convert

to_schematic()

Returns a Type’s Schematic

validate(value)

This validation function is the primary function responsible for calling all associated validators and for managing any details related to aggregation of validation results.

Parameters

value (object) – The value to convert

class typerighter.types.composites.SumType(*a, **kw)

NATIVE

alias of builtins.object

is_coercible(value)

Checks a value for whether or not it can be converted to the correct type. Falls back to the stricter is_type_match if self.strict is True.

Parameters

value (object) – The value to inspect

is_falsy(value)

Checks a value and responds saying whether the Type considers it falsy.

Parameters

value (object) – The value to inspect

Returns

True or False

is_type_match(value)

Checks if a value is an instance of this Type’s native type. :param object value: The value to inspect

to_native(value)

Converts a value to the native form of this type

Parameters

value (object) – The value to convert

to_primitive(value)

Converts a value to the primitive form of this type

Parameters

value (object) – The value to convert

to_schematic()

Returns a Type’s Schematic

validate(value)

This validation function is the primary function responsible for calling all associated validators and for managing any details related to aggregation of validation results.

Parameters

value (object) – The value to convert