/usr/share/doc/python-paramiko/docs/paramiko.SFTPServerInterface-class.html is in python-paramiko 1.7.7.1-2.
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 | <?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>paramiko.SFTPServerInterface</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="paramiko-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>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="paramiko-module.html">Package paramiko</a> ::
Class SFTPServerInterface
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="paramiko.SFTPServerInterface-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SFTPServerInterface</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#SFTPServerInterface">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">SFTPServerInterface</strong>
</pre>
<hr />
<p>This class defines an interface for controlling the behavior of
paramiko when using the <a href="paramiko.SFTPServer-class.html"
class="link">SFTPServer</a> subsystem to provide an SFTP server.</p>
<p>Methods on this class are called from the SFTP session's thread, so
you can block as long as necessary without affecting other sessions (even
other SFTP sessions). However, raising an exception will usually cause
the SFTP session to abruptly end, so you will usually want to catch
exceptions and return an appropriate error code.</p>
<p>All paths are in string form instead of unicode because not all SFTP
clients & servers obey the requirement that paths be encoded in
UTF-8.</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 align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></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="paramiko.SFTPServerInterface-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">server</span>,
<span class="summary-sig-arg">*largs</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Create a new SFTPServerInterface object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">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="paramiko.SFTPServerInterface-class.html#canonicalize" class="summary-sig-name">canonicalize</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Return the canonical form of a path on the server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#chattr" class="summary-sig-name">chattr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">attr</span>)</span><br />
Change the attributes of a file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#list_folder" class="summary-sig-name">list_folder</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Return a list of files within a given folder.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#lstat" class="summary-sig-name">lstat</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Return an <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> object for a path on the server, or
an error code.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#mkdir" class="summary-sig-name">mkdir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">attr</span>)</span><br />
Create a new directory with the given attributes.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">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="paramiko.SFTPServerInterface-class.html#open" class="summary-sig-name">open</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">flags</span>,
<span class="summary-sig-arg">attr</span>)</span><br />
Open a file on the server and create a handle for future operations
on that file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str <i>or error code</i></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#readlink" class="summary-sig-name">readlink</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Return the target of a symbolic link (or shortcut) on the server.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#remove" class="summary-sig-name">remove</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Delete a file, if possible.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#rename" class="summary-sig-name">rename</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">oldpath</span>,
<span class="summary-sig-arg">newpath</span>)</span><br />
Rename (or move) a file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#rmdir" class="summary-sig-name">rmdir</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Remove a directory if it exists.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">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="paramiko.SFTPServerInterface-class.html#session_ended" class="summary-sig-name">session_ended</a>(<span class="summary-sig-arg">self</span>)</span><br />
The SFTP server session has just ended, either cleanly or via an
exception.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">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="paramiko.SFTPServerInterface-class.html#session_started" class="summary-sig-name">session_started</a>(<span class="summary-sig-arg">self</span>)</span><br />
The SFTP server session has just started.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#stat" class="summary-sig-name">stat</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Return an <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> object for a path on the server, or
an error code.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="paramiko.SFTPServerInterface-class.html#symlink" class="summary-sig-name">symlink</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">target_path</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Create a symbolic link on the server, as new pathname
<code>path</code>, with <code>target_path</code> as the target of the
link.</td>
<td align="right" valign="top">
<span class="codelink"><a href="paramiko.sftp_si-pysrc.html">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>
<!-- ==================== 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 align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></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 align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></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">server</span>,
<span class="sig-arg">*largs</span>,
<span class="sig-arg">**kwargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Create a new SFTPServerInterface object. This method does nothing by
default and is meant to be overridden by subclasses.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>server</code></strong> (<a href="paramiko.ServerInterface-class.html"
class="link">ServerInterface</a>) - the server object associated with this channel and SFTP subsystem</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="canonicalize"></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">canonicalize</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the canonical form of a path on the server. For example, if
the server's home folder is <code>/home/foo</code>, the path
<code>"../betty"</code> would be canonicalized to
<code>"/home/betty"</code>. Note the obvious security issues:
if you're serving files only from a specific folder, you probably don't
want this method to reveal path names outside that folder.</p>
<p>You may find the python methods in <code>os.path</code> useful,
especially <code>os.path.normpath</code> and
<code>os.path.realpath</code>.</p>
<p>The default implementation returns <code>os.path.normpath('/' +
path)</code>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="chattr"></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">chattr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">attr</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Change the attributes of a file. The <code>attr</code> object will
contain only those fields provided by the client in its request, so you
should check for the presence of fields before using them.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - requested path (relative or absolute) of the file to change.</li>
<li><strong class="pname"><code>attr</code></strong> (<a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a>) - requested attributes to change on the file.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an error code like SFTP_OK.</dd>
</dl>
</td></tr></table>
</div>
<a name="list_folder"></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">list_folder</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return a list of files within a given folder. The <code>path</code>
will use posix notation (<code>"/"</code> separates folder
names) and may be an absolute or relative path.</p>
<p>The list of files is expected to be a list of <a
href="paramiko.SFTPAttributes-class.html" class="link">SFTPAttributes</a>
objects, which are similar in structure to the objects returned by
<code>os.stat</code>. In addition, each object should have its
<code>filename</code> field filled in, since this is important to a
directory listing and not normally present in <code>os.stat</code>
results. The method <a
href="paramiko.SFTPAttributes-class.html#from_stat"
class="link">SFTPAttributes.from_stat</a> will usually do what you
want.</p>
<p>In case of an error, you should return one of the <code>SFTP_*</code>
error codes, such as SFTP_PERMISSION_DENIED.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - the requested path (relative or absolute) to be listed.</li>
</ul></dd>
<dt>Returns: list of <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></dt>
<dd>a list of the files in the given folder, using <a
href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> objects.</dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
You should normalize the given <code>path</code> first (see the
<code>os.path</code> module) and check appropriate permissions
before returning the list of files. Be careful of malicious
clients attempting to use relative paths to escape restricted
folders, if you're doing a direct translation from the SFTP server
path to your local filesystem.
</p>
</div></td></tr></table>
</div>
<a name="lstat"></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">lstat</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return an <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> object for a path on the server, or an
error code. If your server supports symbolic links (also known as
"aliases"), you should <i>not</i> follow them -- instead, you
should return data on the symlink or alias itself. (<a
href="paramiko.SFTPServerInterface-class.html#stat" class="link">stat</a>
is the corresponding call that follows symlinks/aliases.)</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - the requested path (relative or absolute) to fetch file
statistics for.</li>
</ul></dd>
<dt>Returns: <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></dt>
<dd>an attributes object for the given file, or an SFTP error code
(like SFTP_PERMISSION_DENIED).</dd>
</dl>
</td></tr></table>
</div>
<a name="mkdir"></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">mkdir</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">attr</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Create a new directory with the given attributes. The
<code>attr</code> object may be considered a "hint" and
ignored.</p>
<p>The <code>attr</code> object will contain only those fields provided
by the client in its request, so you should use <code>hasattr</code> to
check for the presense of fields before using them. In some cases, the
<code>attr</code> object may be completely empty.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - requested path (relative or absolute) of the new folder.</li>
<li><strong class="pname"><code>attr</code></strong> (<a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a>) - requested attributes of the new folder.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an SFTP error code like SFTP_OK.</dd>
</dl>
</td></tr></table>
</div>
<a name="open"></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">open</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">flags</span>,
<span class="sig-arg">attr</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Open a file on the server and create a handle for future operations on
that file. On success, a new object subclassed from <a
href="paramiko.SFTPHandle-class.html" class="link">SFTPHandle</a> should
be returned. This handle will be used for future operations on the file
(read, write, etc). On failure, an error code such as
SFTP_PERMISSION_DENIED should be returned.</p>
<p><code>flags</code> contains the requested mode for opening (read-only,
write-append, etc) as a bitset of flags from the <code>os</code>
module:</p>
<ul>
<li>
<code>os.O_RDONLY</code>
</li>
<li>
<code>os.O_WRONLY</code>
</li>
<li>
<code>os.O_RDWR</code>
</li>
<li>
<code>os.O_APPEND</code>
</li>
<li>
<code>os.O_CREAT</code>
</li>
<li>
<code>os.O_TRUNC</code>
</li>
<li>
<code>os.O_EXCL</code>
</li>
</ul>
<p>(One of <code>os.O_RDONLY</code>, <code>os.O_WRONLY</code>, or
<code>os.O_RDWR</code> will always be set.)</p>
<p>The <code>attr</code> object contains requested attributes of the file
if it has to be created. Some or all attribute fields may be missing if
the client didn't specify them.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - the requested path (relative or absolute) of the file to be
opened.</li>
<li><strong class="pname"><code>flags</code></strong> (int) - flags or'd together from the <code>os</code> module indicating
the requested mode for opening the file.</li>
<li><strong class="pname"><code>attr</code></strong> (<a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a>) - requested attributes of the file if it is newly created.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a new <a href="paramiko.SFTPHandle-class.html"
class="link">SFTPHandle</a> <i>or error code</i>. @rtype <a
href="paramiko.SFTPHandle-class.html" class="link">SFTPHandle</a></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
The SFTP protocol defines all files to be in "binary"
mode. There is no equivalent to python's "text" mode.
</p>
</div></td></tr></table>
</div>
<a name="readlink"></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">readlink</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return the target of a symbolic link (or shortcut) on the server. If
the specified path doesn't refer to a symbolic link, an error should be
returned.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - path (relative or absolute) of the symbolic link.</li>
</ul></dd>
<dt>Returns: str <i>or error code</i></dt>
<dd>the target path of the symbolic link, or an error code like
SFTP_NO_SUCH_FILE.</dd>
</dl>
</td></tr></table>
</div>
<a name="remove"></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">remove</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Delete a file, if possible.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - the requested path (relative or absolute) of the file to delete.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an SFTP error code like SFTP_OK.</dd>
</dl>
</td></tr></table>
</div>
<a name="rename"></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">rename</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">oldpath</span>,
<span class="sig-arg">newpath</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Rename (or move) a file. The SFTP specification implies that this
method can be used to move an existing file into a different folder, and
since there's no other (easy) way to move files via SFTP, it's probably a
good idea to implement "move" in this method too, even for
files that cross disk partition boundaries, if at all possible.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>oldpath</code></strong> (str) - the requested path (relative or absolute) of the existing file.</li>
<li><strong class="pname"><code>newpath</code></strong> (str) - the requested new path of the file.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an SFTP error code like SFTP_OK.</dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
You should return an error if a file with the same name as
<code>newpath</code> already exists. (The rename operation should
be non-desctructive.)
</p>
</div></td></tr></table>
</div>
<a name="rmdir"></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">rmdir</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Remove a directory if it exists. The <code>path</code> should refer
to an existing, empty folder -- otherwise this method should return an
error.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - requested path (relative or absolute) of the folder to remove.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an SFTP error code like SFTP_OK.</dd>
</dl>
</td></tr></table>
</div>
<a name="session_ended"></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">session_ended</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>The SFTP server session has just ended, either cleanly or via an
exception. This method is meant to be overridden to perform any
necessary cleanup before this <code>SFTPServerInterface</code> object is
destroyed.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="session_started"></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">session_started</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>The SFTP server session has just started. This method is meant to be
overridden to perform any necessary setup before handling callbacks from
SFTP operations.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="stat"></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">stat</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Return an <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> object for a path on the server, or an
error code. If your server supports symbolic links (also known as
"aliases"), you should follow them. (<a
href="paramiko.SFTPServerInterface-class.html#lstat"
class="link">lstat</a> is the corresponding call that doesn't follow
symlinks/aliases.)</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (str) - the requested path (relative or absolute) to fetch file
statistics for.</li>
</ul></dd>
<dt>Returns: <a href="paramiko.SFTPAttributes-class.html"
class="link">SFTPAttributes</a> <i>or error code</i></dt>
<dd>an attributes object for the given file, or an SFTP error code
(like SFTP_PERMISSION_DENIED).</dd>
</dl>
</td></tr></table>
</div>
<a name="symlink"></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">symlink</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">target_path</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="paramiko.sftp_si-pysrc.html">source code</a></span>
</td>
</tr></table>
<p>Create a symbolic link on the server, as new pathname
<code>path</code>, with <code>target_path</code> as the target of the
link.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>target_path</code></strong> (str) - path (relative or absolute) of the target for this new symbolic
link.</li>
<li><strong class="pname"><code>path</code></strong> (str) - path (relative or absolute) of the symbolic link to create.</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an error code like <code>SFTP_OK</code>.</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="paramiko-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>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon May 23 13:50:03 2011
</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>
|