pepperplus/pepperplus-cb
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: add docstrings to dated file handler

Browse Source 
ref: N25B-401
This commit is contained in:
Twirre Meulenbelt
2026-01-22 11:34:51 +01:00
parent 3fed2f95b0
commit a87ac35201
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/control_backend/logging/dated_file_handler.py
View File

@@ -12,12 +12,21 @@ class DatedFileHandler(FileHandler):
super().__init__(**kwargs) super().__init__(**kwargs)
def _make_filename(self) -> str: def _make_filename(self) -> str:
"""
Create the filename for the current logfile, using the configured file prefix and the
current date and time. If the directory does not exist, it gets created.
:return: A filepath.
"""
filepath = Path(f"{self._file_prefix}-{datetime.now():%Y%m%d-%H%M%S}.log") filepath = Path(f"{self._file_prefix}-{datetime.now():%Y%m%d-%H%M%S}.log")
if not filepath.parent.is_dir(): if not filepath.parent.is_dir():
filepath.parent.mkdir(parents=True, exist_ok=True) filepath.parent.mkdir(parents=True, exist_ok=True)
return str(filepath) return str(filepath)
def do_rollover(self): def do_rollover(self):
"""
Close the current logfile and create a new one with the current date and time.
"""
self.acquire() self.acquire()
try: try:
if self.stream: if self.stream: