brainunit.typing module#

Physical Type Utilities#

PhysicalType

Create a physical type that works with both type annotations and isinstance.

is_physical_type

Check whether obj is a PhysicalType-created class.

quantity_type

Return a runtime-checkable Quantity type for isinstance.

Core Type Aliases#

QuantityLike

Represent a union type

UnitLike

Represent a union type

DimensionLike

Represent a union type

Pre-built Physical-Type Aliases#

brainunit.typing.HAS_UNIT#

Alias for Quantity. Use as a base type annotation for any unit-bearing value, regardless of physical dimension.

brainunit.typing.DIMENSIONLESS_TYPE#
brainunit.typing.LENGTH#
brainunit.typing.MASS#
brainunit.typing.TIME#
brainunit.typing.CURRENT#
brainunit.typing.TEMPERATURE#
brainunit.typing.SUBSTANCE#
brainunit.typing.LUMINOSITY#
brainunit.typing.FREQUENCY#
brainunit.typing.FORCE#
brainunit.typing.ENERGY#
brainunit.typing.POWER#
brainunit.typing.PRESSURE#
brainunit.typing.CHARGE#
brainunit.typing.VOLTAGE#
brainunit.typing.RESISTANCE#
brainunit.typing.CAPACITANCE#
brainunit.typing.CONDUCTANCE#
brainunit.typing.MAGNETIC_FLUX#
brainunit.typing.MAGNETIC_FIELD#
brainunit.typing.INDUCTANCE#
brainunit.typing.SPEED#
brainunit.typing.ACCELERATION#
brainunit.typing.AREA#
brainunit.typing.VOLUME#
brainunit.typing.DENSITY#

Runtime Validation#

validate_units

Decorator that validates Quantity argument units at call time.