--- /tmp/cedar-backup3-3.6.3-16letq509/debian/cedar-backup3-doc_3.6.3-1_all.deb +++ cedar-backup3-doc_3.6.3-1_all.deb ├── file list │ @@ -1,3 +1,3 @@ │ -rw-r--r-- 0 0 0 4 2021-03-13 16:01:32.000000 debian-binary │ --rw-r--r-- 0 0 0 4556 2021-03-13 16:01:32.000000 control.tar.xz │ --rw-r--r-- 0 0 0 268340 2021-03-13 16:01:32.000000 data.tar.xz │ +-rw-r--r-- 0 0 0 4560 2021-03-13 16:01:32.000000 control.tar.xz │ +-rw-r--r-- 0 0 0 268352 2021-03-13 16:01:32.000000 data.tar.xz ├── control.tar.xz │ ├── control.tar │ │ ├── ./md5sums │ │ │ ├── ./md5sums │ │ │ │┄ Files differ ├── data.tar.xz │ ├── data.tar │ │ ├── file list │ │ │ @@ -122,93 +122,93 @@ │ │ │ -rw-r--r-- 0 root (0) root (0) 5183 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/_static/pygments.css │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/action/ │ │ │ -rw-r--r-- 0 root (0) root (0) 3393 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/action/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/collect/ │ │ │ --rw-r--r-- 0 root (0) root (0) 5323 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/collect/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 5324 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/collect/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/constants/ │ │ │ -rw-r--r-- 0 root (0) root (0) 5653 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/constants/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 5656 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/initialize/ │ │ │ -rw-r--r-- 0 root (0) root (0) 4942 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/initialize/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/purge/ │ │ │ --rw-r--r-- 0 root (0) root (0) 5104 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/purge/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 5105 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/purge/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/rebuild/ │ │ │ --rw-r--r-- 0 root (0) root (0) 5609 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/rebuild/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 5611 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/rebuild/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/stage/ │ │ │ --rw-r--r-- 0 root (0) root (0) 5776 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/stage/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 5778 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/stage/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/store/ │ │ │ --rw-r--r-- 0 root (0) root (0) 17776 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/store/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 17784 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/store/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/util/ │ │ │ --rw-r--r-- 0 root (0) root (0) 12902 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/util/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 12908 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/util/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/validate/ │ │ │ --rw-r--r-- 0 root (0) root (0) 5719 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/validate/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 5720 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/validate/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/cli/ │ │ │ --rw-r--r-- 0 root (0) root (0) 40464 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/cli/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 40468 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/cli/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/config/ │ │ │ --rw-r--r-- 0 root (0) root (0) 176830 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/config/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 176854 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/config/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/customize/ │ │ │ -rw-r--r-- 0 root (0) root (0) 6217 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/customize/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/amazons3/ │ │ │ --rw-r--r-- 0 root (0) root (0) 25060 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/amazons3/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 25065 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/amazons3/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/capacity/ │ │ │ --rw-r--r-- 0 root (0) root (0) 24219 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/capacity/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 24224 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/capacity/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/encrypt/ │ │ │ --rw-r--r-- 0 root (0) root (0) 20510 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/encrypt/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 20515 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/encrypt/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 5364 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mbox/ │ │ │ --rw-r--r-- 0 root (0) root (0) 38866 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mbox/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 38873 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mbox/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mysql/ │ │ │ --rw-r--r-- 0 root (0) root (0) 29487 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mysql/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 29494 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mysql/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/postgresql/ │ │ │ --rw-r--r-- 0 root (0) root (0) 26567 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/postgresql/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 26574 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/postgresql/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/split/ │ │ │ --rw-r--r-- 0 root (0) root (0) 19877 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/split/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 19882 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/split/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/subversion/ │ │ │ --rw-r--r-- 0 root (0) root (0) 50799 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/subversion/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 50810 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/subversion/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/sysinfo/ │ │ │ --rw-r--r-- 0 root (0) root (0) 8583 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/sysinfo/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 8585 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/sysinfo/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/filesystem/ │ │ │ --rw-r--r-- 0 root (0) root (0) 69052 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/filesystem/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 69078 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/filesystem/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/image/ │ │ │ -rw-r--r-- 0 root (0) root (0) 3344 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/image/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 12778 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/knapsack/ │ │ │ -rw-r--r-- 0 root (0) root (0) 15727 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/knapsack/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/peer/ │ │ │ --rw-r--r-- 0 root (0) root (0) 32830 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/peer/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 32854 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/peer/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/release/ │ │ │ -rw-r--r-- 0 root (0) root (0) 7163 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/release/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/scripts/ │ │ │ -rw-r--r-- 0 root (0) root (0) 4283 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/scripts/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/testutil/ │ │ │ --rw-r--r-- 0 root (0) root (0) 22540 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/testutil/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 22545 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/testutil/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/amazons3/ │ │ │ --rw-r--r-- 0 root (0) root (0) 26093 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/amazons3/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 26097 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/amazons3/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 4532 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/span/ │ │ │ -rw-r--r-- 0 root (0) root (0) 8315 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/span/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/util/ │ │ │ --rw-r--r-- 0 root (0) root (0) 116628 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/util/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 116657 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/util/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writer/ │ │ │ -rw-r--r-- 0 root (0) root (0) 3351 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writer/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/cdwriter/ │ │ │ --rw-r--r-- 0 root (0) root (0) 43893 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/cdwriter/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 43908 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/cdwriter/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/dvdwriter/ │ │ │ --rw-r--r-- 0 root (0) root (0) 39506 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/dvdwriter/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 39523 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/dvdwriter/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 4065 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/util/ │ │ │ --rw-r--r-- 0 root (0) root (0) 25051 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/util/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 25064 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/util/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/xmlutil/ │ │ │ --rw-r--r-- 0 root (0) root (0) 33577 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/xmlutil/index.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 33584 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/xmlutil/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 12162 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/autoapi/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 191067 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/genindex.html │ │ │ -rw-r--r-- 0 root (0) root (0) 9204 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/index.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/manual/ │ │ │ -rw-r--r-- 0 root (0) root (0) 33465 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/manual/basic.html │ │ │ -rw-r--r-- 0 root (0) root (0) 68770 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/manual/commandline.html │ │ │ -rw-r--r-- 0 root (0) root (0) 189002 2021-03-13 16:01:32.000000 ./usr/share/doc/cedar-backup3/html/manual/config.html │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/collect/index.html │ │ │ @@ -53,15 +53,15 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/purge/index.html │ │ │ @@ -51,15 +51,15 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – Under many generic error conditions

    │ │ │ +

    ValueError – Under many generic error conditions

    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/rebuild/index.html │ │ │ @@ -55,16 +55,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/stage/index.html │ │ │ @@ -58,16 +58,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/store/index.html │ │ │ @@ -56,16 +56,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -83,16 +83,16 @@ │ │ │
  • config – Config object

  • │ │ │
  • newDisc – Indicates whether the disc should be re-initialized

  • │ │ │
  • stagingDirs – Dictionary mapping directory path to date suffix

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -134,16 +134,16 @@ │ │ │
  • todayIsStart – Indicates whether today is the starting day of the week

  • │ │ │
  • blankBehavior – Blank behavior from configuration, or None to use default behavior

  • │ │ │
  • stagingDirs – Dictionary mapping directory path to date suffix

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -182,16 +182,16 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/util/index.html │ │ │ @@ -71,16 +71,16 @@ │ │ │

    config – Config object

    │ │ │
    │ │ │
    Returns
    │ │ │

    Writer that can be used to write a directory to some media

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -107,15 +107,15 @@ │ │ │
    Parameters
    │ │ │

    targetDir – Directory to look in

    │ │ │
    │ │ │
    Returns
    │ │ │

    List of backup files in the directory

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the target directory does not exist

    │ │ │ +

    ValueError – If the target directory does not exist

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.actions.util.checkMediaState(storeConfig)
    │ │ │ @@ -128,15 +128,15 @@ │ │ │ non-rewritable media, we also accept a None media label, since this kind │ │ │ of media cannot safely be initialized.

    │ │ │
    │ │ │
    Parameters
    │ │ │

    storeConfig – Store configuration

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If media is not initialized

    │ │ │ +

    ValueError – If media is not initialized

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.actions.util.initializeMediaState(config)
    │ │ │ @@ -150,16 +150,16 @@ │ │ │ backup.

    │ │ │
    │ │ │
    Parameters
    │ │ │

    config – Cedar Backup configuration

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • ValueError – If media could not be initialized

    • │ │ │ -
    • ValueError – If the configured media type is not rewritable

    • │ │ │ +
    • ValueError – If media could not be initialized

    • │ │ │ +
    • ValueError – If the configured media type is not rewritable

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/actions/validate/index.html │ │ │ @@ -59,15 +59,15 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If some configuration value is invalid

    │ │ │ +

    ValueError – If some configuration value is invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/cli/index.html │ │ │ @@ -305,15 +305,15 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.cli.Options(argumentList=None, argumentString=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing command-line options for the cback3 script.

    │ │ │

    The Options class is a Python object representation of the command-line │ │ │ options of the cback3 script.

    │ │ │

    The object representation is two-way: a command line string or a list of │ │ │ command line arguments can be used to create an Options object, and then │ │ │ changes to the object can be propogated back to a list of command-line │ │ │ arguments or to a command-line string. An Options object can even be │ │ │ @@ -470,15 +470,15 @@ │ │ │ be specified. Other validations (as for allowed values for particular │ │ │ options) will be taken care of at assignment time by the properties │ │ │ functionality.

    │ │ │

    Note: The command line format is specified by the _usage function. │ │ │ Call _usage to see a usage statement for the cback3 script.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ buildArgumentList(self, validate=True)
    │ │ │ @@ -501,15 +501,15 @@ │ │ │
    Parameters
    │ │ │

    validate (Boolean true/false) – Validate the options before extracting the command line

    │ │ │
    │ │ │
    Returns
    │ │ │

    List representation of command-line arguments

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If options within the object are invalid

    │ │ │ +

    ValueError – If options within the object are invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ buildArgumentString(self, validate=True)
    │ │ │ @@ -532,15 +532,15 @@ │ │ │
    Parameters
    │ │ │

    validate (Boolean true/false) – Validate the options before extracting the command line

    │ │ │
    │ │ │
    Returns
    │ │ │

    String representation of command-line arguments

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If options within the object are invalid

    │ │ │ +

    ValueError – If options within the object are invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/config/index.html │ │ │ @@ -321,15 +321,15 @@ │ │ │
    │ │ │ CedarBackup3.config.ACTION_NAME_REGEX = ^[a-z0-9]*$
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ByteQuantity(quantity=None, units=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a byte quantity.

    │ │ │

    A byte quantity has both a quantity and a byte-related unit. Units are │ │ │ maintained using the constants from util.py. If no units are provided, │ │ │ UNIT_BYTES is assumed.

    │ │ │

    The quantity is maintained internally as a string so that issues of │ │ │ precision can be avoided. It really isn’t possible to store a floating │ │ │ point number here while being able to losslessly translate back and forth │ │ │ @@ -398,15 +398,15 @@ │ │ │

    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ActionDependencies(beforeList=None, afterList=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing dependencies associated with an extended action.

    │ │ │

    Execution ordering for extended actions is done in one of two ways: either by using │ │ │ index values (lower index gets run first) or by having the extended action specify │ │ │ dependencies in terms of other named actions. This class encapsulates the dependency │ │ │ information for an extended action.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │ @@ -467,15 +467,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ActionHook(action=None, command=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a hook associated with an action.

    │ │ │

    A hook associated with an action is a shell command to be executed either │ │ │ before or after a named action is executed.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The action name must be a non-empty string matching ACTION_NAME_REGEX

    • │ │ │ @@ -597,15 +597,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.BlankBehavior(blankMode=None, blankFactor=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing optimized store-action media blanking behavior.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The blanking mode must be a one of the values in VALID_BLANK_MODES

    • │ │ │
    • The blanking factor must be a positive floating point number

    • │ │ │
    │ │ │ @@ -663,15 +663,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ExtendedAction(name=None, module=None, function=None, index=None, dependencies=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing an extended action.

    │ │ │

    Essentially, an extended action needs to allow the following to happen:

    │ │ │
    exec("from %s import %s" % (module, function))
    │ │ │  exec("%s(action, configPath")" % function)
    │ │ │  
    │ │ │
    │ │ │

    The following restrictions exist on data in this class:

    │ │ │ @@ -752,15 +752,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.CommandOverride(command=None, absolutePath=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a piece of Cedar Backup command override configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The absolute path must be absolute

    • │ │ │
    │ │ │
    │ │ │ @@ -818,15 +818,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.CollectFile(absolutePath=None, collectMode=None, archiveMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup collect file.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • Absolute paths must be absolute

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The archive mode must be one of the values in VALID_ARCHIVE_MODES.

    • │ │ │ @@ -890,15 +890,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.CollectDir(absolutePath=None, collectMode=None, archiveMode=None, ignoreFile=None, absoluteExcludePaths=None, relativeExcludePaths=None, excludePatterns=None, linkDepth=None, dereference=False, recursionLevel=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup collect directory.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • Absolute paths must be absolute

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The archive mode must be one of the values in VALID_ARCHIVE_MODES.

    • │ │ │ @@ -1003,15 +1003,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.PurgeDir(absolutePath=None, retainDays=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup purge directory.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The absolute path must be an absolute path

    • │ │ │
    • The retain days value must be an integer >= 0.

    • │ │ │
    │ │ │ @@ -1069,15 +1069,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.LocalPeer(name=None, collectDir=None, ignoreFailureMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup peer.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The peer name must be a non-empty string.

    • │ │ │
    • The collect directory must be an absolute path.

    • │ │ │
    • The ignore failure mode must be one of the values in VALID_FAILURE_MODES.

    • │ │ │ @@ -1141,15 +1141,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.RemotePeer(name=None, collectDir=None, remoteUser=None, rcpCommand=None, rshCommand=None, cbackCommand=None, managed=False, managedActions=None, ignoreFailureMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup peer.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The peer name must be a non-empty string.

    • │ │ │
    • The collect directory must be an absolute path.

    • │ │ │
    • The remote user must be a non-empty string.

    • │ │ │ @@ -1248,15 +1248,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ReferenceConfig(author=None, revision=None, description=None, generator=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup reference configuration.

    │ │ │

    The reference information is just used for saving off metadata about │ │ │ configuration and exists mostly for backwards-compatibility with Cedar │ │ │ Backup 1.x.

    │ │ │
    │ │ │
    │ │ │ author
    │ │ │ @@ -1320,15 +1320,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.ExtensionsConfig(actions=None, orderMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing Cedar Backup extensions configuration.

    │ │ │

    Extensions configuration is used to specify “extended actions” implemented │ │ │ by code external to Cedar Backup. For instance, a hypothetical third party │ │ │ might write extension code to collect database repository data. If they │ │ │ write a properly-formatted extension function, they can use the extension │ │ │ configuration to map a command-line Cedar Backup action (i.e. “database”) │ │ │ to their function.

    │ │ │ @@ -1392,15 +1392,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.OptionsConfig(startingDay=None, workingDir=None, backupUser=None, backupGroup=None, rcpCommand=None, overrides=None, hooks=None, rshCommand=None, cbackCommand=None, managedActions=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup global options configuration.

    │ │ │

    The options section is used to store global configuration options and │ │ │ defaults that can be applied to other sections.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The working directory must be an absolute path.

    • │ │ │ @@ -1521,15 +1521,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.PeersConfig(localPeers=None, remotePeers=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing Cedar Backup global peer configuration.

    │ │ │

    This section contains a list of local and remote peers in a master’s backup │ │ │ pool. The section is optional. If a master does not define this section, │ │ │ then all peers are unmanaged, and the stage configuration section must │ │ │ explicitly list any peer that is to be staged. If this section is │ │ │ configured, then peers may be managed or unmanaged, and the stage section │ │ │ peer configuration (if any) completely overrides this configuration.

    │ │ │ @@ -1602,15 +1602,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.CollectConfig(targetDir=None, collectMode=None, archiveMode=None, ignoreFile=None, absoluteExcludePaths=None, excludePatterns=None, collectFiles=None, collectDirs=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup collect configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The target directory must be an absolute path.

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The archive mode must be one of the values in VALID_ARCHIVE_MODES.

    • │ │ │ @@ -1712,15 +1712,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.StageConfig(targetDir=None, localPeers=None, remotePeers=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup stage configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The target directory must be an absolute path

    • │ │ │
    • The list of local peers must contain only LocalPeer objects

    • │ │ │
    • The list of remote peers must contain only RemotePeer objects

    • │ │ │ @@ -1793,15 +1793,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.StoreConfig(sourceDir=None, mediaType=None, deviceType=None, devicePath=None, deviceScsiId=None, driveSpeed=None, checkData=False, warnMidnite=False, noEject=False, checkMedia=False, blankBehavior=None, refreshMediaDelay=None, ejectDelay=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup store configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The source directory must be an absolute path.

    • │ │ │
    • The media type must be one of the values in VALID_MEDIA_TYPES.

    • │ │ │
    • The device type must be one of the values in VALID_DEVICE_TYPES.

    • │ │ │ @@ -1924,15 +1924,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.PurgeConfig(purgeDirs=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup purge configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The purge directory list must be a list of PurgeDir objects.

    • │ │ │
    │ │ │
    │ │ │ @@ -1989,15 +1989,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.config.Config(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a Cedar Backup XML configuration document.

    │ │ │

    The Config class is a Python object representation of a Cedar Backup XML │ │ │ configuration file. It is intended to be the only Python-language interface │ │ │ to Cedar Backup configuration on disk for both Cedar Backup itself and for │ │ │ external applications.

    │ │ │

    The object representation is two-way: XML data can be used to create a │ │ │ Config object, and then changes to the object can be propogated back to │ │ │ @@ -2121,17 +2121,17 @@ │ │ │ │ │ │

    │ │ │
    Returns
    │ │ │

    XML string data or None as described above

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -2153,15 +2153,15 @@ │ │ │
  • requireCollect – Require the collect section

  • │ │ │
  • requireStage – Require the stage section

  • │ │ │
  • requireStore – Require the store section

  • │ │ │
  • requirePurge – Require the purge section

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/amazons3/index.html │ │ │ @@ -90,15 +90,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.amazons3.STORE_INDICATOR = cback.amazons3
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.amazons3.AmazonS3Config(warnMidnite=None, s3Bucket=None, encryptCommand=None, fullBackupSizeLimit=None, incrementalBackupSizeLimit=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing Amazon S3 configuration.

    │ │ │

    Amazon S3 configuration is used for storing backup data in Amazon’s S3 cloud │ │ │ storage using the s3cmd tool.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The s3Bucket value must be a non-empty string

    • │ │ │ @@ -175,15 +175,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.amazons3.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ amazons3-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -238,15 +238,15 @@ │ │ │
    │ │ │
    │ │ │ validate(self)
    │ │ │

    Validates configuration represented by the object.

    │ │ │

    AmazonS3 configuration must be filled in. Within that, the s3Bucket target must be filled in

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -283,16 +283,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/capacity/index.html │ │ │ @@ -46,15 +46,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.capacity.logger
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.capacity.PercentageQuantity(quantity=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a percentage quantity.

    │ │ │

    The percentage is maintained internally as a string so that issues of │ │ │ precision can be avoided. It really isn’t possible to store a floating │ │ │ point number here while being able to losslessly translate back and forth │ │ │ between XML and object representations. (Perhaps the Python 2.4 Decimal │ │ │ class would have been an option, but I originally wanted to stay compatible │ │ │ with Python 2.3.)

    │ │ │ @@ -116,15 +116,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.capacity.CapacityConfig(maxPercentage=None, minBytes=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing capacity configuration.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The maximum percentage utilized must be a PercentageQuantity

    • │ │ │
    • The minimum bytes remaining must be a ByteQuantity

    • │ │ │
    │ │ │ @@ -182,15 +182,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.capacity.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ specific configuration values to this extension. Third parties who need to │ │ │ read and write configuration related to this extension should access it │ │ │ through the constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -283,16 +283,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/encrypt/index.html │ │ │ @@ -66,15 +66,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.encrypt.ENCRYPT_INDICATOR = cback.encrypt
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.encrypt.EncryptConfig(encryptMode=None, encryptTarget=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing encrypt configuration.

    │ │ │

    Encrypt configuration is used for encrypting staging directories.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The encrypt mode must be one of the values in VALID_ENCRYPT_MODES

    • │ │ │
    • The encrypt target value must be a non-empty string

    • │ │ │ @@ -134,15 +134,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.encrypt.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ encrypt-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -198,15 +198,15 @@ │ │ │
    │ │ │ validate(self)
    │ │ │

    Validates configuration represented by the object.

    │ │ │

    Encrypt configuration must be filled in. Within that, both the encrypt │ │ │ mode and encrypt target must be filled in.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -240,16 +240,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mbox/index.html │ │ │ @@ -94,15 +94,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.mbox.REVISION_PATH_EXTENSION = mboxlast
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mbox.MboxFile(absolutePath=None, collectMode=None, compressMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing mbox file configuration..

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The absolute path must be absolute.

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │ @@ -166,15 +166,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mbox.MboxDir(absolutePath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing mbox directory configuration..

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The absolute path must be absolute.

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │ @@ -252,15 +252,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mbox.MboxConfig(collectMode=None, compressMode=None, mboxFiles=None, mboxDirs=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing mbox configuration.

    │ │ │

    Mbox configuration is used for backing up mbox email files.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │ @@ -341,15 +341,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mbox.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ Mbox-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -409,15 +409,15 @@ │ │ │ compress mode are both optional, but the list of repositories must │ │ │ contain at least one entry.

    │ │ │

    Each configured file or directory must contain an absolute path, and then │ │ │ must be either able to take collect mode and compress mode configuration │ │ │ from the parent MboxConfig object, or must set each value on its own.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -459,16 +459,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/mysql/index.html │ │ │ @@ -82,15 +82,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.mysql.MYSQLDUMP_COMMAND = ['mysqldump']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mysql.MysqlConfig(user=None, password=None, compressMode=None, all=None, databases=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing MySQL configuration.

    │ │ │

    The MySQL configuration information is used for backing up MySQL databases.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │
    • The ‘all’ flag must be ‘Y’ if no databases are defined.

    • │ │ │ @@ -166,15 +166,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.mysql.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ MySQL-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -231,15 +231,15 @@ │ │ │ validate(self) │ │ │

    Validates configuration represented by the object.

    │ │ │

    The compress mode must be filled in. Then, if the ‘all’ flag is set, │ │ │ no databases are allowed, and if the ‘all’ flag is not set, at least │ │ │ one database is required.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -280,16 +280,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -331,16 +331,16 @@ │ │ │
  • password (String representing MySQL password, or None) – Password associated with user (if any)

  • │ │ │
  • backupFile (Python file object as from open or file) – File use for writing backup

  • │ │ │
  • database (String representing database name, or None for all databases) – Name of the database to be backed up

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/postgresql/index.html │ │ │ @@ -76,15 +76,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.postgresql.POSTGRESQLDUMPALL_COMMAND = ['pg_dumpall']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.postgresql.PostgresqlConfig(user=None, compressMode=None, all=None, databases=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing PostgreSQL configuration.

    │ │ │

    The PostgreSQL configuration information is used for backing up PostgreSQL databases.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │
    • The ‘all’ flag must be ‘Y’ if no databases are defined.

    • │ │ │ @@ -155,15 +155,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.postgresql.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ PostgreSQL-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -220,15 +220,15 @@ │ │ │ validate(self) │ │ │

    Validates configuration represented by the object.

    │ │ │

    The compress mode must be filled in. Then, if the ‘all’ flag │ │ │ is set, no databases are allowed, and if the ‘all’ flag is │ │ │ not set, at least one database is required.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -268,16 +268,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -298,16 +298,16 @@ │ │ │
  • user (String representing PostgreSQL username) – User to use for connecting to the database

  • │ │ │
  • backupFile (Python file object as from open or file) – File use for writing backup

  • │ │ │
  • database (String representing database name, or None for all databases) – Name of the database to be backed up

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/split/index.html │ │ │ @@ -62,15 +62,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.split.SPLIT_INDICATOR = cback.split
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.split.SplitConfig(sizeLimit=None, splitSize=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing split configuration.

    │ │ │

    Split configuration is used for splitting staging directories.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The size limit must be a ByteQuantity

    • │ │ │
    • The split size must be a ByteQuantity

    • │ │ │ @@ -130,15 +130,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.split.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    This is not a general-purpose configuration object like the main Cedar │ │ │ Backup configuration object. Instead, it just knows how to parse and emit │ │ │ split-specific configuration values. Third parties who need to read and │ │ │ write configuration related to this extension should access it through the │ │ │ constructor, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -194,15 +194,15 @@ │ │ │
    │ │ │ validate(self)
    │ │ │

    Validates configuration represented by the object.

    │ │ │

    Split configuration must be filled in. Within that, both the size limit │ │ │ and split size must be filled in.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -236,16 +236,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/subversion/index.html │ │ │ @@ -77,15 +77,15 @@ │ │ │
    │ │ │ CedarBackup3.extend.subversion.REVISION_PATH_EXTENSION = svnlast
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.subversion.RepositoryDir(repositoryType=None, directoryPath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing Subversion repository directory.

    │ │ │

    A repository directory is a directory that contains one or more Subversion │ │ │ repositories.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The directory path must be absolute.

    • │ │ │ @@ -170,15 +170,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.subversion.Repository(repositoryType=None, repositoryPath=None, collectMode=None, compressMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing generic Subversion repository configuration..

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The respository path must be absolute.

    • │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │ @@ -249,15 +249,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.subversion.SubversionConfig(collectMode=None, compressMode=None, repositories=None, repositoryDirs=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing Subversion configuration.

    │ │ │

    Subversion configuration is used for backing up Subversion repositories.

    │ │ │

    The following restrictions exist on data in this class:

    │ │ │
    │ │ │
      │ │ │
    • The collect mode must be one of the values in VALID_COLLECT_MODES.

    • │ │ │
    • The compress mode must be one of the values in VALID_COMPRESS_MODES.

    • │ │ │ @@ -333,15 +333,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.extend.subversion.LocalConfig(xmlData=None, xmlPath=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing this extension’s configuration document.

    │ │ │

    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, validate and addConfig methods.

    │ │ │

    Note: Lists within this class are “unordered” for equality comparisons.

    │ │ │ @@ -401,15 +401,15 @@ │ │ │ mode and compress mode are both optional, but the list of repositories │ │ │ must contain at least one entry.

    │ │ │

    Each repository must contain a repository path, and then must be either │ │ │ able to take collect mode and compress mode configuration from the parent │ │ │ SubversionConfig object, or must set each value on its own.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ addConfig(self, xmlDom, parentNode)
    │ │ │ @@ -449,16 +449,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -484,16 +484,16 @@ │ │ │
  • backupFile (Python file object as from open or file) – Python file object to use for writing backup

  • │ │ │
  • startRevision (Integer value >= 0) – Starting repository revision to back up (for incremental backups)

  • │ │ │
  • endRevision (Integer value >= 0) – Ending repository revision to back up (for incremental backups)

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -506,16 +506,16 @@ │ │ │

    repositoryPath (String path representing Subversion repository on disk) – Path to Subversion repository to look in

    │ │ │
    │ │ │
    Returns
    │ │ │

    Youngest revision as an integer

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/extend/sysinfo/index.html │ │ │ @@ -96,16 +96,16 @@ │ │ │
  • configPath (String representing a path on disk) – Path to configuration file on disk

  • │ │ │
  • options (Options object) – Program command-line options

  • │ │ │
  • config (Config object) – Program configuration

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/filesystem/index.html │ │ │ @@ -38,15 +38,15 @@ │ │ │
    │ │ │ CedarBackup3.filesystem.logger
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.filesystem.FilesystemList
    │ │ │ -

    Bases: list

    │ │ │ +

    Bases: list

    │ │ │

    Represents a list of filesystem items.

    │ │ │

    This is a generic class that represents a list of filesystem items. Callers │ │ │ can add individual files or directories to the list, or can recursively add │ │ │ the contents of a directory. The class also allows for up-front exclusions │ │ │ in several forms (all files, all directories, all items matching a pattern, │ │ │ all items whose basename matches a pattern, or all directories containing a │ │ │ specific “ignore file”). Symbolic links are typically backed up │ │ │ @@ -114,16 +114,16 @@ │ │ │

    path (String representing a path on disk) – File path to be added to the list

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of items added to the list

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -138,16 +138,16 @@ │ │ │

    path (String representing a path on disk) – Directory path to be added to the list

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of items added to the list

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -187,16 +187,16 @@ │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Number of items recursively added to the list

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -214,15 +214,15 @@ │ │ │
    Parameters
    │ │ │

    pattern – Regular expression pattern representing entries to remove

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of entries removed

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │ +

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ removeDirs(self, pattern=None)
    │ │ │ @@ -241,15 +241,15 @@ │ │ │
    Parameters
    │ │ │

    pattern – Regular expression pattern representing entries to remove

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of entries removed

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │ +

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │ @@ -266,15 +266,15 @@ │ │ │
    Parameters
    │ │ │

    pattern – Regular expression pattern representing entries to remove

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of entries removed

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │ +

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ removeMatch(self, pattern)
    │ │ │ @@ -293,15 +293,15 @@ │ │ │
    Parameters
    │ │ │

    pattern – Regular expression pattern representing entries to remove

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of entries removed

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │ +

    ValueError – If the passed-in pattern is not a valid regular expression

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ removeInvalid(self)
    │ │ │ @@ -330,15 +330,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.filesystem.SpanItem(fileList, size, capacity, utilization)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Item returned by BackupFileList.generateSpan.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.filesystem.BackupFileList
    │ │ │

    Bases: CedarBackup3.filesystem.FilesystemList

    │ │ │ @@ -366,16 +366,16 @@ │ │ │

    path (String representing a path on disk) – Directory path to be added to the list

    │ │ │
    │ │ │
    Returns
    │ │ │

    Number of items added to the list

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -440,15 +440,15 @@ │ │ │
  • algorithm (One of "first_fit", "best_fit", "worst_fit", "alternate_fit") – Knapsack (fit) algorithm to use

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Copy of list with total size no larger than indicated capacity

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the algorithm is invalid

    │ │ │ +

    ValueError – If the algorithm is invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ generateSpan(self, capacity, algorithm='worst_fit')
    │ │ │ @@ -470,16 +470,16 @@ │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    List of SpanItem objects

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -524,17 +524,17 @@ │ │ │
  • mode (One of either 'tar', 'targz' or 'tarbz2') – Tar creation mode

  • │ │ │
  • ignore (Boolean) – Indicates whether to ignore certain errors

  • │ │ │
  • flat (Boolean) – Creates “flat” archive by putting all items in root

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │ @@ -640,16 +640,16 @@ │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Number of items recursively added to the list

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -765,17 +765,17 @@ │ │ │
  • path1 (String representing a path on disk) – First path to compare

  • │ │ │
  • path2 (String representing a path on disk) – First path to compare

  • │ │ │
  • verbose (Boolean) – Indicates whether a verbose response should be given

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -786,15 +786,15 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the two directories are not equivalent

    │ │ │ +

    ValueError – If the two directories are not equivalent

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/peer/index.html │ │ │ @@ -87,15 +87,15 @@ │ │ │
    │ │ │ CedarBackup3.peer.SU_COMMAND = ['su']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.peer.LocalPeer(name, collectDir, ignoreFailureMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Backup peer representing a local peer in a backup pool.

    │ │ │

    This is a class representing a local (non-network) peer in a backup pool. │ │ │ Local peers are backed up by simple filesystem copy operations. A local │ │ │ peer has associated with it a name (typically, but not necessarily, a │ │ │ hostname) and a collect directory.

    │ │ │

    The public methods other than the constructor are part of a “backup peer” │ │ │ interface shared with the RemotePeer class.

    │ │ │ @@ -134,20 +134,20 @@ │ │ │ │ │ │
    │ │ │
    Returns
    │ │ │

    Number of files copied from the source directory to the target directory

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -163,15 +163,15 @@ │ │ │
    Parameters
    │ │ │

    collectIndicator – Name of the collect indicator file to check

    │ │ │
    │ │ │
    Returns
    │ │ │

    Boolean true/false depending on whether the indicator exists

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ writeStageIndicator(self, stageIndicator=None, ownership=None, permissions=None)
    │ │ │ @@ -189,29 +189,29 @@ │ │ │
  • stageIndicator – Name of the indicator file to write

  • │ │ │
  • ownership – Owner and group that files should have, tuple of numeric (uid, gid)

  • │ │ │
  • permissions – Unix permissions mode that the staged files should have, in octal like 0640

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.peer.RemotePeer(name=None, collectDir=None, workingDir=None, remoteUser=None, rcpCommand=None, localUser=None, rshCommand=None, cbackCommand=None, ignoreFailureMode=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Backup peer representing a remote peer in a backup pool.

    │ │ │

    This is a class representing a remote (networked) peer in a backup pool. │ │ │ Remote peers are backed up using an rcp-compatible copy command. A remote │ │ │ peer has associated with it a name (which must be a valid hostname), a │ │ │ collect directory, a working directory and a copy method (an rcp-compatible │ │ │ command).

    │ │ │

    You can also set an optional local user value. This username will be used │ │ │ @@ -296,19 +296,19 @@ │ │ │ │ │ │

    │ │ │
    Returns
    │ │ │

    Number of files copied from the source directory to the target directory

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -329,15 +329,15 @@ │ │ │
    Parameters
    │ │ │

    collectIndicator – Name of the collect indicator file to check

    │ │ │
    │ │ │
    Returns
    │ │ │

    Boolean true/false depending on whether the indicator exists

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ writeStageIndicator(self, stageIndicator=None)
    │ │ │ @@ -351,32 +351,32 @@ │ │ │ to get the associated uid/gid as an ownership tuple.

    │ │ │
    │ │ │
    Parameters
    │ │ │

    stageIndicator – Name of the indicator file to write

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • ValueError – If a path cannot be encoded properly

    • │ │ │ -
    • IOError – If there is an IO error creating the file

    • │ │ │ -
    • OSError – If there is an OS error creating or changing permissions on the file

    • │ │ │ +
    • ValueError – If a path cannot be encoded properly

    • │ │ │ +
    • IOError – If there is an IO error creating the file

    • │ │ │ +
    • OSError – If there is an OS error creating or changing permissions on the file

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ executeRemoteCommand(self, command)
    │ │ │

    Executes a command on the peer via remote shell.

    │ │ │
    │ │ │
    Parameters
    │ │ │

    command – Command to execute

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error executing the command on the remote peer

    │ │ │ +

    IOError – If there is an error executing the command on the remote peer

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ executeManagedAction(self, action, fullBackup)
    │ │ │ @@ -385,15 +385,15 @@ │ │ │
    Parameters
    │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error executing the action on the remote peer

    │ │ │ +

    IOError – If there is an error executing the action on the remote peer

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/testutil/index.html │ │ │ @@ -84,15 +84,15 @@ │ │ │ :param resources: List of required resources │ │ │ :param dataDirs: List of data directories to search within for resources

    │ │ │
    │ │ │
    Returns
    │ │ │

    Dictionary mapping resource name to resource path

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    Exception – If some resource cannot be found

    │ │ │ +

    Exception – If some resource cannot be found

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.testutil.commandAvailable(command)
    │ │ │ @@ -113,41 +113,41 @@ │ │ │ For instance, constructs "/a/b/c" from ["/a", "b", "c"]. │ │ │ :param components: List of components

    │ │ │
    │ │ │
    Returns
    │ │ │

    String path constructed from components

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.testutil.removedir(tree)
    │ │ │

    Recursively removes an entire directory. │ │ │ This is basically taken from an example on python.com. │ │ │ :param tree: Directory tree to remove

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.testutil.extractTar(tmpdir, filepath)
    │ │ │

    Extracts the indicated tar file to the indicated tmpdir. │ │ │ :param tmpdir: Temp directory to extract to │ │ │ :param filepath: Path to tarfile to extract

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.testutil.changeFileAge(filename, subtract=None)
    │ │ │ @@ -164,15 +164,15 @@ │ │ │
    Parameters
    │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a path cannot be encoded properly

    │ │ │ +

    ValueError – If a path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.testutil.getMaskAsMode()
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/tools/amazons3/index.html │ │ │ @@ -61,15 +61,15 @@ │ │ │
    │ │ │ CedarBackup3.tools.amazons3.LONG_SWITCHES = ['help', 'version', 'verbose', 'quiet', 'logfile=', 'owner=', 'mode=', 'output', 'debug', 'stack', 'diagnostics', 'verifyOnly', 'uploadOnly', 'ignoreWarnings']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.tools.amazons3.Options(argumentList=None, argumentString=None, validate=True)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing command-line options for the cback3-amazons3-sync script.

    │ │ │

    The Options class is a Python object representation of the command-line │ │ │ options of the cback3-amazons3-sync script.

    │ │ │

    The object representation is two-way: a command line string or a list of │ │ │ command line arguments can be used to create an Options object, and then │ │ │ changes to the object can be propogated back to a list of command-line │ │ │ arguments or to a command-line string. An Options object can even be │ │ │ @@ -226,15 +226,15 @@ │ │ │ be specified. Other validations (as for allowed values for particular │ │ │ options) will be taken care of at assignment time by the properties │ │ │ functionality.

    │ │ │

    Note: The command line format is specified by the _usage function. │ │ │ Call _usage to see a usage statement for the cback3-amazons3-sync script.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the validations fails

    │ │ │ +

    ValueError – If one of the validations fails

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ buildArgumentList(self, validate=True)
    │ │ │ @@ -257,15 +257,15 @@ │ │ │
    Parameters
    │ │ │

    validate (Boolean true/false) – Validate the options before extracting the command line

    │ │ │
    │ │ │
    Returns
    │ │ │

    List representation of command-line arguments

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If options within the object are invalid

    │ │ │ +

    ValueError – If options within the object are invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ buildArgumentString(self, validate=True)
    │ │ │ @@ -288,15 +288,15 @@ │ │ │
    Parameters
    │ │ │

    validate (Boolean true/false) – Validate the options before extracting the command line

    │ │ │
    │ │ │
    Returns
    │ │ │

    String representation of command-line arguments

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If options within the object are invalid

    │ │ │ +

    ValueError – If options within the object are invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/util/index.html │ │ │ @@ -256,15 +256,15 @@ │ │ │
    │ │ │ CedarBackup3.util.LOCALE_VARS = ['LC_ADDRESS', 'LC_ALL', 'LC_COLLATE', 'LC_CTYPE', 'LC_IDENTIFICATION', 'LC_MEASUREMENT', 'LC_MESSAGES', 'LC_MONETARY', 'LC_NAME', 'LC_NUMERIC', 'LC_PAPER', 'LC_TELEPHONE', 'LC_TIME']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.util.UnorderedList
    │ │ │ -

    Bases: list

    │ │ │ +

    Bases: list

    │ │ │

    Class representing an “unordered list”.

    │ │ │

    An “unordered list” is a list in which only the contents matter, not the │ │ │ order in which the contents appear in the list.

    │ │ │

    For instance, we might be keeping track of set of paths in a list, because │ │ │ it’s convenient to have them in that form. However, for comparison │ │ │ purposes, we would only care that the lists contain exactly the same │ │ │ contents, regardless of order.

    │ │ │ @@ -496,47 +496,47 @@ │ │ │
    │ │ │
    │ │ │ append(self, item)
    │ │ │

    Overrides the standard append method.

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • ValueError – If item is None

    • │ │ │ -
    • ValueError – If item is empty and empty values are not allowed

    • │ │ │ -
    • ValueError – If item does not match the configured regular expression

    • │ │ │ +
    • ValueError – If item is None

    • │ │ │ +
    • ValueError – If item is empty and empty values are not allowed

    • │ │ │ +
    • ValueError – If item does not match the configured regular expression

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ insert(self, index, item)
    │ │ │

    Overrides the standard insert method.

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • ValueError – If item is None

    • │ │ │ -
    • ValueError – If item is empty and empty values are not allowed

    • │ │ │ -
    • ValueError – If item does not match the configured regular expression

    • │ │ │ +
    • ValueError – If item is None

    • │ │ │ +
    • ValueError – If item is empty and empty values are not allowed

    • │ │ │ +
    • ValueError – If item does not match the configured regular expression

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ extend(self, seq)
    │ │ │

    Overrides the standard insert method.

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • ValueError – If any item is None

    • │ │ │ -
    • ValueError – If any item is empty and empty values are not allowed

    • │ │ │ -
    • ValueError – If any item does not match the configured regular expression

    • │ │ │ +
    • ValueError – If any item is None

    • │ │ │ +
    • ValueError – If any item is empty and empty values are not allowed

    • │ │ │ +
    • ValueError – If any item does not match the configured regular expression

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │ @@ -570,15 +570,15 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.util.DirectedGraph(name)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Represents a directed graph.

    │ │ │

    A graph G=(V,E) consists of a set of vertices V together with a set │ │ │ E of vertex pairs or edges. In a directed graph, each edge also has an │ │ │ associated direction (from vertext v1 to vertex v2). A DirectedGraph │ │ │ object provides a way to construct a directed graph and execute a depth- │ │ │ first search.

    │ │ │

    This data structure was designed based on the graphing chapter in │ │ │ @@ -639,28 +639,28 @@ │ │ │

    │ │ │
    │ │ │ createVertex(self, name)
    │ │ │

    Creates a named vertex. │ │ │ :param name: vertex name

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the vertex name is None or empty

    │ │ │ +

    ValueError – If the vertex name is None or empty

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ createEdge(self, start, finish)
    │ │ │

    Adds an edge with an associated direction, from start vertex to finish vertex. │ │ │ :param start: Name of start vertex │ │ │ :param finish: Name of finish vertex

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the named vertices is unknown

    │ │ │ +

    ValueError – If one of the named vertices is unknown

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ topologicalSort(self)
    │ │ │ @@ -681,25 +681,25 @@ │ │ │ graph. If you’re using this method to determine a dependency order, this │ │ │ makes sense: a vertex with no dependencies can go anywhere (and will).

    │ │ │
    │ │ │
    Returns
    │ │ │

    Ordering on the vertices so that all edges go from left to right

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If a cycle is found in the graph

    │ │ │ +

    ValueError – If a cycle is found in the graph

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.util.PathResolverSingleton
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Singleton used for resolving executable paths.

    │ │ │

    Various functions throughout Cedar Backup (including extensions) need a way │ │ │ to resolve the path of executables that they use. For instance, the image │ │ │ functionality needs to find the mkisofs executable, and the Subversion │ │ │ extension needs to find the svnlook executable. Cedar Backup’s original │ │ │ behavior was to assume that the simple name ("svnlook" or whatever) was │ │ │ available on the caller’s $PATH, and to fail otherwise. However, this │ │ │ @@ -771,27 +771,27 @@ │ │ │

    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.util.Pipe(cmd, bufsize=- 1, ignoreStderr=False)
    │ │ │ -

    Bases: subprocess.Popen

    │ │ │ +

    Bases: subprocess.Popen

    │ │ │

    Specialized pipe class for use by executeCommand.

    │ │ │

    The executeCommand function needs a specialized way of interacting │ │ │ with a pipe. First, executeCommand only reads from the pipe, and │ │ │ never writes to it. Second, executeCommand needs a way to discard all │ │ │ output written to stderr, as a means of simulating the shell │ │ │ 2>/dev/null construct.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.util.Diagnostics
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class holding runtime diagnostic information.

    │ │ │

    Diagnostic information is information that is useful to get from users for │ │ │ debugging purposes. I’m consolidating it all here into one object.

    │ │ │
    │ │ │
    │ │ │ version
    │ │ │
    │ │ │ @@ -877,15 +877,15 @@ │ │ │

    Removes all of the keys from the dictionary. │ │ │ The dictionary is altered in-place. │ │ │ Each key must exist in the dictionary. │ │ │ :param d: Dictionary to operate on │ │ │ :param keys: List of keys to remove

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    KeyError – If one of the keys does not exist

    │ │ │ +

    KeyError – If one of the keys does not exist

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.convertSize(size, fromUnit, toUnit)
    │ │ │ @@ -911,15 +911,15 @@ │ │ │
  • toUnit (One of the units listed above) – Unit to convert to

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Number converted to new unit, as a float

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If one of the units is invalid

    │ │ │ +

    ValueError – If one of the units is invalid

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.displayBytes(bytes, digits=2)
    │ │ │ @@ -977,16 +977,16 @@ │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Reference to function associated with name

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │

    @copyright: Some of this code, prior to customization, was originally part │ │ │ of the Python 2.3 codebase. Python code is copyright (c) 2001, 2002 Python │ │ │ Software Foundation; All Rights Reserved.

    │ │ │ │ │ │ @@ -1003,15 +1003,15 @@ │ │ │
  • group (Group name as a string) – Group name

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Tuple (uid, gid) matching passed-in user and group

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the ownership user/group values are invalid

    │ │ │ +

    ValueError – If the ownership user/group values are invalid

    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.changeOwnership(path, user, group)
    │ │ │ @@ -1052,15 +1052,15 @@ │ │ │
    Parameters
    │ │ │

    commandLine (String, i.e. "cback3 --verbose stage store") – Command line string

    │ │ │
    │ │ │
    Returns
    │ │ │

    List of arguments, suitable for passing to popen2

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the command line is None

    │ │ │ +

    ValueError – If the command line is None

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.resolveCommand(command)
    │ │ │ @@ -1167,15 +1167,15 @@ │ │ │
    Parameters
    │ │ │

    path – Path to a file on disk

    │ │ │
    │ │ │
    Returns
    │ │ │

    Age of the file in days (possibly fractional)

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    OSError – If the file doesn’t exist

    │ │ │ +

    OSError – If the file doesn’t exist

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.mount(devicePath, mountPoint, fsType)
    │ │ │ @@ -1193,15 +1193,15 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If the device cannot be mounted

    │ │ │ +

    IOError – If the device cannot be mounted

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.unmount(mountPoint, removeAfter=False, attempts=1, waitSeconds=0)
    │ │ │ @@ -1228,15 +1228,15 @@ │ │ │
  • mountPoint – Mount point to be unmounted

  • │ │ │
  • removeAfter – Remove the mount point after unmounting it

  • │ │ │
  • attempts – Number of times to attempt the unmount

  • │ │ │
  • waitSeconds – Number of seconds to wait between repeated attempts

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │ -

    IOError – If the mount point is still mounted after attempts are exhausted

    │ │ │ +

    IOError – If the mount point is still mounted after attempts are exhausted

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.deviceMounted(devicePath)
    │ │ │ @@ -1263,15 +1263,15 @@ │ │ │

    Safely encodes a filesystem path as a Unicode string, converting bytes to fileystem encoding if necessary. │ │ │ :param path: Path to encode

    │ │ │
    │ │ │
    Returns
    │ │ │

    Path, as a string, encoded appropriately

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the path cannot be encoded properly

    │ │ │ +

    ValueError – If the path cannot be encoded properly

    │ │ │
    │ │ │
    │ │ │

    @see: http://lucumr.pocoo.org/2013/7/2/the-updated-guide-to-unicode/

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -1355,15 +1355,15 @@ │ │ │
    Parameters
    │ │ │

    path – Path to normalize

    │ │ │
    │ │ │
    Returns
    │ │ │

    Normalized path as described above

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the path is None

    │ │ │ +

    ValueError – If the path is None

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.sanitizeEnvironment()
    │ │ │ @@ -1408,15 +1408,15 @@ │ │ │
    Parameters
    │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If there are duplicates in the list

    │ │ │ +

    ValueError – If there are duplicates in the list

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.util.parseCommaSeparatedString(commaString)
    │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/cdwriter/index.html │ │ │ @@ -104,15 +104,15 @@ │ │ │
    │ │ │ CedarBackup3.writers.cdwriter.MKISOFS_COMMAND = ['mkisofs']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.cdwriter.MediaDefinition(mediaType)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class encapsulating information about CD media definitions.

    │ │ │

    The following media types are accepted:

    │ │ │
    │ │ │
      │ │ │
    • MEDIA_CDR_74: 74-minute CD-R media (650 MB capacity)

    • │ │ │
    • MEDIA_CDRW_74: 74-minute CD-RW media (650 MB capacity)

    • │ │ │
    • MEDIA_CDR_80: 80-minute CD-R media (700 MB capacity)

    • │ │ │ @@ -147,15 +147,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.cdwriter.MediaCapacity(bytesUsed, bytesAvailable, boundaries)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class encapsulating information about CD media capacity.

    │ │ │

    Space used includes the required media lead-in (unless the disk is unused). │ │ │ Space available attempts to provide a picture of how many bytes are │ │ │ available for data storage, including any required lead-in.

    │ │ │

    The boundaries value is either None (if multisession discs are not │ │ │ supported or if the disc has no boundaries) or in exactly the form provided │ │ │ by cdrecord -msinfo. It can be passed as-is to the IsoImage class.

    │ │ │ @@ -191,15 +191,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.cdwriter.CdWriter(device, scsiId=None, driveSpeed=None, mediaType=MEDIA_CDRW_74, noEject=False, refreshMediaDelay=0, ejectDelay=0, unittest=False)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a device that knows how to write CD media.

    │ │ │

    This is a class representing a device that knows how to write CD media. It │ │ │ provides common operations for the device, such as ejecting the media, │ │ │ writing an ISO image to the media, or checking for the current media │ │ │ capacity. It also provides a place to store device attributes, such as │ │ │ whether the device supports writing multisession discs, etc.

    │ │ │

    This class is implemented in terms of the eject and cdrecord │ │ │ @@ -378,15 +378,15 @@ │ │ │

  • useMulti (Boolean true/false) – Indicates whether a multisession disc should be assumed, if possible

  • │ │ │ │ │ │
    │ │ │
    Returns
    │ │ │

    MediaCapacity object describing the capacity of the media

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If the media could not be read for some reason

    │ │ │ +

    IOError – If the media could not be read for some reason

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ initializeImage(self, newDisc, tmpdir, mediaLabel=None)
    │ │ │ @@ -417,41 +417,41 @@ │ │ │
    Parameters
    │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If initializeImage() was not previously called

    │ │ │ +

    ValueError – If initializeImage() was not previously called

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ setImageNewDisc(self, newDisc)
    │ │ │

    Resets (overrides) the newDisc flag on the internal image. │ │ │ :param newDisc: New disc flag to set

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If initializeImage() was not previously called

    │ │ │ +

    ValueError – If initializeImage() was not previously called

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ getEstimatedImageSize(self)
    │ │ │

    Gets the estimated size of the image associated with the writer. │ │ │ :returns: Estimated size of the image, in bytes

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • IOError – If there is a problem calling mkisofs

    • │ │ │ -
    • ValueError – If initializeImage() was not previously called

    • │ │ │ +
    • IOError – If there is a problem calling mkisofs

    • │ │ │ +
    • ValueError – If initializeImage() was not previously called

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -473,15 +473,15 @@ │ │ │ eject would give errors like “unable to eject, last error: Inappropriate │ │ │ ioctl for device”. Various sources online (like Ubuntu bug #875543) │ │ │ suggested that the drive was being locked somehow, and that the │ │ │ workaround was to run ‘eject -i off’ to unlock it. Sure enough, that │ │ │ fixed the problem for me, so now it’s a normal error-handling strategy.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ unlockTray(self)
    │ │ │ @@ -497,15 +497,15 @@ │ │ │ We have no way to know if the tray is currently open or closed, so we │ │ │ just send the appropriate command and hope for the best. If the device │ │ │ does not have a tray or does not support ejecting its media, then we do │ │ │ nothing.

    │ │ │

    If the writer was constructed with noEject=True, then this is a no-op.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ refreshMedia(self)
    │ │ │ @@ -519,15 +519,15 @@ │ │ │

    This only works if the device has a tray and supports ejecting its media. │ │ │ We have no way to know if the tray is currently open or closed, so we │ │ │ just send the appropriate command and hope for the best. If the device │ │ │ does not have a tray or does not support ejecting its media, then we do │ │ │ nothing. The configured delays still apply, though.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ writeImage(self, imagePath=None, newDisc=False, writeMulti=True)
    │ │ │ @@ -551,18 +551,18 @@ │ │ │
  • imagePath (String representing a path on disk) – Path to an ISO image on disk, or None to use writer’s image

  • │ │ │
  • newDisc (Boolean true/false) – Indicates whether the entire disc will overwritten

  • │ │ │
  • writeMulti (Boolean true/false) – Indicates whether a multisession disc should be written, if possible

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/dvdwriter/index.html │ │ │ @@ -80,15 +80,15 @@ │ │ │
    │ │ │ CedarBackup3.writers.dvdwriter.EJECT_COMMAND = ['eject']
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.dvdwriter.MediaDefinition(mediaType)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class encapsulating information about DVD media definitions.

    │ │ │

    The following media types are accepted:

    │ │ │
    │ │ │
      │ │ │
    • MEDIA_DVDPLUSR: DVD+R media (4.4 GB capacity)

    • │ │ │
    • MEDIA_DVDPLUSRW: DVD+RW media (4.4 GB capacity)

    • │ │ │
    │ │ │ @@ -114,15 +114,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.dvdwriter.MediaCapacity(bytesUsed, bytesAvailable)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class encapsulating information about DVD media capacity.

    │ │ │

    Space used and space available do not include any information about media │ │ │ lead-in or other overhead.

    │ │ │
    │ │ │
    │ │ │ bytesUsed
    │ │ │
    │ │ │ @@ -149,15 +149,15 @@ │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.dvdwriter.DvdWriter(device, scsiId=None, driveSpeed=None, mediaType=MEDIA_DVDPLUSRW, noEject=False, refreshMediaDelay=0, ejectDelay=0, unittest=False)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Class representing a device that knows how to write some kinds of DVD media.

    │ │ │

    Summary

    │ │ │

    This is a class representing a device that knows how to write some kinds │ │ │ of DVD media. It provides common operations for the device, such as │ │ │ ejecting the media and writing data to the media.

    │ │ │

    This class is implemented in terms of the eject and growisofs │ │ │ utilities, all of which should be available on most UN*X platforms.

    │ │ │ @@ -301,16 +301,16 @@ │ │ │

    entireDisc (Boolean true/false) – Indicates whether to return capacity for entire disc

    │ │ │
    │ │ │
    Returns
    │ │ │

    MediaCapacity object describing the capacity of the media

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -343,29 +343,29 @@ │ │ │
    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ setImageNewDisc(self, newDisc)
    │ │ │

    Resets (overrides) the newDisc flag on the internal image. │ │ │ :param newDisc: New disc flag to set

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If initializeImage() was not previously called

    │ │ │ +

    ValueError – If initializeImage() was not previously called

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ getEstimatedImageSize(self)
    │ │ │ @@ -374,16 +374,16 @@ │ │ │ much as 450 blocks (sectors) smaller under some circmstances.

    │ │ │
    │ │ │
    Returns
    │ │ │

    Estimated size of the image, in bytes

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • IOError – If there is a problem calling mkisofs

    • │ │ │ -
    • ValueError – If initializeImage() was not previously called

    • │ │ │ +
    • IOError – If there is a problem calling mkisofs

    • │ │ │ +
    • ValueError – If initializeImage() was not previously called

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -404,15 +404,15 @@ │ │ │ eject would give errors like “unable to eject, last error: Inappropriate │ │ │ ioctl for device”. Various sources online (like Ubuntu bug #875543) │ │ │ suggested that the drive was being locked somehow, and that the │ │ │ workaround was to run ‘eject -i off’ to unlock it. Sure enough, that │ │ │ fixed the problem for me, so now it’s a normal error-handling strategy.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ unlockTray(self)
    │ │ │ @@ -427,15 +427,15 @@ │ │ │

    This only works if the device has a tray and supports ejecting its media. │ │ │ We have no way to know if the tray is currently open or closed, so we │ │ │ just send the appropriate command and hope for the best. If the device │ │ │ does not have a tray or does not support ejecting its media, then we do │ │ │ nothing.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ refreshMedia(self)
    │ │ │ @@ -449,15 +449,15 @@ │ │ │

    This only works if the device has a tray and supports ejecting its media. │ │ │ We have no way to know if the tray is currently open or closed, so we │ │ │ just send the appropriate command and hope for the best. If the device │ │ │ does not have a tray or does not support ejecting its media, then we do │ │ │ nothing. The configured delays still apply, though.

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    IOError – If there is an error talking to the device

    │ │ │ +

    IOError – If there is an error talking to the device

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ writeImage(self, imagePath=None, newDisc=False, writeMulti=True)
    │ │ │ @@ -482,18 +482,18 @@ │ │ │
  • imagePath (String representing a path on disk) – Path to an ISO image on disk, or None to use writer’s image

  • │ │ │
  • newDisc (Boolean true/false) – Indicates whether the disc should be re-initialized

  • │ │ │
  • writeMulti (Boolean true/false) – Unused

  • │ │ │ │ │ │ │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/writers/util/index.html │ │ │ @@ -59,16 +59,16 @@ │ │ │ :param unittest: Indicates whether we’re unit testing

    │ │ │
    │ │ │
    Returns
    │ │ │

    Device as a string, for instance "/dev/cdrw"

    │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -79,15 +79,15 @@ │ │ │ Note: For consistency, if None is passed in, None will be returned. │ │ │ :param scsiId: SCSI id for the device

    │ │ │
    │ │ │
    Returns
    │ │ │

    SCSI id as a string, for instance "ATA:1,0,0"

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the SCSI id string is invalid

    │ │ │ +

    ValueError – If the SCSI id string is invalid

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.writers.util.validateDriveSpeed(driveSpeed)
    │ │ │ @@ -96,15 +96,15 @@ │ │ │ Note: For consistency, if None is passed in, None will be returned. │ │ │ :param driveSpeed: Speed at which the drive writes

    │ │ │
    │ │ │
    Returns
    │ │ │

    Drive speed as an integer

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the drive speed value is invalid

    │ │ │ +

    ValueError – If the drive speed value is invalid

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.writers.util.readMediaLabel(devicePath)
    │ │ │ @@ -117,15 +117,15 @@ │ │ │ │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.writers.util.IsoImage(device=None, boundaries=None, graftPoint=None)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    Represents an ISO filesystem image.

    │ │ │

    Summary

    │ │ │

    This object represents an ISO 9660 filesystem image. It is implemented │ │ │ in terms of the mkisofs program, which has been ported to many │ │ │ operating systems and platforms. A “sensible subset” of the mkisofs │ │ │ functionality is made available through the public interface, allowing │ │ │ callers to set a variety of basic options such as publisher id, │ │ │ @@ -241,17 +241,17 @@ │ │ │

  • graftPoint (String representing a graft point path, as described above) – Graft point to be used when adding this entry

  • │ │ │
  • override (Boolean true/false) – Override an existing entry with the same path

  • │ │ │
  • contentsOnly (Boolean true/false) – Add directory contents only (standard mkisofs behavior)

  • │ │ │ │ │ │
    │ │ │
    Raises
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -263,16 +263,16 @@ │ │ │ true cost of directories in the structure, etc, etc.

    │ │ │
    │ │ │
    Returns
    │ │ │

    Estimated size of the image, in bytes

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • IOError – If there is a problem calling mkisofs

    • │ │ │ -
    • ValueError – If there are no filesystem entries in the image

    • │ │ │ +
    • IOError – If there is a problem calling mkisofs

    • │ │ │ +
    • ValueError – If there are no filesystem entries in the image

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -280,17 +280,17 @@ │ │ │

    Writes this image to disk using the image path.

    │ │ │
    │ │ │
    Parameters
    │ │ │

    imagePath (String representing a path on disk) – Path to write image out as

    │ │ │
    │ │ │
    Raises
    │ │ │
      │ │ │ -
    • IOError – If there is an error writing the image to disk

    • │ │ │ -
    • ValueError – If there are no filesystem entries in the image

    • │ │ │ -
    • ValueError – If a path cannot be encoded properly

    • │ │ │ +
    • IOError – If there is an error writing the image to disk

    • │ │ │ +
    • ValueError – If there are no filesystem entries in the image

    • │ │ │ +
    • ValueError – If a path cannot be encoded properly

    • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ ├── ./usr/share/doc/cedar-backup3/html/autoapi/CedarBackup3/xmlutil/index.html │ │ │ @@ -86,15 +86,15 @@ │ │ │
    │ │ │
    │ │ │ CedarBackup3.xmlutil.createInputDom(xmlData, name='cb_config')
    │ │ │

    Creates a DOM tree based on reading an XML string. │ │ │ :returns: Tuple (xmlDom, parentNode) for the parsed document

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the document can’t be parsed

    │ │ │ +

    ValueError – If the document can’t be parsed

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.xmlutil.createOutputDom(name='cb_config')
    │ │ │ @@ -220,15 +220,15 @@ │ │ │
  • name – Name of node to search for

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Integer contents of node or None if no matching nodes are found

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the string at the location can’t be converted to an integer

    │ │ │ +

    ValueError – If the string at the location can’t be converted to an integer

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.xmlutil.readLong(parent, name)
    │ │ │ @@ -243,15 +243,15 @@ │ │ │
  • name – Name of node to search for

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Long integer contents of node or None if no matching nodes are found

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the string at the location can’t be converted to an integer

    │ │ │ +

    ValueError – If the string at the location can’t be converted to an integer

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.xmlutil.readFloat(parent, name)
    │ │ │ @@ -266,15 +266,15 @@ │ │ │
  • name – Name of node to search for

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Float contents of node or None if no matching nodes are found

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the string at the location can’t be converted to a

    │ │ │ +

    ValueError – If the string at the location can’t be converted to a

    │ │ │
    │ │ │
    │ │ │

    float value.

    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -291,15 +291,15 @@ │ │ │
  • name – Name of node to search for

  • │ │ │ │ │ │ │ │ │
    Returns
    │ │ │

    Boolean contents of node or None if no matching nodes are found

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If the string at the location can’t be converted to a boolean

    │ │ │ +

    ValueError – If the string at the location can’t be converted to a boolean

    │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ CedarBackup3.xmlutil.addContainerNode(xmlDom, parentNode, nodeName)
    │ │ │ @@ -421,15 +421,15 @@ │ │ │ │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ class CedarBackup3.xmlutil.Serializer(stream=sys.stdout, encoding='UTF-8', indent=3)
    │ │ │ -

    Bases: object

    │ │ │ +

    Bases: object

    │ │ │

    XML serializer class.

    │ │ │

    This is a customized serializer that I hacked together based on what I found │ │ │ in the PyXML distribution. Basically, around release 2.7.0, the only reason │ │ │ I still had around a dependency on PyXML was for the PrettyPrint │ │ │ functionality, and that seemed pointless. So, I stripped the PrettyPrint │ │ │ code out of PyXML and hacked bits of it off until it did just what I needed │ │ │ and no more.

    │ │ │ @@ -449,15 +449,15 @@ │ │ │
    │ │ │
    │ │ │ serialize(self, xmlDom)
    │ │ │

    Serialize the passed-in XML document. │ │ │ :param xmlDom: XML DOM tree to serialize

    │ │ │
    │ │ │
    Raises
    │ │ │ -

    ValueError – If there’s an unknown node type in the document

    │ │ │ +

    ValueError – If there’s an unknown node type in the document

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │