Prechádzať zdrojové kódy

chore: pylint issues w/ preamble and logging_group

Sam Jaffe 1 mesiac pred
rodič
commit
adf97ad730
1 zmenil súbory, kde vykonal 8 pridanie a 2 odobranie
  1. 8 2
      src/cipy/runner.py

+ 8 - 2
src/cipy/runner.py

@@ -7,9 +7,8 @@ import os
 import tempfile
 
 from contextlib import contextmanager
-from typing import Any, Callable, Iterable, Iterator, TypeVar, overload
+from typing import Any, Callable, Iterator, TypeVar
 
-from colored import Style
 from dotenv import dotenv_values
 
 import cipy.common
@@ -77,12 +76,19 @@ def ipc(func: Run[Action]) -> Run[Action]:
 
 @contextmanager
 def logging_group(self: Action, message: str, *args: Any) -> Iterator[None]:
+    """
+    Create a 'group' for logging messages under, allows for a GUI to apply cleaner formatting
+    """
+
     self.logger.info("##[group] " + message, *args)
     yield
     self.logger.info("##[endgroup]")
 
 
 def preamble(func: Run[Action]):
+    """
+    Log a preamble upon entering this Action.run override, which records the arguments to the Action
+    """
 
     @functools.wraps(func)
     def wrapper(self: Action, context: Context) -> Status: