pdmv-http-client 2.1.0__py3-none-any.whl

rest/utils/miscellaneous.py

@@ -0,0 +1,47 @@
+"""
+Other operations that spread to several
+topics and intentions.
+"""
+
+import pprint
+import random
+from copy import deepcopy
+
+
+def pformat(obj) -> str:
+    """
+    Pretty print an object in console
+    """
+    return pprint.pformat(obj, width=50, compact=True)
+
+
+def shuffle_pick(collection: list[dict], size: int, attribute: str = "") -> list:
+    """
+    Given a list of objects, shuffles the collection and picks
+    the requested attribute only for a subset of `size` elements.
+
+    Args:
+        collection: List of objects.
+        size: Subset size.
+        attribute: Attribute to pick from the objects, it is assumed
+            all objects in the collection include it. In case it
+            is not provided, the content of the whole object will
+            be returned.
+
+    Returns:
+        A subset of the original collection, including only the requested
+            attribute.
+
+    Raises:
+        KeyError: In case the request key is not available in the collection's
+            element.
+    """
+    elements = deepcopy(collection)
+    subset_len = min(size, len(elements))
+    random.shuffle(elements)
+    subset = elements[:subset_len]
+
+    if not attribute:
+        return subset
+
+    return [el[attribute] for el in subset]

rest/utils/shell.py

@@ -0,0 +1,57 @@
+"""
+Provides some pure-functions to interact with
+the OS via shell executions.
+"""
+
+import platform
+import subprocess
+import sys
+from typing import Union
+
+
+def run_command(
+    command: Union[str, list[str]], env: dict[str, str] = {}
+) -> tuple[str, str, int]:
+    """
+    Executes a command or a list of commands
+    via shell.
+
+    Args:
+        command: Command to execute, in case a list
+            is provided, the result command to execute will be
+            concatenated.
+        env: Environment variables for the process
+            to spawn.
+
+    Returns:
+        tuple: Standard output, standard error and exit code.
+    """
+    full_command: str = ""
+
+    if isinstance(command, list):
+        full_command = ";".join(command)
+    else:
+        full_command = command
+
+    result = subprocess.run(
+        full_command,
+        shell=True,
+        capture_output=True,
+        text=True,
+        env=env,
+    )
+    stdout: str = result.stdout
+    stderr: str = result.stderr
+    exit_code: int = result.returncode
+    return stdout, stderr, exit_code
+
+
+def describe_platform() -> str:
+    """
+    Retrieves an identifier for describing the current
+    execution environment. This is useful for including
+    User-Agent headers.
+    """
+    version = sys.version_info
+    python_version = f"{version.major}.{version.minor}.{version.micro}"
+    return f"(Python: {python_version}) ({platform.system()}: {platform.machine()})"