Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
pre-commit/pre_commit/util.py at master · precommit/pre-commit · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
precommit
/
pre-commit
Public
forked from
pre-commit/pre-commit
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
master
Breadcrumbs
pre-commit
/
pre_commit
/
util.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
273 lines (219 loc) · 7.96 KB
master
Breadcrumbs
pre-commit
/
pre_commit
/
util.py
Copy path
Top
File metadata and controls
Code
Blame
273 lines (219 loc) · 7.96 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
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
267
268
269
270
271
272
273
import
contextlib
import
errno
import
functools
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
Dict
from
typing
import
Generator
from
typing
import
IO
from
typing
import
Optional
from
typing
import
Tuple
from
typing
import
Type
from
typing
import
Union
import
yaml
from
pre_commit
import
parse_shebang
if
sys
.
version_info
>=
(
3
,
7
):
# pragma: no cover (PY37+)
from
importlib
.
resources
import
open_binary
from
importlib
.
resources
import
read_text
else
:
# pragma: no cover (<PY37)
from
importlib_resources
import
open_binary
from
importlib_resources
import
read_text
EnvironT
=
Union
[
Dict
[
str
,
str
],
'os._Environ'
]
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
open_binary
(
'pre_commit.resources'
,
filename
)
def
resource_text
(
filename
:
str
)
->
str
:
return
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
:
Optional
[
bytes
],
)
->
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
:
Optional
[
bytes
])
->
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
:
Optional
[
int
]
=
0
,
**
kwargs
:
Any
,
)
->
Tuple
[
int
,
bytes
,
Optional
[
bytes
]]:
_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
,
Optional
[
str
]]:
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
:
Optional
[
int
]
=
None
self
.
w
:
Optional
[
int
]
=
None
def
__enter__
(
self
)
->
'Pty'
:
self
.
r
,
self
.
w
=
openpty
()
# tty flags normally change \n to \r\n
attrs
=
termios
.
tcgetattr
(
self
.
r
)
assert
isinstance
(
attrs
[
1
],
int
)
attrs
[
1
]
&=
~
(
termios
.
ONLCR
|
termios
.
OPOST
)
termios
.
tcsetattr
(
self
.
r
,
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
:
Optional
[
Type
[
BaseException
]],
exc_value
:
Optional
[
BaseException
],
traceback
:
Optional
[
TracebackType
],
)
->
None
:
self
.
close_w
()
self
.
close_r
()
def
cmd_output_p
(
*
cmd
:
str
,
retcode
:
Optional
[
int
]
=
0
,
**
kwargs
:
Any
,
)
->
Tuple
[
int
,
bytes
,
Optional
[
bytes
]]:
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
==
errno
.
EACCES
):
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
(
'.'
))
You can’t perform that action at this time.