orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver

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.

class documentation

class WeeklySuffixResolver(SuffixResolver): (source)

Undocumented

Method	`__init__`	Initialize WeeklySuffixResolver.
Method	`getNextRotationTime`	Calculate the next rotation datetime based on the current time.
Method	`getSuffix`	Generate a weekly suffix based on the provided datetime.
Class Variable	`__slots__`	Undocumented
Instance Variable	`at_time`	Undocumented
Instance Variable	`tz`	Undocumented

def __init__(self, at_time: time | None = None): (source) ¶

Initialize WeeklySuffixResolver.

Parameters
at_time:`time or None, optional`	The time of day when rotation should occur. Defaults to midnight.

Returns
`None`	This method does not return a value.

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

overrides orionis.logging.contracts.suffix_resolver.SuffixResolver.getNextRotationTime

Calculate the next rotation datetime based on the current time.

Parameters
current_time:`datetime`	The current datetime.

Returns
`datetime`	The datetime when the next rotation should occur.

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

overrides orionis.logging.contracts.suffix_resolver.SuffixResolver.getSuffix

Generate a weekly suffix based on the provided datetime.

Parameters
dt:`datetime or None, optional`	The datetime to use for suffix generation. If None, uses current local datetime.

Returns
`str`	The generated suffix in the format 'YYYY-weekWW'.

overrides orionis.logging.contracts.suffix_resolver.SuffixResolver.__slots__

Undocumented

Undocumented

Undocumented