iripau 0.1.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

iripau/requests.py

@@ -0,0 +1,81 @@
+"""
+Utilities for the requests module
+"""
+
+import requests
+
+from curlify import to_curl
+
+from iripau.subprocess import TeeStreams, Popen
+
+
+def curlify(
+    response, compressed=False, verify=True, pretty=False,
+    hide_output=False, headers_to_hide=[], headers_to_omit=[],
+    stdout_tees: TeeStreams = [], add_global_stdout_tees=True,
+    stderr_tees: TeeStreams = [], add_global_stderr_tees=True,
+    prompt_tees: TeeStreams = [], add_global_prompt_tees=True,
+    echo=None
+):
+    """ Simulate the request was executed by a curl subprocess.
+        The command and output can be echoed and/or sent to files as described
+        in subprocess.run
+    """
+    request = response.request
+    if headers_to_hide or headers_to_omit:
+        request = request.copy()
+
+        for header in headers_to_omit:
+            if header in request.headers:
+                del request.headers[header]
+
+        for header in headers_to_hide:
+            if header in request.headers:
+                request.headers[header] = "***"
+
+    stdout = hide_output and b"***" or response.content
+    if not stdout.endswith(b"\n"):
+        stdout += b"\n"
+    stderr = ""
+
+    Popen.simulate(
+        cmd=to_curl(request, compressed, verify, pretty),
+        stdout=stdout,
+        stderr=stderr,
+        comment=f"{response.status_code} - {response.reason}",
+        stdout_tees=stdout_tees,
+        stderr_tees=stderr_tees,
+        prompt_tees=prompt_tees,
+        add_global_stdout_tees=add_global_stdout_tees,
+        add_global_stderr_tees=add_global_stderr_tees,
+        add_global_prompt_tees=add_global_prompt_tees,
+        echo=echo
+    )
+
+
+class Session(requests.Session):
+    """ A requests.Session that accepts curlify arguments in the request method """
+
+    def request(
+        self, *args, compressed=False, pretty=False,
+        hide_output=False, headers_to_hide=[], headers_to_omit=[],
+        stdout_tees: TeeStreams = [], add_global_stdout_tees=True,
+        stderr_tees: TeeStreams = [], add_global_stderr_tees=True,
+        prompt_tees: TeeStreams = [], add_global_prompt_tees=True,
+        echo=None, **kwargs
+    ):
+        response = super().request(*args, **kwargs)
+
+        verify = kwargs.get("verify")
+        if verify is None:
+            verify = self.verify
+
+        curlify(
+            response, compressed, verify, pretty,
+            hide_output, headers_to_hide, headers_to_omit,
+            stdout_tees, add_global_stdout_tees,
+            stderr_tees, add_global_stderr_tees,
+            prompt_tees, add_global_prompt_tees,
+            echo
+        )
+        return response

iripau/subprocess.py

@@ -5,7 +5,6 @@ This module relies on the following system utilities being installed:
 * bash
 * kill
 * pstree
-* sudo
 * tee
 """
 
@@ -38,6 +37,7 @@ GLOBAL_PROMPTS = set()
 
 
 TeeStream = Union[io.IOBase, Callable[[], io.IOBase]]
+TeeStreams = Iterable[TeeStream]
 
 
 class PipeFile(SpooledTemporaryFile):
@@ -124,27 +124,21 @@ class Popen(subprocess.Popen):
 
     def __init__(
         self, args, *, cwd=None, env=None, encoding=None, errors=None, text=None,
-        stdout_tees: Iterable[TeeStream] = [], add_global_stdout_tees=True,
-        stderr_tees: Iterable[TeeStream] = [], add_global_stderr_tees=True,
-        prompt_tees: Iterable[TeeStream] = [], add_global_prompt_tees=True,
+        stdout_tees: TeeStreams = [], add_global_stdout_tees=True,
+        stderr_tees: TeeStreams = [], add_global_stderr_tees=True,
+        prompt_tees: TeeStreams = [], add_global_prompt_tees=True,
         echo=None, alias=None, comment=None, **kwargs
     ):
         stdout = kwargs.get("stdout")
         stderr = kwargs.get("stderr")
 
-        stdout_tees, stderr_tees, prompt_tees = self._get_tee_sets(
+        stdout_tees, stderr_tees, prompt_tees, err2out = self._get_tee_sets(
             stdout_tees, add_global_stdout_tees,
             stderr_tees, add_global_stderr_tees,
             prompt_tees, add_global_prompt_tees,
             echo, stdout, stderr
         )
 
-        if stderr is STDOUT:
-            err2out = True
-            stderr_tees = set()
-        else:
-            err2out = False
-
         stdout_fds = {tee.fileno() for tee in stdout_tees}
         stderr_fds = {tee.fileno() for tee in stderr_tees}
         prompt_fds = {tee.fileno() for tee in prompt_tees}
@@ -176,7 +170,7 @@ class Popen(subprocess.Popen):
         self.stderr_process = stderr_process
 
     @staticmethod
-    def _get_tee_files(tees: Iterable[TeeStream]):
+    def _get_tee_files(tees: TeeStreams):
         return set(callable(tee) and tee() or tee for tee in tees)
 
     @classmethod
@@ -218,12 +212,52 @@ class Popen(subprocess.Popen):
             if stderr_tees:
                 stderr_tees.add(sys.stderr)
 
+        if stderr is STDOUT:
+            err2out = True
+            stderr_tees = set()
+        else:
+            err2out = False
+
         return (
             cls._get_tee_files(stdout_tees),
             cls._get_tee_files(stderr_tees),
-            cls._get_tee_files(prompt_tees)
+            cls._get_tee_files(prompt_tees),
+            err2out
+        )
+
+    @classmethod
+    def simulate(
+        cls, cmd, stdout, stderr, encoding=None, errors=None, text=None, comment=None,
+        stdout_tees: TeeStreams = [], add_global_stdout_tees=True,
+        stderr_tees: TeeStreams = [], add_global_stderr_tees=True,
+        prompt_tees: TeeStreams = [], add_global_prompt_tees=True,
+        echo=None
+    ):
+        stdout_tees, stderr_tees, prompt_tees, err2out = cls._get_tee_sets(
+            stdout_tees, add_global_stdout_tees,
+            stderr_tees, add_global_stderr_tees,
+            prompt_tees, add_global_prompt_tees,
+            echo, DEVNULL, DEVNULL
         )
 
+        if not (stdout_tees or stderr_tees or prompt_tees):
+            return
+
+        stdout_fds = {tee.fileno() for tee in stdout_tees}
+        stderr_fds = {tee.fileno() for tee in stderr_tees}
+        prompt_fds = {tee.fileno() for tee in prompt_tees}
+
+        if prompt_fds:
+            stream_prompts(prompt_fds, cmd, None, None, err2out, comment)
+
+        if stdout_fds:
+            with Tee(PIPE, stdout_fds, DEVNULL, encoding, errors, text) as tee:
+                tee.communicate(stdout)
+
+        if stderr_fds:
+            with Tee(PIPE, stderr_fds, DEVNULL, encoding, errors, text) as tee:
+                tee.communicate(stderr)
+
     def get_pids(self):
         """ Return the pid for all of the processes in the tree """
         output = run(
@@ -239,13 +273,13 @@ class Popen(subprocess.Popen):
 
     def terminate_tree(self):
         run(
-            ["sudo", "kill"] + self.get_pids(),
+            ["kill"] + self.get_pids(),
             stdin=DEVNULL, stdout=DEVNULL, stderr=DEVNULL,
         )
 
     def kill_tree(self):
         run(
-            ["sudo", "kill", "-9"] + self.get_pids(),
+            ["kill", "-9"] + self.get_pids(),
             stdin=DEVNULL, stdout=DEVNULL, stderr=DEVNULL,
         )
 
@@ -383,7 +417,7 @@ if subprocess.run(
         stderr=DEVNULL
     ).stdout.splitlines()[-2:]
 
-    def stream_prompts(fds: Iterable[str], cmd, cwd=None, env=None, err2out=False, comment=None):
+    def stream_prompts(fds: Iterable[int], cmd, cwd=None, env=None, err2out=False, comment=None):
         """ Write shell prompt and command into file descriptors fds """
         fds = normalize_outerr_fds(fds)
         custom_env = {"CPS1": PS1, "CPS2": PS2}
@@ -393,7 +427,7 @@ if subprocess.run(
             "(\n"
             "    IFS= read -r \"line\"\n"
             "    echo \"${CPS1@P}${line}\"\n"
-            "    while IFS= read line; do\n"
+            "    while IFS= read -r \"line\"; do\n"
             "        echo \"${CPS2@P}${line}\"\n"
             "    done\n"
             ") | " + quote(Tee.get_cmd(fds - {1}))
@@ -401,7 +435,7 @@ if subprocess.run(
         subprocess.run(
             ["bash", "-c", script],
             text=True,
-            input=shellify(cmd, err2out, comment),
+            input=shellify(cmd, err2out, comment) + "\n",
             stdout=None if 1 in fds else DEVNULL,
             stderr=None if 2 in fds else DEVNULL,
             pass_fds=fds - {1, 2},
@@ -410,7 +444,7 @@ if subprocess.run(
             check=True
         )
 else:  # Use hard-coded PS1 and PS2 strings
-    def stream_prompts(fds: Iterable[str], cmd, cwd=None, env=None, err2out=False, comment=None):
+    def stream_prompts(fds: Iterable[int], cmd, cwd=None, env=None, err2out=False, comment=None):
         """ Write shell prompt and command into file descriptors fds """
         cmd = shellify(cmd, err2out, comment) + "\n"
         input = "$ " + "> ".join(cmd.splitlines(keepends=True))
@@ -450,7 +484,7 @@ def _output_context(kwargs, key, encoding, errors, text):
 
 def run(
     args, *, input=None, capture_output=False, timeout=None, check=False,
-    encoding=None, errors=None, text=None, sigterm_timeout=10, **kwargs
+    encoding=None, errors=None, text=None, sigterm_timeout=10, comment=None, **kwargs
 ):
     """ A subprocess.run that instantiates this module's Popen """
     if input is not None:
@@ -464,7 +498,7 @@ def run(
         kwargs["stdout"] = FILE
         kwargs["stderr"] = FILE
 
-    comment = f"timeout={timeout}" if timeout else None
+    comment = " ".join((comment or "", f"timeout={timeout}" if timeout else "")).strip()
     with (
         _output_context(kwargs, "stdout", encoding, errors, text) as stdout_file,
         _output_context(kwargs, "stderr", encoding, errors, text) as stderr_file,

{iripau-0.1.0.dist-info → iripau-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iripau
-Version: 0.1.0
+Version: 1.1.0
 Summary: Python utilities focused on command execution
 Author: Ricardo Quezada
 Maintainer: Ricardo Quezada
@@ -9,11 +9,12 @@ Project-URL: Repository, https://github.com/ricardo-galo/iripau
 Project-URL: Bug Tracker, https://github.com/ricardo-galo/iripau/issues
 Project-URL: Changelog, https://github.com/ricardo-galo/iripau/blob/master/CHANGELOG.md
 Keywords: subprocess,command,local,remote,ssh,Linux,real-time,log,logging,threading,utilities
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: curlify
 Requires-Dist: psutil
 Dynamic: license-file
 

{iripau-0.1.0.dist-info → iripau-1.1.0.dist-info}/RECORD

@@ -3,11 +3,12 @@ iripau/executable.py,sha256=W00UNJfMWwZ7cZkEvppwVWy8GaGfbr36eRx0BwaI6mA,3109
 iripau/functools.py,sha256=Jyi0LdOx36Ih6s9TF4aFS3Xk-RW78YE2znB1PBWTAIo,2901
 iripau/logging.py,sha256=dA-69y5MN8a_c95e_DOlULO0tc7t267okFi9iqJzrmg,2542
 iripau/random.py,sha256=zC5GxmBdfVa6nAUZcv5gCLwBpZU3sA1TB71Cn311lHo,1023
+iripau/requests.py,sha256=BJIlz2UzB7wNEHx0IZ-BF1UNfmRxXBhRaW86HBO0jII,2597
 iripau/shutil.py,sha256=HwU4sUrStzAZjqbIMK7xm-NfjxMXHZx4lWAjwfBf4rw,2558
-iripau/subprocess.py,sha256=T4BF5pdvLo8bhLccA1Oy8p0VZSoHvWD1YWSJpxYry4E,16358
+iripau/subprocess.py,sha256=mQDLrBgTOEJ_Ueb1nqIbRkrzMlnYWjfXS8kJsspMcsE,17684
 iripau/threading.py,sha256=q-a6OuDrz3hg_5u2Q0eMG3hzu_IgGNBfEw-cI_pyaDo,8955
-iripau-0.1.0.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-iripau-0.1.0.dist-info/METADATA,sha256=yzxsS5gTUZDFlqfTDlU_Nqjk4jXwBuZ3A9cXh2Q4mnY,774
-iripau-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-iripau-0.1.0.dist-info/top_level.txt,sha256=y2HMFLCoP2EP7kbRIqkyCVIf_YRZfA0cYYLNK28U9cY,7
-iripau-0.1.0.dist-info/RECORD,,
+iripau-1.1.0.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+iripau-1.1.0.dist-info/METADATA,sha256=U60idKE5l07kZz3VlMhNPWoHXZsco1DdkpKGGCgGqC0,810
+iripau-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+iripau-1.1.0.dist-info/top_level.txt,sha256=y2HMFLCoP2EP7kbRIqkyCVIf_YRZfA0cYYLNK28U9cY,7
+iripau-1.1.0.dist-info/RECORD,,