/usr/share/doc/cedar-backup3-doc/interface/CedarBackup3.filesystem-module.html is in cedar-backup3-doc 3.1.6-1.
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 | <?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>CedarBackup3.filesystem</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="CedarBackup3-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-backup3">CedarBackup3</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="CedarBackup3-module.html">Package CedarBackup3</a> ::
Module filesystem
</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="CedarBackup3.filesystem-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module filesystem</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html">source code</a></span></p>
<p>Provides filesystem-related objects.</p>
<hr />
<div class="fields"> <p><strong>Author:</strong>
Kenneth J. Pronovici <pronovic@ieee.org>
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
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="CedarBackup3.filesystem.FilesystemList-class.html" class="summary-name">FilesystemList</a><br />
Represents a list of filesystem items.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup3.filesystem.BackupFileList-class.html" class="summary-name">BackupFileList</a><br />
List of files to be backed up.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup3.filesystem.PurgeItemList-class.html" class="summary-name">PurgeItemList</a><br />
List of files and directories to be purged.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup3.filesystem.SpanItem-class.html" class="summary-name">SpanItem</a><br />
Item returned by <a
href="CedarBackup3.filesystem.BackupFileList-class.html#generateSpan"
class="link">BackupFileList.generateSpan</a>.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></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">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
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="CedarBackup3.filesystem-module.html#normalizeDir" class="summary-sig-name">normalizeDir</a>(<span class="summary-sig-arg">path</span>)</span><br />
Normalizes a directory name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#normalizeDir">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="CedarBackup3.filesystem-module.html#compareContents" class="summary-sig-name">compareContents</a>(<span class="summary-sig-arg">path1</span>,
<span class="summary-sig-arg">path2</span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span><br />
Compares the contents of two directories to see if they are
equivalent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#compareContents">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="CedarBackup3.filesystem-module.html#compareDigestMaps" class="summary-sig-name">compareDigestMaps</a>(<span class="summary-sig-arg">digest1</span>,
<span class="summary-sig-arg">digest2</span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span><br />
Compares two digest maps and throws an exception if they differ.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#compareDigestMaps">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></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">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
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 name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger("CedarBackup3.log.filesystem")">logging.getLogger("CedarBackup3.log.filesystem")</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'CedarBackup3'"><code class="variable-quote">'</code><code class="variable-string">CedarBackup3</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></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">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="normalizeDir"></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">normalizeDir</span>(<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#normalizeDir">source code</a></span>
</td>
</tr></table>
<p>Normalizes a directory name.</p>
<p>For our purposes, a directory name is normalized by removing the
trailing path separator, if any. This is important because we want
directories to appear within lists in a consistent way, although from the
user's perspective passing in <code>/path/to/dir/</code> and
<code>/path/to/dir</code> are equivalent.</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) - Path to be normalized.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Normalized path, which should be equivalent to the original.</dd>
</dl>
</td></tr></table>
</div>
<a name="compareContents"></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">compareContents</span>(<span class="sig-arg">path1</span>,
<span class="sig-arg">path2</span>,
<span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#compareContents">source code</a></span>
</td>
</tr></table>
<p>Compares the contents of two directories to see if they are
equivalent.</p>
<p>The two directories are recursively compared. First, we check whether
they contain exactly the same set of files. Then, we check to see every
given file has exactly the same contents in both directories.</p>
<p>This is all relatively simple to implement through the magic of <a
href="CedarBackup3.filesystem.BackupFileList-class.html#generateDigestMap"
class="link">BackupFileList.generateDigestMap</a>, which knows how to
strip a path prefix off the front of each entry in the mapping it
generates. This makes our comparison as simple as creating a list for
each path, then generating a digest map for each path and comparing the
two.</p>
<p>If no exception is thrown, the two directories are considered
identical.</p>
<p>If the <code>verbose</code> flag is <code>True</code>, then an
alternate (but slower) method is used so that any thrown exception can
indicate exactly which file caused the comparison to fail. The thrown
<code>ValueError</code> exception distinguishes between the directories
containing different files, and containing the same files with differing
content.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path1</code></strong> (String representing a path on disk) - First path to compare.</li>
<li><strong class="pname"><code>path2</code></strong> (String representing a path on disk) - First path to compare.</li>
<li><strong class="pname"><code>verbose</code></strong> (Boolean) - Indicates whether a verbose response should be given.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If a directory doesn't exist or can't be read.</li>
<li><code><strong class='fraise'>ValueError</strong></code> - If the two directories are not equivalent.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is an unusual problem reading the directories.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
Symlinks are <i>not</i> followed for the purposes of this
comparison.
</p>
</div></td></tr></table>
</div>
<a name="compareDigestMaps"></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">compareDigestMaps</span>(<span class="sig-arg">digest1</span>,
<span class="sig-arg">digest2</span>,
<span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup3.filesystem-pysrc.html#compareDigestMaps">source code</a></span>
</td>
</tr></table>
<p>Compares two digest maps and throws an exception if they differ.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>digest1</code></strong> (Digest as returned from BackupFileList.generateDigestMap()) - First digest to compare.</li>
<li><strong class="pname"><code>digest2</code></strong> (Digest as returned from BackupFileList.generateDigestMap()) - Second digest to compare.</li>
<li><strong class="pname"><code>verbose</code></strong> (Boolean) - Indicates whether a verbose response should be given.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If the two directories are not equivalent.</li>
</ul></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="CedarBackup3-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-backup3">CedarBackup3</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>
|