orionis.logging.contracts.suffix_resolver.SuffixResolver

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 SuffixResolver(ABC): (source)

Known subclasses: orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver, orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver, orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver, orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver, orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver

View In Hierarchy

Undocumented

Method	`getNextRotationTime`	Compute the next rotation time.
Method	`getSuffix`	Return the suffix based on the rotation type.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def getNextRotationTime(self, current_time: datetime) -> datetime: (source) ¶

overridden in orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver, orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver, orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver, orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver, orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver

Compute the next rotation time.

Parameters
current_time:`datetime`	The current datetime to base the next rotation calculation.

Returns
`datetime`	The next rotation datetime.

@abstractmethod

def getSuffix(self, dt: datetime | None = None) -> str: (source) ¶

Return the suffix based on the rotation type.

Parameters
dt:`datetime or None, optional`	The datetime for which to obtain the suffix. If None, uses current time.

Returns
`str`	The resolved suffix string.

__slots__: tuple = (source) ¶

Undocumented