/usr/share/doc/cedar-backup2-doc/interface/CedarBackup2.extend.subversion.LocalConfig-class.html is in cedar-backup2-doc 2.26.5-3.
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 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.extend.subversion.LocalConfig</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup2">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.extend-module.html">Package extend</a> ::
<a href="CedarBackup2.extend.subversion-module.html">Module subversion</a> ::
Class LocalConfig
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.extend.subversion.LocalConfig-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class LocalConfig</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">LocalConfig</strong>
</pre>
<hr />
<p>Class representing this extension's configuration document.</p>
<p>This is not a general-purpose configuration object like the main Cedar
Backup configuration object. Instead, it just knows how to parse and
emit Subversion-specific configuration values. Third parties who need to
read and write configuration related to this extension should access it
through the constructor, <code>validate</code> and <code>addConfig</code>
methods.</p>
<hr />
<div class="fields"> <p><strong>Note:</strong>
Lists within this class are "unordered" for equality
comparisons.
</p>
</div><!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xmlData</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">xmlPath</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">validate</span>=<span class="summary-sig-default">True</span>)</span><br />
Initializes a configuration object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Official string representation for class instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Informal string representation for class instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#__cmp__" class="summary-sig-name">__cmp__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Definition of equals operator for this class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__cmp__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>)</span><br />
Validates configuration represented by the object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.validate">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#addConfig" class="summary-sig-name">addConfig</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>)</span><br />
Adds a <subversion> configuration section as the next child of
a parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.addConfig">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_setSubversion" class="summary-sig-name" onclick="show_private();">_setSubversion</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Property target used to set the subversion configuration value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._setSubversion">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getSubversion"></a><span class="summary-sig-name">_getSubversion</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the subversion configuration value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._getSubversion">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseXmlData" class="summary-sig-name" onclick="show_private();">_parseXmlData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xmlData</span>)</span><br />
Internal method to parse an XML string into the object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseXmlData">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseSubversion" class="summary-sig-name" onclick="show_private();">_parseSubversion</a>(<span class="summary-sig-arg">parent</span>)</span><br />
Parses a subversion configuration section.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseSubversion">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseRepositories" class="summary-sig-name" onclick="show_private();">_parseRepositories</a>(<span class="summary-sig-arg">parent</span>)</span><br />
Reads a list of <code>Repository</code> objects from immediately
beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseRepositories">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_addRepository" class="summary-sig-name" onclick="show_private();">_addRepository</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">repository</span>)</span><br />
Adds a repository container as the next child of a parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._addRepository">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseRepositoryDirs" class="summary-sig-name" onclick="show_private();">_parseRepositoryDirs</a>(<span class="summary-sig-arg">parent</span>)</span><br />
Reads a list of <code>RepositoryDir</code> objects from immediately
beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseRepositoryDirs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseExclusions" class="summary-sig-name" onclick="show_private();">_parseExclusions</a>(<span class="summary-sig-arg">parentNode</span>)</span><br />
Reads exclusions data from immediately beneath the parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseExclusions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_addRepositoryDir" class="summary-sig-name" onclick="show_private();">_addRepositoryDir</a>(<span class="summary-sig-arg">xmlDom</span>,
<span class="summary-sig-arg">parentNode</span>,
<span class="summary-sig-arg">repositoryDir</span>)</span><br />
Adds a repository dir container as the next child of a parent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._addRepositoryDir">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.LocalConfig-class.html#subversion" class="summary-name">subversion</a><br />
Subversion configuration in terms of a <code>SubversionConfig</code>
object.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">xmlData</span>=<span class="sig-default">None</span>,
<span class="sig-arg">xmlPath</span>=<span class="sig-default">None</span>,
<span class="sig-arg">validate</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__init__">source code</a></span>
</td>
</tr></table>
<p>Initializes a configuration object.</p>
<p>If you initialize the object without passing either
<code>xmlData</code> or <code>xmlPath</code> then configuration will be
empty and will be invalid until it is filled in properly.</p>
<p>No reference to the original XML data or original path is saved off by
this class. Once the data has been parsed (successfully or not) this
original information is discarded.</p>
<p>Unless the <code>validate</code> argument is <code>False</code>, the
<a href="CedarBackup2.extend.subversion.LocalConfig-class.html#validate"
class="link">LocalConfig.validate</a> method will be called (with its
default arguments) against configuration after successfully parsing any
passed-in XML. Keep in mind that even if <code>validate</code> is
<code>False</code>, it might not be possible to parse the passed-in XML
document if lower-level validations fail.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlData</code></strong> (String data.) - XML data representing configuration.</li>
<li><strong class="pname"><code>xmlPath</code></strong> (Absolute path to a file on disk.) - Path to an XML file on disk.</li>
<li><strong class="pname"><code>validate</code></strong> (Boolean true/false.) - Validate the document after parsing it.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If both <code>xmlData</code> and <code>xmlPath</code> are
passed-in.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the XML data in <code>xmlData</code> or <code>xmlPath</code>
cannot be parsed.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the parsed configuration document is not valid.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
It is strongly suggested that the <code>validate</code> option
always be set to <code>True</code> (the default) unless there is a
specific need to read in invalid configuration from disk.
</p>
</div></td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__repr__">source code</a></span>
</td>
</tr></table>
<p>Official string representation for class instance.</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__str__">source code</a></span>
</td>
</tr></table>
<p>Informal string representation for class instance.</p>
<dl class="fields">
<dt>Overrides:
object.__str__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__cmp__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__cmp__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">other</span>)</span>
<br /><em class="fname">(Comparison operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.__cmp__">source code</a></span>
</td>
</tr></table>
<p>Definition of equals operator for this class. Lists within this class
are "unordered" for equality comparisons.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>other</code></strong> - Other object to compare to.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>-1/0/1 depending on whether self is <code><</code>,
<code>=</code> or <code>></code> other.</dd>
</dl>
</td></tr></table>
</div>
<a name="validate"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.validate">source code</a></span>
</td>
</tr></table>
<p>Validates configuration represented by the object.</p>
<p>Subversion configuration must be filled in. Within that, the collect
mode and compress mode are both optional, but the list of repositories
must contain at least one entry.</p>
<p>Each repository must contain a repository path, and then must be
either able to take collect mode and compress mode configuration from the
parent <code>SubversionConfig</code> object, or must set each value on
its own.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If one of the validations fails.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addConfig"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addConfig</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig.addConfig">source code</a></span>
</td>
</tr></table>
<p>Adds a <subversion> configuration section as the next child of a
parent.</p>
<p>Third parties should use this function to write configuration related
to this extension.</p>
<p>We add the following fields to the document:</p>
<pre class="literalblock">
collectMode //cb_config/subversion/collectMode
compressMode //cb_config/subversion/compressMode
</pre>
<p>We also add groups of the following items, one list element per
item:</p>
<pre class="literalblock">
repository //cb_config/subversion/repository
repository_dir //cb_config/subversion/repository_dir
</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent that the section should be appended to.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_setSubversion"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_setSubversion</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._setSubversion">source code</a></span>
</td>
</tr></table>
<p>Property target used to set the subversion configuration value. If not
<code>None</code>, the value must be a <code>SubversionConfig</code>
object.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the value is not a <code>SubversionConfig</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseXmlData"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseXmlData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">xmlData</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseXmlData">source code</a></span>
</td>
</tr></table>
<p>Internal method to parse an XML string into the object.</p>
<p>This method parses the XML document into a DOM tree
(<code>xmlDom</code>) and then calls a static method to parse the
subversion configuration section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlData</code></strong> (String data) - XML data to be parsed</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the XML cannot be successfully parsed.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseSubversion"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseSubversion</span>(<span class="sig-arg">parent</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseSubversion">source code</a></span>
</td>
</tr></table>
<p>Parses a subversion configuration section.</p>
<p>We read the following individual fields:</p>
<pre class="literalblock">
collectMode //cb_config/subversion/collect_mode
compressMode //cb_config/subversion/compress_mode
</pre>
<p>We also read groups of the following item, one list element per
item:</p>
<pre class="literalblock">
repositories //cb_config/subversion/repository
repository_dirs //cb_config/subversion/repository_dir
</pre>
<p>The repositories are parsed by <a
href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseRepositories"
class="link" onclick="show_private();">_parseRepositories</a>, and the
repository dirs are parsed by <a
href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseRepositoryDirs"
class="link" onclick="show_private();">_parseRepositoryDirs</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
</ul></dd>
<dt>Returns:</dt>
<dd><code>SubversionConfig</code> object or <code>None</code> if the
section does not exist.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some filled-in value is invalid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseRepositories"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseRepositories</span>(<span class="sig-arg">parent</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseRepositories">source code</a></span>
</td>
</tr></table>
<p>Reads a list of <code>Repository</code> objects from immediately
beneath the parent.</p>
<p>We read the following individual fields:</p>
<pre class="literalblock">
repositoryType type
repositoryPath abs_path
collectMode collect_mode
compressMode compess_mode
</pre>
<p>The type field is optional, and its value is kept around only for
reference.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List of <code>Repository</code> objects or <code>None</code> if
none are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some filled-in value is invalid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_addRepository"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_addRepository</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">repository</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._addRepository">source code</a></span>
</td>
</tr></table>
<p>Adds a repository container as the next child of a parent.</p>
<p>We add the following fields to the document:</p>
<pre class="literalblock">
repositoryType repository/type
repositoryPath repository/abs_path
collectMode repository/collect_mode
compressMode repository/compress_mode
</pre>
<p>The <repository> node itself is created as the next child of the
parent node. This method only adds one repository node. The parent must
loop for each repository in the <code>SubversionConfig</code> object.</p>
<p>If <code>repository</code> is <code>None</code>, this method call will
be a no-op.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent that the section should be appended to.</li>
<li><strong class="pname"><code>repository</code></strong> - Repository to be added to the document.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseRepositoryDirs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseRepositoryDirs</span>(<span class="sig-arg">parent</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseRepositoryDirs">source code</a></span>
</td>
</tr></table>
<p>Reads a list of <code>RepositoryDir</code> objects from immediately
beneath the parent.</p>
<p>We read the following individual fields:</p>
<pre class="literalblock">
repositoryType type
directoryPath abs_path
collectMode collect_mode
compressMode compess_mode
</pre>
<p>We also read groups of the following items, one list element per
item:</p>
<pre class="literalblock">
relativeExcludePaths exclude/rel_path
excludePatterns exclude/pattern
</pre>
<p>The exclusions are parsed by <a
href="CedarBackup2.extend.subversion.LocalConfig-class.html#_parseExclusions"
class="link" onclick="show_private();">_parseExclusions</a>.</p>
<p>The type field is optional, and its value is kept around only for
reference.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - Parent node to search beneath.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List of <code>RepositoryDir</code> objects or <code>None</code>
if none are found.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some filled-in value is invalid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseExclusions"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseExclusions</span>(<span class="sig-arg">parentNode</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._parseExclusions">source code</a></span>
</td>
</tr></table>
<p>Reads exclusions data from immediately beneath the parent.</p>
<p>We read groups of the following items, one list element per item:</p>
<pre class="literalblock">
relative exclude/rel_path
patterns exclude/pattern
</pre>
<p>If there are none of some pattern (i.e. no relative path items) then
<code>None</code> will be returned for that item in the tuple.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parentNode</code></strong> - Parent node to search beneath.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple of (relative, patterns) exclusions.</dd>
</dl>
</td></tr></table>
</div>
<a name="_addRepositoryDir"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_addRepositoryDir</span>(<span class="sig-arg">xmlDom</span>,
<span class="sig-arg">parentNode</span>,
<span class="sig-arg">repositoryDir</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#LocalConfig._addRepositoryDir">source code</a></span>
</td>
</tr></table>
<p>Adds a repository dir container as the next child of a parent.</p>
<p>We add the following fields to the document:</p>
<pre class="literalblock">
repositoryType repository_dir/type
directoryPath repository_dir/abs_path
collectMode repository_dir/collect_mode
compressMode repository_dir/compress_mode
</pre>
<p>We also add groups of the following items, one list element per
item:</p>
<pre class="literalblock">
relativeExcludePaths dir/exclude/rel_path
excludePatterns dir/exclude/pattern
</pre>
<p>The <repository_dir> node itself is created as the next child of
the parent node. This method only adds one repository node. The parent
must loop for each repository dir in the <code>SubversionConfig</code>
object.</p>
<p>If <code>repositoryDir</code> is <code>None</code>, this method call
will be a no-op.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlDom</code></strong> - DOM tree as from <code>impl.createDocument()</code>.</li>
<li><strong class="pname"><code>parentNode</code></strong> - Parent that the section should be appended to.</li>
<li><strong class="pname"><code>repositoryDir</code></strong> - Repository dir to be added to the document.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="subversion"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">subversion</h3>
<p>Subversion configuration in terms of a <code>SubversionConfig</code>
object.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_getSubversion" class="summary-sig-name" onclick="show_private();">_getSubversion</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the subversion configuration value.
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.subversion.LocalConfig-class.html#_setSubversion" class="summary-sig-name" onclick="show_private();">_setSubversion</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
- Property target used to set the subversion configuration value.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup2">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|