Skip to content

Commit 0b76608

Browse files
cademirchcademirch
committed
rename formatter methods
1 parent 5b4aa42 commit 0b76608

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

‎snakemake/logging.py‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -253,42 +253,42 @@ def __init__(self, printreason=False, show_failed_logs=False, printshellcmds=Fal
253253

254254
def format(self, record):
255255
"""
256-
Override format method to handle Snakemake-specific log messages.
256+
Override format method to format Snakemake-specific log messages.
257257
"""
258258
msg = record.msg
259259
level = msg.get("level", "INFO") # Default to "INFO" if level not in message
260260

261261
# Call specific handlers based on the log level
262262
if level == "info":
263-
return self.handle_info(msg)
263+
return self.format_info(msg)
264264
elif level == "host":
265-
return self.handle_host(msg)
265+
return self.format_host(msg)
266266
elif level == "job_info":
267-
return self.handle_job_info(msg)
267+
return self.format_job_info(msg)
268268
elif level == "group_info":
269-
return self.handle_group_info(msg)
269+
return self.format_group_info(msg)
270270
elif level == "job_error":
271-
return self.handle_job_error(msg)
271+
return self.format_job_error(msg)
272272
elif level == "group_error":
273-
return self.handle_group_error(msg)
273+
return self.format_group_error(msg)
274274
elif level == "progress":
275-
return self.handle_progress(msg)
275+
return self.format_progress(msg)
276276
elif level == "job_finished":
277-
return self.handle_job_finished(msg)
277+
return self.format_job_finished(msg)
278278
elif level == "shellcmd":
279-
return self.handle_shellcmd(msg)
279+
return self.format_shellcmd(msg)
280280
elif level == "rule_info":
281-
return self.handle_rule_info(msg)
281+
return self.format_rule_info(msg)
282282
elif level == "d3dag":
283-
return self.handle_d3dag(msg)
283+
return self.format_d3dag(msg)
284284
elif level == "dag_debug":
285-
return self.handle_dag_debug(msg)
285+
return self.format_dag_debug(msg)
286286
elif level == "run_info":
287-
return self.handle_run_info(msg)
287+
return self.format_run_info(msg)
288288
else:
289289
return msg["msg"]
290290

291-
def handle_info(self, msg):
291+
def format_info(self, msg):
292292
"""
293293
Format 'info' level messages.
294294
"""
@@ -307,15 +307,15 @@ def handle_info(self, msg):
307307
# Return the formatted message as a single string with newlines
308308
return "\n".join(output)
309309

310-
def handle_run_info(self, msg):
310+
def format_run_info(self, msg):
311311
"""Format the run_info log messages."""
312312
return msg["msg"] # Log the message directly
313313

314-
def handle_host(self, msg):
314+
def format_host(self, msg):
315315
"""Format for host log."""
316316
return f"host: {platform.node()}"
317317

318-
def handle_job_info(self, msg):
318+
def format_job_info(self, msg):
319319
"""Format for job_info log."""
320320
output = []
321321

@@ -325,7 +325,7 @@ def handle_job_info(self, msg):
325325
if self.printreason:
326326
output.append(f"Reason: {msg['reason']}")
327327
else:
328-
output.append("\n".join(self.format_job_info(msg)))
328+
output.append("\n".join(self._format_job_info(msg)))
329329

330330
if msg["is_checkpoint"]:
331331
output.append("DAG of jobs will be updated after completion.")
@@ -334,56 +334,56 @@ def handle_job_info(self, msg):
334334
output.append("")
335335
return "\n".join(output)
336336

337-
def handle_group_info(self, msg):
337+
def format_group_info(self, msg):
338338
"""Format for group_info log."""
339339
msg = (
340340
f"{self.timestamp()} group job {msg['groupid']} (jobs in lexicogr. order):"
341341
)
342342

343343
return msg
344344

345-
def handle_job_error(self, msg):
345+
def format_job_error(self, msg):
346346
"""Format for job_error log."""
347347
output = []
348348
output.append(self.timestamp())
349-
output.append("\n".join(self.format_job_error(msg)))
349+
output.append("\n".join(self._format_job_error(msg)))
350350
return "\n".join(output)
351351

352-
def handle_group_error(self, msg):
352+
def format_group_error(self, msg):
353353
"""Format for group_error log."""
354354
output = []
355355
output.append(self.timestamp())
356-
output.append("\n".join(self.format_group_error(msg)))
356+
output.append("\n".join(self._format_group_error(msg)))
357357
return "\n".join(output)
358358

359-
def handle_progress(self, msg):
359+
def format_progress(self, msg):
360360
"""Format for progress log."""
361361
done = msg["done"]
362362
total = msg["total"]
363-
return f"{done} of {total} steps ({self.format_percentage(done, total)}) done"
363+
return f"{done} of {total} steps ({self._format_percentage(done, total)}) done"
364364

365-
def handle_job_finished(self, msg):
365+
def format_job_finished(self, msg):
366366
"""Format for job_finished log."""
367367
return f"{self.timestamp()} Finished job {msg['jobid']}."
368368

369-
def handle_shellcmd(self, msg):
369+
def format_shellcmd(self, msg):
370370
"""Format for shellcmd log."""
371371
if self.printshellcmds:
372372
return msg["msg"]
373373
return ""
374374

375-
def handle_rule_info(self, msg):
375+
def format_rule_info(self, msg):
376376
"""Format for rule_info log."""
377377
output = [msg["name"]]
378378
if msg["docstring"]:
379379
output.append(f" {msg['docstring']}")
380380
return "\n".join(output)
381381

382-
def handle_d3dag(self, msg):
382+
def format_d3dag(self, msg):
383383
"""Format for d3dag log."""
384384
return json.dumps({"nodes": msg["nodes"], "links": msg["edges"]})
385385

386-
def handle_dag_debug(self, msg):
386+
def format_dag_debug(self, msg):
387387
"""Format for dag_debug log."""
388388
output = []
389389

@@ -398,7 +398,7 @@ def handle_dag_debug(self, msg):
398398
)
399399
return "\n".join(output)
400400

401-
def format_job_info(self, msg):
401+
def _format_job_info(self, msg):
402402
"""Helper method to format job info details."""
403403

404404
def format_item(item, omit=None, valueformat=str):
@@ -437,7 +437,7 @@ def format_item(item, omit=None, valueformat=str):
437437

438438
return output
439439

440-
def format_job_error(self, msg):
440+
def _format_job_error(self, msg):
441441
"""Helper method to format job error details."""
442442
output = [f"Error in rule {msg['name']}:"]
443443

@@ -467,7 +467,7 @@ def format_job_error(self, msg):
467467

468468
return output
469469

470-
def format_group_error(self, msg):
470+
def _format_group_error(self, msg):
471471
"""Helper method to format group error details."""
472472
output = [f"Error in group {msg['groupid']}:"]
473473

@@ -501,7 +501,7 @@ def timestamp(self):
501501
"""Helper method to format the timestamp."""
502502
return f"[{time.asctime()}]"
503503

504-
def format_percentage(self, done, total):
504+
def _format_percentage(self, done, total):
505505
"""Helper method to format percentage."""
506506
if done == total:
507507
return "100%"

0 commit comments

Comments
 (0)