-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathdistutils.html
1515 lines (1284 loc) · 112 KB
/
distutils.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" data-content_root="../" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Packaging — NumPy v2.3.dev0 Manual</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="../_static/jupyterlite_sphinx.css?v=2c9f8f05" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/numpy.css?v=a1b581f7" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=5f219352"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=30646c52"></script>
<script src="../_static/jupyterlite_sphinx.js?v=96e329c5"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'reference/distutils';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://numpy.org/doc/_static/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'devdocs';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="distutils.misc_util" href="distutils/misc_util.html" />
<link rel="prev" title="numpy.char.chararray.zfill" href="generated/numpy.char.chararray.zfill.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2.3.dev0" />
<meta name="docbuild:last-update" content="Apr 20, 2025"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/numpylogo.svg" class="logo__image only-light" alt="NumPy v2.3.dev0 Manual - Home"/>
<img src="../_static/numpylogo_dark.svg" class="logo__image only-dark pst-js-only" alt="NumPy v2.3.dev0 Manual - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../user/index.html">
User Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../user/index.html">
User Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="module_structure.html">NumPy’s module structure</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="routines.exceptions.html">numpy.exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.fft.html">numpy.fft</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.linalg.html">numpy.linalg</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.polynomials-package.html">numpy.polynomial</a></li>
<li class="toctree-l2"><a class="reference internal" href="random/index.html">numpy.random</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.strings.html">numpy.strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.testing.html">numpy.testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="typing.html">numpy.typing</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.ctypeslib.html">numpy.ctypeslib</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.dtypes.html">numpy.dtypes</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.emath.html">numpy.emath</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.lib.html">numpy.lib</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.rec.html">numpy.rec</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.version.html">numpy.version</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.char.html">numpy.char</a></li>
<li class="toctree-l2 current active has-children"><a class="current reference internal" href="#">numpy.distutils</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="distutils/misc_util.html">distutils.misc_util</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.ccompiler.html">numpy.distutils.ccompiler</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.ccompiler_opt.html">numpy.distutils.ccompiler_opt</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.cpuinfo.cpu.html">numpy.distutils.cpuinfo.cpu</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.core.Extension.html">numpy.distutils.core.Extension</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.exec_command.html">numpy.distutils.exec_command</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.log.set_verbosity.html">numpy.distutils.log.set_verbosity</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.system_info.get_info.html">numpy.distutils.system_info.get_info</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/numpy.distutils.system_info.get_standard_file.html">numpy.distutils.system_info.get_standard_file</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="../f2py/index.html">numpy.f2py</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.ma.html">numpy.ma</a></li>
<li class="toctree-l2"><a class="reference internal" href="routines.matlib.html">numpy.matlib</a></li>
</ul>
</details></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="arrays.html">Array objects</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="ufuncs.html">Universal functions (<code class="xref py py-class docutils literal notranslate"><span class="pre">ufunc</span></code>)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="routines.html">Routines and objects by topic</a></li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="typing.html">Typing (<code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.typing</span></code>)</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Packaging</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html">distutils.misc_util</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.ccompiler.html">numpy.distutils.ccompiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.ccompiler_opt.html">numpy.distutils.ccompiler_opt</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.cpuinfo.cpu.html">numpy.distutils.cpuinfo.cpu</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.core.Extension.html">numpy.distutils.core.Extension</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.exec_command.html">numpy.distutils.exec_command</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.log.set_verbosity.html">numpy.distutils.log.set_verbosity</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.system_info.get_info.html">numpy.distutils.system_info.get_info</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/numpy.distutils.system_info.get_standard_file.html">numpy.distutils.system_info.get_standard_file</a></li>
</ul>
</details></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="c-api/index.html">NumPy C-API</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="array_api.html">Array API standard compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="simd/index.html">CPU/SIMD optimizations</a></li>
<li class="toctree-l1"><a class="reference internal" href="thread_safety.html">Thread Safety</a></li>
<li class="toctree-l1"><a class="reference internal" href="global_state.html">Global Configuration Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="security.html">NumPy security</a></li>
<li class="toctree-l1"><a class="reference internal" href="distutils_status_migration.html">Status of <code class="docutils literal notranslate"><span class="pre">numpy.distutils</span></code> and migration advice</a></li>
<li class="toctree-l1"><a class="reference internal" href="distutils_guide.html"><code class="docutils literal notranslate"><span class="pre">numpy.distutils</span></code> user guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="swig.html">NumPy and SWIG</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">NumPy reference</a></li>
<li class="breadcrumb-item"><a href="module_structure.html" class="nav-link">NumPy’s module structure</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Packaging</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="module-numpy.distutils">
<span id="packaging"></span><span id="numpy-distutils-refguide"></span><h1>Packaging<a class="headerlink" href="#module-numpy.distutils" title="Link to this heading">#</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><code class="docutils literal notranslate"><span class="pre">numpy.distutils</span></code> is deprecated, and will be removed for
Python >= 3.12. For more details, see <a class="reference internal" href="distutils_status_migration.html#distutils-status-migration"><span class="std std-ref">Status of numpy.distutils and migration advice</span></a></p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Note that <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> does major releases often and those may contain
changes that break <a class="reference internal" href="#module-numpy.distutils" title="numpy.distutils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.distutils</span></code></a>, which will <em>not</em> be updated anymore
for new <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> versions. It is therefore recommended to set an
upper version bound in your build configuration for the last known version
of <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> that works with your build.</p>
</div>
<p>NumPy provides enhanced distutils functionality to make it easier to
build and install sub-packages, auto-generate code, and extension
modules that use Fortran-compiled libraries. A useful <a class="reference internal" href="#numpy.distutils.misc_util.Configuration" title="numpy.distutils.misc_util.Configuration"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configuration</span></code></a> class is also provided in
<a class="reference internal" href="distutils/misc_util.html#module-numpy.distutils.misc_util" title="numpy.distutils.misc_util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.distutils.misc_util</span></code></a> that can make it easier to construct
keyword arguments to pass to the setup function (by passing the
dictionary obtained from the todict() method of the class). More
information is available in the <a class="reference internal" href="distutils_guide.html#distutils-user-guide"><span class="std std-ref">numpy.distutils user guide</span></a>.</p>
<p>The choice and location of linked libraries such as BLAS and LAPACK as well as
include paths and other such build options can be specified in a <code class="docutils literal notranslate"><span class="pre">site.cfg</span></code>
file located in the NumPy root repository or a <code class="docutils literal notranslate"><span class="pre">.numpy-site.cfg</span></code> file in your
home directory. See the <code class="docutils literal notranslate"><span class="pre">site.cfg.example</span></code> example file included in the NumPy
repository or sdist for documentation.</p>
<section id="modules-in-numpy-distutils">
<span id="index-0"></span><h2>Modules in <a class="reference internal" href="#module-numpy.distutils" title="numpy.distutils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.distutils</span></code></a><a class="headerlink" href="#modules-in-numpy-distutils" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="distutils/misc_util.html">distutils.misc_util</a><ul>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.all_strings"><code class="docutils literal notranslate"><span class="pre">all_strings</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.allpath"><code class="docutils literal notranslate"><span class="pre">allpath</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.appendpath"><code class="docutils literal notranslate"><span class="pre">appendpath</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.as_list"><code class="docutils literal notranslate"><span class="pre">as_list</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.blue_text"><code class="docutils literal notranslate"><span class="pre">blue_text</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.cyan_text"><code class="docutils literal notranslate"><span class="pre">cyan_text</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.cyg2win32"><code class="docutils literal notranslate"><span class="pre">cyg2win32</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.default_config_dict"><code class="docutils literal notranslate"><span class="pre">default_config_dict</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.dict_append"><code class="docutils literal notranslate"><span class="pre">dict_append</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.dot_join"><code class="docutils literal notranslate"><span class="pre">dot_join</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.exec_mod_from_location"><code class="docutils literal notranslate"><span class="pre">exec_mod_from_location</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.filter_sources"><code class="docutils literal notranslate"><span class="pre">filter_sources</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.generate_config_py"><code class="docutils literal notranslate"><span class="pre">generate_config_py</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_build_architecture"><code class="docutils literal notranslate"><span class="pre">get_build_architecture</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_cmd"><code class="docutils literal notranslate"><span class="pre">get_cmd</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_data_files"><code class="docutils literal notranslate"><span class="pre">get_data_files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_dependencies"><code class="docutils literal notranslate"><span class="pre">get_dependencies</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_ext_source_files"><code class="docutils literal notranslate"><span class="pre">get_ext_source_files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_frame"><code class="docutils literal notranslate"><span class="pre">get_frame</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_info"><code class="docutils literal notranslate"><span class="pre">get_info</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_language"><code class="docutils literal notranslate"><span class="pre">get_language</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_lib_source_files"><code class="docutils literal notranslate"><span class="pre">get_lib_source_files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_mathlibs"><code class="docutils literal notranslate"><span class="pre">get_mathlibs</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_num_build_jobs"><code class="docutils literal notranslate"><span class="pre">get_num_build_jobs</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_numpy_include_dirs"><code class="docutils literal notranslate"><span class="pre">get_numpy_include_dirs</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_pkg_info"><code class="docutils literal notranslate"><span class="pre">get_pkg_info</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.get_script_files"><code class="docutils literal notranslate"><span class="pre">get_script_files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.gpaths"><code class="docutils literal notranslate"><span class="pre">gpaths</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.green_text"><code class="docutils literal notranslate"><span class="pre">green_text</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.has_cxx_sources"><code class="docutils literal notranslate"><span class="pre">has_cxx_sources</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.has_f_sources"><code class="docutils literal notranslate"><span class="pre">has_f_sources</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.is_local_src_dir"><code class="docutils literal notranslate"><span class="pre">is_local_src_dir</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.is_sequence"><code class="docutils literal notranslate"><span class="pre">is_sequence</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.is_string"><code class="docutils literal notranslate"><span class="pre">is_string</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.mingw32"><code class="docutils literal notranslate"><span class="pre">mingw32</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.minrelpath"><code class="docutils literal notranslate"><span class="pre">minrelpath</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.njoin"><code class="docutils literal notranslate"><span class="pre">njoin</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.red_text"><code class="docutils literal notranslate"><span class="pre">red_text</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.sanitize_cxx_flags"><code class="docutils literal notranslate"><span class="pre">sanitize_cxx_flags</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.terminal_has_colors"><code class="docutils literal notranslate"><span class="pre">terminal_has_colors</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="distutils/misc_util.html#numpy.distutils.misc_util.yellow_text"><code class="docutils literal notranslate"><span class="pre">yellow_text</span></code></a></li>
</ul>
</li>
</ul>
</div>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/numpy.distutils.ccompiler.html#module-numpy.distutils.ccompiler" title="numpy.distutils.ccompiler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ccompiler</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/numpy.distutils.ccompiler_opt.html#module-numpy.distutils.ccompiler_opt" title="numpy.distutils.ccompiler_opt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ccompiler_opt</span></code></a></p></td>
<td><p>Provides the <em class="xref py py-obj">CCompilerOpt</em> class, used for handling the CPU/hardware optimization, starting from parsing the command arguments, to managing the relation between the CPU baseline and dispatch-able features, also generating the required C headers and ending with compiling the sources with proper compiler's flags.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/numpy.distutils.cpuinfo.cpu.html#numpy.distutils.cpuinfo.cpu" title="numpy.distutils.cpuinfo.cpu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cpuinfo.cpu</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/numpy.distutils.core.Extension.html#numpy.distutils.core.Extension" title="numpy.distutils.core.Extension"><code class="xref py py-obj docutils literal notranslate"><span class="pre">core.Extension</span></code></a>(name, sources[, ...])</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/numpy.distutils.exec_command.html#module-numpy.distutils.exec_command" title="numpy.distutils.exec_command"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exec_command</span></code></a></p></td>
<td><p>exec_command</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/numpy.distutils.log.set_verbosity.html#numpy.distutils.log.set_verbosity" title="numpy.distutils.log.set_verbosity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log.set_verbosity</span></code></a>(v[, force])</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/numpy.distutils.system_info.get_info.html#numpy.distutils.system_info.get_info" title="numpy.distutils.system_info.get_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system_info.get_info</span></code></a>(name[, notfound_action])</p></td>
<td><p>notfound_action:</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/numpy.distutils.system_info.get_standard_file.html#numpy.distutils.system_info.get_standard_file" title="numpy.distutils.system_info.get_standard_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system_info.get_standard_file</span></code></a>(fname)</p></td>
<td><p>Returns a list of files named 'fname' from 1) System-wide directory (directory-location of this module) 2) Users HOME directory (os.environ['HOME']) 3) Local directory</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="configuration-class">
<h2>Configuration class<a class="headerlink" href="#configuration-class" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">numpy.distutils.misc_util.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">top_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">package_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">attrs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L750-L2119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration" title="Link to this definition">#</a></dt>
<dd><p>Construct a configuration instance for the given package name. If
<em>parent_name</em> is not None, then construct the package as a
sub-package of the <em>parent_name</em> package. If <em>top_path</em> and
<em>package_path</em> are None then they are assumed equal to
the path of the file this instance was created in. The setup.py
files in the numpy distribution are good examples of how to use
the <a class="reference internal" href="#numpy.distutils.misc_util.Configuration" title="numpy.distutils.misc_util.Configuration"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configuration</span></code></a> instance.</p>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.todict">
<span class="sig-name descname"><span class="pre">todict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L857-L874"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.todict" title="Link to this definition">#</a></dt>
<dd><p>Return a dictionary compatible with the keyword arguments of distutils
setup function.</p>
<p class="rubric">Examples</p>
<div class="try_examples_outer_container docutils container" id="5082f934-9bdf-46c1-9f29-f9b1ed57729d">
<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('5082f934-9bdf-46c1-9f29-f9b1ed57729d','d31d7d27-4bf3-4385-af84-5fc6fc152a68','2c3ab082-905d-47d3-a708-87aab94e076b','../lite/tree/../notebooks/index.html?path=081fa199_1bc0_4cc9_bc40_d0f932c1cc78.ipynb','None')">Try it in your browser!</button></div><div class="try_examples_content docutils container">
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">setup</span><span class="p">(</span><span class="o">**</span><span class="n">config</span><span class="o">.</span><span class="n">todict</span><span class="p">())</span>
</pre></div>
</div>
</div>
</div>
<div id="2c3ab082-905d-47d3-a708-87aab94e076b" class="try_examples_outer_iframe hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('5082f934-9bdf-46c1-9f29-f9b1ed57729d','2c3ab082-905d-47d3-a708-87aab94e076b')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('5082f934-9bdf-46c1-9f29-f9b1ed57729d','2c3ab082-905d-47d3-a708-87aab94e076b')">Open In Tab</button></div><div id="d31d7d27-4bf3-4385-af84-5fc6fc152a68" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.get_distribution">
<span class="sig-name descname"><span class="pre">get_distribution</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L900-L903"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.get_distribution" title="Link to this definition">#</a></dt>
<dd><p>Return the distutils distribution object for self.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.get_subpackage">
<span class="sig-name descname"><span class="pre">get_subpackage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subpackage_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subpackage_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caller_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L957-L1016"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.get_subpackage" title="Link to this definition">#</a></dt>
<dd><p>Return list of subpackage configurations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>subpackage_name</strong><span class="classifier">str or None</span></dt><dd><p>Name of the subpackage to get the configuration. ‘*’ in
subpackage_name is handled as a wildcard.</p>
</dd>
<dt><strong>subpackage_path</strong><span class="classifier">str</span></dt><dd><p>If None, then the path is assumed to be the local path plus the
subpackage_name. If a setup.py file is not found in the
subpackage_path, then a default configuration is used.</p>
</dd>
<dt><strong>parent_name</strong><span class="classifier">str</span></dt><dd><p>Parent name.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_subpackage">
<span class="sig-name descname"><span class="pre">add_subpackage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subpackage_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subpackage_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standalone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1018-L1059"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_subpackage" title="Link to this definition">#</a></dt>
<dd><p>Add a sub-package to the current Configuration instance.</p>
<p>This is useful in a setup.py script for adding sub-packages to a
package.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>subpackage_name</strong><span class="classifier">str</span></dt><dd><p>name of the subpackage</p>
</dd>
<dt><strong>subpackage_path</strong><span class="classifier">str</span></dt><dd><p>if given, the subpackage path such as the subpackage is in
subpackage_path / subpackage_name. If None,the subpackage is
assumed to be located in the local path / subpackage_name.</p>
</dd>
<dt><strong>standalone</strong><span class="classifier">bool</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_data_files">
<span class="sig-name descname"><span class="pre">add_data_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">files</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1191-L1340"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_data_files" title="Link to this definition">#</a></dt>
<dd><p>Add data files to configuration data_files.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<dt><strong>files</strong><span class="classifier">sequence</span></dt><dd><p>Argument(s) can be either</p>
<blockquote>
<div><ul class="simple">
<li><p>2-sequence (<datadir prefix>,<path to data file(s)>)</p></li>
<li><p>paths to data files where python datadir prefix defaults
to package dir.</p></li>
</ul>
</div></blockquote>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The form of each element of the files sequence is very flexible
allowing many combinations of where to get the files from the package
and where they should ultimately be installed on the system. The most
basic usage is for an element of the files argument sequence to be a
simple filename. This will cause that file from the local path to be
installed to the installation path of the self.name package (package
path). The file argument can also be a relative path in which case the
entire relative path will be installed into the package directory.
Finally, the file can be an absolute path name in which case the file
will be found at the absolute path name but installed to the package
path.</p>
<p>This basic behavior can be augmented by passing a 2-tuple in as the
file argument. The first element of the tuple should specify the
relative path (under the package install directory) where the
remaining sequence of files should be installed to (it has nothing to
do with the file-names in the source distribution). The second element
of the tuple is the sequence of files that should be installed. The
files in this sequence can be filenames, relative paths, or absolute
paths. For absolute paths the file will be installed in the top-level
package installation directory (regardless of the first argument).
Filenames and relative path names will be installed in the package
install directory under the path name given as the first element of
the tuple.</p>
<p>Rules for installation paths:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>file.txt -> (., file.txt)-> parent/file.txt</p></li>
<li><p>foo/file.txt -> (foo, foo/file.txt) -> parent/foo/file.txt</p></li>
<li><p>/foo/bar/file.txt -> (., /foo/bar/file.txt) -> parent/file.txt</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">*</span></code>.txt -> parent/a.txt, parent/b.txt</p></li>
<li><p>foo/<code class="docutils literal notranslate"><span class="pre">*</span></code>.txt`` -> parent/foo/a.txt, parent/foo/b.txt</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">*/*.txt</span></code> -> (<code class="docutils literal notranslate"><span class="pre">*</span></code>, <code class="docutils literal notranslate"><span class="pre">*</span></code>/<code class="docutils literal notranslate"><span class="pre">*</span></code>.txt) -> parent/c/a.txt, parent/d/b.txt</p></li>
<li><p>(sun, file.txt) -> parent/sun/file.txt</p></li>
<li><p>(sun, bar/file.txt) -> parent/sun/file.txt</p></li>
<li><p>(sun, /foo/bar/file.txt) -> parent/sun/file.txt</p></li>
<li><p>(sun, <code class="docutils literal notranslate"><span class="pre">*</span></code>.txt) -> parent/sun/a.txt, parent/sun/b.txt</p></li>
<li><p>(sun, bar/<code class="docutils literal notranslate"><span class="pre">*</span></code>.txt) -> parent/sun/a.txt, parent/sun/b.txt</p></li>
<li><p>(sun/<code class="docutils literal notranslate"><span class="pre">*</span></code>, <code class="docutils literal notranslate"><span class="pre">*</span></code>/<code class="docutils literal notranslate"><span class="pre">*</span></code>.txt) -> parent/sun/c/a.txt, parent/d/b.txt</p></li>
</ol>
</div></blockquote>
<p>An additional feature is that the path to a data-file can actually be
a function that takes no arguments and returns the actual path(s) to
the data-files. This is useful when the data files are generated while
building the package.</p>
<p class="rubric">Examples</p>
<div class="try_examples_outer_container docutils container" id="57f428d4-7377-4cb3-a660-f0d862d64964">
<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('57f428d4-7377-4cb3-a660-f0d862d64964','153c9af6-2702-45fe-94af-6c9a30120ca2','035ff7e2-2cec-4a9e-befd-e850a0a9dd06','../lite/tree/../notebooks/index.html?path=5719d47a_9b0b_4823_94f2_2bb252386a3f.ipynb','None')">Try it in your browser!</button></div><div class="try_examples_content docutils container">
<p>Add files to the list of data_files to be included with the package.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="bp">self</span><span class="o">.</span><span class="n">add_data_files</span><span class="p">(</span><span class="s1">'foo.dat'</span><span class="p">,</span>
<span class="gp">... </span> <span class="p">(</span><span class="s1">'fun'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'gun.dat'</span><span class="p">,</span> <span class="s1">'nun/pun.dat'</span><span class="p">,</span> <span class="s1">'/tmp/sun.dat'</span><span class="p">]),</span>
<span class="gp">... </span> <span class="s1">'bar/cat.dat'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'/full/path/to/can.dat'</span><span class="p">)</span>
</pre></div>
</div>
<p>will install these data files to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">package</span> <span class="n">install</span> <span class="n">directory</span><span class="o">>/</span>
<span class="n">foo</span><span class="o">.</span><span class="n">dat</span>
<span class="n">fun</span><span class="o">/</span>
<span class="n">gun</span><span class="o">.</span><span class="n">dat</span>
<span class="n">nun</span><span class="o">/</span>
<span class="n">pun</span><span class="o">.</span><span class="n">dat</span>
<span class="n">sun</span><span class="o">.</span><span class="n">dat</span>
<span class="n">bar</span><span class="o">/</span>
<span class="n">car</span><span class="o">.</span><span class="n">dat</span>
<span class="n">can</span><span class="o">.</span><span class="n">dat</span>
</pre></div>
</div>
<p>where <package install directory> is the package (or sub-package)
directory such as ‘/usr/lib/python2.4/site-packages/mypackage’ (‘C:
Python2.4 Lib site-packages mypackage’) or
‘/usr/lib/python2.4/site- packages/mypackage/mysubpackage’ (‘C:
Python2.4 Lib site-packages mypackage mysubpackage’).</p>
</div>
</div>
<div id="035ff7e2-2cec-4a9e-befd-e850a0a9dd06" class="try_examples_outer_iframe hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('57f428d4-7377-4cb3-a660-f0d862d64964','035ff7e2-2cec-4a9e-befd-e850a0a9dd06')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('57f428d4-7377-4cb3-a660-f0d862d64964','035ff7e2-2cec-4a9e-befd-e850a0a9dd06')">Open In Tab</button></div><div id="153c9af6-2702-45fe-94af-6c9a30120ca2" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_data_dir">
<span class="sig-name descname"><span class="pre">add_data_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1061-L1180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_data_dir" title="Link to this definition">#</a></dt>
<dd><p>Recursively add files under data_path to data_files list.</p>
<p>Recursively add files under data_path to the list of data_files to be
installed (and distributed). The data_path can be either a relative
path-name, or an absolute path-name, or a 2-tuple where the first
argument shows where in the install directory the data directory
should be installed to.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<dt><strong>data_path</strong><span class="classifier">seq or str</span></dt><dd><p>Argument can be either</p>
<blockquote>
<div><ul class="simple">
<li><p>2-sequence (<datadir suffix>, <path to data directory>)</p></li>
<li><p>path to data directory where python datadir suffix defaults
to package dir.</p></li>
</ul>
</div></blockquote>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Rules for installation paths:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span> <span class="o">-></span> <span class="p">(</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span>
<span class="p">(</span><span class="n">gun</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">gun</span>
<span class="n">foo</span><span class="o">/*</span> <span class="o">-></span> <span class="p">(</span><span class="n">foo</span><span class="o">/</span><span class="n">a</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">a</span><span class="p">),</span> <span class="p">(</span><span class="n">foo</span><span class="o">/</span><span class="n">b</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">b</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">a</span><span class="p">,</span> <span class="n">parent</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">b</span>
<span class="p">(</span><span class="n">gun</span><span class="p">,</span> <span class="n">foo</span><span class="o">/*</span><span class="p">)</span> <span class="o">-></span> <span class="p">(</span><span class="n">gun</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">a</span><span class="p">),</span> <span class="p">(</span><span class="n">gun</span><span class="p">,</span> <span class="n">foo</span><span class="o">/</span><span class="n">b</span><span class="p">)</span> <span class="o">-></span> <span class="n">gun</span>
<span class="p">(</span><span class="n">gun</span><span class="o">/*</span><span class="p">,</span> <span class="n">foo</span><span class="o">/*</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">gun</span><span class="o">/</span><span class="n">a</span><span class="p">,</span> <span class="n">parent</span><span class="o">/</span><span class="n">gun</span><span class="o">/</span><span class="n">b</span>
<span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span> <span class="o">-></span> <span class="p">(</span><span class="n">bar</span><span class="p">,</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">bar</span>
<span class="p">(</span><span class="n">gun</span><span class="p">,</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">gun</span>
<span class="p">(</span><span class="n">fun</span><span class="o">/*/</span><span class="n">gun</span><span class="o">/*</span><span class="p">,</span> <span class="n">sun</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="p">)</span> <span class="o">-></span> <span class="n">parent</span><span class="o">/</span><span class="n">fun</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">gun</span><span class="o">/</span><span class="n">bar</span>
</pre></div>
</div>
<p class="rubric">Examples</p>
<div class="try_examples_outer_container docutils container" id="05d9e6c0-034e-40b2-a699-24174860d773">
<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('05d9e6c0-034e-40b2-a699-24174860d773','7d056d2e-d06f-42f0-bd53-66b4df66ac80','de059e7e-bf7e-4070-8fc4-c31f4eab7730','../lite/tree/../notebooks/index.html?path=4f9e9d41_c9cc_4188_bcc9_918a03131158.ipynb','None')">Try it in your browser!</button></div><div class="try_examples_content docutils container">
<p>For example suppose the source directory contains fun/foo.dat and
fun/bar/car.dat:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="bp">self</span><span class="o">.</span><span class="n">add_data_dir</span><span class="p">(</span><span class="s1">'fun'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="bp">self</span><span class="o">.</span><span class="n">add_data_dir</span><span class="p">((</span><span class="s1">'sun'</span><span class="p">,</span> <span class="s1">'fun'</span><span class="p">))</span>
<span class="gp">>>> </span><span class="bp">self</span><span class="o">.</span><span class="n">add_data_dir</span><span class="p">((</span><span class="s1">'gun'</span><span class="p">,</span> <span class="s1">'/full/path/to/fun'</span><span class="p">))</span>
</pre></div>
</div>
<p>Will install data-files to the locations:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">package</span> <span class="n">install</span> <span class="n">directory</span><span class="o">>/</span>
<span class="n">fun</span><span class="o">/</span>
<span class="n">foo</span><span class="o">.</span><span class="n">dat</span>
<span class="n">bar</span><span class="o">/</span>
<span class="n">car</span><span class="o">.</span><span class="n">dat</span>
<span class="n">sun</span><span class="o">/</span>
<span class="n">foo</span><span class="o">.</span><span class="n">dat</span>
<span class="n">bar</span><span class="o">/</span>
<span class="n">car</span><span class="o">.</span><span class="n">dat</span>
<span class="n">gun</span><span class="o">/</span>
<span class="n">foo</span><span class="o">.</span><span class="n">dat</span>
<span class="n">car</span><span class="o">.</span><span class="n">dat</span>
</pre></div>
</div>
</div>
</div>
<div id="de059e7e-bf7e-4070-8fc4-c31f4eab7730" class="try_examples_outer_iframe hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('05d9e6c0-034e-40b2-a699-24174860d773','de059e7e-bf7e-4070-8fc4-c31f4eab7730')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('05d9e6c0-034e-40b2-a699-24174860d773','de059e7e-bf7e-4070-8fc4-c31f4eab7730')">Open In Tab</button></div><div id="7d056d2e-d06f-42f0-bd53-66b4df66ac80" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_include_dirs">
<span class="sig-name descname"><span class="pre">add_include_dirs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">paths</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1360-L1374"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_include_dirs" title="Link to this definition">#</a></dt>
<dd><p>Add paths to configuration include directories.</p>
<p>Add the given sequence of paths to the beginning of the include_dirs
list. This list will be visible to all extension modules of the
current package.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_headers">
<span class="sig-name descname"><span class="pre">add_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">files</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1376-L1408"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_headers" title="Link to this definition">#</a></dt>
<dd><p>Add installable headers to configuration.</p>
<p>Add the given sequence of files to the beginning of the headers list.
By default, headers will be installed under <python-
include>/<self.name.replace(‘.’,’/’)>/ directory. If an item of files
is a tuple, then its first argument specifies the actual installation
location relative to the <python-include> path.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<dt><strong>files</strong><span class="classifier">str or seq</span></dt><dd><p>Argument(s) can be either:</p>
<blockquote>
<div><ul class="simple">
<li><p>2-sequence (<includedir suffix>,<path to header file(s)>)</p></li>
<li><p>path(s) to header file(s) where python includedir suffix will
default to package name.</p></li>
</ul>
</div></blockquote>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_extension">
<span class="sig-name descname"><span class="pre">add_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sources</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1433-L1534"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_extension" title="Link to this definition">#</a></dt>
<dd><p>Add extension to configuration.</p>
<p>Create and add an Extension instance to the ext_modules list. This
method also takes the following optional keyword arguments that are
passed on to the Extension constructor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>name of the extension</p>
</dd>
<dt><strong>sources</strong><span class="classifier">seq</span></dt><dd><p>list of the sources. The list of sources may contain functions
(called source generators) which must take an extension instance
and a build directory as inputs and return a source file or list of
source files or None. If None is returned then no sources are
generated. If the Extension instance has no sources after
processing all source generators, then no extension module is
built.</p>
</dd>
<dt><strong>include_dirs</strong></dt><dd></dd>
<dt><strong>define_macros</strong></dt><dd></dd>
<dt><strong>undef_macros</strong></dt><dd></dd>
<dt><strong>library_dirs</strong></dt><dd></dd>
<dt><strong>libraries</strong></dt><dd></dd>
<dt><strong>runtime_library_dirs</strong></dt><dd></dd>
<dt><strong>extra_objects</strong></dt><dd></dd>
<dt><strong>extra_compile_args</strong></dt><dd></dd>
<dt><strong>extra_link_args</strong></dt><dd></dd>
<dt><strong>extra_f77_compile_args</strong></dt><dd></dd>
<dt><strong>extra_f90_compile_args</strong></dt><dd></dd>
<dt><strong>export_symbols</strong></dt><dd></dd>
<dt><strong>swig_opts</strong></dt><dd></dd>
<dt><strong>depends</strong></dt><dd><p>The depends list contains paths to files or directories that the
sources of the extension module depend on. If any path in the
depends list is newer than the extension module, then the module
will be rebuilt.</p>
</dd>
<dt><strong>language</strong></dt><dd></dd>
<dt><strong>f2py_options</strong></dt><dd></dd>
<dt><strong>module_dirs</strong></dt><dd></dd>
<dt><strong>extra_info</strong><span class="classifier">dict or list</span></dt><dd><p>dict or list of dict of keywords to be appended to keywords.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The self.paths(…) method is applied to all lists that may contain
paths.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="numpy.distutils.misc_util.Configuration.add_library">
<span class="sig-name descname"><span class="pre">add_library</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sources</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">build_info</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/numpy/numpy/blob/main/numpy/distutils/misc_util.py#L1536-L1570"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numpy.distutils.misc_util.Configuration.add_library" title="Link to this definition">#</a></dt>
<dd><p>Add library to configuration.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl>
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the extension.</p>
</dd>
<dt><strong>sources</strong><span class="classifier">sequence</span></dt><dd><p>List of the sources. The list of sources may contain functions
(called source generators) which must take an extension instance
and a build directory as inputs and return a source file or list of