GeezerVison is showing github.com — pre-commit/pre_commit/util.py at main · arshdeepkumar482/pre-commit

Expand file tree

util.py

Copy path

More file actions

Latest commit

History

266 lines (211 loc) · 7.67 KB

util.py

Copy path

File metadata and controls

266 lines (211 loc) · 7.67 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

from __future__ import annotations

import contextlib

import errno

import functools

import importlib.resources

import os.path

import shutil

import stat

import subprocess

import sys

import tempfile

from types import TracebackType

from typing import Any

from typing import Callable

from typing import Generator

from typing import IO

import yaml

from pre_commit import parse_shebang

Loader = getattr(yaml, 'CSafeLoader', yaml.SafeLoader)

yaml_load = functools.partial(yaml.load, Loader=Loader)

Dumper = getattr(yaml, 'CSafeDumper', yaml.SafeDumper)

def yaml_dump(o: Any, **kwargs: Any) -> str:

# when python/mypy#1484 is solved, this can be `functools.partial`

return yaml.dump(

o, Dumper=Dumper, default_flow_style=False, indent=4, sort_keys=False,

**kwargs,

)

def force_bytes(exc: Any) -> bytes:

with contextlib.suppress(TypeError):

return bytes(exc)

with contextlib.suppress(Exception):

return str(exc).encode()

return f'<unprintable {type(exc).__name__} object>'.encode()

@contextlib.contextmanager

def clean_path_on_failure(path: str) -> Generator[None, None, None]:

"""Cleans up the directory on an exceptional failure."""

try:

yield

except BaseException:

if os.path.exists(path):

rmtree(path)

raise

@contextlib.contextmanager

def tmpdir() -> Generator[str, None, None]:

"""Contextmanager to create a temporary directory. It will be cleaned up

afterwards.

"""

tempdir = tempfile.mkdtemp()

try:

yield tempdir

finally:

rmtree(tempdir)

def resource_bytesio(filename: str) -> IO[bytes]:

return importlib.resources.open_binary('pre_commit.resources', filename)

def resource_text(filename: str) -> str:

return importlib.resources.read_text('pre_commit.resources', filename)

def make_executable(filename: str) -> None:

original_mode = os.stat(filename).st_mode

new_mode = original_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH

os.chmod(filename, new_mode)

class CalledProcessError(RuntimeError):

def __init__(

self,

returncode: int,

cmd: tuple[str, ...],

expected_returncode: int,

stdout: bytes,

stderr: bytes | None,

) -> None:

super().__init__(returncode, cmd, expected_returncode, stdout, stderr)

self.returncode = returncode

self.cmd = cmd

self.expected_returncode = expected_returncode

self.stdout = stdout

self.stderr = stderr

def __bytes__(self) -> bytes:

def _indent_or_none(part: bytes | None) -> bytes:

if part:

return b'\n ' + part.replace(b'\n', b'\n ')

else:

return b' (none)'

return b''.join((

f'command: {self.cmd!r}\n'.encode(),

f'return code: {self.returncode}\n'.encode(),

f'expected return code: {self.expected_returncode}\n'.encode(),

b'stdout:', _indent_or_none(self.stdout), b'\n',

b'stderr:', _indent_or_none(self.stderr),

))

def __str__(self) -> str:

return self.__bytes__().decode()

def _setdefault_kwargs(kwargs: dict[str, Any]) -> None:

for arg in ('stdin', 'stdout', 'stderr'):

kwargs.setdefault(arg, subprocess.PIPE)

def _oserror_to_output(e: OSError) -> tuple[int, bytes, None]:

return 1, force_bytes(e).rstrip(b'\n') + b'\n', None

def cmd_output_b(

*cmd: str,

retcode: int | None = 0,

**kwargs: Any,

) -> tuple[int, bytes, bytes | None]:

_setdefault_kwargs(kwargs)

try:

cmd = parse_shebang.normalize_cmd(cmd)

except parse_shebang.ExecutableNotFoundError as e:

returncode, stdout_b, stderr_b = e.to_output()

else:

try:

proc = subprocess.Popen(cmd, **kwargs)

except OSError as e:

returncode, stdout_b, stderr_b = _oserror_to_output(e)

else:

stdout_b, stderr_b = proc.communicate()

returncode = proc.returncode

if retcode is not None and retcode != returncode:

raise CalledProcessError(returncode, cmd, retcode, stdout_b, stderr_b)

return returncode, stdout_b, stderr_b

def cmd_output(*cmd: str, **kwargs: Any) -> tuple[int, str, str | None]:

returncode, stdout_b, stderr_b = cmd_output_b(*cmd, **kwargs)

stdout = stdout_b.decode() if stdout_b is not None else None

stderr = stderr_b.decode() if stderr_b is not None else None

return returncode, stdout, stderr

if os.name != 'nt': # pragma: win32 no cover

from os import openpty

import termios

class Pty:

def __init__(self) -> None:

self.r: int | None = None

self.w: int | None = None

def __enter__(self) -> Pty:

self.r, self.w = openpty()

# tty flags normally change \n to \r\n

attrs = termios.tcgetattr(self.w)

assert isinstance(attrs[1], int)

attrs[1] &= ~(termios.ONLCR | termios.OPOST)

termios.tcsetattr(self.w, termios.TCSANOW, attrs)

return self

def close_w(self) -> None:

if self.w is not None:

os.close(self.w)

self.w = None

def close_r(self) -> None:

assert self.r is not None

os.close(self.r)

self.r = None

def __exit__(

self,

exc_type: type[BaseException] | None,

exc_value: BaseException | None,

traceback: TracebackType | None,

) -> None:

self.close_w()

self.close_r()

def cmd_output_p(

*cmd: str,

retcode: int | None = 0,

**kwargs: Any,

) -> tuple[int, bytes, bytes | None]:

assert retcode is None

assert kwargs['stderr'] == subprocess.STDOUT, kwargs['stderr']

_setdefault_kwargs(kwargs)

try:

cmd = parse_shebang.normalize_cmd(cmd)

except parse_shebang.ExecutableNotFoundError as e:

return e.to_output()

with open(os.devnull) as devnull, Pty() as pty:

assert pty.r is not None

kwargs.update({'stdin': devnull, 'stdout': pty.w, 'stderr': pty.w})

try:

proc = subprocess.Popen(cmd, **kwargs)

except OSError as e:

return _oserror_to_output(e)

pty.close_w()

buf = b''

while True:

try:

bts = os.read(pty.r, 4096)

except OSError as e:

if e.errno == errno.EIO:

bts = b''

else:

raise

else:

buf += bts

if not bts:

break

return proc.wait(), buf, None

else: # pragma: no cover

cmd_output_p = cmd_output_b

def rmtree(path: str) -> None:

"""On windows, rmtree fails for readonly dirs."""

def handle_remove_readonly(

func: Callable[..., Any],

path: str,

exc: tuple[type[OSError], OSError, TracebackType],

) -> None:

excvalue = exc[1]

if (

func in (os.rmdir, os.remove, os.unlink) and

excvalue.errno in {errno.EACCES, errno.EPERM}

for p in (path, os.path.dirname(path)):

os.chmod(p, os.stat(p).st_mode | stat.S_IWUSR)

func(path)

else:

raise

shutil.rmtree(path, ignore_errors=False, onerror=handle_remove_readonly)

def parse_version(s: str) -> tuple[int, ...]:

"""poor man's version comparison"""

return tuple(int(p) for p in s.split('.'))

def win_exe(s: str) -> str:

return s if sys.platform != 'win32' else f'{s}.exe'