forked from astral-sh/uv
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuv.schema.json
More file actions
2588 lines (2588 loc) · 116 KB
/
uv.schema.json
File metadata and controls
2588 lines (2588 loc) · 116 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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CombinedOptions",
"description": "Metadata and configuration for uv.",
"type": "object",
"properties": {
"add-bounds": {
"description": "The default version specifier when adding a dependency.\n\nWhen adding a dependency to the project, if no constraint or URL is provided, a constraint\nis added based on the latest compatible version of the package. By default, a lower bound\nconstraint is used, e.g., `>=1.2.3`.\n\nWhen `--frozen` is provided, no resolution is performed, and dependencies are always added\nwithout constraints.\n\nThis option is in preview and may change in any future release.",
"anyOf": [
{
"$ref": "#/definitions/AddBoundsKind"
},
{
"type": "null"
}
]
},
"allow-insecure-host": {
"description": "Allow insecure connections to host.\n\nExpects to receive either a hostname (e.g., `localhost`), a host-port pair (e.g.,\n`localhost:8080`), or a URL (e.g., `https://localhost`).\n\nWARNING: Hosts included in this list will not be verified against the system's certificate\nstore. Only use `--allow-insecure-host` in a secure network with verified sources, as it\nbypasses SSL verification and could expose you to MITM attacks.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/TrustedHost"
}
},
"audit": {
"anyOf": [
{
"$ref": "#/definitions/AuditOptions"
},
{
"type": "null"
}
]
},
"build-backend": {
"description": "Configuration for the uv build backend.\n\nNote that those settings only apply when using the `uv_build` backend, other build backends\n(such as hatchling) have their own configuration.",
"anyOf": [
{
"$ref": "#/definitions/BuildBackendSettings"
},
{
"type": "null"
}
]
},
"build-constraint-dependencies": {
"description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"cache-dir": {
"description": "Path to the cache directory.\n\nDefaults to `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Linux and macOS, and\n`%LOCALAPPDATA%\\uv\\cache` on Windows.",
"type": ["string", "null"]
},
"cache-keys": {
"description": "The keys to consider when caching builds for the project.\n\nCache keys enable you to specify the files or directories that should trigger a rebuild when\nmodified. By default, uv will rebuild a project whenever the `pyproject.toml`, `setup.py`,\nor `setup.cfg` files in the project directory are modified, or if a `src` directory is\nadded or removed, i.e.:\n\n```toml\ncache-keys = [{ file = \"pyproject.toml\" }, { file = \"setup.py\" }, { file = \"setup.cfg\" }, { dir = \"src\" }]\n```\n\nAs an example: if a project uses dynamic metadata to read its dependencies from a\n`requirements.txt` file, you can specify `cache-keys = [{ file = \"requirements.txt\" }, { file = \"pyproject.toml\" }]`\nto ensure that the project is rebuilt whenever the `requirements.txt` file is modified (in\naddition to watching the `pyproject.toml`).\n\nGlobs are supported, following the syntax of the [`glob`](https://docs.rs/glob/0.3.1/glob/struct.Pattern.html)\ncrate. For example, to invalidate the cache whenever a `.toml` file in the project directory\nor any of its subdirectories is modified, you can specify `cache-keys = [{ file = \"**/*.toml\" }]`.\nNote that the use of globs can be expensive, as uv may need to walk the filesystem to\ndetermine whether any files have changed.\n\nCache keys can also include version control information. For example, if a project uses\n`setuptools_scm` to read its version from a Git commit, you can specify `cache-keys = [{ git = { commit = true }, { file = \"pyproject.toml\" }]`\nto include the current Git commit hash in the cache key (in addition to the\n`pyproject.toml`). Git tags are also supported via `cache-keys = [{ git = { commit = true, tags = true } }]`.\n\nCache keys can also include environment variables. For example, if a project relies on\n`MACOSX_DEPLOYMENT_TARGET` or other environment variables to determine its behavior, you can\nspecify `cache-keys = [{ env = \"MACOSX_DEPLOYMENT_TARGET\" }]` to invalidate the cache\nwhenever the environment variable changes.\n\nCache keys only affect the project defined by the `pyproject.toml` in which they're\nspecified (as opposed to, e.g., affecting all members in a workspace), and all paths and\nglobs are interpreted as relative to the project directory.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/CacheKey"
}
},
"check-url": {
"description": "Check an index URL for existing files to skip duplicate uploads.\n\nThis option allows retrying publishing that failed after only some, but not all files have\nbeen uploaded, and handles error due to parallel uploads of the same file.\n\nBefore uploading, the index is checked. If the exact same file already exists in the index,\nthe file will not be uploaded. If an error occurred during the upload, the index is checked\nagain, to handle cases where the identical file was uploaded twice in parallel.\n\nThe exact behavior will vary based on the index. When uploading to PyPI, uploading the same\nfile succeeds even without `--check-url`, while most other indexes error.\n\nThe index must provide one of the supported hashes (SHA-256, SHA-384, or SHA-512).",
"anyOf": [
{
"$ref": "#/definitions/IndexUrl"
},
{
"type": "null"
}
]
},
"compile-bytecode": {
"description": "Compile Python files to bytecode after installation.\n\nBy default, uv does not compile Python (`.py`) files to bytecode (`__pycache__/*.pyc`);\ninstead, compilation is performed lazily the first time a module is imported. For use-cases\nin which start time is critical, such as CLI applications and Docker containers, this option\ncan be enabled to trade longer installation times for faster start times.\n\nWhen enabled, uv will process the entire site-packages directory (including packages that\nare not being modified by the current operation) for consistency. Like pip, it will also\nignore errors.",
"type": ["boolean", "null"]
},
"concurrent-builds": {
"description": "The maximum number of source distributions that uv will build concurrently at any given\ntime.\n\nDefaults to the number of available CPU cores.",
"type": ["integer", "null"],
"format": "uint",
"minimum": 1
},
"concurrent-downloads": {
"description": "The maximum number of in-flight concurrent downloads that uv will perform at any given\ntime.",
"type": ["integer", "null"],
"format": "uint",
"minimum": 1
},
"concurrent-installs": {
"description": "The number of threads used when installing and unzipping packages.\n\nDefaults to the number of available CPU cores.",
"type": ["integer", "null"],
"format": "uint",
"minimum": 1
},
"config-settings": {
"description": "Settings to pass to the [PEP 517](https://peps.python.org/pep-0517/) build backend,\nspecified as `KEY=VALUE` pairs.",
"anyOf": [
{
"$ref": "#/definitions/ConfigSettings"
},
{
"type": "null"
}
]
},
"config-settings-package": {
"description": "Settings to pass to the [PEP 517](https://peps.python.org/pep-0517/) build backend for specific packages,\nspecified as `KEY=VALUE` pairs.\n\nAccepts a map from package names to string key-value pairs.",
"anyOf": [
{
"$ref": "#/definitions/PackageConfigSettings"
},
{
"type": "null"
}
]
},
"conflicts": {
"description": "A list of sets of conflicting groups or extras.",
"anyOf": [
{
"$ref": "#/definitions/SchemaConflicts"
},
{
"type": "null"
}
]
},
"constraint-dependencies": {
"description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"default-groups": {
"description": "The list of `dependency-groups` to install by default.\n\nCan also be the literal `\"all\"` to default enable all groups.",
"anyOf": [
{
"$ref": "#/definitions/DefaultGroups"
},
{
"type": "null"
}
]
},
"dependency-groups": {
"description": "Additional settings for `dependency-groups`.\n\nCurrently this can only be used to add `requires-python` constraints\nto dependency groups (typically to inform uv that your dev tooling\nhas a higher python requirement than your actual project).\n\nThis cannot be used to define dependency groups, use the top-level\n`[dependency-groups]` table for that.",
"anyOf": [
{
"$ref": "#/definitions/ToolUvDependencyGroups"
},
{
"type": "null"
}
]
},
"dependency-metadata": {
"description": "Pre-defined static metadata for dependencies of the project (direct or transitive). When\nprovided, enables the resolver to use the specified metadata instead of querying the\nregistry or building the relevant package from source.\n\nMetadata should be provided in adherence with the [Metadata 2.3](https://packaging.python.org/en/latest/specifications/core-metadata/)\nstandard, though only the following fields are respected:\n\n- `name`: The name of the package.\n- (Optional) `version`: The version of the package. If omitted, the metadata will be applied\n to all versions of the package.\n- (Optional) `requires-dist`: The dependencies of the package (e.g., `werkzeug>=0.14`).\n- (Optional) `requires-python`: The Python version required by the package (e.g., `>=3.10`).\n- (Optional) `provides-extra`: The extras provided by the package.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/StaticMetadata"
}
},
"dev-dependencies": {
"description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"environments": {
"description": "A list of environment markers, e.g., `python_version >= '3.6'`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"exclude-dependencies": {
"description": "Package names to exclude, e.g., `werkzeug`, `numpy`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"exclude-newer": {
"description": "Limit candidate packages to those that were uploaded prior to the given date.\n\nThe date is compared against the upload time of each individual distribution artifact\n(i.e., when each file was uploaded to the package index), not the release date of the\npackage version.\n\nAccepts RFC 3339 timestamps (e.g., `2006-12-02T02:07:43Z`), a \"friendly\" duration (e.g.,\n`24 hours`, `1 week`, `30 days`), or an ISO 8601 duration (e.g., `PT24H`, `P7D`, `P30D`).\n\nDurations do not respect semantics of the local time zone and are always resolved to a fixed\nnumber of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored).\nCalendar units such as months and years are not allowed.",
"anyOf": [
{
"$ref": "#/definitions/ExcludeNewerValue"
},
{
"type": "null"
}
]
},
"exclude-newer-package": {
"description": "Limit candidate packages for specific packages to those that were uploaded prior to the\ngiven date.\n\nAccepts a dictionary format of `PACKAGE = \"DATE\"` pairs, where `DATE` is an RFC 3339\ntimestamp (e.g., `2006-12-02T02:07:43Z`), a \"friendly\" duration (e.g., `24 hours`, `1 week`,\n`30 days`), or a ISO 8601 duration (e.g., `PT24H`, `P7D`, `P30D`).\n\nDurations do not respect semantics of the local time zone and are always resolved to a fixed\nnumber of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored).\nCalendar units such as months and years are not allowed.\n\nSet a package to `false` to exempt it from the global [`exclude-newer`](#exclude-newer)\nconstraint entirely.",
"anyOf": [
{
"$ref": "#/definitions/ExcludeNewerPackage"
},
{
"type": "null"
}
]
},
"extra-build-dependencies": {
"description": "Additional build dependencies for packages.\n\nThis allows extending the PEP 517 build environment for the project's dependencies with\nadditional packages. This is useful for packages that assume the presence of packages like\n`pip`, and do not declare them as build dependencies.",
"anyOf": [
{
"$ref": "#/definitions/ExtraBuildDependencies"
},
{
"type": "null"
}
]
},
"extra-build-variables": {
"description": "Extra environment variables to set when building certain packages.\n\nEnvironment variables will be added to the environment when building the\nspecified packages.",
"anyOf": [
{
"$ref": "#/definitions/ExtraBuildVariables"
},
{
"type": "null"
}
]
},
"extra-index-url": {
"description": "Extra URLs of package indexes to use, in addition to `--index-url`.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nAll indexes provided via this flag take priority over the index specified by\n[`index_url`](#index-url) or [`index`](#index) with `default = true`. When multiple indexes\nare provided, earlier values take priority.\n\nTo control uv's resolution strategy when multiple indexes are present, see\n[`index_strategy`](#index-strategy).\n\n(Deprecated: use `index` instead.)",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/IndexUrl"
}
},
"find-links": {
"description": "Locations to search for candidate distributions, in addition to those found in the registry\nindexes.\n\nIf a path, the target must be a directory that contains packages as wheel files (`.whl`) or\nsource distributions (e.g., `.tar.gz` or `.zip`) at the top level.\n\nIf a URL, the page must contain a flat list of links to package files adhering to the\nformats described above.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/IndexUrl"
}
},
"fork-strategy": {
"description": "The strategy to use when selecting multiple versions of a given package across Python\nversions and platforms.\n\nBy default, uv will optimize for selecting the latest version of each package for each\nsupported Python version (`requires-python`), while minimizing the number of selected\nversions across platforms.\n\nUnder `fewest`, uv will minimize the number of selected versions for each package,\npreferring older versions that are compatible with a wider range of supported Python\nversions or platforms.",
"anyOf": [
{
"$ref": "#/definitions/ForkStrategy"
},
{
"type": "null"
}
]
},
"http-proxy": {
"description": "The URL of the HTTP proxy to use.",
"anyOf": [
{
"$ref": "#/definitions/ProxyUrl"
},
{
"type": "null"
}
]
},
"https-proxy": {
"description": "The URL of the HTTPS proxy to use.",
"anyOf": [
{
"$ref": "#/definitions/ProxyUrl"
},
{
"type": "null"
}
]
},
"index": {
"description": "The indexes to use when resolving dependencies.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nIndexes are considered in the order in which they're defined, such that the first-defined\nindex has the highest priority. Further, the indexes provided by this setting are given\nhigher priority than any indexes specified via [`index_url`](#index-url) or\n[`extra_index_url`](#extra-index-url). uv will only consider the first index that contains\na given package, unless an alternative [index strategy](#index-strategy) is specified.\n\nIf an index is marked as `explicit = true`, it will be used exclusively for the\ndependencies that select it explicitly via `[tool.uv.sources]`, as in:\n\n```toml\n[[tool.uv.index]]\nname = \"pytorch\"\nurl = \"https://download.pytorch.org/whl/cu121\"\nexplicit = true\n\n[tool.uv.sources]\ntorch = { index = \"pytorch\" }\n```\n\nIf an index is marked as `default = true`, it will be moved to the end of the prioritized list, such that it is\ngiven the lowest priority when resolving packages. Additionally, marking an index as default will disable the\nPyPI default index.",
"type": ["array", "null"],
"default": null,
"items": {
"$ref": "#/definitions/Index"
}
},
"index-strategy": {
"description": "The strategy to use when resolving against multiple index URLs.\n\nBy default, uv will stop at the first index on which a given package is available, and\nlimit resolutions to those present on that first index (`first-index`). This prevents\n\"dependency confusion\" attacks, whereby an attacker can upload a malicious package under the\nsame name to an alternate index.",
"anyOf": [
{
"$ref": "#/definitions/IndexStrategy"
},
{
"type": "null"
}
]
},
"index-url": {
"description": "The URL of the Python package index (by default: <https://pypi.org/simple>).\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nThe index provided by this setting is given lower priority than any indexes specified via\n[`extra_index_url`](#extra-index-url) or [`index`](#index).\n\n(Deprecated: use `index` instead.)",
"anyOf": [
{
"$ref": "#/definitions/IndexUrl"
},
{
"type": "null"
}
]
},
"keyring-provider": {
"description": "Attempt to use `keyring` for authentication for index URLs.\n\nAt present, only `--keyring-provider subprocess` is supported, which configures uv to\nuse the `keyring` CLI to handle authentication.",
"anyOf": [
{
"$ref": "#/definitions/KeyringProviderType"
},
{
"type": "null"
}
]
},
"link-mode": {
"description": "The method to use when installing packages from the global cache.\n\nDefaults to `clone` (also known as Copy-on-Write) on macOS and Linux, and `hardlink` on\nWindows.\n\nWARNING: The use of symlink link mode is discouraged, as they create tight coupling between\nthe cache and the target environment. For example, clearing the cache (`uv cache clean`)\nwill break all installed packages by way of removing the underlying source files. Use\nsymlinks with caution.",
"anyOf": [
{
"$ref": "#/definitions/LinkMode"
},
{
"type": "null"
}
]
},
"managed": {
"description": "Whether the project is managed by uv. If `false`, uv will ignore the project when\n`uv run` is invoked.",
"type": ["boolean", "null"]
},
"native-tls": {
"description": "Whether to load TLS certificates from the platform's native certificate store.\n\nBy default, uv uses bundled Mozilla root certificates. When enabled, this loads\ncertificates from the platform's native certificate store instead.\n\n(Deprecated: use `system-certs` instead.)",
"type": ["boolean", "null"],
"deprecated": true
},
"no-binary": {
"description": "Don't install pre-built wheels.\n\nThe given packages will be built and installed from source. The resolver will still use\npre-built wheels to extract package metadata, if available.",
"type": ["boolean", "null"]
},
"no-binary-package": {
"description": "Don't install pre-built wheels for a specific package.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/PackageName"
}
},
"no-build": {
"description": "Don't build source distributions.\n\nWhen enabled, resolving will not run arbitrary Python code. The cached wheels of\nalready-built source distributions will be reused, but operations that require building\ndistributions will exit with an error.",
"type": ["boolean", "null"]
},
"no-build-isolation": {
"description": "Disable isolation when building source distributions.\n\nAssumes that build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.",
"type": ["boolean", "null"]
},
"no-build-isolation-package": {
"description": "Disable isolation when building source distributions for a specific package.\n\nAssumes that the packages' build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/PackageName"
}
},
"no-build-package": {
"description": "Don't build source distributions for a specific package.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/PackageName"
}
},
"no-cache": {
"description": "Avoid reading from or writing to the cache, instead using a temporary directory for the\nduration of the operation.",
"type": ["boolean", "null"]
},
"no-index": {
"description": "Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and\nthose provided via `--find-links`.",
"type": ["boolean", "null"]
},
"no-proxy": {
"description": "A list of hosts to exclude from proxying.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"no-sources": {
"description": "Ignore the `tool.uv.sources` table when resolving dependencies. Used to lock against the\nstandards-compliant, publishable package metadata, as opposed to using any local or Git\nsources.",
"type": ["boolean", "null"]
},
"no-sources-package": {
"description": "Ignore `tool.uv.sources` for the specified packages.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/PackageName"
}
},
"offline": {
"description": "Disable network access, relying only on locally cached data and locally available files.",
"type": ["boolean", "null"]
},
"override-dependencies": {
"description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"package": {
"description": "Whether the project should be considered a Python package, or a non-package (\"virtual\")\nproject.\n\nPackages are built and installed into the virtual environment in editable mode and thus\nrequire a build backend, while virtual projects are _not_ built or installed; instead, only\ntheir dependencies are included in the virtual environment.\n\nCreating a package requires that a `build-system` is present in the `pyproject.toml`, and\nthat the project adheres to a structure that adheres to the build backend's expectations\n(e.g., a `src` layout).",
"type": ["boolean", "null"]
},
"pip": {
"anyOf": [
{
"$ref": "#/definitions/PipOptions"
},
{
"type": "null"
}
]
},
"prerelease": {
"description": "The strategy to use when considering pre-release versions.\n\nBy default, uv will accept pre-releases for packages that _only_ publish pre-releases,\nalong with first-party requirements that contain an explicit pre-release marker in the\ndeclared specifiers (`if-necessary-or-explicit`).",
"anyOf": [
{
"$ref": "#/definitions/PrereleaseMode"
},
{
"type": "null"
}
]
},
"preview": {
"description": "Whether to enable experimental, preview features.",
"type": ["boolean", "null"]
},
"publish-url": {
"description": "The URL for publishing packages to the Python package index (by default:\n<https://upload.pypi.org/legacy/>).",
"anyOf": [
{
"$ref": "#/definitions/DisplaySafeUrl"
},
{
"type": "null"
}
]
},
"pypy-install-mirror": {
"description": "Mirror URL to use for downloading managed PyPy installations.\n\nBy default, managed PyPy installations are downloaded from [downloads.python.org](https://downloads.python.org/).\nThis variable can be set to a mirror URL to use a different source for PyPy installations.\nThe provided URL will replace `https://downloads.python.org/pypy` in, e.g., `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.\n\nDistributions can be read from a\nlocal directory by using the `file://` URL scheme.",
"type": ["string", "null"]
},
"python-downloads": {
"description": "Whether to allow Python downloads.",
"anyOf": [
{
"$ref": "#/definitions/PythonDownloads"
},
{
"type": "null"
}
]
},
"python-downloads-json-url": {
"description": "URL pointing to JSON of custom Python installations.",
"type": ["string", "null"]
},
"python-install-mirror": {
"description": "Mirror URL for downloading managed Python installations.\n\nBy default, managed Python installations are downloaded from [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone).\nThis variable can be set to a mirror URL to use a different source for Python installations.\nThe provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g., `https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.\n\nDistributions can be read from a local directory by using the `file://` URL scheme.",
"type": ["string", "null"]
},
"python-preference": {
"description": "Whether to prefer using Python installations that are already present on the system, or\nthose that are downloaded and installed by uv.",
"anyOf": [
{
"$ref": "#/definitions/PythonPreference"
},
{
"type": "null"
}
]
},
"reinstall": {
"description": "Reinstall all packages, regardless of whether they're already installed. Implies `refresh`.",
"type": ["boolean", "null"]
},
"reinstall-package": {
"description": "Reinstall a specific package, regardless of whether it's already installed. Implies\n`refresh-package`.",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/PackageName"
}
},
"required-environments": {
"description": "A list of environment markers, e.g., `sys_platform == 'darwin'.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"required-version": {
"description": "Enforce a requirement on the version of uv.\n\nIf the version of uv does not meet the requirement at runtime, uv will exit\nwith an error.\n\nAccepts a [PEP 440](https://peps.python.org/pep-0440/) specifier, like `==0.5.0` or `>=0.5.0`.",
"anyOf": [
{
"$ref": "#/definitions/RequiredVersion"
},
{
"type": "null"
}
]
},
"resolution": {
"description": "The strategy to use when selecting between the different compatible versions for a given\npackage requirement.\n\nBy default, uv will use the latest compatible version of each package (`highest`).",
"anyOf": [
{
"$ref": "#/definitions/ResolutionMode"
},
{
"type": "null"
}
]
},
"sources": {
"description": "The sources to use when resolving dependencies.\n\n`tool.uv.sources` enriches the dependency metadata with additional sources, incorporated\nduring development. A dependency source can be a Git repository, a URL, a local path, or an\nalternative registry.\n\nSee [Dependencies](https://docs.astral.sh/uv/concepts/projects/dependencies/) for more.",
"anyOf": [
{
"$ref": "#/definitions/ToolUvSources"
},
{
"type": "null"
}
]
},
"system-certs": {
"description": "Whether to load TLS certificates from the platform's native certificate store.\n\nBy default, uv uses bundled Mozilla root certificates. When enabled, this loads\ncertificates from the platform's native certificate store instead.",
"type": ["boolean", "null"]
},
"torch-backend": {
"description": "The backend to use when fetching packages in the PyTorch ecosystem.\n\nWhen set, uv will ignore the configured index URLs for packages in the PyTorch ecosystem,\nand will instead use the defined backend.\n\nFor example, when set to `cpu`, uv will use the CPU-only PyTorch index; when set to `cu126`,\nuv will use the PyTorch index for CUDA 12.6.\n\nThe `auto` mode will attempt to detect the appropriate PyTorch index based on the currently\ninstalled CUDA drivers.\n\nThis setting is only respected by `uv pip` commands.\n\nThis option is in preview and may change in any future release.",
"anyOf": [
{
"$ref": "#/definitions/TorchMode"
},
{
"type": "null"
}
]
},
"trusted-publishing": {
"description": "Configure trusted publishing.\n\nBy default, uv checks for trusted publishing when running in a supported environment, but\nignores it if it isn't configured.\n\nuv's supported environments for trusted publishing include GitHub Actions and GitLab CI/CD.",
"anyOf": [
{
"$ref": "#/definitions/TrustedPublishing"
},
{
"type": "null"
}
]
},
"upgrade": {
"description": "Allow package upgrades, ignoring pinned versions in any existing output file.",
"type": ["boolean", "null"]
},
"upgrade-package": {
"description": "Allow upgrades for a specific package, ignoring pinned versions in any existing output\nfile.\n\nAccepts both standalone package names (`ruff`) and version specifiers (`ruff<0.5.0`).",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/Requirement"
}
},
"workspace": {
"description": "The workspace definition for the project, if any.",
"anyOf": [
{
"$ref": "#/definitions/ToolUvWorkspace"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"definitions": {
"AddBoundsKind": {
"description": "The default version specifier when adding a dependency.",
"oneOf": [
{
"description": "Only a lower bound, e.g., `>=1.2.3`.",
"type": "string",
"const": "lower"
},
{
"description": "Allow the same major version, similar to the semver caret, e.g., `>=1.2.3, <2.0.0`.\n\nLeading zeroes are skipped, e.g. `>=0.1.2, <0.2.0`.",
"type": "string",
"const": "major"
},
{
"description": "Allow the same minor version, similar to the semver tilde, e.g., `>=1.2.3, <1.3.0`.\n\nLeading zeroes are skipped, e.g. `>=0.1.2, <0.1.3`.",
"type": "string",
"const": "minor"
},
{
"description": "Pin the exact version, e.g., `==1.2.3`.\n\nThis option is not recommended, as versions are already pinned in the uv lockfile.",
"type": "string",
"const": "exact"
}
]
},
"AnnotationStyle": {
"description": "Indicate the style of annotation comments, used to indicate the dependencies that requested each\npackage.",
"oneOf": [
{
"description": "Render the annotations on a single, comma-separated line.",
"type": "string",
"const": "line"
},
{
"description": "Render each annotation on its own line.",
"type": "string",
"const": "split"
}
]
},
"AuditOptions": {
"type": "object",
"properties": {
"ignore": {
"description": "A list of vulnerability IDs to ignore during auditing.\n\nVulnerabilities matching any of the provided IDs (including aliases) will be excluded from\nthe audit results.",
"type": ["array", "null"],
"items": {
"type": "string"
}
},
"ignore-until-fixed": {
"description": "A list of vulnerability IDs to ignore during auditing, but only while no fix is available.\n\nVulnerabilities matching any of the provided IDs (including aliases) will be excluded from\nthe audit results as long as they have no known fix versions. Once a fix version becomes\navailable, the vulnerability will be reported again.",
"type": ["array", "null"],
"items": {
"type": "string"
}
}
}
},
"AuthPolicy": {
"description": "When to use authentication.",
"oneOf": [
{
"description": "Authenticate when necessary.\n\nIf credentials are provided, they will be used. Otherwise, an unauthenticated request will\nbe attempted first. If the request fails, uv will search for credentials. If credentials are\nfound, an authenticated request will be attempted.",
"type": "string",
"const": "auto"
},
{
"description": "Always authenticate.\n\nIf credentials are not provided, uv will eagerly search for credentials. If credentials\ncannot be found, uv will error instead of attempting an unauthenticated request.",
"type": "string",
"const": "always"
},
{
"description": "Never authenticate.\n\nIf credentials are provided, uv will error. uv will not search for credentials.",
"type": "string",
"const": "never"
}
]
},
"BuildBackendSettings": {
"description": "Settings for the uv build backend (`uv_build`).\n\nNote that those settings only apply when using the `uv_build` backend, other build backends\n(such as hatchling) have their own configuration.\n\nAll options that accept globs use the portable glob patterns from\n[PEP 639](https://packaging.python.org/en/latest/specifications/glob-patterns/).",
"type": "object",
"properties": {
"data": {
"description": "Data includes for wheels.\n\nEach entry is a directory, whose contents are copied to the matching directory in the wheel\nin `<name>-<version>.data/(purelib|platlib|headers|scripts|data)`. Upon installation, this\ndata is moved to its target location, as defined by\n<https://docs.python.org/3.12/library/sysconfig.html#installation-paths>. Usually, small\ndata files are included by placing them in the Python module instead of using data includes.\n\n- `scripts`: Installed to the directory for executables, `<venv>/bin` on Unix or\n `<venv>\\Scripts` on Windows. This directory is added to `PATH` when the virtual\n environment is activated or when using `uv run`, so this data type can be used to install\n additional binaries. Consider using `project.scripts` instead for Python entrypoints.\n- `data`: Installed over the virtualenv environment root.\n\n Warning: This may override existing files!\n\n- `headers`: Installed to the include directory. Compilers building Python packages\n with this package as build requirement use the include directory to find additional header\n files.\n- `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended\n to use these two options.",
"allOf": [
{
"$ref": "#/definitions/WheelDataIncludes"
}
],
"default": {
"data": null,
"headers": null,
"platlib": null,
"purelib": null,
"scripts": null
}
},
"default-excludes": {
"description": "If set to `false`, the default excludes aren't applied.\n\nDefault excludes: `__pycache__`, `*.pyc`, and `*.pyo`.",
"type": "boolean",
"default": true
},
"module-name": {
"description": "The name of the module directory inside `module-root`.\n\nThe default module name is the package name with dots and dashes replaced by underscores.\n\nPackage names need to be valid Python identifiers, and the directory needs to contain a\n`__init__.py`. An exception are stubs packages, whose name ends with `-stubs`, with the stem\nbeing the module name, and which contain a `__init__.pyi` file.\n\nFor namespace packages with a single module, the path can be dotted, e.g., `foo.bar` or\n`foo-stubs.bar`.\n\nFor namespace packages with multiple modules, the path can be a list, e.g.,\n`[\"foo\", \"bar\"]`. We recommend using a single module per package, splitting multiple\npackages into a workspace.\n\nNote that using this option runs the risk of creating two packages with different names but\nthe same module names. Installing such packages together leads to unspecified behavior,\noften with corrupted files or directory trees.",
"anyOf": [
{
"$ref": "#/definitions/ModuleName"
},
{
"type": "null"
}
],
"default": null
},
"module-root": {
"description": "The directory that contains the module directory.\n\nCommon values are `src` (src layout, the default) or an empty path (flat layout).",
"type": "string",
"default": "src"
},
"namespace": {
"description": "Build a namespace package.\n\nBuild a PEP 420 implicit namespace package, allowing more than one root `__init__.py`.\n\nUse this option when the namespace package contains multiple root `__init__.py`, for\nnamespace packages with a single root `__init__.py` use a dotted `module-name` instead.\n\nTo compare dotted `module-name` and `namespace = true`, the first example below can be\nexpressed with `module-name = \"cloud.database\"`: There is one root `__init__.py` `database`.\nIn the second example, we have three roots (`cloud.database`, `cloud.database_pro`,\n`billing.modules.database_pro`), so `namespace = true` is required.\n\n```text\nsrc\n└── cloud\n └── database\n ├── __init__.py\n ├── query_builder\n │ └── __init__.py\n └── sql\n ├── parser.py\n └── __init__.py\n```\n\n```text\nsrc\n├── cloud\n│ ├── database\n│ │ ├── __init__.py\n│ │ ├── query_builder\n│ │ │ └── __init__.py\n│ │ └── sql\n│ │ ├── __init__.py\n│ │ └── parser.py\n│ └── database_pro\n│ ├── __init__.py\n│ └── query_builder.py\n└── billing\n └── modules\n └── database_pro\n ├── __init__.py\n └── sql.py\n```",
"type": "boolean",
"default": false
},
"source-exclude": {
"description": "Glob expressions which files and directories to exclude from the source distribution.\n\nThese exclusions are also applied to wheels to ensure that a wheel built from a source tree\nis consistent with a wheel built from a source distribution.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
},
"source-include": {
"description": "Glob expressions which files and directories to additionally include in the source\ndistribution.\n\n`pyproject.toml` and the contents of the module directory are always included.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
},
"wheel-exclude": {
"description": "Glob expressions which files and directories to exclude from the wheel.",
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
}
},
"CacheKey": {
"anyOf": [
{
"description": "Ex) `\"Cargo.lock\"` or `\"**/*.toml\"`",
"type": "string"
},
{
"description": "Ex) `{ file = \"Cargo.lock\" }` or `{ file = \"**/*.toml\" }`",
"type": "object",
"properties": {
"file": {
"type": "string"
}
},
"additionalProperties": false,
"required": ["file"]
},
{
"description": "Ex) `{ dir = \"src\" }`",
"type": "object",
"properties": {
"dir": {
"type": "string"
}
},
"additionalProperties": false,
"required": ["dir"]
},
{
"description": "Ex) `{ git = true }` or `{ git = { commit = true, tags = false } }`",
"type": "object",
"properties": {
"git": {
"$ref": "#/definitions/GitPattern"
}
},
"additionalProperties": false,
"required": ["git"]
},
{
"description": "Ex) `{ env = \"UV_CACHE_INFO\" }`",
"type": "object",
"properties": {
"env": {
"type": "string"
}
},
"additionalProperties": false,
"required": ["env"]
}
]
},
"ConfigSettingValue": {
"anyOf": [
{
"description": "The value consists of a single string.",
"type": "string"
},
{
"description": "The value consists of a list of strings.",
"type": "array",
"items": {
"type": "string"
}
}
]
},
"ConfigSettings": {
"description": "Settings to pass to a PEP 517 build backend, structured as a map from (string) key to string or\nlist of strings.\n\nSee: <https://peps.python.org/pep-0517/#config-settings>",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ConfigSettingValue"
}
},
"DefaultGroups": {
"description": "Either the literal \"all\" or a list of groups",
"oneOf": [
{
"description": "All groups are defaulted",
"type": "string",
"const": "all"
},
{
"description": "A list of groups",
"type": "array",
"items": {
"$ref": "#/definitions/GroupName"
}
}
]
},
"DependencyGroupSettings": {
"type": "object",
"properties": {
"requires-python": {
"description": "Version of python to require when installing this group",
"type": ["string", "null"]
}
}
},
"DisplaySafeUrl": {
"description": "A [`Url`] wrapper that redacts credentials when displaying the URL.\n\n`DisplaySafeUrl` wraps the standard [`url::Url`] type, providing functionality to mask\nsecrets by default when the URL is displayed or logged. This helps prevent accidental\nexposure of sensitive information in logs and debug output.\n\n# Examples\n\n```\nuse uv_redacted::DisplaySafeUrl;\nuse std::str::FromStr;\n\n// Create a `DisplaySafeUrl` from a `&str`\nlet mut url = DisplaySafeUrl::parse(\"https://user:[email protected]\").unwrap();\n\n// Display will mask secrets\nassert_eq!(url.to_string(), \"https://user:****@example.com/\");\n\n// You can still access the username and password\nassert_eq!(url.username(), \"user\");\nassert_eq!(url.password(), Some(\"password\"));\n\n// And you can still update the username and password\nlet _ = url.set_username(\"new_user\");\nlet _ = url.set_password(Some(\"new_password\"));\nassert_eq!(url.username(), \"new_user\");\nassert_eq!(url.password(), Some(\"new_password\"));\n\n// It is also possible to remove the credentials entirely\nurl.remove_credentials();\nassert_eq!(url.username(), \"\");\nassert_eq!(url.password(), None);\n```",
"type": "string",
"format": "uri"
},
"ExcludeNewerOverride": {
"oneOf": [
{
"description": "Disable exclude-newer.",
"type": "boolean",
"const": false
},
{
"$ref": "#/definitions/ExcludeNewerValue"
}
]
},
"ExcludeNewerPackage": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ExcludeNewerOverride"
}
},
"ExcludeNewerValue": {
"description": "Exclude distributions uploaded after the given timestamp.\n\nAccepts both RFC 3339 timestamps (e.g., `2006-12-02T02:07:43Z`) and local dates in the same format (e.g., `2006-12-02`), as well as relative durations (e.g., `1 week`, `30 days`, `6 months`). Relative durations are resolved to a timestamp at lock time.",
"type": "string"
},
"ExtraBuildDependencies": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtraBuildDependency"
}
}
},
"ExtraBuildDependency": {
"anyOf": [
{
"$ref": "#/definitions/Requirement"
},
{
"type": "object",
"properties": {
"match-runtime": {
"type": "boolean"
},
"requirement": {
"$ref": "#/definitions/Requirement"
}
},
"required": ["requirement", "match-runtime"]
}
]
},
"ExtraBuildVariables": {
"description": "Extra environment variables to set during builds, on a per-package basis.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"ExtraName": {
"description": "The normalized name of an extra dependency.\n\nConverts the name to lowercase and collapses runs of `-`, `_`, and `.` down to a single `-`.\nFor example, `---`, `.`, and `__` are all converted to a single `-`.\n\nSee:\n- <https://peps.python.org/pep-0685/#specification/>\n- <https://packaging.python.org/en/latest/specifications/name-normalization/>",
"type": "string"
},
"ForkStrategy": {
"oneOf": [
{
"description": "Optimize for selecting the fewest number of versions for each package. Older versions may\nbe preferred if they are compatible with a wider range of supported Python versions or\nplatforms.",
"type": "string",
"const": "fewest"
},
{
"description": "Optimize for selecting latest supported version of each package, for each supported Python\nversion.",
"type": "string",
"const": "requires-python"
}
]
},
"GitPattern": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/GitSet"
}
]
},
"GitSet": {
"type": "object",
"properties": {
"commit": {
"type": ["boolean", "null"]
},
"tags": {
"type": ["boolean", "null"]
}
},
"additionalProperties": false
},
"GroupName": {
"description": "The normalized name of a dependency group.\n\nSee:\n- <https://peps.python.org/pep-0735/>\n- <https://packaging.python.org/en/latest/specifications/name-normalization/>",
"type": "string"
},
"Index": {
"type": "object",
"properties": {
"authenticate": {
"description": "When uv should use authentication for requests to the index.\n\n```toml\n[[tool.uv.index]]\nname = \"my-index\"\nurl = \"https://<omitted>/simple\"\nauthenticate = \"always\"\n```",
"allOf": [
{
"$ref": "#/definitions/AuthPolicy"
}
],
"default": "auto"
},
"cache-control": {
"description": "Cache control configuration for this index.\n\nWhen set, these headers will override the server's cache control headers\nfor both package metadata requests and artifact downloads.\n\n```toml\n[[tool.uv.index]]\nname = \"my-index\"\nurl = \"https://<omitted>/simple\"\ncache-control = { api = \"max-age=600\", files = \"max-age=3600\" }\n```",
"anyOf": [
{
"$ref": "#/definitions/IndexCacheControl"
},
{
"type": "null"
}
],
"default": null
},
"default": {
"description": "Mark the index as the default index.\n\nBy default, uv uses PyPI as the default index, such that even if additional indexes are\ndefined via `[[tool.uv.index]]`, PyPI will still be used as a fallback for packages that\naren't found elsewhere. To disable the PyPI default, set `default = true` on at least one\nother index.\n\nMarking an index as default will move it to the front of the list of indexes, such that it\nis given the highest priority when resolving packages.",
"type": "boolean",
"default": false
},
"explicit": {
"description": "Mark the index as explicit.\n\nExplicit indexes will _only_ be used when explicitly requested via a `[tool.uv.sources]`\ndefinition, as in:\n\n```toml\n[[tool.uv.index]]\nname = \"pytorch\"\nurl = \"https://download.pytorch.org/whl/cu121\"\nexplicit = true\n\n[tool.uv.sources]\ntorch = { index = \"pytorch\" }\n```",
"type": "boolean",
"default": false
},
"format": {
"description": "The format used by the index.\n\nIndexes can either be PEP 503-compliant (i.e., a PyPI-style registry implementing the Simple\nAPI) or structured as a flat list of distributions (e.g., `--find-links`). In both cases,\nindexes can point to either local or remote resources.",
"allOf": [
{
"$ref": "#/definitions/IndexFormat"
}
],
"default": "simple"
},
"ignore-error-codes": {
"description": "Status codes that uv should ignore when deciding whether\nto continue searching in the next index after a failure.\n\n```toml\n[[tool.uv.index]]\nname = \"my-index\"\nurl = \"https://<omitted>/simple\"\nignore-error-codes = [401, 403]\n```",
"type": ["array", "null"],
"default": null,
"items": {
"$ref": "#/definitions/StatusCode"
}
},
"name": {
"description": "The name of the index.\n\nIndex names can be used to reference indexes elsewhere in the configuration. For example,\nyou can pin a package to a specific index by name:\n\n```toml\n[[tool.uv.index]]\nname = \"pytorch\"\nurl = \"https://download.pytorch.org/whl/cu121\"\n\n[tool.uv.sources]\ntorch = { index = \"pytorch\" }\n```",
"anyOf": [
{
"$ref": "#/definitions/IndexName"