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/commands/hook_impl.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
/
commands
/
hook_impl.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
217 lines (192 loc) · 6.87 KB
master
Breadcrumbs
pre-commit
/
pre_commit
/
commands
/
hook_impl.py
Copy path
Top
File metadata and controls
Code
Blame
217 lines (192 loc) · 6.87 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
import
argparse
import
os
.
path
import
subprocess
import
sys
from
typing
import
Optional
from
typing
import
Sequence
from
typing
import
Tuple
from
pre_commit
.
commands
.
run
import
run
from
pre_commit
.
envcontext
import
envcontext
from
pre_commit
.
parse_shebang
import
normalize_cmd
from
pre_commit
.
store
import
Store
Z40
=
'0'
*
40
def
_run_legacy
(
hook_type
:
str
,
hook_dir
:
str
,
args
:
Sequence
[
str
],
)
->
Tuple
[
int
,
bytes
]:
if
os
.
environ
.
get
(
'PRE_COMMIT_RUNNING_LEGACY'
):
raise
SystemExit
(
f"bug: pre-commit's script is installed in migration mode
\n
"
f'run `pre-commit install -f --hook-type
{
hook_type
}
` to fix '
f'this
\n
\n
'
f'Please report this bug at '
f'https://github.com/pre-commit/pre-commit/issues'
,
)
if
hook_type
==
'pre-push'
:
stdin
=
sys
.
stdin
.
buffer
.
read
()
else
:
stdin
=
b''
# not running in legacy mode
legacy_hook
=
os
.
path
.
join
(
hook_dir
,
f'
{
hook_type
}
.legacy'
)
if
not
os
.
access
(
legacy_hook
,
os
.
X_OK
):
return
0
,
stdin
with
envcontext
(((
'PRE_COMMIT_RUNNING_LEGACY'
,
'1'
),)):
cmd
=
normalize_cmd
((
legacy_hook
,
*
args
))
return
subprocess
.
run
(
cmd
,
input
=
stdin
).
returncode
,
stdin
def
_validate_config
(
retv
:
int
,
config
:
str
,
skip_on_missing_config
:
bool
,
)
->
None
:
if
not
os
.
path
.
isfile
(
config
):
if
skip_on_missing_config
or
os
.
getenv
(
'PRE_COMMIT_ALLOW_NO_CONFIG'
):
print
(
f'`
{
config
}
` config file not found. Skipping `pre-commit`.'
)
raise
SystemExit
(
retv
)
else
:
print
(
f'No
{
config
}
file was found
\n
'
f'- To temporarily silence this, run '
f'`PRE_COMMIT_ALLOW_NO_CONFIG=1 git ...`
\n
'
f'- To permanently silence this, install pre-commit with the '
f'--allow-missing-config option
\n
'
f'- To uninstall pre-commit run `pre-commit uninstall`'
,
)
raise
SystemExit
(
1
)
def
_ns
(
hook_type
:
str
,
color
:
bool
,
*
,
all_files
:
bool
=
False
,
from_ref
:
Optional
[
str
]
=
None
,
to_ref
:
Optional
[
str
]
=
None
,
remote_name
:
Optional
[
str
]
=
None
,
remote_url
:
Optional
[
str
]
=
None
,
commit_msg_filename
:
Optional
[
str
]
=
None
,
checkout_type
:
Optional
[
str
]
=
None
,
)
->
argparse
.
Namespace
:
return
argparse
.
Namespace
(
color
=
color
,
hook_stage
=
hook_type
.
replace
(
'pre-'
,
''
),
from_ref
=
from_ref
,
to_ref
=
to_ref
,
remote_name
=
remote_name
,
remote_url
=
remote_url
,
commit_msg_filename
=
commit_msg_filename
,
all_files
=
all_files
,
checkout_type
=
checkout_type
,
files
=
(),
hook
=
None
,
verbose
=
False
,
show_diff_on_failure
=
False
,
)
def
_rev_exists
(
rev
:
str
)
->
bool
:
return
not
subprocess
.
call
((
'git'
,
'rev-list'
,
'--quiet'
,
rev
))
def
_pre_push_ns
(
color
:
bool
,
args
:
Sequence
[
str
],
stdin
:
bytes
,
)
->
Optional
[
argparse
.
Namespace
]:
remote_name
=
args
[
0
]
remote_url
=
args
[
1
]
for
line
in
stdin
.
decode
().
splitlines
():
_
,
local_sha
,
_
,
remote_sha
=
line
.
split
()
if
local_sha
==
Z40
:
continue
elif
remote_sha
!=
Z40
and
_rev_exists
(
remote_sha
):
return
_ns
(
'pre-push'
,
color
,
from_ref
=
remote_sha
,
to_ref
=
local_sha
,
remote_name
=
remote_name
,
remote_url
=
remote_url
,
)
else
:
# ancestors not found in remote
ancestors
=
subprocess
.
check_output
((
'git'
,
'rev-list'
,
local_sha
,
'--topo-order'
,
'--reverse'
,
'--not'
,
f'--remotes=
{
remote_name
}
'
,
)).
decode
().
strip
()
if
not
ancestors
:
continue
else
:
first_ancestor
=
ancestors
.
splitlines
()[
0
]
cmd
=
(
'git'
,
'rev-list'
,
'--max-parents=0'
,
local_sha
)
roots
=
set
(
subprocess
.
check_output
(
cmd
).
decode
().
splitlines
())
if
first_ancestor
in
roots
:
# pushing the whole tree including root commit
return
_ns
(
'pre-push'
,
color
,
all_files
=
True
,
remote_name
=
remote_name
,
remote_url
=
remote_url
,
)
else
:
rev_cmd
=
(
'git'
,
'rev-parse'
,
f'
{
first_ancestor
}
^'
)
source
=
subprocess
.
check_output
(
rev_cmd
).
decode
().
strip
()
return
_ns
(
'pre-push'
,
color
,
from_ref
=
source
,
to_ref
=
local_sha
,
remote_name
=
remote_name
,
remote_url
=
remote_url
,
)
# nothing to push
return
None
_EXPECTED_ARG_LENGTH_BY_HOOK
=
{
'commit-msg'
:
1
,
'post-checkout'
:
3
,
'post-commit'
:
0
,
'pre-commit'
:
0
,
'pre-merge-commit'
:
0
,
'pre-push'
:
2
,
}
def
_check_args_length
(
hook_type
:
str
,
args
:
Sequence
[
str
])
->
None
:
if
hook_type
==
'prepare-commit-msg'
:
if
len
(
args
)
<
1
or
len
(
args
)
>
3
:
raise
SystemExit
(
f'hook-impl for
{
hook_type
}
expected 1, 2, or 3 arguments '
f'but got
{
len
(
args
)
}
:
{
args
}
'
,
)
elif
hook_type
in
_EXPECTED_ARG_LENGTH_BY_HOOK
:
expected
=
_EXPECTED_ARG_LENGTH_BY_HOOK
[
hook_type
]
if
len
(
args
)
!=
expected
:
arguments_s
=
'argument'
if
expected
==
1
else
'arguments'
raise
SystemExit
(
f'hook-impl for
{
hook_type
}
expected
{
expected
}
{
arguments_s
}
'
f'but got
{
len
(
args
)
}
:
{
args
}
'
,
)
else
:
raise
AssertionError
(
f'unexpected hook type:
{
hook_type
}
'
)
def
_run_ns
(
hook_type
:
str
,
color
:
bool
,
args
:
Sequence
[
str
],
stdin
:
bytes
,
)
->
Optional
[
argparse
.
Namespace
]:
_check_args_length
(
hook_type
,
args
)
if
hook_type
==
'pre-push'
:
return
_pre_push_ns
(
color
,
args
,
stdin
)
elif
hook_type
in
{
'commit-msg'
,
'prepare-commit-msg'
}:
return
_ns
(
hook_type
,
color
,
commit_msg_filename
=
args
[
0
])
elif
hook_type
in
{
'post-commit'
,
'pre-merge-commit'
,
'pre-commit'
}:
return
_ns
(
hook_type
,
color
)
elif
hook_type
==
'post-checkout'
:
return
_ns
(
hook_type
,
color
,
from_ref
=
args
[
0
],
to_ref
=
args
[
1
],
checkout_type
=
args
[
2
],
)
else
:
raise
AssertionError
(
f'unexpected hook type:
{
hook_type
}
'
)
def
hook_impl
(
store
:
Store
,
*
,
config
:
str
,
color
:
bool
,
hook_type
:
str
,
hook_dir
:
str
,
skip_on_missing_config
:
bool
,
args
:
Sequence
[
str
],
)
->
int
:
retv
,
stdin
=
_run_legacy
(
hook_type
,
hook_dir
,
args
)
_validate_config
(
retv
,
config
,
skip_on_missing_config
)
ns
=
_run_ns
(
hook_type
,
color
,
args
,
stdin
)
if
ns
is
None
:
return
retv
else
:
return
retv
|
run
(
config
,
store
,
ns
)
You can’t perform that action at this time.