/usr/share/doc/cedar-backup2-doc/interface/CedarBackup2.writers.cdwriter.CdWriter-class.html is in cedar-backup2-doc 2.26.5-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.writers.cdwriter.CdWriter</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup2">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.writers-module.html">Package writers</a> ::
<a href="CedarBackup2.writers.cdwriter-module.html">Module cdwriter</a> ::
Class CdWriter
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.writers.cdwriter.CdWriter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class CdWriter</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">CdWriter</strong>
</pre>
<hr />
<p>Class representing a device that knows how to write CD media.</p>
<h1 class="heading">Summary</h1>
<p>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.</p>
<p>This class is implemented in terms of the <code>eject</code> and
<code>cdrecord</code> programs, both of which should be available on
most UN*X platforms.</p>
<h1 class="heading">Image Writer Interface</h1>
<p>The following methods make up the "image writer" interface
shared with other kinds of writers (such as DVD writers):</p>
<pre class="literalblock">
__init__
initializeImage()
addImageEntry()
writeImage()
setImageNewDisc()
retrieveCapacity()
getEstimatedImageSize()
</pre>
<p>Only these methods will be used by other Cedar Backup functionality
that expects a compatible image writer.</p>
<p>The media attribute is also assumed to be available.</p>
<h1 class="heading">Media Types</h1>
<p>This class knows how to write to two different kinds of media,
represented by the following constants:</p>
<ul>
<li>
<code>MEDIA_CDR_74</code>: 74-minute CD-R media (650 MB capacity)
</li>
<li>
<code>MEDIA_CDRW_74</code>: 74-minute CD-RW media (650 MB capacity)
</li>
<li>
<code>MEDIA_CDR_80</code>: 80-minute CD-R media (700 MB capacity)
</li>
<li>
<code>MEDIA_CDRW_80</code>: 80-minute CD-RW media (700 MB capacity)
</li>
</ul>
<p>Most hardware can read and write both 74-minute and 80-minute CD-R
and CD-RW media. Some older drives may only be able to write CD-R
media. The difference between the two is that CD-RW media can be
rewritten (erased), while CD-R media cannot be.</p>
<p>I do not support any other configurations for a couple of reasons.
The first is that I've never tested any other kind of media. The
second is that anything other than 74 or 80 minute is apparently
non-standard.</p>
<h1 class="heading">Device Attributes vs. Media Attributes</h1>
<p>A given writer instance has two different kinds of attributes
associated with it, which I call device attributes and media
attributes. Device attributes are things which can be determined
without looking at the media, such as whether the drive supports
writing multisession disks or has a tray. Media attributes are
attributes which vary depending on the state of the media, such as the
remaining capacity on a disc. In general, device attributes are
available via instance variables and are constant over the life of an
object, while media attributes can be retrieved through method
calls.</p>
<h1 class="heading">Talking to Hardware</h1>
<p>This class needs to talk to CD writer hardware in two different
ways: through cdrecord to actually write to the media, and through the
filesystem to do things like open and close the tray.</p>
<p>Historically, CdWriter has interacted with cdrecord using the scsiId
attribute, and with most other utilities using the device attribute.
This changed somewhat in Cedar Backup 2.9.0.</p>
<p>When Cedar Backup was first written, the only way to interact with
cdrecord was by using a SCSI device id. IDE devices were mapped to
pseudo-SCSI devices through the kernel. Later, extended SCSI
"methods" arrived, and it became common to see
<code>ATA:1,0,0</code> or <code>ATAPI:0,0,0</code> as a way to address
IDE hardware. By late 2006, <code>ATA</code> and <code>ATAPI</code>
had apparently been deprecated in favor of just addressing the IDE
device directly by name, i.e. <code>/dev/cdrw</code>.</p>
<p>Because of this latest development, it no longer makes sense to
require a CdWriter to be created with a SCSI id -- there might not be
one. So, the passed-in SCSI id is now optional. Also, there is now a
hardwareId attribute. This attribute is filled in with either the SCSI
id (if provided) or the device (otherwise). The hardware id is the
value that will be passed to cdrecord in the <code>dev=</code>
argument.</p>
<h1 class="heading">Testing</h1>
<p>It's rather difficult to test this code in an automated fashion,
even if you have access to a physical CD writer drive. It's even more
difficult to test it if you are running on some build daemon (think of
a Debian autobuilder) which can't be expected to have any hardware or
any media that you could write to.</p>
<p>Because of this, much of the implementation below is in terms of
static methods that are supposed to take defined actions based on their
arguments. Public methods are then implemented in terms of a series of
calls to simplistic static methods. This way, we can test as much as
possible of the functionality via testing the static methods, while
hoping that if the static methods are called appropriately, things will
work properly. It's not perfect, but it's much better than no testing
at all.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">device</span>,
<span class="summary-sig-arg">scsiId</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">driveSpeed</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">mediaType</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">noEject</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">refreshMediaDelay</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">ejectDelay</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">unittest</span>=<span class="summary-sig-default">False</span>)</span><br />
Initializes a CD writer object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="isRewritable"></a><span class="summary-sig-name">isRewritable</span>(<span class="summary-sig-arg">self</span>)</span><br />
Indicates whether the media is rewritable per configuration.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.isRewritable">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_retrieveProperties" class="summary-sig-name" onclick="show_private();">_retrieveProperties</a>(<span class="summary-sig-arg">self</span>)</span><br />
Retrieves properties for a device from <code>cdrecord</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._retrieveProperties">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#retrieveCapacity" class="summary-sig-name">retrieveCapacity</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">entireDisc</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">useMulti</span>=<span class="summary-sig-default">True</span>)</span><br />
Retrieves capacity for the current media in terms of a
<code>MediaCapacity</code> object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.retrieveCapacity">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getBoundaries" class="summary-sig-name" onclick="show_private();">_getBoundaries</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">entireDisc</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">useMulti</span>=<span class="summary-sig-default">True</span>)</span><br />
Gets the ISO boundaries for the media.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getBoundaries">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#openTray" class="summary-sig-name">openTray</a>(<span class="summary-sig-arg">self</span>)</span><br />
Opens the device's tray and leaves it open.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.openTray">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#closeTray" class="summary-sig-name">closeTray</a>(<span class="summary-sig-arg">self</span>)</span><br />
Closes the device's tray.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.closeTray">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#refreshMedia" class="summary-sig-name">refreshMedia</a>(<span class="summary-sig-arg">self</span>)</span><br />
Opens and then immediately closes the device's tray, to refresh the
device's idea of the media.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.refreshMedia">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#writeImage" class="summary-sig-name">writeImage</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">imagePath</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">newDisc</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">writeMulti</span>=<span class="summary-sig-default">True</span>)</span><br />
Writes an ISO image to the media in the device.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.writeImage">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_blankMedia" class="summary-sig-name" onclick="show_private();">_blankMedia</a>(<span class="summary-sig-arg">self</span>)</span><br />
Blanks the media in the device, if the media is rewritable.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._blankMedia">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#initializeImage" class="summary-sig-name">initializeImage</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">newDisc</span>,
<span class="summary-sig-arg">tmpdir</span>,
<span class="summary-sig-arg">mediaLabel</span>=<span class="summary-sig-default">None</span>)</span><br />
Initializes the writer's associated ISO image.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.initializeImage">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#addImageEntry" class="summary-sig-name">addImageEntry</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">graftPoint</span>)</span><br />
Adds a filepath entry to the writer's associated ISO image.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.addImageEntry">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#setImageNewDisc" class="summary-sig-name">setImageNewDisc</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">newDisc</span>)</span><br />
Resets (overrides) the newDisc flag on the internal image.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.setImageNewDisc">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#getEstimatedImageSize" class="summary-sig-name">getEstimatedImageSize</a>(<span class="summary-sig-arg">self</span>)</span><br />
Gets the estimated size of the image associated with the writer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.getEstimatedImageSize">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDevice"></a><span class="summary-sig-name">_getDevice</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDevice">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getScsiId"></a><span class="summary-sig-name">_getScsiId</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the SCSI id value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getScsiId">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getHardwareId"></a><span class="summary-sig-name">_getHardwareId</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the hardware id value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getHardwareId">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDriveSpeed"></a><span class="summary-sig-name">_getDriveSpeed</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the drive speed.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDriveSpeed">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getMedia"></a><span class="summary-sig-name">_getMedia</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the media description.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getMedia">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceType"></a><span class="summary-sig-name">_getDeviceType</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device type.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceType">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceVendor"></a><span class="summary-sig-name">_getDeviceVendor</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device vendor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceVendor">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceId"></a><span class="summary-sig-name">_getDeviceId</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device id.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceId">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceBufferSize"></a><span class="summary-sig-name">_getDeviceBufferSize</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device buffer size.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceBufferSize">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceSupportsMulti"></a><span class="summary-sig-name">_getDeviceSupportsMulti</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device-support-multi flag.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceSupportsMulti">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceHasTray"></a><span class="summary-sig-name">_getDeviceHasTray</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device-has-tray flag.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceHasTray">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getDeviceCanEject"></a><span class="summary-sig-name">_getDeviceCanEject</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the device-can-eject flag.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getDeviceCanEject">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getRefreshMediaDelay"></a><span class="summary-sig-name">_getRefreshMediaDelay</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the configured refresh media delay, in
seconds.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getRefreshMediaDelay">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getEjectDelay"></a><span class="summary-sig-name">_getEjectDelay</span>(<span class="summary-sig-arg">self</span>)</span><br />
Property target used to get the configured eject delay, in seconds.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getEjectDelay">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#unlockTray" class="summary-sig-name">unlockTray</a>(<span class="summary-sig-arg">self</span>)</span><br />
Unlocks the device's tray.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.unlockTray">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_createImage" class="summary-sig-name" onclick="show_private();">_createImage</a>(<span class="summary-sig-arg">self</span>)</span><br />
Creates an ISO image based on configuration in self._image.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._createImage">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_writeImage" class="summary-sig-name" onclick="show_private();">_writeImage</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">imagePath</span>,
<span class="summary-sig-arg">writeMulti</span>,
<span class="summary-sig-arg">newDisc</span>)</span><br />
Write an ISO image to disc using cdrecord.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._writeImage">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_calculateCapacity" class="summary-sig-name" onclick="show_private();">_calculateCapacity</a>(<span class="summary-sig-arg">media</span>,
<span class="summary-sig-arg">boundaries</span>)</span><br />
Calculates capacity for the media in terms of boundaries.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._calculateCapacity">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_parsePropertiesOutput" class="summary-sig-name" onclick="show_private();">_parsePropertiesOutput</a>(<span class="summary-sig-arg">output</span>)</span><br />
Parses the output from a <code>cdrecord</code> properties command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._parsePropertiesOutput">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_parseBoundariesOutput" class="summary-sig-name" onclick="show_private();">_parseBoundariesOutput</a>(<span class="summary-sig-arg">output</span>)</span><br />
Parses the output from a <code>cdrecord</code> capacity command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._parseBoundariesOutput">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildOpenTrayArgs" class="summary-sig-name" onclick="show_private();">_buildOpenTrayArgs</a>(<span class="summary-sig-arg">device</span>)</span><br />
Builds a list of arguments to be passed to a <code>eject</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildOpenTrayArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildCloseTrayArgs" class="summary-sig-name" onclick="show_private();">_buildCloseTrayArgs</a>(<span class="summary-sig-arg">device</span>)</span><br />
Builds a list of arguments to be passed to a <code>eject</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildCloseTrayArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildPropertiesArgs" class="summary-sig-name" onclick="show_private();">_buildPropertiesArgs</a>(<span class="summary-sig-arg">hardwareId</span>)</span><br />
Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildPropertiesArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildBoundariesArgs" class="summary-sig-name" onclick="show_private();">_buildBoundariesArgs</a>(<span class="summary-sig-arg">hardwareId</span>)</span><br />
Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildBoundariesArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildBlankArgs" class="summary-sig-name" onclick="show_private();">_buildBlankArgs</a>(<span class="summary-sig-arg">hardwareId</span>,
<span class="summary-sig-arg">driveSpeed</span>=<span class="summary-sig-default">None</span>)</span><br />
Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildBlankArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildWriteArgs" class="summary-sig-name" onclick="show_private();">_buildWriteArgs</a>(<span class="summary-sig-arg">hardwareId</span>,
<span class="summary-sig-arg">imagePath</span>,
<span class="summary-sig-arg">driveSpeed</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">writeMulti</span>=<span class="summary-sig-default">True</span>)</span><br />
Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildWriteArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_buildUnlockTrayArgs" class="summary-sig-name" onclick="show_private();">_buildUnlockTrayArgs</a>(<span class="summary-sig-arg">device</span>)</span><br />
Builds a list of arguments to be passed to a <code>eject</code>
command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildUnlockTrayArgs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#device" class="summary-name">device</a><br />
Filesystem device name for this writer.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#scsiId" class="summary-name">scsiId</a><br />
SCSI id for the device, in the form
<code>[<method>:]scsibus,target,lun</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#hardwareId" class="summary-name">hardwareId</a><br />
Hardware id for this writer, either SCSI id or device path.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#driveSpeed" class="summary-name">driveSpeed</a><br />
Speed at which the drive writes.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#media" class="summary-name">media</a><br />
Definition of media that is expected to be in the device.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceType" class="summary-name">deviceType</a><br />
Type of the device, as returned from <code>cdrecord -prcap</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceVendor" class="summary-name">deviceVendor</a><br />
Vendor of the device, as returned from <code>cdrecord -prcap</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceId" class="summary-name">deviceId</a><br />
Device identification, as returned from <code>cdrecord -prcap</code>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceBufferSize" class="summary-name">deviceBufferSize</a><br />
Size of the device's write buffer, in bytes.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceSupportsMulti" class="summary-name">deviceSupportsMulti</a><br />
Indicates whether device supports multisession discs.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceHasTray" class="summary-name">deviceHasTray</a><br />
Indicates whether the device has a media tray.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#deviceCanEject" class="summary-name">deviceCanEject</a><br />
Indicates whether the device supports ejecting its media.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#refreshMediaDelay" class="summary-name">refreshMediaDelay</a><br />
Refresh media delay, in seconds.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#ejectDelay" class="summary-name">ejectDelay</a><br />
Eject delay, in seconds.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">device</span>,
<span class="sig-arg">scsiId</span>=<span class="sig-default">None</span>,
<span class="sig-arg">driveSpeed</span>=<span class="sig-default">None</span>,
<span class="sig-arg">mediaType</span>=<span class="sig-default">1</span>,
<span class="sig-arg">noEject</span>=<span class="sig-default">False</span>,
<span class="sig-arg">refreshMediaDelay</span>=<span class="sig-default">0</span>,
<span class="sig-arg">ejectDelay</span>=<span class="sig-default">0</span>,
<span class="sig-arg">unittest</span>=<span class="sig-default">False</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.__init__">source code</a></span>
</td>
</tr></table>
<p>Initializes a CD writer object.</p>
<p>The current user must have write access to the device at the time the
object is instantiated, or an exception will be thrown. However, no
media-related validation is done, and in fact there is no need for any
media to be in the drive until one of the other media attribute-related
methods is called.</p>
<p>The various instance variables such as <code>deviceType</code>,
<code>deviceVendor</code>, etc. might be <code>None</code>, if we're
unable to parse this specific information from the <code>cdrecord</code>
output. This information is just for reference.</p>
<p>The SCSI id is optional, but the device path is required. If the SCSI
id is passed in, then the hardware id attribute will be taken from the
SCSI id. Otherwise, the hardware id will be taken from the device.</p>
<p>If cdrecord improperly detects whether your writer device has a tray
and can be safely opened and closed, then pass in
<code>noEject=False</code>. This will override the properties and the
device will never be ejected.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>device</code></strong> (Absolute path to a filesystem device, i.e. <code>/dev/cdrw</code>) - Filesystem device associated with this writer.</li>
<li><strong class="pname"><code>scsiId</code></strong> (If provided, SCSI id in the form
<code>[<method>:]scsibus,target,lun</code>) - SCSI id for the device (optional).</li>
<li><strong class="pname"><code>driveSpeed</code></strong> (Use <code>2</code> for 2x device, etc. or <code>None</code> to
use device default.) - Speed at which the drive writes.</li>
<li><strong class="pname"><code>mediaType</code></strong> (One of the valid media type as discussed above.) - Type of the media that is assumed to be in the drive.</li>
<li><strong class="pname"><code>noEject</code></strong> (Boolean true/false) - Overrides properties to indicate that the device does not support
eject.</li>
<li><strong class="pname"><code>refreshMediaDelay</code></strong> (Number of seconds, an integer >= 0) - Refresh media delay to use, if any</li>
<li><strong class="pname"><code>ejectDelay</code></strong> (Number of seconds, an integer >= 0) - Eject delay to use, if any</li>
<li><strong class="pname"><code>unittest</code></strong> (Boolean true/false) - Turns off certain validations, for use in unit testing.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the device is not valid for some reason.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the SCSI id is not in a valid form.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the drive speed is not an integer >= 1.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If device properties could not be read for some reason.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
The <code>unittest</code> parameter should never be set to
<code>True</code> outside of Cedar Backup code. It is intended for
use in unit testing Cedar Backup internals and has no other
sensible purpose.
</p>
</div></td></tr></table>
</div>
<a name="_retrieveProperties"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_retrieveProperties</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._retrieveProperties">source code</a></span>
</td>
</tr></table>
<p>Retrieves properties for a device from <code>cdrecord</code>.</p>
<p>The results are returned as a tuple of the object device attributes as
returned from <a
href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_parsePropertiesOutput"
class="link" onclick="show_private();">_parsePropertiesOutput</a>:
<code>(deviceType, deviceVendor, deviceId, deviceBufferSize,
deviceSupportsMulti, deviceHasTray, deviceCanEject)</code>.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>Results tuple as described above.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem talking to the device.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="retrieveCapacity"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">retrieveCapacity</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">entireDisc</span>=<span class="sig-default">False</span>,
<span class="sig-arg">useMulti</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.retrieveCapacity">source code</a></span>
</td>
</tr></table>
<p>Retrieves capacity for the current media in terms of a
<code>MediaCapacity</code> object.</p>
<p>If <code>entireDisc</code> is passed in as <code>True</code> the
capacity will be for the entire disc, as if it were to be rewritten from
scratch. If the drive does not support writing multisession discs or if
<code>useMulti</code> is passed in as <code>False</code>, the capacity
will also be as if the disc were to be rewritten from scratch, but the
indicated boundaries value will be <code>None</code>. The same will
happen if the disc cannot be read for some reason. Otherwise, the
capacity (including the boundaries) will represent whatever space remains
on the disc to be filled by future sessions.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>entireDisc</code></strong> (Boolean true/false) - Indicates whether to return capacity for entire disc.</li>
<li><strong class="pname"><code>useMulti</code></strong> (Boolean true/false) - Indicates whether a multisession disc should be assumed, if
possible.</li>
</ul></dd>
<dt>Returns:</dt>
<dd><code>MediaCapacity</code> object describing the capacity of the
media.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If the media could not be read for some reason.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getBoundaries"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getBoundaries</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">entireDisc</span>=<span class="sig-default">False</span>,
<span class="sig-arg">useMulti</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._getBoundaries">source code</a></span>
</td>
</tr></table>
<p>Gets the ISO boundaries for the media.</p>
<p>If <code>entireDisc</code> is passed in as <code>True</code> the
boundaries will be <code>None</code>, as if the disc were to be rewritten
from scratch. If the drive does not support writing multisession discs,
the returned value will be <code>None</code>. The same will happen if the
disc can't be read for some reason. Otherwise, the returned value will be
represent the boundaries of the disc's current contents.</p>
<p>The results are returned as a tuple of (lower, upper) as needed by the
<code>IsoImage</code> class. Note that these values are in terms of ISO
sectors, not bytes. Clients should generally consider the boundaries
value opaque, however.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>entireDisc</code></strong> (Boolean true/false) - Indicates whether to return capacity for entire disc.</li>
<li><strong class="pname"><code>useMulti</code></strong> (Boolean true/false) - Indicates whether a multisession disc should be assumed, if
possible.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Boundaries tuple or <code>None</code>, as described above.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If the media could not be read for some reason.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_calculateCapacity"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_calculateCapacity</span>(<span class="sig-arg">media</span>,
<span class="sig-arg">boundaries</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._calculateCapacity">source code</a></span>
</td>
</tr></table>
<p>Calculates capacity for the media in terms of boundaries.</p>
<p>If <code>boundaries</code> is <code>None</code> or the lower bound is
0 (zero), then the capacity will be for the entire disc minus the initial
lead in. Otherwise, capacity will be as if the caller wanted to add an
additional session to the end of the existing data on the disc.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>media</code></strong> - MediaDescription object describing the media capacity.</li>
<li><strong class="pname"><code>boundaries</code></strong> - Session boundaries as returned from <a
href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getBoundaries"
class="link" onclick="show_private();">_getBoundaries</a>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd><code>MediaCapacity</code> object describing the capacity of the
media.</dd>
</dl>
</td></tr></table>
</div>
<a name="openTray"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">openTray</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.openTray">source code</a></span>
</td>
</tr></table>
<p>Opens the device's tray and leaves it open.</p>
<p>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.</p>
<p>If the writer was constructed with <code>noEject=True</code>, then
this is a no-op.</p>
<p>Starting with Debian wheezy on my backup hardware, I started seeing
consistent problems with the eject command. I couldn't tell whether
these problems were due to the device management system or to the new
kernel (3.2.0). Initially, I saw simple eject failures, possibly because
I was opening and closing the tray too quickly. I worked around that
behavior with the new ejectDelay flag.</p>
<p>Later, I sometimes ran into issues after writing an image to a disc:
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.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error talking to the device.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="closeTray"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">closeTray</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.closeTray">source code</a></span>
</td>
</tr></table>
<p>Closes the device's tray.</p>
<p>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.</p>
<p>If the writer was constructed with <code>noEject=True</code>, then
this is a no-op.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error talking to the device.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="refreshMedia"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">refreshMedia</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.refreshMedia">source code</a></span>
</td>
</tr></table>
<p>Opens and then immediately closes the device's tray, to refresh the
device's idea of the media.</p>
<p>Sometimes, a device gets confused about the state of its media.
Often, all it takes to solve the problem is to eject the media and then
immediately reload it. (There are also configurable eject and refresh
media delays which can be applied, for situations where this makes a
difference.)</p>
<p>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.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error talking to the device.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="writeImage"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">writeImage</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">imagePath</span>=<span class="sig-default">None</span>,
<span class="sig-arg">newDisc</span>=<span class="sig-default">False</span>,
<span class="sig-arg">writeMulti</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.writeImage">source code</a></span>
</td>
</tr></table>
<p>Writes an ISO image to the media in the device.</p>
<p>If <code>newDisc</code> is passed in as <code>True</code>, we assume
that the entire disc will be overwritten, and the media will be blanked
before writing it if possible (i.e. if the media is rewritable).</p>
<p>If <code>writeMulti</code> is passed in as <code>True</code>, then a
multisession disc will be written if possible (i.e. if the drive supports
writing multisession discs).</p>
<p>if <code>imagePath</code> is passed in as <code>None</code>, then the
existing image configured with <code>initializeImage</code> will be used.
Under these circumstances, the passed-in <code>newDisc</code> flag will
be ignored.</p>
<p>By default, we assume that the disc can be written multisession and
that we should append to the current contents of the disc. In any case,
the ISO image must be generated appropriately (i.e. must take into
account any existing session boundaries, etc.)</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>imagePath</code></strong> (String representing a path on disk) - Path to an ISO image on disk, or <code>None</code> to use
writer's image</li>
<li><strong class="pname"><code>newDisc</code></strong> (Boolean true/false.) - Indicates whether the entire disc will overwritten.</li>
<li><strong class="pname"><code>writeMulti</code></strong> (Boolean true/false) - Indicates whether a multisession disc should be written, if
possible.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the image path is not absolute.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If some path cannot be encoded properly.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If the media could not be written to for some reason.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If no image is passed in and initializeImage() was not previously
called</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_blankMedia"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_blankMedia</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._blankMedia">source code</a></span>
</td>
</tr></table>
<p>Blanks the media in the device, if the media is rewritable.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If the media could not be written to for some reason.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parsePropertiesOutput"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parsePropertiesOutput</span>(<span class="sig-arg">output</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._parsePropertiesOutput">source code</a></span>
</td>
</tr></table>
<p>Parses the output from a <code>cdrecord</code> properties command.</p>
<p>The <code>output</code> parameter should be a list of strings as
returned from <code>executeCommand</code> for a <code>cdrecord</code>
command with arguments as from <code>_buildPropertiesArgs</code>. The
list of strings will be parsed to yield information about the properties
of the device.</p>
<p>The output is expected to be a huge long list of strings.
Unfortunately, the strings aren't in a completely regular format.
However, the format of individual lines seems to be regular enough that
we can look for specific values. Two kinds of parsing take place: one
kind of parsing picks out out specific values like the device id, device
vendor, etc. The other kind of parsing just sets a boolean flag
<code>True</code> if a matching line is found. All of the parsing is
done with regular expressions.</p>
<p>Right now, pretty much nothing in the output is required and we should
parse an empty document successfully (albeit resulting in a device that
can't eject, doesn't have a tray and doesnt't support multisession
discs). I had briefly considered erroring out if certain lines weren't
found or couldn't be parsed, but that seems like a bad idea given that
most of the information is just for reference.</p>
<p>The results are returned as a tuple of the object device attributes:
<code>(deviceType, deviceVendor, deviceId, deviceBufferSize,
deviceSupportsMulti, deviceHasTray, deviceCanEject)</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>output</code></strong> - Output from a <code>cdrecord -prcap</code> command.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Results tuple as described above.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is problem parsing the output.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_parseBoundariesOutput"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parseBoundariesOutput</span>(<span class="sig-arg">output</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._parseBoundariesOutput">source code</a></span>
</td>
</tr></table>
<p>Parses the output from a <code>cdrecord</code> capacity command.</p>
<p>The <code>output</code> parameter should be a list of strings as
returned from <code>executeCommand</code> for a <code>cdrecord</code>
command with arguments as from <code>_buildBoundaryArgs</code>. The list
of strings will be parsed to yield information about the capacity of the
media in the device.</p>
<p>Basically, we expect the list of strings to include just one line, a
pair of values. There isn't supposed to be whitespace, but we allow it
anyway in the regular expression. Any lines below the one line we parse
are completely ignored. It would be a good idea to ignore
<code>stderr</code> when executing the <code>cdrecord</code> command that
generates output for this method, because sometimes <code>cdrecord</code>
spits out kernel warnings about the actual output.</p>
<p>The results are returned as a tuple of (lower, upper) as needed by the
<code>IsoImage</code> class. Note that these values are in terms of ISO
sectors, not bytes. Clients should generally consider the boundaries
value opaque, however.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>output</code></strong> - Output from a <code>cdrecord -msinfo</code> command.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Boundaries tuple as described above.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is problem parsing the output.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
If the boundaries output can't be parsed, we return
<code>None</code>.
</p>
</div></td></tr></table>
</div>
<a name="_buildOpenTrayArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildOpenTrayArgs</span>(<span class="sig-arg">device</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildOpenTrayArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>eject</code>
command.</p>
<p>The arguments will cause the <code>eject</code> command to open the
tray and eject the media. No validation is done by this method as to
whether this action actually makes sense.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>device</code></strong> - Filesystem device name for this writer, i.e.
<code>/dev/cdrw</code>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildCloseTrayArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildCloseTrayArgs</span>(<span class="sig-arg">device</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildCloseTrayArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>eject</code>
command.</p>
<p>The arguments will cause the <code>eject</code> command to close the
tray and reload the media. No validation is done by this method as to
whether this action actually makes sense.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>device</code></strong> - Filesystem device name for this writer, i.e.
<code>/dev/cdrw</code>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildPropertiesArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildPropertiesArgs</span>(<span class="sig-arg">hardwareId</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildPropertiesArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</p>
<p>The arguments will cause the <code>cdrecord</code> command to ask the
device for a list of its capacities via the <code>-prcap</code>
switch.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hardwareId</code></strong> - Hardware id for the device (either SCSI id or device path)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildBoundariesArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildBoundariesArgs</span>(<span class="sig-arg">hardwareId</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildBoundariesArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</p>
<p>The arguments will cause the <code>cdrecord</code> command to ask the
device for the current multisession boundaries of the media using the
<code>-msinfo</code> switch.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hardwareId</code></strong> - Hardware id for the device (either SCSI id or device path)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildBlankArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildBlankArgs</span>(<span class="sig-arg">hardwareId</span>,
<span class="sig-arg">driveSpeed</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildBlankArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</p>
<p>The arguments will cause the <code>cdrecord</code> command to blank
the media in the device identified by <code>hardwareId</code>. No
validation is done by this method as to whether the action makes sense
(i.e. to whether the media even can be blanked).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hardwareId</code></strong> - Hardware id for the device (either SCSI id or device path)</li>
<li><strong class="pname"><code>driveSpeed</code></strong> - Speed at which the drive writes.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildWriteArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildWriteArgs</span>(<span class="sig-arg">hardwareId</span>,
<span class="sig-arg">imagePath</span>,
<span class="sig-arg">driveSpeed</span>=<span class="sig-default">None</span>,
<span class="sig-arg">writeMulti</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildWriteArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>cdrecord</code>
command.</p>
<p>The arguments will cause the <code>cdrecord</code> command to write
the indicated ISO image (<code>imagePath</code>) to the media in the
device identified by <code>hardwareId</code>. The
<code>writeMulti</code> argument controls whether to write a multisession
disc. No validation is done by this method as to whether the action
makes sense (i.e. to whether the device even can write multisession
discs, for instance).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hardwareId</code></strong> - Hardware id for the device (either SCSI id or device path)</li>
<li><strong class="pname"><code>imagePath</code></strong> - Path to an ISO image on disk.</li>
<li><strong class="pname"><code>driveSpeed</code></strong> - Speed at which the drive writes.</li>
<li><strong class="pname"><code>writeMulti</code></strong> - Indicates whether to write a multisession disc.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="initializeImage"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">initializeImage</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">newDisc</span>,
<span class="sig-arg">tmpdir</span>,
<span class="sig-arg">mediaLabel</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.initializeImage">source code</a></span>
</td>
</tr></table>
<p>Initializes the writer's associated ISO image.</p>
<p>This method initializes the <code>image</code> instance variable so
that the caller can use the <code>addImageEntry</code> method. Once
entries have been added, the <code>writeImage</code> method can be called
with no arguments.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>newDisc</code></strong> (Boolean true/false.) - Indicates whether the disc should be re-initialized</li>
<li><strong class="pname"><code>tmpdir</code></strong> (String representing a directory path on disk) - Temporary directory to use if needed</li>
<li><strong class="pname"><code>mediaLabel</code></strong> (String, no more than 25 characters long) - Media label to be applied to the image, if any</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addImageEntry"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addImageEntry</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">graftPoint</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.addImageEntry">source code</a></span>
</td>
</tr></table>
<p>Adds a filepath entry to the writer's associated ISO image.</p>
<p>The contents of the filepath -- but not the path itself -- will be
added to the image at the indicated graft point. If you don't want to
use a graft point, just pass <code>None</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (String representing a path on disk) - File or directory to be added to the image</li>
<li><strong class="pname"><code>graftPoint</code></strong> (String representing a graft point path, as described above) - Graft point to be used when adding this entry</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If initializeImage() was not previously called</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
Before calling this method, you must call <a
href="CedarBackup2.writers.cdwriter.CdWriter-class.html#initializeImage"
class="link">initializeImage</a>.
</p>
</div></td></tr></table>
</div>
<a name="setImageNewDisc"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setImageNewDisc</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">newDisc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.setImageNewDisc">source code</a></span>
</td>
</tr></table>
<p>Resets (overrides) the newDisc flag on the internal image.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>newDisc</code></strong> - New disc flag to set</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If initializeImage() was not previously called</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getEstimatedImageSize"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getEstimatedImageSize</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.getEstimatedImageSize">source code</a></span>
</td>
</tr></table>
<p>Gets the estimated size of the image associated with the writer.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>Estimated size of the image, in bytes.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem calling <code>mkisofs</code>.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If initializeImage() was not previously called</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="unlockTray"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">unlockTray</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter.unlockTray">source code</a></span>
</td>
</tr></table>
<p>Unlocks the device's tray.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error talking to the device.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_createImage"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_createImage</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._createImage">source code</a></span>
</td>
</tr></table>
<p>Creates an ISO image based on configuration in self._image.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>Path to the newly-created ISO image on disk.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IOError</strong></code> - If there is an error writing the image to disk.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If there are no filesystem entries in the image</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If a path cannot be encoded properly.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_writeImage"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_writeImage</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">imagePath</span>,
<span class="sig-arg">writeMulti</span>,
<span class="sig-arg">newDisc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._writeImage">source code</a></span>
</td>
</tr></table>
<p>Write an ISO image to disc using cdrecord. The disc is blanked first
if <code>newDisc</code> is <code>True</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>imagePath</code></strong> - Path to an ISO image on disk</li>
<li><strong class="pname"><code>writeMulti</code></strong> - Indicates whether a multisession disc should be written, if
possible.</li>
<li><strong class="pname"><code>newDisc</code></strong> - Indicates whether the entire disc will overwritten.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_buildUnlockTrayArgs"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildUnlockTrayArgs</span>(<span class="sig-arg">device</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.writers.cdwriter-pysrc.html#CdWriter._buildUnlockTrayArgs">source code</a></span>
</td>
</tr></table>
<p>Builds a list of arguments to be passed to a <code>eject</code>
command.</p>
<p>The arguments will cause the <code>eject</code> command to unlock the
tray.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>device</code></strong> - Filesystem device name for this writer, i.e.
<code>/dev/cdrw</code>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List suitable for passing to <a
href="CedarBackup2.util-module.html#executeCommand"
class="link">util.executeCommand</a> as <code>args</code>.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="device"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">device</h3>
<p>Filesystem device name for this writer.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDevice" class="summary-sig-name" onclick="show_private();">_getDevice</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device value.
</dd>
</dl>
</td></tr></table>
</div>
<a name="scsiId"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">scsiId</h3>
<p>SCSI id for the device, in the form
<code>[<method>:]scsibus,target,lun</code>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getScsiId" class="summary-sig-name" onclick="show_private();">_getScsiId</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the SCSI id value.
</dd>
</dl>
</td></tr></table>
</div>
<a name="hardwareId"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">hardwareId</h3>
<p>Hardware id for this writer, either SCSI id or device path.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getHardwareId" class="summary-sig-name" onclick="show_private();">_getHardwareId</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the hardware id value.
</dd>
</dl>
</td></tr></table>
</div>
<a name="driveSpeed"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">driveSpeed</h3>
<p>Speed at which the drive writes.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDriveSpeed" class="summary-sig-name" onclick="show_private();">_getDriveSpeed</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the drive speed.
</dd>
</dl>
</td></tr></table>
</div>
<a name="media"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">media</h3>
<p>Definition of media that is expected to be in the device.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getMedia" class="summary-sig-name" onclick="show_private();">_getMedia</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the media description.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceType"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceType</h3>
<p>Type of the device, as returned from <code>cdrecord -prcap</code>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceType" class="summary-sig-name" onclick="show_private();">_getDeviceType</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device type.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceVendor"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceVendor</h3>
<p>Vendor of the device, as returned from <code>cdrecord
-prcap</code>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceVendor" class="summary-sig-name" onclick="show_private();">_getDeviceVendor</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device vendor.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceId"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceId</h3>
<p>Device identification, as returned from <code>cdrecord
-prcap</code>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceId" class="summary-sig-name" onclick="show_private();">_getDeviceId</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device id.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceBufferSize"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceBufferSize</h3>
<p>Size of the device's write buffer, in bytes.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceBufferSize" class="summary-sig-name" onclick="show_private();">_getDeviceBufferSize</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device buffer size.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceSupportsMulti"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceSupportsMulti</h3>
<p>Indicates whether device supports multisession discs.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceSupportsMulti" class="summary-sig-name" onclick="show_private();">_getDeviceSupportsMulti</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device-support-multi flag.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceHasTray"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceHasTray</h3>
<p>Indicates whether the device has a media tray.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceHasTray" class="summary-sig-name" onclick="show_private();">_getDeviceHasTray</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device-has-tray flag.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deviceCanEject"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deviceCanEject</h3>
<p>Indicates whether the device supports ejecting its media.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getDeviceCanEject" class="summary-sig-name" onclick="show_private();">_getDeviceCanEject</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the device-can-eject flag.
</dd>
</dl>
</td></tr></table>
</div>
<a name="refreshMediaDelay"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">refreshMediaDelay</h3>
<p>Refresh media delay, in seconds.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getRefreshMediaDelay" class="summary-sig-name" onclick="show_private();">_getRefreshMediaDelay</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the configured refresh media delay, in
seconds.
</dd>
</dl>
</td></tr></table>
</div>
<a name="ejectDelay"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">ejectDelay</h3>
<p>Eject delay, in seconds.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="CedarBackup2.writers.cdwriter.CdWriter-class.html#_getEjectDelay" class="summary-sig-name" onclick="show_private();">_getEjectDelay</a>(<span class="summary-sig-arg">self</span>)</span>
- Property target used to get the configured eject delay, in seconds.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://bitbucket.org/cedarsolutions/cedar-backup2">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|