/
build_dictionary.html
4820 lines (4711 loc) · 228 KB
/
build_dictionary.html
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
<!DOCTYPE html>
<html lang="en">
<!--
Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
Licensed under the Apache License, Version 2.0 (see LICENSE).
-->
<head>
<meta charset="utf-8"/>
<title>Pants BUILD Dictionary</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="pants-logo.ico">
<!-- In case this is a "test publish", tell search engines where real version lives: -->
<link rel="canonical" href="http://pantsbuild.org/build_dictionary.html">
<link rel="stylesheet" href="bootstrap-custom.min.css">
<link rel="stylesheet" href="bootstrap-custom-theme.min.css">
<link rel="stylesheet" href="docsite.css">
</head>
<body>
<div class="header">
<nav class="navbar navbar-default navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-img" href="index.html">
<img src="pants-logo.ico" alt="[pantsbuild logo]">
</a>
<a class="navbar-brand" href="index.html">
Pants v1
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="/">Docs</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="https://www.github.com/pantsbuild/pants">GitHub</a></li>
<li>
<form class="navbar-form navbar-left search" role="search" action="https://www.google.com/search">
<div class="form-group">
<input type="text" name="as_q" class="form-control query" placeholder="Search">
<input name="as_sitesearch" value="pantsbuild.org" type="hidden">
</div>
</form>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
<div class="deprecated">Pants v1 is no longer maintained. See <a href="https://www.pantsbuild.org/">here</a> for the Pants v2 documentation.</div>
</nav>
</div>
<div class="page">
<div class="container-fluid">
<div class="row">
<div class="col-md-1">
</div>
<div class="col-md-2">
<div class="site-toc">
<ul>
<li class="toc-h1 toc-heading">
Getting Started
</li>
<li class="toc-h1 toc-link ">
<a href="install.html">Installing Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="setup_repo.html">Setting Up Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_tutorial.html">Tutorial</a>
</li>
<li class="toc-h1 toc-link ">
<a href="common_tasks.html">Common Tasks</a>
</li>
<li class="toc-h1 toc-link ">
<a href="orgs.html">Pants for Organizations</a>
</li>
<li class="toc-h1 toc-heading">
Pants Basics
</li>
<li class="toc-h1 toc-link ">
<a href="why_use_pants.html">Why Use Pants?</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_concepts.html">Pants Concepts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="build_files.html">BUILD files</a>
</li>
<li class="toc-h1 toc-link ">
<a href="target_addresses.html">Target Addresses</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty.html">Third-Party Dependencies</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options.html">Pants Options</a>
</li>
<li class="toc-h1 toc-link ">
<a href="invoking.html">Invoking Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="reporting_server.html">Reporting Server</a>
</li>
<li class="toc-h1 toc-link ">
<a href="ide_support.html">IDE Support</a>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#JVM-Support" aria-expanded="false" aria-controls="JVM-Support">JVM Support<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="JVM-Support">
<li class="toc-h1 toc-link ">
<a href="jvm_projects.html">JVM Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_jvm.html">JVM Dependency Management</a>
</li>
<li class="toc-h1 toc-link ">
<a href="scala.html">Scala Support</a>
</li>
<li class="toc-h1 toc-link ">
<a href="publish.html">Publishing Artifacts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="from_maven.html">Pants for Maven Experts</a>
</li>
</ul>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#Python-Support" aria-expanded="false" aria-controls="Python-Support">Python Support<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="Python-Support">
<li class="toc-h1 toc-link ">
<a href="python_readme.html">Python Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_py.html">Python 3rdparty Pattern</a>
</li>
</ul>
</li>
<li class="toc-h1 toc-link ">
<a href="go_readme.html">Go support for Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="node_readme.html">Node.js Support</a>
</li>
<li class="toc-h1 toc-heading">
Code & Doc Generation
</li>
<li class="toc-h1 toc-link ">
<a href="thrift_deps.html">Thrift</a>
</li>
<li class="toc-h1 toc-link ">
<a href="grpcio_gen.html">Python gRPC + protobufs</a>
</li>
<li class="toc-h1 toc-link ">
<a href="page.html">Markdown</a>
</li>
<li class="toc-h1 toc-heading">
Getting Help
</li>
<li class="toc-h1 toc-link ">
<a href="tshoot.html">Troubleshooting</a>
</li>
<li class="toc-h1 toc-link ">
<a href="community.html">Community</a>
</li>
<li class="toc-h1 toc-heading">
Reference
</li>
<li class="toc-h1 toc-link toc-here">
Pants BUILD Dictionary
</li>
<li class="toc-h1 toc-link ">
<a href="options_reference.html">Pants Reference</a>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#Release-Notes" aria-expanded="false" aria-controls="Release-Notes">Release Notes<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="Release-Notes">
<li class="toc-h1 toc-link ">
<a href="notes-1.30.x.html">1.30.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.29.x.html">1.29.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.28.x.html">1.28.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.27.x.html">1.27.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.26.x.html">1.26.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.25.x.html">1.25.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.24.x.html">1.24.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.23.x.html">1.23.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.22.x.html">1.22.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.21.x.html">1.21.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.20.x.html">1.20.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.19.x.html">1.19.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.18.x.html">1.18.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.17.x.html">1.17.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.16.x.html">1.16.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.15.x.html">1.15.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.14.x.html">1.14.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.13.x.html">1.13.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.12.x.html">1.12.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.11.x.html">1.11.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.10.x.html">1.10.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.9.x.html">1.9.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.8.x.html">1.8.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.7.x.html">1.7.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.6.x.html">1.6.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.5.x.html">1.5.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.4.x.html">1.4.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.3.x.html">1.3.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.2.x.html">1.2.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.1.x.html">1.1.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.0.x.html">1.0.x Stable Releases</a>
</li>
</ul>
</li>
<li class="toc-h1 toc-heading">
Developer
</li>
<li class="toc-h1 toc-link ">
<a href="dev.html">Pants Developer Center</a>
</li>
<li class="toc-h1 toc-link ">
<a href="export.html">Export Format</a>
</li>
<li class="toc-h1 toc-link ">
<a href="architecture.html">Architecture</a>
</li>
<li class="toc-h1 toc-heading">
Blogs
</li>
<li class="toc-h1 toc-link ">
<a href="coursier_migration.html">Twitter's Coursier Migration</a>
</li>
</ul>
</div> <!-- site-toc -->
</div>
<div class="col-md-8">
<div class="content">
<div class="mainflow">
<nav class="pagetoc">
<ul>
<li class="toc-h1"><a href="#heading_targettypes_102">Target Types</a></li>
<li class="toc-h1"><a href="#heading_otherbuildsymbols_103">Other BUILD Symbols</a></li>
</ul>
</nav>
<!-- main content start -->
<style>
code {
color: green;
white-space: nowrap;
}
pre {
color: green;
background-color: lightgray;
border: 1px solid black;
padding: 4px;
}
.top-link-bar a {
padding-right: 8px;
}
.option-category-header {
font-size: 16px;
font-weight: bold;
}
.goal-name {
font-size: 14px;
font-weight: bold;
}
.goal-header {
padding-bottom: 8px;
}
.global-subsystem-header {
padding-bottom: 8px;
}
.scope {
color: blue;
font-size: 14px;
font-family: monospace;
}
.options-group {
padding-top: 4px;
}
.option-args {
color: blue;
font-family: monospace;
font-weight: bold;
}
.option-default {
color: green;
font-family: monospace;
font-weight: bold;
}
.build-symbols {
padding-top: 16px;
}
.build-symbol {
color: blue;
font-family: monospace;
font-weight: bold;
}
.build-symbol-arg-name {
color: darkcyan;
font-family: monospace;
font-weight: bold;
}
.build-symbol-arg-default {
color: green;
font-family: monospace;
font-weight: bold;
}
.build-symbol-args {
margin-left: 48px;
}
.build-symbol-args td {
vertical-align: top;
padding-bottom: 1em;
}
.build-symbol-details {
white-space: pre;
}
/* Remove list bullets and substitute our own. */
ul.nobullets {
list-style: none;
padding: 0;
margin: 0;
}
ul.collapsible > li {
padding-left: 16px;
clear: both;
}
ul.collapsible > li.collapsed:before {
content: "▶";
padding-right: 8px;
font-family: monospace;
display: block;
float: left;
cursor: pointer;
}
ul.collapsible > li.expanded:before {
content: "▼";
padding-right: 8px;
font-family: monospace;
display: block;
float: left;
cursor: pointer;
}
ul.collapsible > li.collapsed > ul {
display: none;
}
ul.collapsible > li.expanded > ul {
display: block;
}
</style>
<script type="text/javascript">
function toggleTreeView(evt, elem) {
if (evt.target == elem) {
elem.classList.toggle('expanded');
elem.classList.toggle('collapsed');
}
}
function expandAll(evt) {
if (evt !== undefined) {
evt.preventDefault();
}
// We copy the returned htmlCollection, because our action changes it, which will
// invalidate indexes.
var liElems = [].slice.call(document.getElementsByClassName('collapsed'));
for (var i = 0; i < liElems.length; i++) {
expandLiElem(liElems[i]);
}
}
function collapseAll(evt) {
if (evt !== undefined) {
evt.preventDefault();
}
// We copy the returned htmlCollection, because our action changes it, which will
// invalidate indexes.
var liElems = [].slice.call(document.getElementsByClassName('expanded'));
for (var i = 0; i < liElems.length; i++) {
collapseLiElem(liElems[i]);
}
}
function expandLiElem(elem) {
if (elem !== undefined) {
elem.classList.add('expanded');
elem.classList.remove('collapsed');
}
}
function collapseLiElem(elem) {
if (elem !== undefined) {
elem.classList.add('collapsed');
elem.classList.remove('expanded');
}
}
function expandGoal(goal) {
expandLiElem(document.getElementById(goal));
expandLiElem(document.getElementById('task-options'));
}
window.onload = function() {
var liElems = document.getElementsByTagName('li');
for (var i = 0; i < liElems.length; i++) {
var elem = liElems[i];
if (elem.classList.contains('expanded') || elem.classList.contains('collapsed')) {
elem.addEventListener('click', function(evt) { toggleTreeView(evt, this); });
}
}
// Expand all if the user hits ctrl-f (cmd-f on OSX) to search on the page, so that their
// search sees all content. Note that we can't capture Edit->Find via the menus,
// but this should be useful in practice.
var isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;
var ctrlKey = isMac ? 'metaKey' : 'ctrlKey';
document.addEventListener('keydown', function(e) {
if (e.which == '70' && e[ctrlKey]) {
expandAll();
}
});
};
</script>
<h1 id="heading_pantsbuilddictionary_101">Pants BUILD Dictionary</h1>
<p>
A <code>BUILD</code> file defines one or more <em>build targets</em>.
A target represents a set of source files, dependencies or other 'nouns' that
build commands can act on. The <em>type</em> of a target determines what actions
apply to it. For example, a <code>jvm_binary</code> target can be compiled and run.
</p>
<div class="expand-bar">
[ <a href="#" onclick="expandAll(event)">Expand All</a> | <a href="#" onclick="collapseAll(event)">Collapse All</a> ]
</div>
<h2 id="heading_targettypes_102">Target Types</h2>
<div class="build-symbols">
<ul class="nobullets collapsible">
<a id="bdict__python_requirements_file" pantsmark="bdict__python_requirements_file"></a>
<li class="collapsed">
<code class="build-symbol">_python_requirements_file</code>: <span class="build-symbol-description">A requirements.txt file.</span>
<ul class="nobullets">
<span class="build-symbol-details">The python_requirements macro generates python_requirement_library targets and makes them depend
on a _python_requirements_file() target, so that pantsd knows to invalidate correctly when the
requirements.txt file changes. We don't want to use a regular files() target for this, as we
don't want to consider the requirements.txt a source for the purpose of building pexes (e.g., we
don't want whitespace changes to requirements.txt to invalidate the sources pex).</span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td>Files to "include". Paths are relative to the BUILD file's directory.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_alias" pantsmark="bdict_alias"></a>
<li class="collapsed">
<code class="build-symbol">alias</code>: <span class="build-symbol-description">A target that gets replaced by its dependencies.</span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_annotation_processor" pantsmark="bdict_annotation_processor"></a>
<li class="collapsed">
<code class="build-symbol">annotation_processor</code>: <span class="build-symbol-description">A Java library containing annotation processors.</span>
<ul class="nobullets">
<span class="build-symbol-details">:API: public</span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name"> = ...,</span></td>
<td>class:`pants.backend.jvm.artifact.Artifact` provides:<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">*args = ...,</span></td>
<td>None</td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">compiler_option_sets = ...,</span></td>
<td>A list of compiler_option_sets keys for the target. Platform dependent.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">excludes = ...,</span></td>
<td>List of `exclude <#exclude>`_\s to filter this target's transitive dependencies against.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">exports = ...,</span></td>
<td>A list of exported targets, which will be accessible to dependents even with strict_deps turned on. A common use case is for library targets to to export dependencies that it knows its dependents will need. Then any dependents of that library target will have access to those dependencies even when strict_deps is True. Note: exports is transitive, which means dependents have access to the closure of exports. An example will be that if A exports B, and B exports C, then any targets that depends on A will have access to both B and C.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">javac_plugin_args = ...,</span></td>
<td>Map from javac plugin name to list of arguments for that plugin.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">javac_plugins = ...,</span></td>
<td>names of compiler plugins to use when compiling this target with javac.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">platform = ...,</span></td>
<td>The name of the platform (defined under the jvm-platform subsystem) to use for compilation (that is, a key into the --jvm-platform-platforms dictionary). If unspecified, the platform will default to the first one of these that exist: (1) the default_platform specified for jvm-platform, (2) a platform constructed from whatever java version is returned by DistributionLocator.cached().version.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">processors = ...,</span></td>
<td>A list of the fully qualified class names of the annotation processors this library exports.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">provides = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">scalac_plugin_args = ...,</span></td>
<td>Map from scalac plugin name to list of arguments for that plugin.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">scalac_plugins = ...,</span></td>
<td>names of compiler plugins to use when compiling this target with scalac.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">services = ...,</span></td>
<td>A dict mapping service interface names to the classes owned by this target that implement them. Keys are fully qualified service class names, values are lists of strings, each string the fully qualified class name of a class owned by this target that implements the service interface and should be discoverable by the jvm service provider discovery mechanism described here: https://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td>Source code files to build. Paths are relative to the BUILD file's directory.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">strict_deps = ...,</span></td>
<td>When True, only the directly declared deps of the target will be used at compilation time. This enforces that all direct deps of the target are declared, and can improve compilation speed due to smaller classpaths. Transitive deps are always provided at runtime.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">zinc_file_manager = ...,</span></td>
<td>Whether to use zinc provided file manager that allows transactional rollbacks, but in certain cases may conflict with user libraries.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_benchmark" pantsmark="bdict_benchmark"></a>
<li class="collapsed">
<code class="build-symbol">benchmark</code>: <span class="build-symbol-description">A caliper benchmark.</span>
<ul class="nobullets">
<span class="build-symbol-details">Run it with the ``bench`` goal.</span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">compiler_option_sets = ...,</span></td>
<td>A list of compiler_option_sets keys for the target. Platform dependent.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">excludes = ...,</span></td>
<td>List of `exclude <#exclude>`_\s to filter this target's transitive dependencies against.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">exports = ...,</span></td>
<td>A list of exported targets, which will be accessible to dependents even with strict_deps turned on. A common use case is for library targets to to export dependencies that it knows its dependents will need. Then any dependents of that library target will have access to those dependencies even when strict_deps is True. Note: exports is transitive, which means dependents have access to the closure of exports. An example will be that if A exports B, and B exports C, then any targets that depends on A will have access to both B and C.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">javac_plugin_args = ...,</span></td>
<td>Map from javac plugin name to list of arguments for that plugin.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">javac_plugins = ...,</span></td>
<td>names of compiler plugins to use when compiling this target with javac.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">platform = ...,</span></td>
<td>The name of the platform (defined under the jvm-platform subsystem) to use for compilation (that is, a key into the --jvm-platform-platforms dictionary). If unspecified, the platform will default to the first one of these that exist: (1) the default_platform specified for jvm-platform, (2) a platform constructed from whatever java version is returned by DistributionLocator.cached().version.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">provides = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">runtime_platform = ...,</span></td>
<td>The name of the platform (defined under the jvm-platform subsystem) to use for runtime (that is, a key into the --jvm-platform-platforms dictionary). If unspecified, the platform will default to the first one of these that exist: (1) the default_runtime_platform specified for jvm-platform, (2) the platform that would be used for the platform kwarg.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">scalac_plugin_args = ...,</span></td>
<td>Map from scalac plugin name to list of arguments for that plugin.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">scalac_plugins = ...,</span></td>
<td>names of compiler plugins to use when compiling this target with scalac.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">services = ...,</span></td>
<td>A dict mapping service interface names to the classes owned by this target that implement them. Keys are fully qualified service class names, values are lists of strings, each string the fully qualified class name of a class owned by this target that implements the service interface and should be discoverable by the jvm service provider discovery mechanism described here: https://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td>Source code files to build. Paths are relative to the BUILD file's directory.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">strict_deps = ...,</span></td>
<td>When True, only the directly declared deps of the target will be used at compilation time. This enforces that all direct deps of the target are declared, and can improve compilation speed due to smaller classpaths. Transitive deps are always provided at runtime.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">zinc_file_manager = ...,</span></td>
<td>Whether to use zinc provided file manager that allows transactional rollbacks, but in certain cases may conflict with user libraries.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_contrib_plugin" pantsmark="bdict_contrib_plugin"></a>
<li class="collapsed">
<code class="build-symbol">contrib_plugin</code>: <span class="build-symbol-description"><Add description></span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">compatibility = ...,</span></td>
<td>either a string that represents interpreter compatibility for this target using the Requirement-style format, e.g. ``'CPython>=2.7,<3'`` (Select a CPython interpreter with version ``>=2.7`` AND version ``<3``) or a list of Requirement-style strings which will be OR'ed together. If the compatibility requirement is agnostic to interpreter class, using the example above, a Requirement-style compatibility constraint like '>=2.7,<3' (N.B.: not prefixed with CPython) can be used.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td>The addresses of targets that this target depends on. These dependencies may be ``python_library``-like targets (``python_library``, ``python_thrift_library``, ``resources`` and so forth) or ``python_requirement_library`` targets.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">provides = ...,</span></td>
<td>The `setup_py <#setup_py>`_ to publish that represents this target outside the repo.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td>Files to "include". Paths are relative to the BUILD file's directory.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_credentials" pantsmark="bdict_credentials"></a>
<li class="collapsed">
<code class="build-symbol">credentials</code>: <span class="build-symbol-description"><Add description></span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td>The name of these credentials.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">password = ...,</span></td>
<td>A constant password value.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">username = ...,</span></td>
<td>A constant username value.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_ctypes_compatible_c_library" pantsmark="bdict_ctypes_compatible_c_library"></a>
<li class="collapsed">
<code class="build-symbol">ctypes_compatible_c_library</code>: <span class="build-symbol-description"><Add description></span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">compiler_option_sets = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">ctypes_native_library = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">fatal_warnings = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">strict_deps = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">toolchain_variant = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_ctypes_compatible_cpp_library" pantsmark="bdict_ctypes_compatible_cpp_library"></a>
<li class="collapsed">
<code class="build-symbol">ctypes_compatible_cpp_library</code>: <span class="build-symbol-description"><Add description></span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">compiler_option_sets = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">ctypes_native_library = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">fatal_warnings = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">sources = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">strict_deps = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">toolchain_variant = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_external_native_library" pantsmark="bdict_external_native_library"></a>
<li class="collapsed">
<code class="build-symbol">external_native_library</code>: <span class="build-symbol-description">A set of Conan package strings to be passed to the Conan package manager.</span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">description = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">name = ...,</span></td>
<td></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">no_cache = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: False)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">packages = ...,</span></td>
<td>the `ConanRequirement`s to resolve into a `packaged_native_library()` target.<span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
<tr>
<td><span class="build-symbol-arg-name">tags = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: None)</span></td>
</tr>
</table>
</li>
</ul>
</li>
<a id="bdict_files" pantsmark="bdict_files"></a>
<li class="collapsed">
<code class="build-symbol">files</code>: <span class="build-symbol-description">A collection of loose files.</span>
<ul class="nobullets">
<span class="build-symbol-details"></span>
<li>
<table class="build-symbol-args">
<tr>
<td><span class="build-symbol-arg-name">dependencies = ...,</span></td>
<td><span class="build-symbol-arg-default"> (default: [])</span></td>
</tr>