various cleanup, adding type annotations, setting up travis CI

Author: jpetrucciani

.circleci/config.yml

@@ -0,0 +1,69 @@
+strictness: veryhigh
+doc-warnings: true
+member-warnings: false
+test-warnings: false
+
+ignore-patterns:
+  - (^|/)\..+
+
+pylint:
+  disable:
+    - anomalous-backslash-in-string
+    - import-error
+    - broad-except
+    - protected-access
+    - unsupported-membership-test
+    - wrong-import-order
+
+  options:
+    max-args: 14
+    max-locals: 100
+    max-returns: 10
+    max-branches: 30
+    max-statements: 180
+    max-parents: 10
+    max-attributes: 12
+    min-public-methods: 0
+    max-public-methods: 20
+    max-module-lines: 2000
+    max-line-length: 100
+
+mccabe:
+  options:
+    max-complexity: 22
+
+pep8:
+  disable:
+    - N802
+    - N807
+    - W503
+  options:
+    max-line-length: 100
+    single-line-if-stmt: n
+
+vulture:
+  run: false
+
+pyroma:
+  run: false
+  disable:
+    - PYR19
+    - PYR16
+
+pep257:
+  disable:
+    - D000
+    - D100
+    - D104
+    - D107
+    - D200
+    - D202
+    - D203
+    - D205
+    - D212
+    - D204
+    - D300
+    - D400
+    - D401
+    - D404
+    - D403

.prospector.yaml

@@ -0,0 +1,22 @@
+dist: xenial
+sudo: false
+language: python
+matrix:
+  include:
+    - python: 3.6
+      env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py37
+install:
+  - pip install tox pipenv
+  - pipenv install
+script: tox
+deploy:
+  provider: pypi
+  user: jacobi
+  skip_existing: true
+  on:
+    branch: master
+    tags: true
+  password:
+    secure: Ykd2RDetnQmlZpXMm3YuaXWbtt5TbuJYcOsppQsmvr2RD59jYjTaoaoQ97TXJCw2luR949JioFG48j+mD3nUQ/heooJrvQLa1Kmf6CNSAd6TM1cy1+pWwx8Wj4KqktCp3tEg+7hcjVh5wUQo6br4zfjKhl8jVwWEqH6DU4evsoeR74sEH/1GVpcDDWglEKxOi90FhcE1iiEqOMPXM/VF5CXpYhxgOzYDY49NRqVQMUnoBsXmSFdOHVNtE/+6mdu/G3mYheKRxq9yXhP6WOYDWKjzT8E4Rf+/AChjSNEkFkBvptODHRJ+2eG+UzNvsMpFgq++Om/7KCTzgYg24OQuj2f/S2QqANWmHQEY+MK/40XczD8eoxaRcZCtG1Q5pFPAQdbNWCQ3ilfQnbdvF5YwtM7vn8QzU9AjTgWYC/GHh84NLrZOx5GG7fO5YsuKJQrXCLVtxYmhJdkL3mQTnVrg287ZUPppBYe5eq6sO1cntcdUlz3CKmsy1JngdoBGARKJYs2gkoy7DcHkTwIT64iffvzfuvOZQIxjrJ+byW2dOB9iDL+XdafNko97BHuCowIqySDq8dAeqBUTB88YcRnn4BnVlZ2c+E0VZAOzzIzJ0Uu3ualAltviuaQNSqHEZPihMicRmHB/yjdJUGAWpLHgMp1aF/fVRi5Aoh7BR4M6VpQ=

.travis.yml

@@ -0,0 +1,44 @@
+bash.py
+=======
+
+.. image:: https://travis-ci.org/jpetrucciani/bash.py.svg?branch=master
+    :target: https://travis-ci.org/jpetrucciani/bash.py
+
+
+.. image:: https://badge.fury.io/py/bash.py.svg
+   :target: https://badge.fury.io/py/bash.py
+   :alt: PyPI version
+
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/ambv/black
+   :alt: Code style: black
+
+
+.. image:: https://img.shields.io/badge/python-3.6+-blue.svg
+   :target: https://www.python.org/downloads/release/python-360/
+   :alt: Python 3.6+ supported
+
+
+An inline Bash script runner, for Python.
+-----------------------------------------
+
+Example Usage
+~~~~~~~~~~~~~
+
+.. code:: pycon
+
+   >>> import bash
+
+   >>> bash.run("echo hi")
+   <BashProcess pid=24108 return_code=0>
+
+   >>> _.output
+   'hi\n'
+
+Installation
+~~~~~~~~~~~~
+
+.. code:: shell
+
+   $ pipenv install bash.py

Dockerfile

@@ -1,8 +1,12 @@
-import os
+"""
+bash.py module
+"""
+import delegator
 import re
+import time
+import json as json_lib
 from shlex import quote as shlex_quote
 
-import delegator
 
 DELEGATOR_MINIMUM_TIMEOUT = 60 * 60 * 60 * 8
 WHICH_BASH = "bash"
@@ -15,7 +19,10 @@
 
 
 class BashProcess:
-    def __init__(self, args, parent, blocking=True):
+    """bash process object"""
+
+    def __init__(self, args, parent: "Bash", blocking: bool = True) -> None:
+        """constructor"""
         # Environ inherents from parent.
 
         # Remember passed-in arguments.
@@ -24,29 +31,55 @@ def __init__(self, args, parent, blocking=True):
 
         # Run the subprocess.
         args = " ".join(args)
+        self.start_time = time.time()
         self.sub = delegator.run(
             f"{self.parent.path} {args}", env=self.parent.environ, block=blocking
         )
+        if blocking:
+            self.elapsed_time = time.time() - self.start_time
 
     @property
-    def output(self):
+    def output(self) -> str:
+        """stdout of the running process"""
         return str(self.sub.out)
 
     @property
-    def ok(self):
+    def err(self) -> str:
+        """stderr of the running process"""
+        return str(self.sub.err)
+
+    @property
+    def json(self) -> dict:
+        """stdout of the running process, converted to a dict if it's json"""
+        return json_lib.loads(str(self.sub.out))
+
+    @property
+    def ok(self) -> bool:
+        """if the process exited with a 0 exit code"""
         return self.sub.ok
 
-    def return_code(self):
+    @property
+    def return_code(self) -> int:
+        """the exit code of the process"""
         return self.sub.return_code
 
-    def __repr__(self):
+    @property
+    def pid(self) -> int:
+        """the process id"""
+        return self.sub.pid
+
+    def __repr__(self) -> str:
+        """string representation of the bash process"""
         return (
             f"<BashProcess pid={self.sub.pid!r} return_code={self.sub.return_code!r}>"
         )
 
 
 class Bash:
+    """an instance of bash"""
+
     def __init__(self, *, path=WHICH_BASH, environ=None, interactive=False):
+        """constructor"""
         self.path = path
         self.interactive = interactive
         self.environ = environ or {}
@@ -57,22 +90,21 @@ def __init__(self, *, path=WHICH_BASH, environ=None, interactive=False):
         self.about = ver_proc.output
 
     @property
-    def version(self):
+    def version(self) -> str:
         """Returns the version number of the Bash-interpreter."""
-        m = re.search(r"\bversion\s+(.+)\b", self.about)
+        matches = re.search(r"\bversion\s+(.+)\b", self.about)
         # ...GNU Bash, version 4.4.19(1)-release ... --> 4.4.19(1)-release
-        if m:
-            return m.group(1)
+        return matches.group(1) if matches else "version_unknown"
 
-    def _exec(self, *args):
+    def _exec(self, *args) -> BashProcess:
+        """execute the bash process as a child of this process"""
         return BashProcess(parent=self, args=args)
 
-    def command(self, script):
-
+    def command(self, script: str) -> BashProcess:
+        """form up the command with shlex and execute"""
         return self._exec(f"-c {shlex_quote(script)}")
 
 
 def run(script=None, **kwargs):
     """Runs the given bash script."""
-    # Run the script.
     return Bash(**kwargs).command(script)

README.md

@@ -0,0 +1,11 @@
+[mypy]
+python_version = 3.6
+disallow_untyped_defs = True
+ignore_missing_imports = True
+warn_unused_ignores = True
+
+
+[flake8]
+ignore = N802,N807,W503
+max-line-length = 100
+max-complexity = 30