summaryrefslogtreecommitdiff
path: root/src/tox/execute/request.py
diff options
context:
space:
mode:
authorBernát Gábor <bgabor8@bloomberg.net>2020-10-19 09:29:51 +0100
committerBernát Gábor <bgabor8@bloomberg.net>2020-10-19 09:29:51 +0100
commit61869b12edd970998e235c86fcf72b189445c6eb (patch)
tree2b9bc817bfc28fa6d11ec2bba82dedd065e4aeed /src/tox/execute/request.py
parent860983a992f5b6a613c111b5e1cbfd2a7213bea8 (diff)
downloadtox-git-61869b12edd970998e235c86fcf72b189445c6eb.tar.gz
Improve documentation
Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
Diffstat (limited to 'src/tox/execute/request.py')
-rw-r--r--src/tox/execute/request.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/tox/execute/request.py b/src/tox/execute/request.py
index 9f4fe415..328499b2 100644
--- a/src/tox/execute/request.py
+++ b/src/tox/execute/request.py
@@ -1,13 +1,16 @@
+"""Module declaring a command execution request."""
import sys
from pathlib import Path
from typing import Dict, List, Sequence, Union
class ExecuteRequest:
+ """Defines a commands execution request"""
+
def __init__(self, cmd: Sequence[Union[str, Path]], cwd: Path, env: Dict[str, str], allow_stdin: bool):
if len(cmd) == 0:
raise ValueError("cannot execute an empty command")
- self.cmd = [str(i) for i in cmd] # type: List[str]
+ self.cmd: List[str] = [str(i) for i in cmd]
self.cwd = cwd
self.env = env
self.allow_stdin = allow_stdin