1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>paramiko.SFTPClient</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" width="100%"></th>
22
<table width="100%" cellpadding="0" cellspacing="0">
25
<font size="-1"><b class="breadcrumbs">
26
<a href="paramiko-module.html">Package paramiko</a> ::
30
<td><table cellpadding="0" cellspacing="0">
31
<tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPClient-class.html">hide private</a>]</font></td></tr>
32
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPClient-class.html" target="_top">no frames</a>]</font></td></tr>
36
<!-- =========== START OF CLASS DESCRIPTION =========== -->
37
<h2 class="class">Type SFTPClient</h2>
39
<pre class="base-tree">
40
<a href="__builtin__.object-class.html"><code>object</code></a> --+
42
<a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+
47
<dl><dt><b>Known Subclasses:</b></dt>
49
<a href="paramiko.SFTP-class.html"><code>SFTP</code></a></dd></dl>
53
SFTP client object. <code>SFTPClient</code> is used to open an sftp
54
session across an open ssh <a href="paramiko.Transport-class.html"
55
class="link"><code>Transport</code></a> and do remote file
60
<!-- =========== START OF METHOD SUMMARY =========== -->
61
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
62
<tr bgcolor="#70b0f0" class="summary">
63
<th colspan="2">Method Summary</th></tr>
64
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
65
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
66
<span class=summary-sig-arg>sock</span>)</span></code>
68
Create an SFTP client from an existing <a
69
href="paramiko.Channel-class.html"
70
class="link"><code>Channel</code></a>.</td></tr>
71
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
72
<td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code>
74
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
75
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chdir" class="summary-sig-name"><code>chdir</code></a>(<span class=summary-sig-arg>self</span>,
76
<span class=summary-sig-arg>path</span>)</span></code>
78
Change the "current directory" of this SFTP session.</td></tr>
79
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
80
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chmod" class="summary-sig-name"><code>chmod</code></a>(<span class=summary-sig-arg>self</span>,
81
<span class=summary-sig-arg>path</span>,
82
<span class=summary-sig-arg>mode</span>)</span></code>
84
Change the mode (permissions) of a file.</td></tr>
85
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
86
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chown" class="summary-sig-name"><code>chown</code></a>(<span class=summary-sig-arg>self</span>,
87
<span class=summary-sig-arg>path</span>,
88
<span class=summary-sig-arg>uid</span>,
89
<span class=summary-sig-arg>gid</span>)</span></code>
91
Change the owner (<code>uid</code>) and group (<code>gid</code>) of a
93
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
94
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
96
Close the SFTP session and its underlying channel.</td></tr>
97
<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile
99
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>file</code></a>(<span class=summary-sig-arg>self</span>,
100
<span class=summary-sig-arg>filename</span>,
101
<span class=summary-sig-arg>mode</span>,
102
<span class=summary-sig-arg>bufsize</span>)</span></code>
104
Open a file on the remote server.</td></tr>
105
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html"
106
class="link"><code>SFTPClient</code></a>
108
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#from_transport" class="summary-sig-name"><code>from_transport</code></a>(<span class=summary-sig-arg>selfclass</span>,
109
<span class=summary-sig-arg>t</span>)</span></code>
111
Create an SFTP client channel from an open <a
112
href="paramiko.Transport-class.html"
113
class="link"><code>Transport</code></a>. <i>(Class method)</i>
115
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
116
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>,
117
<span class=summary-sig-arg>remotepath</span>,
118
<span class=summary-sig-arg>localpath</span>)</span></code>
120
Copy a remote file (<code>remotepath</code>) from the SFTP server to
121
the local host as <code>localpath</code>.</td></tr>
122
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
124
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#getcwd" class="summary-sig-name"><code>getcwd</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
126
Return the "current working directory" for this SFTP
127
session, as emulated by paramiko.</td></tr>
128
<tr><td align="right" valign="top" width="15%"><font size="-1"> list of str
130
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir" class="summary-sig-name"><code>listdir</code></a>(<span class=summary-sig-arg>self</span>,
131
<span class=summary-sig-arg>path</span>)</span></code>
133
Return a list containing the names of the entries in the given
134
<code>path</code>.</td></tr>
135
<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html"
136
class="link"><code>SFTPAttributes</code></a>
138
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir_attr" class="summary-sig-name"><code>listdir_attr</code></a>(<span class=summary-sig-arg>self</span>,
139
<span class=summary-sig-arg>path</span>)</span></code>
141
Return a list containing <a href="paramiko.SFTPAttributes-class.html"
142
class="link"><code>SFTPAttributes</code></a> objects corresponding to
143
files in the given <code>path</code>.</td></tr>
144
<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes
146
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>,
147
<span class=summary-sig-arg>path</span>)</span></code>
149
Retrieve information about a file on the remote system, without
150
following symbolic links (shortcuts).</td></tr>
151
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
152
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>,
153
<span class=summary-sig-arg>path</span>,
154
<span class=summary-sig-arg>mode</span>)</span></code>
156
Create a folder (directory) named <code>path</code> with numeric mode
157
<code>mode</code>.</td></tr>
158
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
160
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#normalize" class="summary-sig-name"><code>normalize</code></a>(<span class=summary-sig-arg>self</span>,
161
<span class=summary-sig-arg>path</span>)</span></code>
163
Return the normalized path (on the server) of a given path.</td></tr>
164
<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile
166
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>,
167
<span class=summary-sig-arg>filename</span>,
168
<span class=summary-sig-arg>mode</span>,
169
<span class=summary-sig-arg>bufsize</span>)</span></code>
171
Open a file on the remote server.</td></tr>
172
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
173
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#put" class="summary-sig-name"><code>put</code></a>(<span class=summary-sig-arg>self</span>,
174
<span class=summary-sig-arg>localpath</span>,
175
<span class=summary-sig-arg>remotepath</span>)</span></code>
177
Copy a local file (<code>localpath</code>) to the SFTP server as
178
<code>remotepath</code>.</td></tr>
179
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
181
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>,
182
<span class=summary-sig-arg>path</span>)</span></code>
184
Return the target of a symbolic link (shortcut).</td></tr>
185
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
186
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>,
187
<span class=summary-sig-arg>path</span>)</span></code>
189
Remove the file at the given path.</td></tr>
190
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
191
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>,
192
<span class=summary-sig-arg>oldpath</span>,
193
<span class=summary-sig-arg>newpath</span>)</span></code>
195
Rename a file or folder from <code>oldpath</code> to
196
<code>newpath</code>.</td></tr>
197
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
198
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>,
199
<span class=summary-sig-arg>path</span>)</span></code>
201
Remove the folder named <code>path</code>.</td></tr>
202
<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes
204
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>,
205
<span class=summary-sig-arg>path</span>)</span></code>
207
Retrieve information about a file on the remote system.</td></tr>
208
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
209
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>,
210
<span class=summary-sig-arg>source</span>,
211
<span class=summary-sig-arg>dest</span>)</span></code>
213
Create a symbolic link (shortcut) of the <code>source</code> path at
214
<code>destination</code>.</td></tr>
215
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
216
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>unlink</code></a>(<span class=summary-sig-arg>self</span>,
217
<span class=summary-sig-arg>path</span>)</span></code>
219
Remove the file at the given path.</td></tr>
220
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
221
<td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#utime" class="summary-sig-name"><code>utime</code></a>(<span class=summary-sig-arg>self</span>,
222
<span class=summary-sig-arg>path</span>,
223
<span class=summary-sig-arg>times</span>)</span></code>
225
Set the access and modified times of the file specified by
226
<code>path</code>.</td></tr>
227
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
228
<td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_adjust_cwd" class="summary-sig-name"><code>_adjust_cwd</code></a>(<span class=summary-sig-arg>self</span>,
229
<span class=summary-sig-arg>path</span>)</span></code>
231
Return an adjusted path if we're emulating a "current working
232
directory" for the server.</td></tr>
233
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
234
<td><code><a name="_async_request"></a><span class="summary-sig"><span class="summary-sig-name">_async_request</span>(<span class=summary-sig-arg>self</span>,
235
<span class=summary-sig-arg>fileobj</span>,
236
<span class=summary-sig-arg>t</span>,
237
<span class="summary-sig-vararg">*arg</span>)</span></code>
239
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
240
<td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_convert_status" class="summary-sig-name"><code>_convert_status</code></a>(<span class=summary-sig-arg>self</span>,
241
<span class=summary-sig-arg>msg</span>)</span></code>
243
Raises EOFError or IOError on error status; otherwise does
245
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
246
<td><code><a name="_finish_responses"></a><span class="summary-sig"><span class="summary-sig-name">_finish_responses</span>(<span class=summary-sig-arg>self</span>,
247
<span class=summary-sig-arg>fileobj</span>)</span></code>
249
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
250
<td><code><a name="_read_response"></a><span class="summary-sig"><span class="summary-sig-name">_read_response</span>(<span class=summary-sig-arg>self</span>,
251
<span class=summary-sig-arg>waitfor</span>)</span></code>
253
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
254
<td><code><a name="_request"></a><span class="summary-sig"><span class="summary-sig-name">_request</span>(<span class=summary-sig-arg>self</span>,
255
<span class=summary-sig-arg>t</span>,
256
<span class="summary-sig-vararg">*arg</span>)</span></code>
258
<tr bgcolor="#e8f0f8" class="group">
259
<th colspan="2"> Inherited from BaseSFTP</th></tr>
260
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
261
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_log" class="summary-sig-name"><code>_log</code></a>(<span class=summary-sig-arg>self</span>,
262
<span class=summary-sig-arg>level</span>,
263
<span class=summary-sig-arg>msg</span>)</span></code>
265
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
266
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_read_all" class="summary-sig-name"><code>_read_all</code></a>(<span class=summary-sig-arg>self</span>,
267
<span class=summary-sig-arg>n</span>)</span></code>
269
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
270
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_read_packet" class="summary-sig-name"><code>_read_packet</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
272
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
273
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_send_packet" class="summary-sig-name"><code>_send_packet</code></a>(<span class=summary-sig-arg>self</span>,
274
<span class=summary-sig-arg>t</span>,
275
<span class=summary-sig-arg>packet</span>)</span></code>
277
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
278
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_send_server_version" class="summary-sig-name"><code>_send_server_version</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
280
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
281
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_send_version" class="summary-sig-name"><code>_send_version</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
283
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
284
<td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>,
285
<span class=summary-sig-arg>out</span>)</span></code>
287
<tr bgcolor="#e8f0f8" class="group">
288
<th colspan="2"> Inherited from object</th></tr>
289
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
290
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
292
x.__delattr__('name') <==> del x.name</td></tr>
293
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
294
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
296
x.__getattribute__('name') <==> x.name</td></tr>
297
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
298
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
300
x.__hash__() <==> hash(x)</td></tr>
301
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
302
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
303
<span class=summary-sig-arg>S</span>,
304
<span class="summary-sig-vararg">...</span>)</span></code>
306
T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr>
307
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
308
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
310
helper for pickle</td></tr>
311
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
312
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
314
helper for pickle</td></tr>
315
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
316
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
318
x.__repr__() <==> repr(x)</td></tr>
319
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
320
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
322
x.__setattr__('name', value) <==> x.name = value</td></tr>
323
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
324
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
326
x.__str__() <==> str(x)</td></tr>
330
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
331
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
332
<tr bgcolor="#70b0f0" class="details">
333
<th colspan="2">Instance Method Details</th></tr>
336
<a name="__init__"></a>
337
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
338
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
339
<span class=sig-arg>sock</span>)</span>
340
<br /><i>(Constructor)</i>
342
<p>Create an SFTP client from an existing <a
343
href="paramiko.Channel-class.html"
344
class="link"><code>Channel</code></a>. The channel should already have
345
requested the <code>"sftp"</code> subsystem.</p>
346
An alternate way to create an SFTP client context is by using <a
347
href="paramiko.SFTPClient-class.html#from_transport"
348
class="link"><code>from_transport</code></a>.
350
<dl><dt><b>Parameters:</b></dt>
351
<dd><code><b>sock</b></code> -
352
an open <a href="paramiko.Channel-class.html"
353
class="link"><code>Channel</code></a> using the
354
<code>"sftp"</code> subsystem.
355
<br /><i>
356
(type=<a href="paramiko.Channel-class.html"
357
class="link"><code>Channel</code></a>)</i>
360
<dl><dt><b>Overrides:</b></dt>
361
<dd><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>paramiko.BaseSFTP.__init__</code></a></dd>
367
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
368
<h3><span class="sig"><span class="sig-name">chdir</span>(<span class=sig-arg>self</span>,
369
<span class=sig-arg>path</span>)</span>
371
Change the "current directory" of this SFTP session. Since
372
SFTP doesn't really have the concept of a current working directory,
373
this is emulated by paramiko. Once you use this method to set a working
374
directory, all operations on this SFTPClient object will be relative to
377
<dl><dt><b>Parameters:</b></dt>
378
<dd><code><b>path</b></code> -
379
new current working directory
380
<br /><i>
384
<dl><dt><b>Raises:</b></dt>
385
<dd><code><b>IOError</b></code> -
386
if the requested path doesn't exist on the server
395
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
396
<h3><span class="sig"><span class="sig-name">chmod</span>(<span class=sig-arg>self</span>,
397
<span class=sig-arg>path</span>,
398
<span class=sig-arg>mode</span>)</span>
400
Change the mode (permissions) of a file. The permissions are
401
unix-style and identical to those used by python's
402
<code>os.chmod</code> function.
404
<dl><dt><b>Parameters:</b></dt>
405
<dd><code><b>path</b></code> -
406
path of the file to change the permissions of.
407
<br /><i>
409
<dd><code><b>mode</b></code> -
411
<br /><i>
419
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
420
<h3><span class="sig"><span class="sig-name">chown</span>(<span class=sig-arg>self</span>,
421
<span class=sig-arg>path</span>,
422
<span class=sig-arg>uid</span>,
423
<span class=sig-arg>gid</span>)</span>
425
Change the owner (<code>uid</code>) and group (<code>gid</code>) of
426
a file. As with python's <code>os.chown</code> function, you must pass
427
both arguments, so if you only want to change one, use <a
428
href="paramiko.SFTPClient-class.html#stat"
429
class="link"><code>stat</code></a> first to retrieve the current owner
432
<dl><dt><b>Parameters:</b></dt>
433
<dd><code><b>path</b></code> -
434
path of the file to change the owner and group of.
435
<br /><i>
437
<dd><code><b>uid</b></code> -
439
<br /><i>
441
<dd><code><b>gid</b></code> -
443
<br /><i>
451
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
452
<h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span>
454
Close the SFTP session and its underlying channel.
463
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
464
<h3><span class="sig"><span class="sig-name">file</span>(<span class=sig-arg>self</span>,
465
<span class=sig-arg>filename</span>,
466
<span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>,
467
<span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span>
469
<p>Open a file on the remote server. The arguments are the same as for
470
python's built-in <code>file</code> (aka <code>open</code>). A
471
file-like object is returned, which closely mimics the behavior of a
472
normal python file object.</p>
473
<p>The mode indicates how the file is to be opened: <code>'r'</code>
474
for reading, <code>'w'</code> for writing (truncating an existing
475
file), <code>'a'</code> for appending, <code>'r+'</code> for
476
reading/writing, <code>'w+'</code> for reading/writing (truncating an
477
existing file), <code>'a+'</code> for reading/appending. The python
478
<code>'b'</code> flag is ignored, since SSH treats all files as binary.
479
The <code>'U'</code> flag is supported in a compatible way.</p>
480
<p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation
481
should only succeed if the file was created and did not previously
482
exist. This has no direct mapping to python's file flags, but is
483
commonly known as the <code>O_EXCL</code> flag in posix.</p>
484
The file will be buffered in standard python style by default, but
485
can be altered with the <code>bufsize</code> parameter. <code>0</code>
486
turns off buffering, <code>1</code> uses line buffering, and any number
487
greater than 1 (<code>>1</code>) uses that specific buffer size.
489
<dl><dt><b>Parameters:</b></dt>
490
<dd><code><b>filename</b></code> -
491
name of the file to open.
492
<br /><i>
494
<dd><code><b>mode</b></code> -
495
mode (python-style) to open in.
496
<br /><i>
498
<dd><code><b>bufsize</b></code> -
499
desired buffering (-1 = default buffer size)
500
<br /><i>
504
<dl><dt><b>Returns:</b></dt>
506
a file object representing the open file.
507
<br /><i>
511
<dl><dt><b>Raises:</b></dt>
512
<dd><code><b>IOError</b></code> -
513
if the file could not be opened.
519
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
520
<h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>self</span>,
521
<span class=sig-arg>remotepath</span>,
522
<span class=sig-arg>localpath</span>)</span>
524
Copy a remote file (<code>remotepath</code>) from the SFTP server to
525
the local host as <code>localpath</code>. Any exception raised by
526
operations will be passed through. This method is primarily provided as
529
<dl><dt><b>Parameters:</b></dt>
530
<dd><code><b>remotepath</b></code> -
531
the remote file to copy
532
<br /><i>
534
<dd><code><b>localpath</b></code> -
535
the destination path on the local host
536
<br /><i>
546
<a name="getcwd"></a>
547
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
548
<h3><span class="sig"><span class="sig-name">getcwd</span>(<span class=sig-arg>self</span>)</span>
550
Return the "current working directory" for this SFTP
551
session, as emulated by paramiko. If no directory has been set with <a
552
href="paramiko.SFTPClient-class.html#chdir"
553
class="link"><code>chdir</code></a>, this method will return
556
<dl><dt><b>Returns:</b></dt>
558
the current working directory on the server, or
560
<br /><i>
570
<a name="listdir"></a>
571
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
572
<h3><span class="sig"><span class="sig-name">listdir</span>(<span class=sig-arg>self</span>,
573
<span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span>
575
Return a list containing the names of the entries in the given
576
<code>path</code>. The list is in arbitrary order. It does not include
577
the special entries <code>'.'</code> and <code>'..'</code> even if they
578
are present in the folder. This method is meant to mirror
579
<code>os.listdir</code> as closely as possible. For a list of full <a
580
href="paramiko.SFTPAttributes-class.html"
581
class="link"><code>SFTPAttributes</code></a> objects, see <a
582
href="paramiko.SFTPClient-class.html#listdir_attr"
583
class="link"><code>listdir_attr</code></a>.
585
<dl><dt><b>Parameters:</b></dt>
586
<dd><code><b>path</b></code> -
587
path to list (defaults to <code>'.'</code>)
588
<br /><i>
592
<dl><dt><b>Returns:</b></dt>
595
<br /><i>
596
(type=list of str)</i>
602
<a name="listdir_attr"></a>
603
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
604
<h3><span class="sig"><span class="sig-name">listdir_attr</span>(<span class=sig-arg>self</span>,
605
<span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span>
607
Return a list containing <a
608
href="paramiko.SFTPAttributes-class.html"
609
class="link"><code>SFTPAttributes</code></a> objects corresponding to
610
files in the given <code>path</code>. The list is in arbitrary order.
611
It does not include the special entries <code>'.'</code> and
612
<code>'..'</code> even if they are present in the folder.
614
<dl><dt><b>Parameters:</b></dt>
615
<dd><code><b>path</b></code> -
616
path to list (defaults to <code>'.'</code>)
617
<br /><i>
621
<dl><dt><b>Returns:</b></dt>
624
<br /><i>
625
(type=list of <a href="paramiko.SFTPAttributes-class.html"
626
class="link"><code>SFTPAttributes</code></a>)</i>
636
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
637
<h3><span class="sig"><span class="sig-name">lstat</span>(<span class=sig-arg>self</span>,
638
<span class=sig-arg>path</span>)</span>
640
Retrieve information about a file on the remote system, without
641
following symbolic links (shortcuts). This otherwise behaves exactly
642
the same as <a href="paramiko.SFTPClient-class.html#stat"
643
class="link"><code>stat</code></a>.
645
<dl><dt><b>Parameters:</b></dt>
646
<dd><code><b>path</b></code> -
647
the filename to stat.
648
<br /><i>
652
<dl><dt><b>Returns:</b></dt>
654
an object containing attributes about the given file.
655
<br /><i>
656
(type=SFTPAttributes)</i>
663
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
664
<h3><span class="sig"><span class="sig-name">mkdir</span>(<span class=sig-arg>self</span>,
665
<span class=sig-arg>path</span>,
666
<span class=sig-arg>mode</span>=<span class=sig-default>511</span>)</span>
668
Create a folder (directory) named <code>path</code> with numeric
669
mode <code>mode</code>. The default mode is 0777 (octal). On some
670
systems, mode is ignored. Where it is used, the current umask value is
673
<dl><dt><b>Parameters:</b></dt>
674
<dd><code><b>path</b></code> -
675
name of the folder to create.
676
<br /><i>
678
<dd><code><b>mode</b></code> -
679
permissions (posix-style) for the newly-created folder.
680
<br /><i>
687
<a name="normalize"></a>
688
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
689
<h3><span class="sig"><span class="sig-name">normalize</span>(<span class=sig-arg>self</span>,
690
<span class=sig-arg>path</span>)</span>
692
Return the normalized path (on the server) of a given path. This can
693
be used to quickly resolve symbolic links or determine what the server
694
is considering to be the "current folder" (by passing
695
<code>'.'</code> as <code>path</code>).
697
<dl><dt><b>Parameters:</b></dt>
698
<dd><code><b>path</b></code> -
699
path to be normalized.
700
<br /><i>
704
<dl><dt><b>Returns:</b></dt>
706
normalized form of the given path.
707
<br /><i>
711
<dl><dt><b>Raises:</b></dt>
712
<dd><code><b>IOError</b></code> -
713
if the path can't be resolved on the server
719
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
720
<h3><span class="sig"><span class="sig-name">open</span>(<span class=sig-arg>self</span>,
721
<span class=sig-arg>filename</span>,
722
<span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>,
723
<span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span>
725
<p>Open a file on the remote server. The arguments are the same as for
726
python's built-in <code>file</code> (aka <code>open</code>). A
727
file-like object is returned, which closely mimics the behavior of a
728
normal python file object.</p>
729
<p>The mode indicates how the file is to be opened: <code>'r'</code>
730
for reading, <code>'w'</code> for writing (truncating an existing
731
file), <code>'a'</code> for appending, <code>'r+'</code> for
732
reading/writing, <code>'w+'</code> for reading/writing (truncating an
733
existing file), <code>'a+'</code> for reading/appending. The python
734
<code>'b'</code> flag is ignored, since SSH treats all files as binary.
735
The <code>'U'</code> flag is supported in a compatible way.</p>
736
<p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation
737
should only succeed if the file was created and did not previously
738
exist. This has no direct mapping to python's file flags, but is
739
commonly known as the <code>O_EXCL</code> flag in posix.</p>
740
The file will be buffered in standard python style by default, but
741
can be altered with the <code>bufsize</code> parameter. <code>0</code>
742
turns off buffering, <code>1</code> uses line buffering, and any number
743
greater than 1 (<code>>1</code>) uses that specific buffer size.
745
<dl><dt><b>Parameters:</b></dt>
746
<dd><code><b>filename</b></code> -
747
name of the file to open.
748
<br /><i>
750
<dd><code><b>mode</b></code> -
751
mode (python-style) to open in.
752
<br /><i>
754
<dd><code><b>bufsize</b></code> -
755
desired buffering (-1 = default buffer size)
756
<br /><i>
760
<dl><dt><b>Returns:</b></dt>
762
a file object representing the open file.
763
<br /><i>
767
<dl><dt><b>Raises:</b></dt>
768
<dd><code><b>IOError</b></code> -
769
if the file could not be opened.
775
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
776
<h3><span class="sig"><span class="sig-name">put</span>(<span class=sig-arg>self</span>,
777
<span class=sig-arg>localpath</span>,
778
<span class=sig-arg>remotepath</span>)</span>
780
<p>Copy a local file (<code>localpath</code>) to the SFTP server as
781
<code>remotepath</code>. Any exception raised by operations will be
782
passed through. This method is primarily provided as a convenience.</p>
783
The SFTP operations use pipelining for speed.
785
<dl><dt><b>Parameters:</b></dt>
786
<dd><code><b>localpath</b></code> -
787
the local file to copy
788
<br /><i>
790
<dd><code><b>remotepath</b></code> -
791
the destination path on the SFTP server
792
<br /><i>
802
<a name="readlink"></a>
803
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
804
<h3><span class="sig"><span class="sig-name">readlink</span>(<span class=sig-arg>self</span>,
805
<span class=sig-arg>path</span>)</span>
807
Return the target of a symbolic link (shortcut). You can use <a
808
href="paramiko.SFTPClient-class.html#symlink"
809
class="link"><code>symlink</code></a> to create these. The result may
810
be either an absolute or relative pathname.
812
<dl><dt><b>Parameters:</b></dt>
813
<dd><code><b>path</b></code> -
814
path of the symbolic link file.
815
<br /><i>
819
<dl><dt><b>Returns:</b></dt>
822
<br /><i>
829
<a name="remove"></a>
830
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
831
<h3><span class="sig"><span class="sig-name">remove</span>(<span class=sig-arg>self</span>,
832
<span class=sig-arg>path</span>)</span>
834
Remove the file at the given path.
836
<dl><dt><b>Parameters:</b></dt>
837
<dd><code><b>path</b></code> -
838
path (absolute or relative) of the file to remove.
839
<br /><i>
843
<dl><dt><b>Raises:</b></dt>
844
<dd><code><b>IOError</b></code> -
845
if the path refers to a folder (directory). Use <a
846
href="paramiko.SFTPClient-class.html#rmdir"
847
class="link"><code>rmdir</code></a> to remove a folder.
852
<a name="rename"></a>
853
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
854
<h3><span class="sig"><span class="sig-name">rename</span>(<span class=sig-arg>self</span>,
855
<span class=sig-arg>oldpath</span>,
856
<span class=sig-arg>newpath</span>)</span>
858
Rename a file or folder from <code>oldpath</code> to
859
<code>newpath</code>.
861
<dl><dt><b>Parameters:</b></dt>
862
<dd><code><b>oldpath</b></code> -
863
existing name of the file or folder.
864
<br /><i>
866
<dd><code><b>newpath</b></code> -
867
new name for the file or folder.
868
<br /><i>
872
<dl><dt><b>Raises:</b></dt>
873
<dd><code><b>IOError</b></code> -
874
if <code>newpath</code> is a folder, or something else goes
881
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
882
<h3><span class="sig"><span class="sig-name">rmdir</span>(<span class=sig-arg>self</span>,
883
<span class=sig-arg>path</span>)</span>
885
Remove the folder named <code>path</code>.
887
<dl><dt><b>Parameters:</b></dt>
888
<dd><code><b>path</b></code> -
889
name of the folder to remove.
890
<br /><i>
898
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
899
<h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>,
900
<span class=sig-arg>path</span>)</span>
902
<p>Retrieve information about a file on the remote system. The return
903
value is an object whose attributes correspond to the attributes of
904
python's <code>stat</code> structure as returned by
905
<code>os.stat</code>, except that it contains fewer fields. An SFTP
906
server may return as much or as little info as it wants, so the results
907
may vary from server to server.</p>
908
<p>Unlike a python <code>stat</code> object, the result may not be
909
accessed as a tuple. This is mostly due to the author's slack
911
The fields supported are: <code>st_mode</code>,
912
<code>st_size</code>, <code>st_uid</code>, <code>st_gid</code>,
913
<code>st_atime</code>, and <code>st_mtime</code>.
915
<dl><dt><b>Parameters:</b></dt>
916
<dd><code><b>path</b></code> -
917
the filename to stat.
918
<br /><i>
922
<dl><dt><b>Returns:</b></dt>
924
an object containing attributes about the given file.
925
<br /><i>
926
(type=SFTPAttributes)</i>
932
<a name="symlink"></a>
933
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
934
<h3><span class="sig"><span class="sig-name">symlink</span>(<span class=sig-arg>self</span>,
935
<span class=sig-arg>source</span>,
936
<span class=sig-arg>dest</span>)</span>
938
Create a symbolic link (shortcut) of the <code>source</code> path at
939
<code>destination</code>.
941
<dl><dt><b>Parameters:</b></dt>
942
<dd><code><b>source</b></code> -
943
path of the original file.
944
<br /><i>
946
<dd><code><b>dest</b></code> -
947
path of the newly created symlink.
948
<br /><i>
955
<a name="remove"></a>
956
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
957
<h3><span class="sig"><span class="sig-name">unlink</span>(<span class=sig-arg>self</span>,
958
<span class=sig-arg>path</span>)</span>
960
Remove the file at the given path.
962
<dl><dt><b>Parameters:</b></dt>
963
<dd><code><b>path</b></code> -
964
path (absolute or relative) of the file to remove.
965
<br /><i>
969
<dl><dt><b>Raises:</b></dt>
970
<dd><code><b>IOError</b></code> -
971
if the path refers to a folder (directory). Use <a
972
href="paramiko.SFTPClient-class.html#rmdir"
973
class="link"><code>rmdir</code></a> to remove a folder.
979
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
980
<h3><span class="sig"><span class="sig-name">utime</span>(<span class=sig-arg>self</span>,
981
<span class=sig-arg>path</span>,
982
<span class=sig-arg>times</span>)</span>
984
Set the access and modified times of the file specified by
985
<code>path</code>. If <code>times</code> is <code>None</code>, then the
986
file's access and modified times are set to the current time.
987
Otherwise, <code>times</code> must be a 2-tuple of numbers, of the form
988
<code>(atime, mtime)</code>, which is used to set the access and
989
modified times, respectively. This bizarre API is mimicked from python
990
for the sake of consistency -- I apologize.
992
<dl><dt><b>Parameters:</b></dt>
993
<dd><code><b>path</b></code> -
994
path of the file to modify.
995
<br /><i>
997
<dd><code><b>times</b></code> -
998
<code>None</code> or a tuple of (access time, modified time)
999
in standard internet epoch time (seconds since 01 January 1970
1001
<br /><i>
1002
(type=tuple of int)</i>
1008
<a name="_adjust_cwd"></a>
1009
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
1010
<h3><span class="sig"><span class="sig-name">_adjust_cwd</span>(<span class=sig-arg>self</span>,
1011
<span class=sig-arg>path</span>)</span>
1013
Return an adjusted path if we're emulating a "current working
1014
directory" for the server.
1019
<a name="_convert_status"></a>
1020
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
1021
<h3><span class="sig"><span class="sig-name">_convert_status</span>(<span class=sig-arg>self</span>,
1022
<span class=sig-arg>msg</span>)</span>
1024
Raises EOFError or IOError on error status; otherwise does
1032
<!-- =========== START OF CLASS METHOD DETAILS =========== -->
1033
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
1034
<tr bgcolor="#70b0f0" class="details">
1035
<th colspan="2">Class Method Details</th></tr>
1038
<a name="from_transport"></a>
1039
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
1040
<h3><span class="sig"><span class="sig-name">from_transport</span>(<span class=sig-arg>selfclass</span>,
1041
<span class=sig-arg>t</span>)</span>
1043
Create an SFTP client channel from an open <a
1044
href="paramiko.Transport-class.html"
1045
class="link"><code>Transport</code></a>.
1047
<dl><dt><b>Parameters:</b></dt>
1048
<dd><code><b>t</b></code> -
1049
an open <a href="paramiko.Transport-class.html"
1050
class="link"><code>Transport</code></a> which is already
1052
<br /><i>
1053
(type=<a href="paramiko.Transport-class.html"
1054
class="link"><code>Transport</code></a>)</i>
1057
<dl><dt><b>Returns:</b></dt>
1059
a new <a href="paramiko.SFTPClient-class.html"
1060
class="link"><code>SFTPClient</code></a> object, referring to an
1061
sftp session (channel) across the transport.
1062
<br /><i>
1063
(type=<a href="paramiko.SFTPClient-class.html"
1064
class="link"><code>SFTPClient</code></a>)</i>
1072
<!-- =========== START OF NAVBAR =========== -->
1073
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
1074
<tr valign="center">
1075
<th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th>
1076
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
1077
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
1078
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
1079
<th class="navbar" width="100%"></th>
1083
<table border="0" cellpadding="0" cellspacing="0" width="100%">
1085
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</font></td>
1086
<td align="right"><a href="http://epydoc.sourceforge.net"
1087
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
docs/private/paramiko.SFTPClient-class.html
