orionis.schemas.rules.Dimensions

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.

Explore modules View classes

class documentation

class Dimensions(Rule): (source)

Constructor: Dimensions(min_width, max_width, min_height, max_height, ...)

View In Hierarchy

Ensure an uploaded image satisfies the given dimension constraints.

Widths and heights are read from the image header, so no third-party imaging library is required. Ratios accept either a number or a "width/height" string such as "3/2".

Method	`__checkBounds`	Check the pixel dimensions against the configured bounds.
Method	`__checkRatio`	Check the aspect ratio against the configured constraints.
Method	`__init__`	Initialize the rule with the accepted dimension constraints.
Method	`enforce`	Validate an uploaded image against the dimension constraints.
Class Variable	`__code__`	Undocumented
Class Variable	`__message__`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`_height`	Undocumented
Instance Variable	`_max_height`	Undocumented
Instance Variable	`_max_ratio`	Undocumented
Instance Variable	`_max_width`	Undocumented
Instance Variable	`_min_height`	Undocumented
Instance Variable	`_min_ratio`	Undocumented
Instance Variable	`_min_width`	Undocumented
Instance Variable	`_ratio`	Undocumented
Instance Variable	`_width`	Undocumented

Inherited from Rule:

Async Method	`enforceAsync`	Run an explicitly asynchronous rule check without blocking the loop.
Method	`validate`	Validate the field value and return a failure when invalid.
Async Method	`validateAsync`	Await the rule and describe an invalid field value.
Instance Variable	`_code`	Undocumented
Instance Variable	`_message`	Undocumented

def __checkBounds(self, width: int, height: int) -> bool: (source) ¶

Check the pixel dimensions against the configured bounds.

Parameters
width:`int`	Image width in pixels.
height:`int`	Image height in pixels.

Returns
`bool`	Return `True` when every configured bound is satisfied.

def __checkRatio(self, width: int, height: int) -> bool: (source) ¶

Check the aspect ratio against the configured constraints.

Parameters
width:`int`	Image width in pixels.
height:`int`	Image height in pixels.

Returns
`bool`	Return `True` when every configured ratio is satisfied.

overrides orionis.schemas.rule.Rule.__init__

Initialize the rule with the accepted dimension constraints.

Parameters
min_width:`int \| None, optional`	Lowest accepted width in pixels.
max_width:`int \| None, optional`	Highest accepted width in pixels.
min_height:`int \| None, optional`	Lowest accepted height in pixels.
max_height:`int \| None, optional`	Highest accepted height in pixels.
width:`int \| None, optional`	Exact required width in pixels.
height:`int \| None, optional`	Exact required height in pixels.
ratio:`float \| str \| None, optional`	Exact required aspect ratio.
min_ratio:`float \| str \| None, optional`	Lowest accepted aspect ratio.
max_ratio:`float \| str \| None, optional`	Highest accepted aspect ratio.
message:`str \| None, optional`	Override message used when validation fails.

Returns
`None`	This method initializes the instance and returns None.

Raises
`ValueError`	If any ratio constraint cannot be parsed.

def enforce(self, field: str, value: object, instance: object) -> bool: (source) ¶

overrides orionis.schemas.rule.Rule.enforce

Validate an uploaded image against the dimension constraints.

Parameters
field:`str`	Field name associated with the value.
value:`object`	Value to validate.
instance:`object`	Owning object instance. This argument is accepted for interface compatibility.