-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Expand file tree
/
Copy path.pre-commit-config.yaml
More file actions
435 lines (415 loc) · 18.7 KB
/
Copy path.pre-commit-config.yaml
File metadata and controls
435 lines (415 loc) · 18.7 KB
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
exclude: |
(?x)^(
python/ray/core/generated/|
python/ray/serve/generated/|
python/ray/cloudpickle/|
python/ray/dashboard/client/public/|
python/ray/tests/test_cli_patterns|
python/ray/_private/runtime_env/_clonevirtualenv.py|
python/ray/data/examples/data/|
release/release_logs/|
rllib/offline/tests/data|
thirdparty/patches/|
python/requirements/llm/patches/|
src/ray/thirdparty/|
doc/external/|
# Excludes doc/source, except the Markdown and rST prose under doc/source/data
# that the `vale` hook below lints. pre-commit ANDs this top-level `exclude`
# with each hook's own `files`, so a bare `doc/source/` here cancelled that
# hook out entirely and it silently matched zero files.
doc/source/(?!data/.*[.](md|rst)$)|
doc/.claude/skills/sphinx-fix/tests/
)
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: trailing-whitespace
# Narrowing the top-level `exclude` above (so the `vale` hook can see
# doc/source/data prose) also exposed those files to this hook for the
# first time, which would rewrite 17 unrelated files. Keep them exempt
# here so enabling Vale stays a config-only change, and clean the
# whitespace up in its own PR.
exclude: ^doc/source/data/
- id: end-of-file-fixer
# Same reason as trailing-whitespace above.
exclude: ^doc/source/data/
- id: check-added-large-files
- id: check-ast
exclude: |
(?x)(
python/ray/serve/tests/test_config_files/syntax_error\.py
)$
- id: check-json
exclude: |
(?x)^(
# Intentionally bad json schema
python/ray/tests/unit/test_runtime_env_validation_bad_schema.json
)
- id: check-toml
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.8.4
hooks:
- id: ruff
args: [ --fix, --exit-non-zero-on-fix ]
- id: ruff
args: [ --select, "I", --fix, --exit-non-zero-on-fix ]
- repo: https://github.com/jsh9/pydoclint
rev: "0.8.3"
hooks:
- id: pydoclint
args: [
--style=google,
--baseline=ci/lint/pydoclint-baseline.txt,
--exclude=thirdparty|^python/ray/serve/tests/test_config_files/syntax_error\.py$|^python/ray/_private/parameter\.py$,
# --generate-baseline=True, # Not generally needed, but documenting since this is how we generate the initial baseline
--auto-regenerate-baseline=True,
# Current settings (not because we think they're right, but because we
# don't want a baseline the size of the codebase)
--arg-type-hints-in-docstring=False,
--skip-checking-raises=True,
--check-return-types=False,
--allow-init-docstring=True,
--check-class-attributes=False,
--check-style-mismatch=True,
]
types: [python]
files: '^python/ray/'
- repo: https://github.com/cpplint/cpplint
rev: 2.0.0
hooks:
- id: cpplint
args: ["--filter=-whitespace/braces,-whitespace/line_length,-build/c++11,-build/c++14,-build/c++17,-readability/braces,-whitespace/indent_namespace,-runtime/int,-runtime/references,-build/include_order"]
files: ^src/ray/(gcs/actor|common/cgroup2|common/scheduling|common/ray_syncer|common/test|util|raylet_client|internal|scheduling|pubsub|object_manager|rpc(?:/.*)?|raylet|core_worker|ipc)/.*\.(h|cc)$
exclude: |
(?x)^(
src/ray/raylet/scheduling/.*\.(h|cc)$ |
src/ray/core_worker/lib/java/.*\.h$
)
- repo: https://github.com/keith/pre-commit-buildifier
rev: 8.0.1
hooks:
- id: buildifier
files: ^(src|cpp|python|rllib|ci|release|java)(/[^/]+)*/BUILD(\.bazel)?$|^BUILD.bazel$
- id: buildifier-lint
files: ^(src|cpp|python|rllib|ci|release|java)(/[^/]+)*/BUILD(\.bazel)?$|^BUILD.bazel$
- repo: https://github.com/psf/black
rev: 22.10.0
hooks:
- id: black
exclude: |
(?x)^(
doc/external/|
python/build/|
python/ray/_private/thirdparty/|
python/ray/cloudpickle/|
python/ray/core/src/ray/gcs/|
python/ray/serve/_private/benchmarks/streaming/_grpc/test_server_pb2_grpc\.py|
python/ray/serve/tests/test_config_files/syntax_error\.py|
python/ray/thirdparty_files/
)
types_or: [python]
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.0.3
hooks:
- id: prettier
files: 'doc/'
types_or: [javascript, ts, tsx, html, css]
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.7.0
hooks:
- id: mypy
args: ['--follow-imports=skip', '--ignore-missing-imports']
files: |
(?x)^(
python/ray/autoscaler/node_provider.py|
python/ray/autoscaler/sdk/__init__.py|
python/ray/autoscaler/sdk/sdk.py|
python/ray/autoscaler/_private/commands.py|
python/ray/autoscaler/_private/autoscaler.py|
python/ray/_private/gcs_utils.py
)
additional_dependencies:
[
types-PyYAML==6.0.12.2,
]
# Serve-scoped type checking. Unlike the hook above, this uses
# `--follow-imports=silent` so imported types actually resolve (with
# `skip`, every cross-module type collapses to `Any` and wrong-type
# arguments go undetected). Only files listed here are checked; once a
# file is mypy-clean, add it to the list so it can't regress.
- id: mypy
name: mypy (ray serve)
args: ['--follow-imports=silent', '--ignore-missing-imports']
additional_dependencies:
[
types-requests==2.31.0.6,
]
files: |
(?x)^(
python/ray/serve/_private/__init__.py|
python/ray/serve/_private/api.py|
python/ray/serve/_private/application_state.py|
python/ray/serve/_private/autoscaling_state.py|
python/ray/serve/_private/benchmarks/__init__.py|
python/ray/serve/_private/benchmarks/serialization/__init__.py|
python/ray/serve/_private/benchmarks/serialization/common.py|
python/ray/serve/_private/benchmarks/streaming/__init__.py|
python/ray/serve/_private/benchmarks/streaming/_grpc/__init__.py|
python/ray/serve/_private/broker.py|
python/ray/serve/_private/build_app.py|
python/ray/serve/_private/cluster_node_info_cache.py|
python/ray/serve/_private/common.py|
python/ray/serve/_private/config.py|
python/ray/serve/_private/constants.py|
python/ray/serve/_private/constants_utils.py|
python/ray/serve/_private/controller.py|
python/ray/serve/_private/controller_avatar.py|
python/ray/serve/_private/controller_health_metrics_tracker.py|
python/ray/serve/_private/default_impl.py|
python/ray/serve/_private/deploy_utils.py|
python/ray/serve/_private/deployment_info.py|
python/ray/serve/_private/deployment_node.py|
python/ray/serve/_private/deployment_state.py|
python/ray/serve/_private/direct_ingress_grpc_util.py|
python/ray/serve/_private/direct_ingress_http_util.py|
python/ray/serve/_private/endpoint_state.py|
python/ray/serve/_private/event_loop_monitoring.py|
python/ray/serve/_private/exceptions.py|
python/ray/serve/_private/gang_scheduling_autoscaling_policy.py|
python/ray/serve/_private/grpc_util.py|
python/ray/serve/_private/handle_options.py|
python/ray/serve/_private/haproxy.py|
python/ray/serve/_private/haproxy_metrics.py|
python/ray/serve/_private/haproxy_templates.py|
python/ray/serve/_private/http_util.py|
python/ray/serve/_private/local_testing_mode.py|
python/ray/serve/_private/logging_utils.py|
python/ray/serve/_private/long_poll.py|
python/ray/serve/_private/metrics_utils.py|
python/ray/serve/_private/node_port_manager.py|
python/ray/serve/_private/proxy.py|
python/ray/serve/_private/proxy_request_response.py|
python/ray/serve/_private/proxy_response_generator.py|
python/ray/serve/_private/proxy_router.py|
python/ray/serve/_private/proxy_state.py|
python/ray/serve/_private/queue_monitor.py|
python/ray/serve/_private/replica.py|
python/ray/serve/_private/replica_response_generator.py|
python/ray/serve/_private/replica_result.py|
python/ray/serve/_private/request_ingress_metrics.py|
python/ray/serve/_private/request_router/__init__.py|
python/ray/serve/_private/request_router/common.py|
python/ray/serve/_private/request_router/pow_2_router.py|
python/ray/serve/_private/request_router/replica_wrapper.py|
python/ray/serve/_private/rolling_window.py|
python/ray/serve/_private/serialization.py|
python/ray/serve/_private/storage/__init__.py|
python/ray/serve/_private/storage/kv_store.py|
python/ray/serve/_private/storage/kv_store_base.py|
python/ray/serve/_private/task_consumer.py|
python/ray/serve/_private/thirdparty/__init__.py|
python/ray/serve/_private/tracing_utils.py|
python/ray/serve/_private/usage.py|
python/ray/serve/_private/utils.py|
python/ray/serve/_private/version.py|
python/ray/serve/handle.py|
python/ray/serve/tests/typing_files/check_handle_typing.py
)
# Second type checker over the same Serve allowlist. Pyrefly resolves
# modules and narrows differently than mypy, so it catches a disjoint set
# of bugs; scope/config (import replacement, search path) lives in
# pyrefly.toml. Keep the files list in sync with the "mypy (ray serve)"
# hook above.
- repo: local
hooks:
- id: pyrefly-serve
name: pyrefly (ray serve)
language: python
additional_dependencies: [pyrefly==1.1.1]
# The repo-root pyrefly.toml belongs to the ray/data CI job
# (ci/lint/pyrefly-check.sh); pass the serve-scoped config explicitly
# under a name pyrefly does not auto-discover.
entry: pyrefly check --config python/ray/serve/pyrefly-serve.toml
pass_filenames: true
files: |
(?x)^(
python/ray/serve/_private/__init__.py|
python/ray/serve/_private/api.py|
python/ray/serve/_private/application_state.py|
python/ray/serve/_private/autoscaling_state.py|
python/ray/serve/_private/benchmarks/__init__.py|
python/ray/serve/_private/benchmarks/serialization/__init__.py|
python/ray/serve/_private/benchmarks/serialization/common.py|
python/ray/serve/_private/benchmarks/streaming/__init__.py|
python/ray/serve/_private/benchmarks/streaming/_grpc/__init__.py|
python/ray/serve/_private/broker.py|
python/ray/serve/_private/build_app.py|
python/ray/serve/_private/cluster_node_info_cache.py|
python/ray/serve/_private/common.py|
python/ray/serve/_private/config.py|
python/ray/serve/_private/constants.py|
python/ray/serve/_private/constants_utils.py|
python/ray/serve/_private/controller.py|
python/ray/serve/_private/controller_avatar.py|
python/ray/serve/_private/controller_health_metrics_tracker.py|
python/ray/serve/_private/default_impl.py|
python/ray/serve/_private/deploy_utils.py|
python/ray/serve/_private/deployment_info.py|
python/ray/serve/_private/deployment_node.py|
python/ray/serve/_private/deployment_state.py|
python/ray/serve/_private/direct_ingress_grpc_util.py|
python/ray/serve/_private/direct_ingress_http_util.py|
python/ray/serve/_private/endpoint_state.py|
python/ray/serve/_private/event_loop_monitoring.py|
python/ray/serve/_private/exceptions.py|
python/ray/serve/_private/gang_scheduling_autoscaling_policy.py|
python/ray/serve/_private/grpc_util.py|
python/ray/serve/_private/handle_options.py|
python/ray/serve/_private/haproxy.py|
python/ray/serve/_private/haproxy_metrics.py|
python/ray/serve/_private/haproxy_templates.py|
python/ray/serve/_private/http_util.py|
python/ray/serve/_private/local_testing_mode.py|
python/ray/serve/_private/logging_utils.py|
python/ray/serve/_private/long_poll.py|
python/ray/serve/_private/metrics_utils.py|
python/ray/serve/_private/node_port_manager.py|
python/ray/serve/_private/proxy.py|
python/ray/serve/_private/proxy_request_response.py|
python/ray/serve/_private/proxy_response_generator.py|
python/ray/serve/_private/proxy_router.py|
python/ray/serve/_private/proxy_state.py|
python/ray/serve/_private/queue_monitor.py|
python/ray/serve/_private/replica.py|
python/ray/serve/_private/replica_response_generator.py|
python/ray/serve/_private/replica_result.py|
python/ray/serve/_private/request_ingress_metrics.py|
python/ray/serve/_private/request_router/__init__.py|
python/ray/serve/_private/request_router/common.py|
python/ray/serve/_private/request_router/pow_2_router.py|
python/ray/serve/_private/request_router/replica_wrapper.py|
python/ray/serve/_private/rolling_window.py|
python/ray/serve/_private/serialization.py|
python/ray/serve/_private/storage/__init__.py|
python/ray/serve/_private/storage/kv_store.py|
python/ray/serve/_private/storage/kv_store_base.py|
python/ray/serve/_private/task_consumer.py|
python/ray/serve/_private/thirdparty/__init__.py|
python/ray/serve/_private/tracing_utils.py|
python/ray/serve/_private/usage.py|
python/ray/serve/_private/utils.py|
python/ray/serve/_private/version.py|
python/ray/serve/handle.py|
python/ray/serve/tests/typing_files/check_handle_typing.py
)
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: rst-directive-colons
- id: rst-inline-touching-normal
- id: python-no-log-warn
- id: python-check-mock-methods
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.9.0.1
hooks:
- id: shellcheck
args: ['--exclude=1090,1091,2207']
# 1090: Can't follow non-constant source. Use a directive to specify location.
# 1091: Not following {file} due to some error
# 2207: Prefer mapfile or read -a to split command output (or quote to avoid splitting). -- these aren't compatible with macOS's old Bash
- repo: https://github.com/pre-commit/mirrors-clang-format
# `rev` specifies a tag on the above repo that mirrors the corresponding clang-format version.
rev: v12.0.1
hooks:
- id: clang-format
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.11.0
hooks:
- id: pretty-format-java
args: [--autofix, --google-java-formatter-version=1.7]
exclude: |
(?x)^(
java/api/src/main/java/io/ray/api/ActorCall.java|
java/api/src/main/java/io/ray/api/CppActorCall.java|
java/api/src/main/java/io/ray/api/PyActorCall.java|
java/api/src/main/java/io/ray/api/RayCall.java
)
- repo: local
hooks:
- id: docstyle
name: Check for Ray docstyle violations
entry: ci/lint/check-docstyle.sh
language: system
types: [python]
- repo: https://github.com/semgrep/pre-commit
rev: v1.32.0
hooks:
- id: semgrep
args: [--config=semgrep.yml, --error]
# semgrep.yml's `code-block-python` rule targets doc/source/data/**/*.rst,
# but the top-level `exclude` above has kept every doc/source path out of
# this hook, so the rule has never actually run on those files. Narrowing
# that exclude for Vale exposes 8 pre-existing violations under
# doc/source/data and would fail `semgrep_lint`. Keep them exempt here and
# fix the violations separately, rather than converting code blocks in a
# PR about Vale.
exclude: ^doc/source/data/
- repo: https://github.com/errata-ai/vale
rev: v3.17.1
hooks:
- id: vale
files: ^doc/source/data/.*\.(md|rst)$
- repo: https://github.com/MarcoGorelli/cython-lint
rev: v0.18.1
hooks:
- id: cython-lint
args: [--no-pycodestyle]
- repo: local
hooks:
- id: check-import-order
name: Check for Ray import order violations
entry: python ci/lint/check_import_order.py
language: python
types: [python]
pass_filenames: false
args: [".", "-s", "ci", "-s", "python/ray/thirdparty_files", "-s", "python/build", "-s", "lib"]
- repo: local
hooks:
- id: check-cpp-files-inclusion
name: Check ray core C++ files inclusion violations
entry: ci/lint/check_cpp_files_inclusion.py
language: python
files: '^src/ray/'
types: [c++]
- repo: local
hooks:
- id: check-train-circular-imports
name: Check Ray Train circular imports
entry: python python/ray/train/lint/check_circular_imports.py
language: system
types: [python]
files: '^python/ray/train/.*\.py$'
pass_filenames: false
args: ["--patch_dir", "ray/train/v2"]
- repo: https://github.com/pre-commit/mirrors-eslint
rev: v8.26.0
hooks:
- id: eslint
files: ^python/ray/dashboard/client/src/.*\.(tsx|ts)$
types: [file]
args:
- --max-warnings=0
additional_dependencies:
- eslint@8.26.0
- eslint-plugin-react@7.31.10
- eslint-plugin-import@2.26.0
- eslint-config-react-app@7.0.1
- eslint-plugin-prefer-arrow@1.2.3
- '@typescript-eslint/parser@5.41.0'
- '@typescript-eslint/eslint-plugin@5.41.0'
# Pin typescript: eslint-config-react-app declares `typescript: "*"`,
# which otherwise floats to a TS major incompatible with
# @typescript-eslint 5.41 and breaks plugin load in CI. Matches the
# dashboard client's own typescript devDependency.
- typescript@4.8.4