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/git.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
/
git.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
197 lines (153 loc) · 6.54 KB
master
Breadcrumbs
pre-commit
/
pre_commit
/
git.py
Copy path
Top
File metadata and controls
Code
Blame
197 lines (153 loc) · 6.54 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
import
logging
import
os
.
path
import
sys
from
typing
import
Dict
from
typing
import
List
from
typing
import
Optional
from
typing
import
Set
from
pre_commit
.
util
import
cmd_output
from
pre_commit
.
util
import
cmd_output_b
from
pre_commit
.
util
import
EnvironT
logger
=
logging
.
getLogger
(
__name__
)
def
zsplit
(
s
:
str
)
->
List
[
str
]:
s
=
s
.
strip
(
'
\0
'
)
if
s
:
return
s
.
split
(
'
\0
'
)
else
:
return
[]
def
no_git_env
(
_env
:
Optional
[
EnvironT
]
=
None
)
->
Dict
[
str
,
str
]:
# Too many bugs dealing with environment variables and GIT:
# https://github.com/pre-commit/pre-commit/issues/300
# In git 2.6.3 (maybe others), git exports GIT_WORK_TREE while running
# pre-commit hooks
# In git 1.9.1 (maybe others), git exports GIT_DIR and GIT_INDEX_FILE
# while running pre-commit hooks in submodules.
# GIT_DIR: Causes git clone to clone wrong thing
# GIT_INDEX_FILE: Causes 'error invalid object ...' during commit
_env
=
_env
if
_env
is
not
None
else
os
.
environ
return
{
k
:
v
for
k
,
v
in
_env
.
items
()
if
not
k
.
startswith
(
'GIT_'
)
or
k
in
{
'GIT_EXEC_PATH'
,
'GIT_SSH'
,
'GIT_SSH_COMMAND'
,
'GIT_SSL_CAINFO'
,
'GIT_SSL_NO_VERIFY'
,
}
}
def
get_root
()
->
str
:
return
cmd_output
(
'git'
,
'rev-parse'
,
'--show-toplevel'
)[
1
].
strip
()
def
get_git_dir
(
git_root
:
str
=
'.'
)
->
str
:
opts
=
(
'--git-common-dir'
,
'--git-dir'
)
_
,
out
,
_
=
cmd_output
(
'git'
,
'rev-parse'
,
*
opts
,
cwd
=
git_root
)
for
line
,
opt
in
zip
(
out
.
splitlines
(),
opts
):
if
line
!=
opt
:
# pragma: no branch (git < 2.5)
return
os
.
path
.
normpath
(
os
.
path
.
join
(
git_root
,
line
))
else
:
raise
AssertionError
(
'unreachable: no git dir'
)
def
get_remote_url
(
git_root
:
str
)
->
str
:
_
,
out
,
_
=
cmd_output
(
'git'
,
'config'
,
'remote.origin.url'
,
cwd
=
git_root
)
return
out
.
strip
()
def
is_in_merge_conflict
()
->
bool
:
git_dir
=
get_git_dir
(
'.'
)
return
(
os
.
path
.
exists
(
os
.
path
.
join
(
git_dir
,
'MERGE_MSG'
))
and
os
.
path
.
exists
(
os
.
path
.
join
(
git_dir
,
'MERGE_HEAD'
))
)
def
parse_merge_msg_for_conflicts
(
merge_msg
:
bytes
)
->
List
[
str
]:
# Conflicted files start with tabs
return
[
line
.
lstrip
(
b'#'
).
strip
().
decode
()
for
line
in
merge_msg
.
splitlines
()
# '#\t' for git 2.4.1
if
line
.
startswith
((
b'
\t
'
,
b'#
\t
'
))
]
def
get_conflicted_files
()
->
Set
[
str
]:
logger
.
info
(
'Checking merge-conflict files only.'
)
# Need to get the conflicted files from the MERGE_MSG because they could
# have resolved the conflict by choosing one side or the other
with
open
(
os
.
path
.
join
(
get_git_dir
(
'.'
),
'MERGE_MSG'
),
'rb'
)
as
f
:
merge_msg
=
f
.
read
()
merge_conflict_filenames
=
parse_merge_msg_for_conflicts
(
merge_msg
)
# This will get the rest of the changes made after the merge.
# If they resolved the merge conflict by choosing a mesh of both sides
# this will also include the conflicted files
tree_hash
=
cmd_output
(
'git'
,
'write-tree'
)[
1
].
strip
()
merge_diff_filenames
=
zsplit
(
cmd_output
(
'git'
,
'diff'
,
'--name-only'
,
'--no-ext-diff'
,
'-z'
,
'-m'
,
tree_hash
,
'HEAD'
,
'MERGE_HEAD'
,
)[
1
],
)
return
set
(
merge_conflict_filenames
)
|
set
(
merge_diff_filenames
)
def
get_staged_files
(
cwd
:
Optional
[
str
]
=
None
)
->
List
[
str
]:
return
zsplit
(
cmd_output
(
'git'
,
'diff'
,
'--staged'
,
'--name-only'
,
'--no-ext-diff'
,
'-z'
,
# Everything except for D
'--diff-filter=ACMRTUXB'
,
cwd
=
cwd
,
)[
1
],
)
def
intent_to_add_files
()
->
List
[
str
]:
_
,
stdout
,
_
=
cmd_output
(
'git'
,
'status'
,
'--porcelain'
,
'-z'
)
parts
=
list
(
reversed
(
zsplit
(
stdout
)))
intent_to_add
=
[]
while
parts
:
line
=
parts
.
pop
()
status
,
filename
=
line
[:
3
],
line
[
3
:]
if
status
[
0
]
in
{
'C'
,
'R'
}:
# renames / moves have an additional arg
parts
.
pop
()
if
status
[
1
]
==
'A'
:
intent_to_add
.
append
(
filename
)
return
intent_to_add
def
get_all_files
()
->
List
[
str
]:
return
zsplit
(
cmd_output
(
'git'
,
'ls-files'
,
'-z'
)[
1
])
def
get_changed_files
(
old
:
str
,
new
:
str
)
->
List
[
str
]:
return
zsplit
(
cmd_output
(
'git'
,
'diff'
,
'--name-only'
,
'--no-ext-diff'
,
'-z'
,
f'
{
old
}
...
{
new
}
'
,
)[
1
],
)
def
head_rev
(
remote
:
str
)
->
str
:
_
,
out
,
_
=
cmd_output
(
'git'
,
'ls-remote'
,
'--exit-code'
,
remote
,
'HEAD'
)
return
out
.
split
()[
0
]
def
has_diff
(
*
args
:
str
,
repo
:
str
=
'.'
)
->
bool
:
cmd
=
(
'git'
,
'diff'
,
'--quiet'
,
'--no-ext-diff'
,
*
args
)
return
cmd_output_b
(
*
cmd
,
cwd
=
repo
,
retcode
=
None
)[
0
]
==
1
def
has_core_hookpaths_set
()
->
bool
:
_
,
out
,
_
=
cmd_output_b
(
'git'
,
'config'
,
'core.hooksPath'
,
retcode
=
None
)
return
bool
(
out
.
strip
())
def
init_repo
(
path
:
str
,
remote
:
str
)
->
None
:
if
os
.
path
.
isdir
(
remote
):
remote
=
os
.
path
.
abspath
(
remote
)
env
=
no_git_env
()
# avoid the user's template so that hooks do not recurse
cmd_output_b
(
'git'
,
'init'
,
'--template='
,
path
,
env
=
env
)
cmd_output_b
(
'git'
,
'remote'
,
'add'
,
'origin'
,
remote
,
cwd
=
path
,
env
=
env
)
def
commit
(
repo
:
str
=
'.'
)
->
None
:
env
=
no_git_env
()
name
,
email
=
'pre-commit'
,
'asottile+pre-commit@umich.edu'
env
[
'GIT_AUTHOR_NAME'
]
=
env
[
'GIT_COMMITTER_NAME'
]
=
name
env
[
'GIT_AUTHOR_EMAIL'
]
=
env
[
'GIT_COMMITTER_EMAIL'
]
=
email
cmd
=
(
'git'
,
'commit'
,
'--no-edit'
,
'--no-gpg-sign'
,
'-n'
,
'-minit'
)
cmd_output_b
(
*
cmd
,
cwd
=
repo
,
env
=
env
)
def
git_path
(
name
:
str
,
repo
:
str
=
'.'
)
->
str
:
_
,
out
,
_
=
cmd_output
(
'git'
,
'rev-parse'
,
'--git-path'
,
name
,
cwd
=
repo
)
return
os
.
path
.
join
(
repo
,
out
.
strip
())
def
check_for_cygwin_mismatch
()
->
None
:
"""See https://github.com/pre-commit/pre-commit/issues/354"""
if
sys
.
platform
in
(
'cygwin'
,
'win32'
):
# pragma: no cover (windows)
is_cygwin_python
=
sys
.
platform
==
'cygwin'
toplevel
=
cmd_output
(
'git'
,
'rev-parse'
,
'--show-toplevel'
)[
1
]
is_cygwin_git
=
toplevel
.
startswith
(
'/'
)
if
is_cygwin_python
^
is_cygwin_git
:
exe_type
=
{
True
:
'(cygwin)'
,
False
:
'(windows)'
}
logger
.
warn
(
f'pre-commit has detected a mix of cygwin python / git
\n
'
f'This combination is not supported, it is likely you will '
f'receive an error later in the program.
\n
'
f'Make sure to use cygwin git+python while using cygwin
\n
'
f'These can be installed through the cygwin installer.
\n
'
f' - python
{
exe_type
[
is_cygwin_python
]
}
\n
'
f' - git
{
exe_type
[
is_cygwin_git
]
}
\n
'
,
)
You can’t perform that action at this time.