doc/ps

rwx/ps/__init__.py

@@ -9,13 +9,22 @@ class Command(Class):
     """Command to run."""
 
     def __init__(self, *arguments: str | tuple[str, ...]) -> None:
-        """Set raw & flat arguments."""
+        """Set raw & flat arguments.
+
+        :param *arguments: single argument or grouped ones
+        :type *arguments: str | tuple[str, ...]
+        """
         self.raw = arguments
         self.flat: list[str] = []
 
 
 def get_tuples_args(*items: str | tuple[str, ...]) -> list[str]:
-    """Turn arguments tuples into an arguments list."""
+    """Turn arguments tuples into an arguments list.
+
+    :param *items: single item or grouped ones
+    :type *items: str | tuple[str, ...]
+    :rtype: list[str]
+    """
     args: list[str] = []
     for item in items:
         match item:
@@ -27,14 +36,26 @@ def get_tuples_args(*items: str | tuple[str, ...]) -> list[str]:
 
 
 def run(*items: str | tuple[str, ...]) -> subprocess.CompletedProcess:
-    """Run from a list of arguments tuples."""
+    """Run from a list of arguments tuples.
+
+    :param *items: single item or grouped ones
+    :type *items: str | tuple[str, ...]
+    :rtype: subprocess.CompletedProcess
+    """
     return subprocess.run(
         get_tuples_args(*items), capture_output=False, check=True
     )
 
 
 def run_line(*items: str | tuple[str, ...], charset: str = txt.CHARSET) -> str:
-    """Run and return output line."""
+    """Run and return output line.
+
+    :param *items: single item or grouped ones
+    :type *items: str | tuple[str, ...]
+    :param charset: charset to use for decoding binary output
+    :type charset: str
+    :rtype: str
+    """
     line, *_ = run_lines(*items, charset=charset)
     return line
 
@@ -42,7 +63,14 @@ def run_line(*items: str | tuple[str, ...], charset: str = txt.CHARSET) -> str:
 def run_lines(
     *items: str | tuple[str, ...], charset: str = txt.CHARSET
 ) -> list[str]:
-    """Run and return output lines."""
+    """Run and return output lines.
+
+    :param *items: single item or grouped ones
+    :type *items: str | tuple[str, ...]
+    :param charset: charset to use for decoding binary output
+    :type charset: str
+    :rtype: list[str]
+    """
     process = subprocess.run(
         get_tuples_args(*items), capture_output=True, check=True
     )