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/lang_base.py at main · Sonder528/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 }}
Sonder528
/
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
5
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
pre-commit
/
pre_commit
/
lang_base.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
196 lines (156 loc) · 5.26 KB
main
Breadcrumbs
pre-commit
/
pre_commit
/
lang_base.py
Copy path
Top
File metadata and controls
Code
Blame
196 lines (156 loc) · 5.26 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
from
__future__
import
annotations
import
contextlib
import
os
import
random
import
re
import
shlex
import
sys
from
collections
.
abc
import
Generator
from
collections
.
abc
import
Sequence
from
typing
import
Any
from
typing
import
ContextManager
from
typing
import
NoReturn
from
typing
import
Protocol
import
pre_commit
.
constants
as
C
from
pre_commit
import
parse_shebang
from
pre_commit
import
xargs
from
pre_commit
.
prefix
import
Prefix
from
pre_commit
.
util
import
cmd_output_b
FIXED_RANDOM_SEED
=
1542676187
SHIMS_RE
=
re
.
compile
(
r'[/\\]shims[/\\]'
)
class
Language
(
Protocol
):
# Use `None` for no installation / environment
@
property
def
ENVIRONMENT_DIR
(
self
)
->
str
|
None
: ...
# return a value to replace `'default` for `language_version`
def
get_default_version
(
self
)
->
str
: ...
# return whether the environment is healthy (or should be rebuilt)
def
health_check
(
self
,
prefix
:
Prefix
,
version
:
str
)
->
str
|
None
: ...
# install a repository for the given language and language_version
def
install_environment
(
self
,
prefix
:
Prefix
,
version
:
str
,
additional_dependencies
:
Sequence
[
str
],
)
->
None
:
...
# modify the environment for hook execution
def
in_env
(
self
,
prefix
:
Prefix
,
version
:
str
)
->
ContextManager
[
None
]: ...
# execute a hook and return the exit code and output
def
run_hook
(
self
,
prefix
:
Prefix
,
entry
:
str
,
args
:
Sequence
[
str
],
file_args
:
Sequence
[
str
],
*
,
is_local
:
bool
,
require_serial
:
bool
,
color
:
bool
,
)
->
tuple
[
int
,
bytes
]:
...
def
exe_exists
(
exe
:
str
)
->
bool
:
found
=
parse_shebang
.
find_executable
(
exe
)
if
found
is
None
:
# exe exists
return
False
homedir
=
os
.
path
.
expanduser
(
'~'
)
try
:
common
:
str
|
None
=
os
.
path
.
commonpath
((
found
,
homedir
))
except
ValueError
:
# on windows, different drives raises ValueError
common
=
None
return
(
# it is not in a /shims/ directory
not
SHIMS_RE
.
search
(
found
)
and
(
# the homedir is / (docker, service user, etc.)
os
.
path
.
dirname
(
homedir
)
==
homedir
or
# the exe is not contained in the home directory
common
!=
homedir
)
)
def
setup_cmd
(
prefix
:
Prefix
,
cmd
:
tuple
[
str
, ...],
**
kwargs
:
Any
)
->
None
:
cmd_output_b
(
*
cmd
,
cwd
=
prefix
.
prefix_dir
,
**
kwargs
)
def
environment_dir
(
prefix
:
Prefix
,
d
:
str
,
language_version
:
str
)
->
str
:
return
prefix
.
path
(
f'
{
d
}
-
{
language_version
}
'
)
def
assert_version_default
(
binary
:
str
,
version
:
str
)
->
None
:
if
version
!=
C
.
DEFAULT
:
raise
AssertionError
(
f'for now, pre-commit requires system-installed
{
binary
}
-- '
f'you selected `language_version:
{
version
}
`'
,
)
def
assert_no_additional_deps
(
lang
:
str
,
additional_deps
:
Sequence
[
str
],
)
->
None
:
if
additional_deps
:
raise
AssertionError
(
f'for now, pre-commit does not support '
f'additional_dependencies for
{
lang
}
-- '
f'you selected `additional_dependencies:
{
additional_deps
}
`'
,
)
def
basic_get_default_version
()
->
str
:
return
C
.
DEFAULT
def
basic_health_check
(
prefix
:
Prefix
,
language_version
:
str
)
->
str
|
None
:
return
None
def
no_install
(
prefix
:
Prefix
,
version
:
str
,
additional_dependencies
:
Sequence
[
str
],
)
->
NoReturn
:
raise
AssertionError
(
'This language is not installable'
)
@
contextlib
.
contextmanager
def
no_env
(
prefix
:
Prefix
,
version
:
str
)
->
Generator
[
None
]:
yield
def
target_concurrency
()
->
int
:
if
'PRE_COMMIT_NO_CONCURRENCY'
in
os
.
environ
:
return
1
else
:
# Travis appears to have a bunch of CPUs, but we can't use them all.
if
'TRAVIS'
in
os
.
environ
:
return
2
else
:
return
xargs
.
cpu_count
()
def
_shuffled
(
seq
:
Sequence
[
str
])
->
list
[
str
]:
"""Deterministically shuffle"""
fixed_random
=
random
.
Random
()
fixed_random
.
seed
(
FIXED_RANDOM_SEED
,
version
=
1
)
seq
=
list
(
seq
)
fixed_random
.
shuffle
(
seq
)
return
seq
def
run_xargs
(
cmd
:
tuple
[
str
, ...],
file_args
:
Sequence
[
str
],
*
,
require_serial
:
bool
,
color
:
bool
,
)
->
tuple
[
int
,
bytes
]:
if
require_serial
:
jobs
=
1
else
:
# Shuffle the files so that they more evenly fill out the xargs
# partitions, but do it deterministically in case a hook cares about
# ordering.
file_args
=
_shuffled
(
file_args
)
jobs
=
target_concurrency
()
return
xargs
.
xargs
(
cmd
,
file_args
,
target_concurrency
=
jobs
,
color
=
color
)
def
hook_cmd
(
entry
:
str
,
args
:
Sequence
[
str
])
->
tuple
[
str
, ...]:
cmd
=
shlex
.
split
(
entry
)
if
cmd
[:
2
]
==
[
'pre-commit'
,
'hazmat'
]:
cmd
=
[
sys
.
executable
,
'-m'
,
'pre_commit.commands.hazmat'
,
*
cmd
[
2
:]]
return
(
*
cmd
,
*
args
)
def
basic_run_hook
(
prefix
:
Prefix
,
entry
:
str
,
args
:
Sequence
[
str
],
file_args
:
Sequence
[
str
],
*
,
is_local
:
bool
,
require_serial
:
bool
,
color
:
bool
,
)
->
tuple
[
int
,
bytes
]:
return
run_xargs
(
hook_cmd
(
entry
,
args
),
file_args
,
require_serial
=
require_serial
,
color
=
color
,
)
You can’t perform that action at this time.