ORIONIS API REFERENCE

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

orionis.support.performance.contracts.counter.IPerformanceCounter

class documentation

class IPerformanceCounter(ABC): (source)

Known subclasses: orionis.support.performance.PerformanceCounter

View In Hierarchy

Undocumented

Async Method aelapsedTime Return the elapsed time in seconds asynchronously.
Async Method agetMicroseconds Return the elapsed time in microseconds asynchronously.
Async Method agetMilliseconds Return the elapsed time in milliseconds asynchronously.
Async Method agetMinutes Return the elapsed time in minutes asynchronously.
Async Method agetSeconds Return the elapsed time in seconds asynchronously.
Async Method arestart Restart the performance counter asynchronously.
Async Method astart Start the performance counter asynchronously.
Async Method astop Stop the performance counter asynchronously.
Method elapsedTime Return the elapsed time in seconds between the last start and stop calls.
Method getMicroseconds Return the elapsed time in microseconds.
Method getMilliseconds Return the elapsed time in milliseconds.
Method getMinutes Return the elapsed time in minutes.
Method getSeconds Return the elapsed time in seconds.
Method restart Restart the performance counter.
Method start Start the performance counter.
Method stop Stop the performance counter and compute elapsed time.
Class Variable __slots__ Undocumented
async def aelapsedTime(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in seconds asynchronously.

Returns
floatElapsed time in seconds as a float.
Raises
ValueErrorIf the counter has not been started and stopped properly.
async def agetMicroseconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in microseconds asynchronously.

Returns
floatElapsed time in microseconds as a float.
async def agetMilliseconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in milliseconds asynchronously.

Returns
floatElapsed time in milliseconds as a float.
async def agetMinutes(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in minutes asynchronously.

Returns
floatElapsed time in minutes as a float.
async def agetSeconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in seconds asynchronously.

Returns
floatElapsed time in seconds as a float.
async def arestart(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Restart the performance counter asynchronously.

Resets internal timing attributes and starts the counter again in async mode.

Returns
IPerformanceCounterThis instance for method chaining.
async def astart(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Start the performance counter asynchronously.

Records the current high-resolution time for an asynchronous measurement.

Returns
IPerformanceCounterThe current instance for method chaining.
async def astop(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Stop the performance counter asynchronously.

Records the current high-resolution time as the end time and computes the elapsed time since astart() was called.

Returns
IPerformanceCounterThis instance for method chaining.
Raises
RuntimeErrorIf called after synchronous start.
def elapsedTime(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in seconds between the last start and stop calls.

Returns
floatElapsed time in seconds as a float.
Raises
ValueErrorIf the counter has not been started and stopped properly.
def getMicroseconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in microseconds.

Converts the elapsed time in seconds to microseconds.

Returns
floatElapsed time in microseconds.
def getMilliseconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in milliseconds.

Converts the elapsed time in seconds to milliseconds.

Returns
floatElapsed time in milliseconds as a float.
def getMinutes(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in minutes.

Returns
floatElapsed time in minutes as a float.
def getSeconds(self) -> float: (source)
overridden in orionis.support.performance.PerformanceCounter

Return the elapsed time in seconds.

Returns
floatElapsed time in seconds as a float.
def restart(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Restart the performance counter.

Resets internal timing attributes and starts the counter again. Useful for measuring a new interval without creating a new instance.

Returns
IPerformanceCounterThis instance for method chaining.
def start(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Start the performance counter.

Records the current high-resolution time as the start time.

Returns
IPerformanceCounterThis instance for method chaining.
def stop(self) -> IPerformanceCounter: (source)
overridden in orionis.support.performance.PerformanceCounter

Stop the performance counter and compute elapsed time.

Records the current high-resolution time as the end time and computes the elapsed time since start() was called.

Returns
IPerformanceCounterThe current instance for method chaining.
Raises
RuntimeErrorIf called after asynchronous start.
ValueErrorIf called before start.
__slots__: tuple = (source)
overridden in orionis.support.performance.PerformanceCounter

Undocumented