lint/txt

rwx/log/__init__.py

@@ -1,31 +1,35 @@
+"""Handle logging."""
+
 import logging
 import sys
 
 
 def get_file_logger(name: str) -> logging.Logger:
+    """Return a file logger."""
+    # formatter
     formatter = logging.Formatter(
         "%(name)s: %(asctime)s | %(levelname)s | %(filename)s:%(lineno)s | %(process)d >>> %(message)s",
     )
-    #
+    # handler
     out_handler = logging.StreamHandler(stream=sys.stdout)
     out_handler.setFormatter(formatter)
     out_handler.setLevel(logging.INFO)
-    #
+    # logger
     logger = logging.getLogger(name)
     logger.addHandler(out_handler)
     logger.setLevel(logging.INFO)
-    #
     return logger
 
 
 def get_stream_logger(level: int) -> logging.Logger:
+    """Return a stream logger."""
+    # handler
     out_handler = logging.StreamHandler(stream=sys.stdout)
     out_handler.setLevel(level)
-    #
+    # logger
     logger = logging.getLogger()
     logger.addHandler(out_handler)
     logger.setLevel(level)
-    #
     return logger
 
 

rwx/ps/__init__.py

@@ -1,9 +1,12 @@
+"""Handle processes."""
+
 import subprocess
 
 from rwx import txt
 
 
-def get_tuples_args(tuples) -> list[str]:
+def get_tuples_args(*tuples: tuple[str]) -> list[str]:
+    """Turn arguments tuples into an arguments list."""
     args: list[str] = []
     for item in tuples:
         if type(item) is tuple:
@@ -13,18 +16,21 @@ def get_tuples_args(tuples) -> list[str]:
     return args
 
 
-def run(*tuples) -> subprocess.CompletedProcess:
+def run(*tuples: tuple[str]) -> subprocess.CompletedProcess:
+    """Run from a list of arguments tuples."""
     return subprocess.run(
         get_tuples_args(tuples), capture_output=False, check=True
     )
 
 
-def run_line(*tuples, charset: str = txt.CHARSET) -> str:
+def run_line(*tuples: tuple[str], charset: str = txt.CHARSET) -> str:
+    """Run and return output line."""
     lines = run_lines(*get_tuples_args(tuples), charset=charset)
     return lines[0]
 
 
-def run_lines(*tuples, charset: str = txt.CHARSET) -> list[str]:
+def run_lines(*tuples: tuple[str], charset: str = txt.CHARSET) -> list[str]:
+    """Run and return output lines."""
     process = subprocess.run(
         get_tuples_args(tuples), capture_output=True, check=True
     )

rwx/txt/__init__.py

@@ -1 +1,3 @@
+"""Handle text."""
+
 CHARSET = "UTF-8"