orionis.schemas.rules.measure

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

module documentation

(source)

Undocumented

Function	`is_file`	Report whether a value behaves like an uploaded file.
Function	`measure`	Compute the comparable size of a value.
Function	`read_content`	Read the whole content of an uploaded file.
Constant	`_FILE_ATTRIBUTES`	Undocumented
Constant	`KILOBYTE`	Undocumented

def is_file(value: object) -> bool: (source) ¶

Report whether a value behaves like an uploaded file.

Parameters
value:`object`	Value to inspect.

Returns
`bool`	Return `True` when the value exposes the uploaded-file protocol.

def measure(value: object) -> float | None: (source) ¶

Compute the comparable size of a value.

Numbers are compared by their own magnitude, strings and collections by their length, and uploaded files by their size in kilobytes.

Parameters
value:`object`	Value whose size is required.

Returns
`float \| None`	Comparable size, or `None` when the value has no measurable size.

def read_content(value: object) -> bytes | None: (source) ¶

Read the whole content of an uploaded file.

Parameters
value:`object`	Uploaded file to read.

Returns
`bytes \| None`	Raw content, or `None` when the value is not a readable file.

_FILE_ATTRIBUTES: tuple[str, ...] = (source) ¶

Undocumented

Value

('read', 'size', 'filename')

Undocumented

Value