iripau 1.1.1__py3-none-any.whl → 1.1.2__py3-none-any.whl

iripau/executable.py

@@ -10,7 +10,11 @@ from iripau.command import host_run
 
 
 class Command:
-    """ Run an executable command as a Python callable """
+    """ Run an executable command as a Python callable
+
+
+
+    """
 
     def __init__(self, parent, command):
         self._parent = parent
@@ -27,16 +31,63 @@ class Command:
 
 
 def make_command(command):
+    """ Replace underscore with dash.
+
+        Suitable for a CLI that uses dashes as word-separator in their
+        positional arguments.
+
+        Args:
+            command (str): Python identifier referring to a CLI command or
+                sub-command.
+
+        Returns:
+            str: Final token to be used as a CLI positional argument.
+    """
     return command.replace("_", "-")
 
 
 def make_option(option):
+    """ Replace underscore with dash and prepend two more dashes.
+
+        Suitable for a CLI that uses dashes as word-separator in their
+        positional arguments.
+
+        Args:
+            option (str): Python identifier referring to a CLI optional
+                argument.
+
+        Returns:
+            Tuple[str]: The tokens that could be used as a CLI positional argument.
+    """
     return "--" + option.replace("_", "-"),
 
 
 class Executable:
-    """ Run an executable as a Python callable """
-
+    """ Run an executable as a Python callable.
+
+        Args:
+            executable (str): Path to an executable file or just the name if it
+                exists in the ``PATH``.
+            make_command (Callable[[str], str]): Function to convert a Python
+                identifier to the corresponding command positional argument for
+                the CLI.
+            make_option (Callable[str], Tuple[str]): Function to convert a Python
+                identifier into the corresponding optional argument for the CLI.
+                randomly, and 
+            alias (str, list(str)): Alias for ``executable``. See ``alias`` in
+                `iripau.subprocess.Popen`_.
+            run_args_prefix (str): When calling an instance of this class, all
+                of the ``**kwargs`` starting with this prefix will be passed to
+                the ``run_function`` after removing the prefix.
+            run_function (Callable[List[str] *Any], subprocess.CompletedProcess):
+                The function that will actually run the process, wait for it and
+                return a ``CompletedProcess``.
+
+                If ``None``, the default function is `iripau.command.host_run`_.
+            **kwargs: Keyword arguments to be passed to ``run_function`` every
+                time an instance of this object is called.
+                The ``run_args_prefix`` is not needed here.
+    """
     def __init__(
         self, executable, make_command=make_command, make_option=make_option,
         alias=None, run_args_prefix="_", run_function=None, **kwargs
@@ -84,10 +135,27 @@ class Executable:
         return hasattr(value, "__iter__")
 
     @classmethod
-    def _make_arg(cls, options, value=None):
-        """ Return a list of tokens. Randomly choose a short or long option.
-            If a 'value' is given it's appended appropriately.
-            If 'value' is iterable, the option will be repeated for each item.
+    def _make_arg(cls, options, value):
+        """ Return a list of tokens.
+
+            Args:
+                options (Tuple[str]): One of this strings will be randomly chosen.
+
+                    If the chosen option starts with ``--``, there will be a
+                    single token with the option and the value: ``["--option=value"]``
+
+                    If not, there will be two tokens: ``["-o", "value"]``.
+                value: The value of the optional argument for the CLI.
+
+                    If ``True``, the option will be treated as a flag, with no
+                    value: ``["--option"]``.
+
+                    If ``False`` or ``None``, the option will be ignored: ``[]``.
+
+                    If an iterable and not a string, the option will be repeated
+                    for each item: ``["--option=value1", "--option=value2"]
+
+                    Otherwise, it will be converted to a string before using it.
         """
         if cls._is_iterable(value):
             return chain.from_iterable(

iripau/logging.py

@@ -50,8 +50,8 @@ class LoggerFile:
 
 
 class SimpleThreadNameFormatter(logging.Formatter):
-    """ The same logging.Formatter but threadName is just the first token after
-        splitting it: record.threadName.split(maxsplit=1)[0]
+    """ The same ``logging.Formatter`` but threadName is just the first token
+        after splitting it: ``record.threadName.split(maxsplit=1)[0]``.
     """
 
     def format(self, record):

iripau/subprocess.py

@@ -459,17 +459,17 @@ def set_global_echo(value):
 
 def set_global_stdout_files(*files: TeeStream):
     global GLOBAL_STDOUTS
-    GLOBAL_STDOUTS = set(*files)
+    GLOBAL_STDOUTS = set(files)
 
 
 def set_global_stderr_files(*files: TeeStream):
     global GLOBAL_STDERRS
-    GLOBAL_STDERRS = set(*files)
+    GLOBAL_STDERRS = set(files)
 
 
 def set_global_prompt_files(*files: TeeStream):
     global GLOBAL_PROMPTS
-    GLOBAL_PROMPTS = set(*files)
+    GLOBAL_PROMPTS = set(files)
 
 
 def _output_context(kwargs, key, encoding, errors, text):

{iripau-1.1.1.dist-info → iripau-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iripau
-Version: 1.1.1
+Version: 1.1.2
 Summary: Python utilities focused on command execution
 Author: Ricardo Quezada
 Maintainer: Ricardo Quezada

iripau-1.1.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+iripau/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+iripau/executable.py,sha256=aJ1adOGbviQa5IJvLvwlUtK7a9V_k8iDhDLvI29W3mI,5889
+iripau/functools.py,sha256=Jyi0LdOx36Ih6s9TF4aFS3Xk-RW78YE2znB1PBWTAIo,2901
+iripau/logging.py,sha256=SFKHDspnfNL4qEIpZ_3LMXjbjAqdf5o_4lnk8L9Beg8,2551
+iripau/random.py,sha256=zC5GxmBdfVa6nAUZcv5gCLwBpZU3sA1TB71Cn311lHo,1023
+iripau/requests.py,sha256=MIf1I7jhHk3-8R36VpRSng8aoefdsSTHHW11HApmoDw,3108
+iripau/shutil.py,sha256=HwU4sUrStzAZjqbIMK7xm-NfjxMXHZx4lWAjwfBf4rw,2558
+iripau/subprocess.py,sha256=AafUuFNZ8i5Y1PxAIqbYTit5sVwz2t4enSRxYmMtrz4,17681
+iripau/threading.py,sha256=q-a6OuDrz3hg_5u2Q0eMG3hzu_IgGNBfEw-cI_pyaDo,8955
+iripau-1.1.2.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+iripau-1.1.2.dist-info/METADATA,sha256=J0or7nlpcPnXt487qp0oiYKZVimRkUhLgmIft01fhBM,810
+iripau-1.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+iripau-1.1.2.dist-info/top_level.txt,sha256=y2HMFLCoP2EP7kbRIqkyCVIf_YRZfA0cYYLNK28U9cY,7
+iripau-1.1.2.dist-info/RECORD,,

iripau-1.1.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-iripau/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-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=MIf1I7jhHk3-8R36VpRSng8aoefdsSTHHW11HApmoDw,3108
-iripau/shutil.py,sha256=HwU4sUrStzAZjqbIMK7xm-NfjxMXHZx4lWAjwfBf4rw,2558
-iripau/subprocess.py,sha256=mQDLrBgTOEJ_Ueb1nqIbRkrzMlnYWjfXS8kJsspMcsE,17684
-iripau/threading.py,sha256=q-a6OuDrz3hg_5u2Q0eMG3hzu_IgGNBfEw-cI_pyaDo,8955
-iripau-1.1.1.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-iripau-1.1.1.dist-info/METADATA,sha256=7IUERIMs_JNTZKxzuNBLgjqOB_68Pp_gIwoH7Zn4rMI,810
-iripau-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-iripau-1.1.1.dist-info/top_level.txt,sha256=y2HMFLCoP2EP7kbRIqkyCVIf_YRZfA0cYYLNK28U9cY,7
-iripau-1.1.1.dist-info/RECORD,,