summaryrefslogtreecommitdiffstats
path: root/gitlint-core/gitlint/shell.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-19 14:52:46 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-19 14:52:46 +0000
commita2aa51f5702b18016c25d943499941323952704d (patch)
tree7ee43f79639ee53903e7ca389e548974e1497c3a /gitlint-core/gitlint/shell.py
parentAdding upstream version 0.17.0. (diff)
downloadgitlint-a2aa51f5702b18016c25d943499941323952704d.tar.xz
gitlint-a2aa51f5702b18016c25d943499941323952704d.zip
Adding upstream version 0.18.0.upstream/0.18.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'gitlint-core/gitlint/shell.py')
-rw-r--r--gitlint-core/gitlint/shell.py30
1 files changed, 16 insertions, 14 deletions
diff --git a/gitlint-core/gitlint/shell.py b/gitlint-core/gitlint/shell.py
index 365c65d..c378c1c 100644
--- a/gitlint-core/gitlint/shell.py
+++ b/gitlint-core/gitlint/shell.py
@@ -1,4 +1,3 @@
-
"""
This module implements a shim for the 'sh' library, mainly for use on Windows (sh is not supported on Windows).
We might consider removing the 'sh' dependency altogether in the future, but 'sh' does provide a few
@@ -10,26 +9,28 @@ from gitlint.utils import USE_SH_LIB, DEFAULT_ENCODING
def shell(cmd):
- """ Convenience function that opens a given command in a shell. Does not use 'sh' library. """
+ """Convenience function that opens a given command in a shell. Does not use 'sh' library."""
with subprocess.Popen(cmd, shell=True) as p:
p.communicate()
if USE_SH_LIB:
from sh import git # pylint: disable=unused-import,import-error
+
# import exceptions separately, this makes it a little easier to mock them out in the unit tests
from sh import CommandNotFound, ErrorReturnCode # pylint: disable=import-error
else:
class CommandNotFound(Exception):
- """ Exception indicating a command was not found during execution """
+ """Exception indicating a command was not found during execution"""
+
pass
class ShResult:
- """ Result wrapper class. We use this to more easily migrate from using https://amoffat.github.io/sh/ to using
- the builtin subprocess module """
+ """Result wrapper class. We use this to more easily migrate from using https://amoffat.github.io/sh/ to using
+ the builtin subprocess module"""
- def __init__(self, full_cmd, stdout, stderr='', exitcode=0):
+ def __init__(self, full_cmd, stdout, stderr="", exitcode=0):
self.full_cmd = full_cmd
self.stdout = stdout
self.stderr = stderr
@@ -39,22 +40,23 @@ else:
return self.stdout
class ErrorReturnCode(ShResult, Exception):
- """ ShResult subclass for unexpected results (acts as an exception). """
+ """ShResult subclass for unexpected results (acts as an exception)."""
+
pass
def git(*command_parts, **kwargs):
- """ Git shell wrapper.
+ """Git shell wrapper.
Implemented as separate function here, so we can do a 'sh' style imports:
`from shell import git`
"""
- args = ['git'] + list(command_parts)
+ args = ["git"] + list(command_parts)
return _exec(*args, **kwargs)
def _exec(*args, **kwargs):
pipe = subprocess.PIPE
- popen_kwargs = {'stdout': pipe, 'stderr': pipe, 'shell': kwargs.get('_tty_out', False)}
- if '_cwd' in kwargs:
- popen_kwargs['cwd'] = kwargs['_cwd']
+ popen_kwargs = {"stdout": pipe, "stderr": pipe, "shell": kwargs.get("_tty_out", False)}
+ if "_cwd" in kwargs:
+ popen_kwargs["cwd"] = kwargs["_cwd"]
try:
with subprocess.Popen(args, **popen_kwargs) as p:
@@ -65,10 +67,10 @@ else:
exit_code = p.returncode
stdout = result[0].decode(DEFAULT_ENCODING)
stderr = result[1] # 'sh' does not decode the stderr bytes to unicode
- full_cmd = '' if args is None else ' '.join(args)
+ full_cmd = "" if args is None else " ".join(args)
# If not _ok_code is specified, then only a 0 exit code is allowed
- ok_exit_codes = kwargs.get('_ok_code', [0])
+ ok_exit_codes = kwargs.get("_ok_code", [0])
if exit_code in ok_exit_codes:
return ShResult(full_cmd, stdout, stderr, exit_code)