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/repository.py at allow_ci_key · 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
allow_ci_key
Breadcrumbs
pre-commit
/
pre_commit
/
repository.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
208 lines (170 loc) · 6.49 KB
allow_ci_key
Breadcrumbs
pre-commit
/
pre_commit
/
repository.py
Copy path
Top
File metadata and controls
Code
Blame
208 lines (170 loc) · 6.49 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
import
json
import
logging
import
os
from
typing
import
Any
from
typing
import
Dict
from
typing
import
List
from
typing
import
Optional
from
typing
import
Sequence
from
typing
import
Set
from
typing
import
Tuple
import
pre_commit
.
constants
as
C
from
pre_commit
.
clientlib
import
load_manifest
from
pre_commit
.
clientlib
import
LOCAL
from
pre_commit
.
clientlib
import
META
from
pre_commit
.
hook
import
Hook
from
pre_commit
.
languages
.
all
import
languages
from
pre_commit
.
languages
.
helpers
import
environment_dir
from
pre_commit
.
prefix
import
Prefix
from
pre_commit
.
store
import
Store
from
pre_commit
.
util
import
parse_version
from
pre_commit
.
util
import
rmtree
logger
=
logging
.
getLogger
(
'pre_commit'
)
def
_state
(
additional_deps
:
Sequence
[
str
])
->
object
:
return
{
'additional_dependencies'
:
sorted
(
additional_deps
)}
def
_state_filename
(
prefix
:
Prefix
,
venv
:
str
)
->
str
:
return
prefix
.
path
(
venv
,
f'.install_state_v
{
C
.
INSTALLED_STATE_VERSION
}
'
)
def
_read_state
(
prefix
:
Prefix
,
venv
:
str
)
->
Optional
[
object
]:
filename
=
_state_filename
(
prefix
,
venv
)
if
not
os
.
path
.
exists
(
filename
):
return
None
else
:
with
open
(
filename
)
as
f
:
return
json
.
load
(
f
)
def
_write_state
(
prefix
:
Prefix
,
venv
:
str
,
state
:
object
)
->
None
:
state_filename
=
_state_filename
(
prefix
,
venv
)
staging
=
f'
{
state_filename
}
staging'
with
open
(
staging
,
'w'
)
as
state_file
:
state_file
.
write
(
json
.
dumps
(
state
))
# Move the file into place atomically to indicate we've installed
os
.
rename
(
staging
,
state_filename
)
def
_hook_installed
(
hook
:
Hook
)
->
bool
:
lang
=
languages
[
hook
.
language
]
venv
=
environment_dir
(
lang
.
ENVIRONMENT_DIR
,
hook
.
language_version
)
return
(
venv
is
None
or
(
(
_read_state
(
hook
.
prefix
,
venv
)
==
_state
(
hook
.
additional_dependencies
)
)
and
lang
.
healthy
(
hook
.
prefix
,
hook
.
language_version
)
)
)
def
_hook_install
(
hook
:
Hook
)
->
None
:
logger
.
info
(
f'Installing environment for
{
hook
.
src
}
.'
)
logger
.
info
(
'Once installed this environment will be reused.'
)
logger
.
info
(
'This may take a few minutes...'
)
lang
=
languages
[
hook
.
language
]
assert
lang
.
ENVIRONMENT_DIR
is
not
None
venv
=
environment_dir
(
lang
.
ENVIRONMENT_DIR
,
hook
.
language_version
)
# There's potentially incomplete cleanup from previous runs
# Clean it up!
if
hook
.
prefix
.
exists
(
venv
):
rmtree
(
hook
.
prefix
.
path
(
venv
))
lang
.
install_environment
(
hook
.
prefix
,
hook
.
language_version
,
hook
.
additional_dependencies
,
)
# Write our state to indicate we're installed
_write_state
(
hook
.
prefix
,
venv
,
_state
(
hook
.
additional_dependencies
))
def
_hook
(
*
hook_dicts
:
Dict
[
str
,
Any
],
root_config
:
Dict
[
str
,
Any
],
)
->
Dict
[
str
,
Any
]:
ret
,
rest
=
dict
(
hook_dicts
[
0
]),
hook_dicts
[
1
:]
for
dct
in
rest
:
ret
.
update
(
dct
)
version
=
ret
[
'minimum_pre_commit_version'
]
if
parse_version
(
version
)
>
parse_version
(
C
.
VERSION
):
logger
.
error
(
f'The hook `
{
ret
[
"id"
]
}
` requires pre-commit version
{
version
}
'
f'but version
{
C
.
VERSION
}
is installed. '
f'Perhaps run `pip install --upgrade pre-commit`.'
,
)
exit
(
1
)
lang
=
ret
[
'language'
]
if
ret
[
'language_version'
]
==
C
.
DEFAULT
:
ret
[
'language_version'
]
=
root_config
[
'default_language_version'
][
lang
]
if
ret
[
'language_version'
]
==
C
.
DEFAULT
:
ret
[
'language_version'
]
=
languages
[
lang
].
get_default_version
()
if
not
ret
[
'stages'
]:
ret
[
'stages'
]
=
root_config
[
'default_stages'
]
return
ret
def
_non_cloned_repository_hooks
(
repo_config
:
Dict
[
str
,
Any
],
store
:
Store
,
root_config
:
Dict
[
str
,
Any
],
)
->
Tuple
[
Hook
, ...]:
def
_prefix
(
language_name
:
str
,
deps
:
Sequence
[
str
])
->
Prefix
:
language
=
languages
[
language_name
]
# pygrep / script / system / docker_image do not have
# environments so they work out of the current directory
if
language
.
ENVIRONMENT_DIR
is
None
:
return
Prefix
(
os
.
getcwd
())
else
:
return
Prefix
(
store
.
make_local
(
deps
))
return
tuple
(
Hook
.
create
(
repo_config
[
'repo'
],
_prefix
(
hook
[
'language'
],
hook
[
'additional_dependencies'
]),
_hook
(
hook
,
root_config
=
root_config
),
)
for
hook
in
repo_config
[
'hooks'
]
)
def
_cloned_repository_hooks
(
repo_config
:
Dict
[
str
,
Any
],
store
:
Store
,
root_config
:
Dict
[
str
,
Any
],
)
->
Tuple
[
Hook
, ...]:
repo
,
rev
=
repo_config
[
'repo'
],
repo_config
[
'rev'
]
manifest_path
=
os
.
path
.
join
(
store
.
clone
(
repo
,
rev
),
C
.
MANIFEST_FILE
)
by_id
=
{
hook
[
'id'
]:
hook
for
hook
in
load_manifest
(
manifest_path
)}
for
hook
in
repo_config
[
'hooks'
]:
if
hook
[
'id'
]
not
in
by_id
:
logger
.
error
(
f'`
{
hook
[
"id"
]
}
` is not present in repository
{
repo
}
. '
f'Typo? Perhaps it is introduced in a newer version? '
f'Often `pre-commit autoupdate` fixes this.'
,
)
exit
(
1
)
hook_dcts
=
[
_hook
(
by_id
[
hook
[
'id'
]],
hook
,
root_config
=
root_config
)
for
hook
in
repo_config
[
'hooks'
]
]
return
tuple
(
Hook
.
create
(
repo_config
[
'repo'
],
Prefix
(
store
.
clone
(
repo
,
rev
,
hook
[
'additional_dependencies'
])),
hook
,
)
for
hook
in
hook_dcts
)
def
_repository_hooks
(
repo_config
:
Dict
[
str
,
Any
],
store
:
Store
,
root_config
:
Dict
[
str
,
Any
],
)
->
Tuple
[
Hook
, ...]:
if
repo_config
[
'repo'
]
in
{
LOCAL
,
META
}:
return
_non_cloned_repository_hooks
(
repo_config
,
store
,
root_config
)
else
:
return
_cloned_repository_hooks
(
repo_config
,
store
,
root_config
)
def
install_hook_envs
(
hooks
:
Sequence
[
Hook
],
store
:
Store
)
->
None
:
def
_need_installed
()
->
List
[
Hook
]:
seen
:
Set
[
Tuple
[
Prefix
,
str
,
str
,
Tuple
[
str
, ...]]]
=
set
()
ret
=
[]
for
hook
in
hooks
:
if
hook
.
install_key
not
in
seen
and
not
_hook_installed
(
hook
):
ret
.
append
(
hook
)
seen
.
add
(
hook
.
install_key
)
return
ret
if
not
_need_installed
():
return
with
store
.
exclusive_lock
():
# Another process may have already completed this work
for
hook
in
_need_installed
():
_hook_install
(
hook
)
def
all_hooks
(
root_config
:
Dict
[
str
,
Any
],
store
:
Store
)
->
Tuple
[
Hook
, ...]:
return
tuple
(
hook
for
repo
in
root_config
[
'repos'
]
for
hook
in
_repository_hooks
(
repo
,
store
,
root_config
)
)
You can’t perform that action at this time.