1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
# Copyright 2016 Alethea Katherine Flowers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import os
import shlex
import shutil
import subprocess
import sys
from collections.abc import Iterable, Mapping, Sequence
from nox.logger import logger
from nox.popen import DEFAULT_INTERRUPT_TIMEOUT, DEFAULT_TERMINATE_TIMEOUT, popen
if sys.version_info < (3, 8):
from typing_extensions import Literal
else:
from typing import Literal
TYPE_CHECKING = False
if TYPE_CHECKING:
from typing import IO
ExternalType = Literal["error", True, False]
_PLATFORM = sys.platform
class CommandFailed(Exception):
"""Raised when an executed command returns a non-success status code."""
def __init__(self, reason: str | None = None) -> None:
super().__init__(reason)
self.reason = reason
def which(program: str | os.PathLike[str], paths: Sequence[str] | None) -> str:
"""Finds the full path to an executable."""
if paths is not None:
full_path = shutil.which(program, path=os.pathsep.join(paths))
if full_path:
return os.fspath(full_path)
full_path = shutil.which(program)
if full_path:
return os.fspath(full_path)
logger.error(f"Program {program} not found.")
raise CommandFailed(f"Program {program} not found")
def _clean_env(env: Mapping[str, str | None] | None = None) -> dict[str, str] | None:
if env is None:
return None
clean_env = {k: v for k, v in env.items() if v is not None}
# Ensure systemroot is passed down, otherwise Windows will explode.
if _PLATFORM.startswith("win"):
clean_env.setdefault("SYSTEMROOT", os.environ.get("SYSTEMROOT", ""))
return clean_env
def _shlex_join(args: Sequence[str | os.PathLike[str]]) -> str:
return " ".join(shlex.quote(os.fspath(arg)) for arg in args)
def run(
args: Sequence[str | os.PathLike[str]],
*,
env: Mapping[str, str | None] | None = None,
silent: bool = False,
paths: Sequence[str] | None = None,
success_codes: Iterable[int] | None = None,
log: bool = True,
external: ExternalType = False,
stdout: int | IO[str] | None = None,
stderr: int | IO[str] = subprocess.STDOUT,
interrupt_timeout: float | None = DEFAULT_INTERRUPT_TIMEOUT,
terminate_timeout: float | None = DEFAULT_TERMINATE_TIMEOUT,
) -> str | bool:
"""Run a command-line program."""
if success_codes is None:
success_codes = [0]
cmd, args = args[0], args[1:]
full_cmd = f"{cmd} {_shlex_join(args)}"
cmd_path = which(os.fspath(cmd), paths)
str_args = [os.fspath(arg) for arg in args]
if log:
logger.info(full_cmd)
is_external_tool = paths is not None and not any(
cmd_path.startswith(path) for path in paths
)
if is_external_tool:
if external == "error":
logger.error(
f"Error: {cmd} is not installed into the virtualenv, it is located"
f" at {cmd_path}. Pass external=True into run() to explicitly allow"
" this."
)
raise CommandFailed("External program disallowed.")
elif external is False:
logger.warning(
f"Warning: {cmd} is not installed into the virtualenv, it is"
f" located at {cmd_path}. This might cause issues! Pass"
" external=True into run() to silence this message."
)
env = _clean_env(env)
try:
return_code, output = popen(
[cmd_path, *str_args],
silent=silent,
env=env,
stdout=stdout,
stderr=stderr,
interrupt_timeout=interrupt_timeout,
terminate_timeout=terminate_timeout,
)
if return_code not in success_codes:
suffix = ":" if silent else ""
logger.error(
f"Command {full_cmd} failed with exit code {return_code}{suffix}"
)
if silent:
sys.stderr.write(output)
raise CommandFailed(f"Returned code {return_code}")
if output:
logger.output(output)
return output if silent else True
except KeyboardInterrupt:
logger.error("Interrupted...")
raise
|
