/usr/share/doc/python-sip-doc/html/build_system.html is in python-sip-doc 4.15.5-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The Build System — SIP 4.15.5 Reference Guide</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.15.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/logo_tn.ico"/>
<link rel="top" title="SIP 4.15.5 Reference Guide" href="index.html" />
<link rel="next" title="Building Your Extension with distutils" href="distutils.html" />
<link rel="prev" title="Python API for Applications" href="python_api.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="distutils.html" title="Building Your Extension with distutils"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="python_api.html" title="Python API for Applications"
accesskey="P">previous</a> |</li>
<li><a href="index.html">SIP 4.15.5 Reference Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sipconfig">
<span id="the-build-system"></span><span id="ref-build-system"></span><h1>The Build System<a class="headerlink" href="#module-sipconfig" title="Permalink to this headline">¶</a></h1>
<p>The purpose of the build system is to make it easy for you to write
configuration scripts in Python for your own bindings. The build system takes
care of the details of particular combinations of platform and compiler. It
supports over 50 different platform/compiler combinations.</p>
<p>The build system is implemented as a pure Python module called <a class="reference internal" href="#module-sipconfig" title="sipconfig"><tt class="xref py py-mod docutils literal"><span class="pre">sipconfig</span></tt></a>
that contains a number of classes and functions. Using this module you can
write bespoke configuration scripts (e.g. PyQt’s <tt class="docutils literal"><span class="pre">configure.py</span></tt>) or use it
with other Python based build systems (e.g.
<a class="reference external" href="http://www.python.org/sigs/distutils-sig/distutils.html">Distutils</a> and
<a class="reference external" href="http://www.scons.org">SCons</a>).</p>
<p>An important feature of SIP is the ability to generate bindings that are built
on top of existing bindings. For example, both
<a class="reference external" href="http://www.riverbankcomputing.com/software/pykde/">PyKDE</a> and
<a class="reference external" href="http://pyqwt.sourceforge.net/">PyQwt</a> are built on top of PyQt but all three
packages are maintained by different developers. To make this easier PyQt
includes its own configuration module, <tt class="docutils literal"><span class="pre">pyqtconfig</span></tt>, that contains additional
classes intended to be used by the configuration scripts of bindings built on
top of PyQt. The SIP build system includes facilities that do a lot of the
work of creating these additional configuration modules.</p>
<dl class="function">
<dt id="sipconfig.create_config_module">
<tt class="descclassname">sipconfig.</tt><tt class="descname">create_config_module</tt><big>(</big><em>module</em>, <em>template</em>, <em>content</em><span class="optional">[</span>, <em>macros=None</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.create_config_module" title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a configuration module (e.g. <tt class="docutils literal"><span class="pre">pyqtconfig</span></tt>) from a template
file and a string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>module</strong> – the name of the configuration module file to create.</li>
<li><strong>template</strong> – the name of the template file.</li>
<li><strong>content</strong> – a string which replaces every occurence of the pattern
<tt class="docutils literal"><span class="pre">@SIP_CONFIGURATION@</span></tt> in the template file. The content string is
usually created from a Python dictionary using
<a class="reference internal" href="#sipconfig.create_content" title="sipconfig.create_content"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.create_content()</span></tt></a>. <em>content</em> may also be a
dictionary, in which case <a class="reference internal" href="#sipconfig.create_content" title="sipconfig.create_content"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.create_content()</span></tt></a> is
automatically called to convert it to a string.</li>
<li><strong>macros</strong> – an optional dictionary of platform specific build macros. It is only
used if <a class="reference internal" href="#sipconfig.create_content" title="sipconfig.create_content"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.create_content()</span></tt></a> is called automatically to
convert a <em>content</em> dictionary to a string.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.create_content">
<tt class="descclassname">sipconfig.</tt><tt class="descname">create_content</tt><big>(</big><em>dict</em><span class="optional">[</span>, <em>macros=None</em><span class="optional">]</span><big>)</big> → string<a class="headerlink" href="#sipconfig.create_content" title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a Python dictionary to a string that can be parsed by the
Python interpreter and converted back to an equivalent dictionary. It is
typically used to generate the content string for
<a class="reference internal" href="#sipconfig.create_config_module" title="sipconfig.create_config_module"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.create_config_module()</span></tt></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>dict</strong> – the Python dictionary to convert.</li>
<li><strong>macros</strong> – the optional dictionary of platform specific build macros.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the string representation of the dictionary.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.create_wrapper">
<tt class="descclassname">sipconfig.</tt><tt class="descname">create_wrapper</tt><big>(</big><em>script</em>, <em>wrapper</em><span class="optional">[</span>, <em>gui=0</em><span class="optional">[</span>, <em>use_arch=''</em><span class="optional">]</span><span class="optional">]</span><big>)</big> → string<a class="headerlink" href="#sipconfig.create_wrapper" title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a platform dependent executable wrapper around a Python
script.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>script</strong> – the full pathname of the script.</li>
<li><strong>wrapper</strong> – the full pathname of the wrapper to create, excluding any platform
specific extension.</li>
<li><strong>gui</strong> – is non-zero if a GUI enabled version of the interpreter should be used
on platforms that require it.</li>
<li><strong>use_arch</strong> – is the MacOS/X architectures to invoke python with. Several space
separated architectures may be specified.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the platform specific name of the wrapper.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.error">
<tt class="descclassname">sipconfig.</tt><tt class="descname">error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#sipconfig.error" title="Permalink to this definition">¶</a></dt>
<dd><p>This displays an error message on <tt class="docutils literal"><span class="pre">stderr</span></tt> and calls <tt class="docutils literal"><span class="pre">sys.exit(1)</span></tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> – the text of the message and should not include any newline characters.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.format">
<tt class="descclassname">sipconfig.</tt><tt class="descname">format</tt><big>(</big><em>msg</em><span class="optional">[</span>, <em>leftmargin=0</em><span class="optional">[</span>, <em>rightmargin=78</em><span class="optional">]</span><span class="optional">]</span><big>)</big> → string<a class="headerlink" href="#sipconfig.format" title="Permalink to this definition">¶</a></dt>
<dd><p>This formats a message by inserting newline characters at appropriate
places.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>msg</strong> – the text of the message and should not include any newline characters.</li>
<li><strong>leftmargin</strong> – the optional position of the left margin.</li>
<li><strong>rightmargin</strong> – the optional position of the right margin.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the formatted message.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.inform">
<tt class="descclassname">sipconfig.</tt><tt class="descname">inform</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#sipconfig.inform" title="Permalink to this definition">¶</a></dt>
<dd><p>This displays an information message on <tt class="docutils literal"><span class="pre">stdout</span></tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> – the text of the message and should not include any newline characters.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.parse_build_macros">
<tt class="descclassname">sipconfig.</tt><tt class="descname">parse_build_macros</tt><big>(</big><em>filename</em>, <em>names</em><span class="optional">[</span>, <em>overrides=None</em><span class="optional">[</span>, <em>properties=None</em><span class="optional">]</span><span class="optional">]</span><big>)</big> → dict<a class="headerlink" href="#sipconfig.parse_build_macros" title="Permalink to this definition">¶</a></dt>
<dd><p>This parses a <tt class="docutils literal"><span class="pre">qmake</span></tt> compatible file of build system macros and converts
it to a dictionary. A macro is a name/value pair. Individual macros may
be augmented or replaced.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filename</strong> – the name of the file to parse.</li>
<li><strong>names</strong> – the list of the macro names to extract from the file.</li>
<li><strong>overrides</strong> – the optional list of macro names and values that modify those found in
the file. They are of the form <tt class="docutils literal"><span class="pre">name=value</span></tt> (in which case the value
replaces the value found in the file) or <tt class="docutils literal"><span class="pre">name+=value</span></tt> (in which case
the value is appended to the value found in the file).</li>
<li><strong>properties</strong> – the optional dictionary of property name and values that are used to
resolve any expressions of the form <tt class="docutils literal"><span class="pre">$[name]</span></tt> in the file.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the dictionary of parsed macros or <tt class="docutils literal"><span class="pre">None</span></tt> if any of the overrides
were invalid.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.read_version">
<tt class="descclassname">sipconfig.</tt><tt class="descname">read_version</tt><big>(</big><em>filename</em>, <em>description</em><span class="optional">[</span>, <em>numdefine=None</em><span class="optional">[</span>, <em>strdefine=None</em><span class="optional">]</span><span class="optional">]</span><big>)</big> → integer, string<a class="headerlink" href="#sipconfig.read_version" title="Permalink to this definition">¶</a></dt>
<dd><p>This extracts version information for a package from a file, usually a C or
C++ header file. The version information must each be specified as a
<tt class="docutils literal"><span class="pre">#define</span></tt> of a numeric (hexadecimal or decimal) value and/or a string
value.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filename</strong> – the name of the file to read.</li>
<li><strong>description</strong> – a descriptive name of the package used in error messages.</li>
<li><strong>numdefine</strong> – the optional name of the <tt class="docutils literal"><span class="pre">#define</span></tt> of the version as a number. If it
is <tt class="docutils literal"><span class="pre">None</span></tt> then the numeric version is ignored.</li>
<li><strong>strdefine</strong> – the optional name of the <tt class="docutils literal"><span class="pre">#define</span></tt> of the version as a string. If it
is <tt class="docutils literal"><span class="pre">None</span></tt> then the string version is ignored.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a tuple of the numeric and string versions. <a class="reference internal" href="#sipconfig.error" title="sipconfig.error"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.error()</span></tt></a>
is called if either were required but could not be found.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.version_to_sip_tag">
<tt class="descclassname">sipconfig.</tt><tt class="descname">version_to_sip_tag</tt><big>(</big><em>version</em>, <em>tags</em>, <em>description</em><big>)</big> → string<a class="headerlink" href="#sipconfig.version_to_sip_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a version number to a SIP version tag. SIP uses the
<a class="reference internal" href="directives.html#directive-%Timeline"><tt class="xref std std-directive docutils literal"><span class="pre">%Timeline</span></tt></a> directive to define the chronology of the different
versions of the C/C++ library being wrapped. Typically it is not necessary
to define a version tag for every version of the library, but only for
those versions that affect the library’s API as SIP sees it.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>version</strong> – the numeric version number of the C/C++ library being wrapped. If it
is negative then the latest version is assumed. (This is typically
useful if a snapshot is indicated by a negative version number.)</li>
<li><strong>tags</strong> – the dictionary of SIP version tags keyed by the corresponding C/C++
library version number. The tag used is the one with the smallest key
(i.e. earliest version) that is greater than <em>version</em>.</li>
<li><strong>description</strong> – a descriptive name of the C/C++ library used in error messages.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the SIP version tag. <a class="reference internal" href="#sipconfig.error" title="sipconfig.error"><tt class="xref py py-func docutils literal"><span class="pre">sipconfig.error()</span></tt></a> is called if the C/C++
library version number did not correspond to a SIP version tag.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="sipconfig.version_to_string">
<tt class="descclassname">sipconfig.</tt><tt class="descname">version_to_string</tt><big>(</big><em>v</em><big>)</big> → string<a class="headerlink" href="#sipconfig.version_to_string" title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a 3 part version number encoded as a hexadecimal value to a
string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>v</strong> – the version number.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a string.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="sipconfig.Configuration">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">Configuration</tt><a class="headerlink" href="#sipconfig.Configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>This class encapsulates configuration values that can be accessed as
instance objects. A sub-class may provide a dictionary of additional
configuration values in its constructor the elements of which will have
precedence over the super-class’s values.</p>
<p>The following configuration values are provided:</p>
<dl class="attribute">
<dt id="sipconfig.Configuration.default_bin_dir">
<tt class="descname">default_bin_dir</tt><a class="headerlink" href="#sipconfig.Configuration.default_bin_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory where executables should be installed by
default.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.default_mod_dir">
<tt class="descname">default_mod_dir</tt><a class="headerlink" href="#sipconfig.Configuration.default_mod_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory where SIP generated modules should be
installed by default.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.default_sip_dir">
<tt class="descname">default_sip_dir</tt><a class="headerlink" href="#sipconfig.Configuration.default_sip_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the base directory where the <tt class="docutils literal"><span class="pre">.sip</span></tt> files for SIP
generated modules should be installed by default. A sub-directory with
the same name as the module should be created and its <tt class="docutils literal"><span class="pre">.sip</span></tt> files
should be installed in the sub-directory. The <tt class="docutils literal"><span class="pre">.sip</span></tt> files only need
to be installed if you might want to build other bindings based on
them.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.platform">
<tt class="descname">platform</tt><a class="headerlink" href="#sipconfig.Configuration.platform" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the platform/compiler for which the build system has been
configured for.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.py_conf_inc_dir">
<tt class="descname">py_conf_inc_dir</tt><a class="headerlink" href="#sipconfig.Configuration.py_conf_inc_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory containing the <tt class="docutils literal"><span class="pre">pyconfig.h</span></tt> header file.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.py_inc_dir">
<tt class="descname">py_inc_dir</tt><a class="headerlink" href="#sipconfig.Configuration.py_inc_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory containing the <tt class="docutils literal"><span class="pre">Python.h</span></tt> header file.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.py_lib_dir">
<tt class="descname">py_lib_dir</tt><a class="headerlink" href="#sipconfig.Configuration.py_lib_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory containing the Python interpreter library.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.py_version">
<tt class="descname">py_version</tt><a class="headerlink" href="#sipconfig.Configuration.py_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The Python version as a 3 part hexadecimal number (e.g. v2.3.3 is
represented as <tt class="docutils literal"><span class="pre">0x020303</span></tt>).</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_bin">
<tt class="descname">sip_bin</tt><a class="headerlink" href="#sipconfig.Configuration.sip_bin" title="Permalink to this definition">¶</a></dt>
<dd><p>The full pathname of the SIP executable.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_config_args">
<tt class="descname">sip_config_args</tt><a class="headerlink" href="#sipconfig.Configuration.sip_config_args" title="Permalink to this definition">¶</a></dt>
<dd><p>The command line passed to <tt class="docutils literal"><span class="pre">configure.py</span></tt> when SIP was configured.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_inc_dir">
<tt class="descname">sip_inc_dir</tt><a class="headerlink" href="#sipconfig.Configuration.sip_inc_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory containing the <tt class="docutils literal"><span class="pre">sip.h</span></tt> header file.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_mod_dir">
<tt class="descname">sip_mod_dir</tt><a class="headerlink" href="#sipconfig.Configuration.sip_mod_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the directory containing the SIP module.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_version">
<tt class="descname">sip_version</tt><a class="headerlink" href="#sipconfig.Configuration.sip_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The SIP version as a 3 part hexadecimal number (e.g. v4.0.0 is
represented as <tt class="docutils literal"><span class="pre">0x040000</span></tt>).</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.sip_version_str">
<tt class="descname">sip_version_str</tt><a class="headerlink" href="#sipconfig.Configuration.sip_version_str" title="Permalink to this definition">¶</a></dt>
<dd><p>The SIP version as a string. For development snapshots it will start
with <tt class="docutils literal"><span class="pre">snapshot-</span></tt>.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.universal">
<tt class="descname">universal</tt><a class="headerlink" href="#sipconfig.Configuration.universal" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the MacOS/X SDK used when creating universal binaries.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.arch">
<tt class="descname">arch</tt><a class="headerlink" href="#sipconfig.Configuration.arch" title="Permalink to this definition">¶</a></dt>
<dd><p>The space separated MacOS/X architectures to build.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Configuration.deployment_target">
<tt class="descname">deployment_target</tt><a class="headerlink" href="#sipconfig.Configuration.deployment_target" title="Permalink to this definition">¶</a></dt>
<dd><p>The MacOS/X deployment target.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Configuration.__init__">
<tt class="descname">__init__</tt><big>(</big><span class="optional">[</span><em>sub_cfg=None</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.Configuration.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_cfg</strong> – an optional list of sub-class configurations. It should only be
used by the <tt class="docutils literal"><span class="pre">__init__()</span></tt> method of a sub-class to append its own
dictionary of configuration values before passing the list to its
super-class.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Configuration.build_macros">
<tt class="descname">build_macros</tt><big>(</big><big>)</big> → dict<a class="headerlink" href="#sipconfig.Configuration.build_macros" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the dictionary of platform specific build macros.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the macros dictionary.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Configuration.set_build_macros">
<tt class="descname">set_build_macros</tt><big>(</big><em>macros</em><big>)</big><a class="headerlink" href="#sipconfig.Configuration.set_build_macros" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dictionary of platform specific build macros to be used when
generating Makefiles. Normally there is no need to change the default
macros.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>macros</strong> – the macros dictionary.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.Makefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">Makefile</tt><a class="headerlink" href="#sipconfig.Makefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class encapsulates a Makefile. It is intended to be sub-classed to
generate Makefiles for particular purposes. It handles all platform and
compiler specific flags, but allows them to be adjusted to suit the
requirements of a particular module or program. These are defined using a
number of macros which can be accessed as instance attributes.</p>
<p>The following instance attributes are provided to help in fine tuning the
generated Makefile:</p>
<dl class="attribute">
<dt id="sipconfig.Makefile.chkdir">
<tt class="descname">chkdir</tt><a class="headerlink" href="#sipconfig.Makefile.chkdir" title="Permalink to this definition">¶</a></dt>
<dd><p>A string that will check for the existence of a directory.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.config">
<tt class="descname">config</tt><a class="headerlink" href="#sipconfig.Makefile.config" title="Permalink to this definition">¶</a></dt>
<dd><p>A reference to the <em>configuration</em> argument that was passed to
<a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">Makefile.__init__()</span></tt></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.console">
<tt class="descname">console</tt><a class="headerlink" href="#sipconfig.Makefile.console" title="Permalink to this definition">¶</a></dt>
<dd><p>A reference to the <em>console</em> argument that was passed to the
<a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">Makefile.__init__()</span></tt></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.copy">
<tt class="descname">copy</tt><a class="headerlink" href="#sipconfig.Makefile.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>A string that will copy a file.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_cflags">
<tt class="descname">extra_cflags</tt><a class="headerlink" href="#sipconfig.Makefile.extra_cflags" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional flags passed to the C compiler.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_cxxflags">
<tt class="descname">extra_cxxflags</tt><a class="headerlink" href="#sipconfig.Makefile.extra_cxxflags" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional flags passed to the C++ compiler.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_defines">
<tt class="descname">extra_defines</tt><a class="headerlink" href="#sipconfig.Makefile.extra_defines" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional macro names passed to the C/C++ preprocessor.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_include_dirs">
<tt class="descname">extra_include_dirs</tt><a class="headerlink" href="#sipconfig.Makefile.extra_include_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional include directories passed to the C/C++
preprocessor.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_lflags">
<tt class="descname">extra_lflags</tt><a class="headerlink" href="#sipconfig.Makefile.extra_lflags" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional flags passed to the linker.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_lib_dirs">
<tt class="descname">extra_lib_dirs</tt><a class="headerlink" href="#sipconfig.Makefile.extra_lib_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional library directories passed to the linker.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.extra_libs">
<tt class="descname">extra_libs</tt><a class="headerlink" href="#sipconfig.Makefile.extra_libs" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of additional libraries passed to the linker. The names of the
libraries must be in platform neutral form (i.e. without any platform
specific prefixes, version numbers or extensions).</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.generator">
<tt class="descname">generator</tt><a class="headerlink" href="#sipconfig.Makefile.generator" title="Permalink to this definition">¶</a></dt>
<dd><p>A string that defines the platform specific style of Makefile. The
only supported values are <tt class="docutils literal"><span class="pre">UNIX</span></tt>, <tt class="docutils literal"><span class="pre">MSVC</span></tt>, <tt class="docutils literal"><span class="pre">MSVC.NET</span></tt>, <tt class="docutils literal"><span class="pre">MINGW</span></tt>
and <tt class="docutils literal"><span class="pre">BMAKE</span></tt>.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.mkdir">
<tt class="descname">mkdir</tt><a class="headerlink" href="#sipconfig.Makefile.mkdir" title="Permalink to this definition">¶</a></dt>
<dd><p>A string that will create a directory.</p>
</dd></dl>
<dl class="attribute">
<dt id="sipconfig.Makefile.rm">
<tt class="descname">rm</tt><a class="headerlink" href="#sipconfig.Makefile.rm" title="Permalink to this definition">¶</a></dt>
<dd><p>A string that will remove a file.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>configuration</em><span class="optional">[</span>, <em>console=0</em><span class="optional">[</span>, <em>qt=0</em><span class="optional">[</span>, <em>opengl=0</em><span class="optional">[</span>, <em>python=0</em><span class="optional">[</span>, <em>threaded=0</em><span class="optional">[</span>, <em>warnings=None</em><span class="optional">[</span>, <em>debug=0</em><span class="optional">[</span>, <em>dir=None</em><span class="optional">[</span>, <em>makefile="Makefile"</em><span class="optional">[</span>, <em>installs=None</em><span class="optional">[</span>, <em>universal=None</em><span class="optional">[</span>, <em>arch=None</em><span class="optional">[</span>, <em>deployment_target=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.Makefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – the current configuration and is an instance of the
<a class="reference internal" href="#sipconfig.Configuration" title="sipconfig.Configuration"><tt class="xref py py-class docutils literal"><span class="pre">Configuration</span></tt></a> class or a sub-class.</li>
<li><strong>console</strong> – is set if the target is a console (rather than GUI) target. This
only affects Windows and is ignored on other platforms.</li>
<li><strong>qt</strong> – is set if the target uses Qt. For Qt v4 a list of Qt libraries may
be specified and a simple non-zero value implies QtCore and QtGui.</li>
<li><strong>opengl</strong> – is set if the target uses OpenGL.</li>
<li><strong>python</strong> – is set if the target uses Python.h.</li>
<li><strong>threaded</strong> – is set if the target requires thread support. It is set
automatically if the target uses Qt and Qt has thread support
enabled.</li>
<li><strong>warnings</strong> – is set if compiler warning messages should be enabled. The default
of <tt class="docutils literal"><span class="pre">None</span></tt> means that warnings are enabled for SIP v4.x and
disabled for SIP v3.x.</li>
<li><strong>debug</strong> – is set if debugging symbols should be generated.</li>
<li><strong>dir</strong> – the name of the directory where build files are read from (if they
are not absolute file names) and Makefiles are written to. The
default of <tt class="docutils literal"><span class="pre">None</span></tt> means the current directory is used.</li>
<li><strong>makefile</strong> – the name of the generated Makefile.</li>
<li><strong>installs</strong> – the list of extra install targets. Each element is a two part
list, the first of which is the source and the second is the
destination. If the source is another list then it is a list of
source files and the destination is a directory.</li>
<li><strong>universal</strong> – the name of the SDK if universal binaries are to be created under
MacOS/X. If it is <tt class="docutils literal"><span class="pre">None</span></tt> then the value is taken from the
configuration.</li>
<li><strong>arch</strong> – the space separated MacOS/X architectures to build. If it is
<tt class="docutils literal"><span class="pre">None</span></tt> then the value is taken from the configuration.</li>
<li><strong>deployment_target</strong> – the MacOS/X deployment target. If it is <tt class="docutils literal"><span class="pre">None</span></tt> then the value is
taken from the configuration.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.clean_build_file_objects">
<tt class="descname">clean_build_file_objects</tt><big>(</big><em>mfile</em>, <em>build</em><big>)</big><a class="headerlink" href="#sipconfig.Makefile.clean_build_file_objects" title="Permalink to this definition">¶</a></dt>
<dd><p>This generates the Makefile commands that will remove any files
generated during the build of the default target.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mfile</strong> – the Python file object of the Makefile.</li>
<li><strong>build</strong> – the dictionary created from parsing the build file.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.finalise">
<tt class="descname">finalise</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.Makefile.finalise" title="Permalink to this definition">¶</a></dt>
<dd><p>This is called just before the Makefile is generated to ensure that it
is fully configured. It must be reimplemented by a sub-class.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.generate">
<tt class="descname">generate</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.Makefile.generate" title="Permalink to this definition">¶</a></dt>
<dd><p>This generates the Makefile.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.generate_macros_and_rules">
<tt class="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.Makefile.generate_macros_and_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile macros and rules
generation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mfile</strong> – the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.generate_target_clean">
<tt class="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.Makefile.generate_target_clean" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile clean target
generation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mfile</strong> – the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.generate_target_default">
<tt class="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.Makefile.generate_target_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile default target
generation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mfile</strong> – the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.generate_target_install">
<tt class="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.Makefile.generate_target_install" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile install target
generation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mfile</strong> – the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.install_file">
<tt class="descname">install_file</tt><big>(</big><em>mfile</em>, <em>src</em>, <em>dst</em><span class="optional">[</span>, <em>strip=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.Makefile.install_file" title="Permalink to this definition">¶</a></dt>
<dd><p>This generates the Makefile commands to install one or more files to a
directory.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mfile</strong> – the Python file object of the Makefile.</li>
<li><strong>src</strong> – the name of a single file to install or a list of a number of files
to install.</li>
<li><strong>dst</strong> – the name of the destination directory.</li>
<li><strong>strip</strong> – is set if the files should be stripped of unneeded symbols after
having been installed.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.optional_list">
<tt class="descname">optional_list</tt><big>(</big><em>name</em><big>)</big> → list<a class="headerlink" href="#sipconfig.Makefile.optional_list" title="Permalink to this definition">¶</a></dt>
<dd><p>This returns an optional Makefile macro as a list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – the name of the macro.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the macro as a list.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.optional_string">
<tt class="descname">optional_string</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>default=""</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.Makefile.optional_string" title="Permalink to this definition">¶</a></dt>
<dd><p>This returns an optional Makefile macro as a string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – the name of the macro.</li>
<li><strong>default</strong> – the optional default value of the macro.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the macro as a string.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.parse_build_file">
<tt class="descname">parse_build_file</tt><big>(</big><em>filename</em><big>)</big> → dict<a class="headerlink" href="#sipconfig.Makefile.parse_build_file" title="Permalink to this definition">¶</a></dt>
<dd><p>This parses a build file (created with the <a class="reference internal" href="command_line.html#cmdoption-sip-b"><em class="xref std std-option">-b</em></a> SIP
command line option) and converts it to a dictionary. It can also
validate an existing dictionary created through other means.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> – is the name of the build file, or is a dictionary to
be validated. A valid dictionary will contain the name of the
target to build (excluding any platform specific extension) keyed
by <tt class="docutils literal"><span class="pre">target</span></tt>; the names of all source files keyed by <tt class="docutils literal"><span class="pre">sources</span></tt>;
and, optionally, the names of all header files keyed by
<tt class="docutils literal"><span class="pre">headers</span></tt>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a dictionary corresponding to the parsed build file.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.platform_lib">
<tt class="descname">platform_lib</tt><big>(</big><em>clib</em><span class="optional">[</span>, <em>framework=0</em><span class="optional">]</span><big>)</big> → string<a class="headerlink" href="#sipconfig.Makefile.platform_lib" title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a library name to a platform specific form.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>clib</strong> – the name of the library in cannonical form.</li>
<li><strong>framework</strong> – is set if the library is implemented as a MacOS framework.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the platform specific name.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.ready">
<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.Makefile.ready" title="Permalink to this definition">¶</a></dt>
<dd><p>This is called to ensure that the Makefile is fully configured. It is
normally called automatically when needed.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.Makefile.required_string">
<tt class="descname">required_string</tt><big>(</big><em>name</em><big>)</big> → string<a class="headerlink" href="#sipconfig.Makefile.required_string" title="Permalink to this definition">¶</a></dt>
<dd><p>This returns a required Makefile macro as a string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – the name of the macro.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the macro as a string. An exception is raised if the macro does
not exist or has an empty value.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.ModuleMakefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">ModuleMakefile</tt><a class="headerlink" href="#sipconfig.ModuleMakefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <a class="reference internal" href="#sipconfig.Makefile" title="sipconfig.Makefile"><tt class="xref py py-class docutils literal"><span class="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build a generic Python extension
module.</p>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>build_file</em><span class="optional">[</span>, <em>install_dir=None</em><span class="optional">[</span>, <em>static=0</em><span class="optional">[</span>, <em>console=0</em><span class="optional">[</span>, <em>opengl=0</em><span class="optional">[</span>, <em>threaded=0</em><span class="optional">[</span>, <em>warnings=None</em><span class="optional">[</span>, <em>debug=0</em><span class="optional">[</span>, <em>dir=None</em><span class="optional">[</span>, <em>makefile="Makefile"</em><span class="optional">[</span>, <em>installs=None</em><span class="optional">[</span>, <em>strip=1</em><span class="optional">[</span>, <em>export_all=0</em><span class="optional">[</span>, <em>universal=None</em><span class="optional">[</span>, <em>arch=None</em><span class="optional">[</span>, <em>deployment_target=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>build_file</strong> – the name of the build file. Build files are generated using the
<a class="reference internal" href="command_line.html#cmdoption-sip-b"><em class="xref std std-option">-b</em></a> SIP command line option.</li>
<li><strong>install_dir</strong> – the name of the directory where the module will be optionally
installed.</li>
<li><strong>static</strong> – is set if the module should be built as a static library (see
<a class="reference internal" href="builtin.html#ref-builtin"><em>Builtin Modules and Custom Interpreters</em></a>).</li>
<li><strong>console</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>qt</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>opengl</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>threaded</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>warnings</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>debug</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>dir</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>makefile</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>installs</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>strip</strong> – is set if the module should be stripped of unneeded symbols after
installation. It is ignored if either <em>debug</em> or <em>static</em> is set,
or if the platform doesn’t support it.</li>
<li><strong>export_all</strong> – is set if all of the module’s symbols should be exported rather
than just the module’s initialisation function. Exporting all
symbols increases the size of the module and slows down module load
times but may avoid problems with modules that use C++ exceptions.
All symbols are exported if either <em>debug</em> or <em>static</em> is set, or
if the platform doesn’t support it.</li>
<li><strong>universal</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>arch</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>deployment_target</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.finalise">
<tt class="descname">finalise</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.finalise" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of <a class="reference internal" href="#sipconfig.Makefile.finalise" title="sipconfig.Makefile.finalise"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.finalise()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.generate_macros_and_rules">
<tt class="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.generate_macros_and_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_macros_and_rules" title="sipconfig.Makefile.generate_macros_and_rules"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_macros_and_rules()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.generate_target_clean">
<tt class="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.generate_target_clean" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_clean" title="sipconfig.Makefile.generate_target_clean"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_clean()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.generate_target_default">
<tt class="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.generate_target_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_default" title="sipconfig.Makefile.generate_target_default"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_default()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.generate_target_install">
<tt class="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ModuleMakefile.generate_target_install" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_install" title="sipconfig.Makefile.generate_target_install"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_install()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ModuleMakefile.module_as_lib">
<tt class="descname">module_as_lib</tt><big>(</big><em>mname</em><big>)</big> → string<a class="headerlink" href="#sipconfig.ModuleMakefile.module_as_lib" title="Permalink to this definition">¶</a></dt>
<dd><p>This gets the name of a SIP v3.x module for when it is used as a
library to be linked against. An exception will be raised if it is
used with SIP v4.x modules.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mname</strong> – the name of the module.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the corresponding library name.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.ParentMakefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">ParentMakefile</tt><a class="headerlink" href="#sipconfig.ParentMakefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <a class="reference internal" href="#sipconfig.Makefile" title="sipconfig.Makefile"><tt class="xref py py-class docutils literal"><span class="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile that sits above a number of other
Makefiles in sub-directories.</p>
<dl class="method">
<dt id="sipconfig.ParentMakefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>self, configuration, subdirs[, dir=None[, makefile[="Makefile"[, installs=None]]]]</em><big>)</big><a class="headerlink" href="#sipconfig.ParentMakefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>subdirs</strong> – the sequence of sub-directories.</li>
<li><strong>dir</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>makefile</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>installs</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ParentMakefile.generate_macros_and_rules">
<tt class="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ParentMakefile.generate_macros_and_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_macros_and_rules" title="sipconfig.Makefile.generate_macros_and_rules"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_macros_and_rules()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ParentMakefile.generate_target_clean">
<tt class="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ParentMakefile.generate_target_clean" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_clean" title="sipconfig.Makefile.generate_target_clean"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_clean()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ParentMakefile.generate_target_default">
<tt class="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ParentMakefile.generate_target_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_default" title="sipconfig.Makefile.generate_target_default"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_default()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ParentMakefile.generate_target_install">
<tt class="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ParentMakefile.generate_target_install" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_install" title="sipconfig.Makefile.generate_target_install"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_install()</span></tt></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.ProgramMakefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">ProgramMakefile</tt><a class="headerlink" href="#sipconfig.ProgramMakefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <a class="reference internal" href="#sipconfig.Makefile" title="sipconfig.Makefile"><tt class="xref py py-class docutils literal"><span class="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build an executable program.</p>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>configuration</em><span class="optional">[</span>, <em>build_file=None</em><span class="optional">[</span>, <em>install_dir=None</em><span class="optional">[</span>, <em>console=0</em><span class="optional">[</span>, <em>qt=0</em><span class="optional">[</span>, <em>opengl=0</em><span class="optional">[</span>, <em>python=0</em><span class="optional">[</span>, <em>threaded=0</em><span class="optional">[</span>, <em>warnings=None</em><span class="optional">[</span>, <em>debug=0</em><span class="optional">[</span>, <em>dir=None</em><span class="optional">[</span>, <em>makefile="Makefile"</em><span class="optional">[</span>, <em>installs=None</em><span class="optional">[</span>, <em>universal=None</em><span class="optional">[</span>, <em>arch=None</em><span class="optional">[</span>, <em>deployment_target=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>build_file</strong> – the name of the optional build file. Build files are generated
using the <a class="reference internal" href="command_line.html#cmdoption-sip-b"><em class="xref std std-option">-b</em></a> SIP command line option.</li>
<li><strong>install_dir</strong> – the name of the directory where the executable program will be
optionally installed.</li>
<li><strong>console</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>qt</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>opengl</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>python</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>threaded</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>warnings</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>debug</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>dir</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>makefile</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>installs</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>universal</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>arch</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>deployment_target</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.build_command">
<tt class="descname">build_command</tt><big>(</big><em>source</em><big>)</big> → string, string<a class="headerlink" href="#sipconfig.ProgramMakefile.build_command" title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a single command line that will create an executable
program from a single source file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>source</strong> – the name of the source file.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a tuple of the name of the executable that will be created and the
command line.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.finalise">
<tt class="descname">finalise</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.finalise" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of <a class="reference internal" href="#sipconfig.Makefile.finalise" title="sipconfig.Makefile.finalise"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.finalise()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.generate_macros_and_rules">
<tt class="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.generate_macros_and_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_macros_and_rules" title="sipconfig.Makefile.generate_macros_and_rules"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_macros_and_rules()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.generate_target_clean">
<tt class="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.generate_target_clean" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_clean" title="sipconfig.Makefile.generate_target_clean"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_clean()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.generate_target_default">
<tt class="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.generate_target_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_default" title="sipconfig.Makefile.generate_target_default"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_default()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.ProgramMakefile.generate_target_install">
<tt class="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.ProgramMakefile.generate_target_install" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_install" title="sipconfig.Makefile.generate_target_install"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_install()</span></tt></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.PythonModuleMakefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">PythonModuleMakefile</tt><a class="headerlink" href="#sipconfig.PythonModuleMakefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <a class="reference internal" href="#sipconfig.Makefile" title="sipconfig.Makefile"><tt class="xref py py-class docutils literal"><span class="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile that installs a pure Python module.</p>
<dl class="method">
<dt id="sipconfig.PythonModuleMakefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>dstdir</em><span class="optional">[</span>, <em>srcdir=None</em><span class="optional">[</span>, <em>dir=None</em><span class="optional">[</span>, <em>makefile="Makefile"</em><span class="optional">[</span>, <em>installs=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.PythonModuleMakefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>dstdir</strong> – the name of the directory in which the module’s Python code will be
installed.</li>
<li><strong>srcdir</strong> – the name of the directory (relative to <em>dir</em>) containing the
module’s Python code. It defaults to the same directory.</li>
<li><strong>dir</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>makefile</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>installs</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.PythonModuleMakefile.generate_macros_and_rules">
<tt class="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.PythonModuleMakefile.generate_macros_and_rules" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_macros_and_rules" title="sipconfig.Makefile.generate_macros_and_rules"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_macros_and_rules()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="sipconfig.PythonModuleMakefile.generate_target_install">
<tt class="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><a class="headerlink" href="#sipconfig.PythonModuleMakefile.generate_target_install" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of
<a class="reference internal" href="#sipconfig.Makefile.generate_target_install" title="sipconfig.Makefile.generate_target_install"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.generate_target_install()</span></tt></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="sipconfig.SIPModuleMakefile">
<em class="property">class </em><tt class="descclassname">sipconfig.</tt><tt class="descname">SIPModuleMakefile</tt><a class="headerlink" href="#sipconfig.SIPModuleMakefile" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <a class="reference internal" href="#sipconfig.ModuleMakefile" title="sipconfig.ModuleMakefile"><tt class="xref py py-class docutils literal"><span class="pre">sipconfig.ModuleMakefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build a SIP generated Python
extension module.</p>
<dl class="method">
<dt id="sipconfig.SIPModuleMakefile.__init__">
<tt class="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>build_file</em><span class="optional">[</span>, <em>install_dir=None</em><span class="optional">[</span>, <em>static=0</em><span class="optional">[</span>, <em>console=0</em><span class="optional">[</span>, <em>opengl=0</em><span class="optional">[</span>, <em>threaded=0</em><span class="optional">[</span>, <em>warnings=None</em><span class="optional">[</span>, <em>debug=0</em><span class="optional">[</span>, <em>dir=None</em><span class="optional">[</span>, <em>makefile="Makefile"</em><span class="optional">[</span>, <em>installs=None</em><span class="optional">[</span>, <em>strip=1</em><span class="optional">[</span>, <em>export_all=0</em><span class="optional">[</span>, <em>universal=None</em><span class="optional">[</span>, <em>arch=None</em><span class="optional">[</span>, <em>prot_is_public=0</em><span class="optional">[</span>, <em>deployment_target=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sipconfig.SIPModuleMakefile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>build_file</strong> – see <a class="reference internal" href="#sipconfig.ModuleMakefile.__init__" title="sipconfig.ModuleMakefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><strong>install_dir</strong> – see <a class="reference internal" href="#sipconfig.ModuleMakefile.__init__" title="sipconfig.ModuleMakefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><strong>static</strong> – see <a class="reference internal" href="#sipconfig.ModuleMakefile.__init__" title="sipconfig.ModuleMakefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><strong>console</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>qt</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>opengl</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>threaded</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>warnings</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>debug</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>dir</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>makefile</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>installs</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>strip</strong> – see <a class="reference internal" href="#sipconfig.ModuleMakefile.__init__" title="sipconfig.ModuleMakefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><strong>export_all</strong> – see <a class="reference internal" href="#sipconfig.ModuleMakefile.__init__" title="sipconfig.ModuleMakefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><strong>universal</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>arch</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><strong>prot_is_public</strong> – is set if <tt class="docutils literal"><span class="pre">protected</span></tt> should be redefined as <tt class="docutils literal"><span class="pre">public</span></tt> when
compiling the generated module.</li>
<li><strong>deployment_target</strong> – see <a class="reference internal" href="#sipconfig.Makefile.__init__" title="sipconfig.Makefile.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="sipconfig.SIPModuleMakefile.finalise">
<tt class="descname">finalise</tt><big>(</big><big>)</big><a class="headerlink" href="#sipconfig.SIPModuleMakefile.finalise" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a reimplementation of <a class="reference internal" href="#sipconfig.Makefile.finalise" title="sipconfig.Makefile.finalise"><tt class="xref py py-meth docutils literal"><span class="pre">sipconfig.Makefile.finalise()</span></tt></a>.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="python_api.html"
title="previous chapter">Python API for Applications</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="distutils.html"
title="next chapter">Building Your Extension with distutils</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="distutils.html" title="Building Your Extension with distutils"
>next</a> |</li>
<li class="right" >
<a href="python_api.html" title="Python API for Applications"
>previous</a> |</li>
<li><a href="index.html">SIP 4.15.5 Reference Guide</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014 Riverbank Computing Limited.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|