Skip to content

Commit ec4f6f6

Browse files
committed
chore: Cleanup variable names and log messages
1 parent e925127 commit ec4f6f6

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

src/gallia/utils.py

+10-8
Original file line numberDiff line numberDiff line change
@@ -283,32 +283,34 @@ def get_file_log_level(args: Any) -> Loglevel:
283283

284284

285285
CONTEXT_SHARED_VARIABLE = "logger_name"
286-
ctxVar: contextvars.ContextVar[tuple[str, str | None]] = contextvars.ContextVar(
286+
context: contextvars.ContextVar[tuple[str, str | None]] = contextvars.ContextVar(
287287
CONTEXT_SHARED_VARIABLE
288288
)
289289

290290

291291
def set_task_handler_ctx_variable(
292-
logger_name: str, task_name: str | None = None
292+
logger_name: str,
293+
task_name: str | None = None,
293294
) -> contextvars.Context:
294295
ctx = contextvars.copy_context()
295-
ctx.run(ctxVar.set, (logger_name, task_name))
296+
ctx.run(context.set, (logger_name, task_name))
296297
return ctx
297298

298299

299300
def handle_task_error(fut: asyncio.Future[Any]) -> None:
300-
(logger_name, task_name) = ctxVar.get((__name__, "Task"))
301+
logger_name, task_name = context.get((__name__, "Task"))
301302
logger = get_logger(logger_name)
302303
if logger.name is __name__:
303-
logger.warning(
304-
f"<DEV> {fut} did not have context variable '{CONTEXT_SHARED_VARIABLE}' set; please fix this for proper logging"
305-
)
304+
logger.warning(f"BUG: {fut} had no context '{CONTEXT_SHARED_VARIABLE}' set")
305+
logger.warning("BUG: please fix this to ensure the task name is logged correctly")
306306

307307
try:
308308
fut.result()
309309
except BaseException as e:
310+
task_name = task_name if task_name is not None else "Task"
311+
310312
# Info level is enough, since our aim is only to consume the stack trace
311-
logger.info(f"{task_name if task_name is not None else 'Task'} ended with error: {e!r}")
313+
logger.info(f"{task_name} ended with error: {e!r}")
312314

313315

314316
class AddrInfo(pydantic.BaseModel):

0 commit comments

Comments
 (0)