~dkuhlman/python-training-materials/Materials

<h1>20.8. <a class="reference internal" href="#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal">ftplib</code></a> — FTP protocol client<a class="headerlink" href="#module-ftplib" title="Permalink to this headline">¶</a></h1>

Source code: <a class="reference external" href="https://hg.python.org/cpython/file/2.7/Lib/ftplib.py">Lib/ftplib.py</a>

This module defines the class <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> and a few related items. The

<a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> class implements the client side of the FTP protocol. You can use

this to write Python programs that perform a variety of automated FTP jobs, such

as mirroring other ftp servers. It is also used by the module <a class="reference internal" href="urllib.html#module-urllib" title="urllib: Open an arbitrary network resource by URL (requires sockets)."><code class="xref py py-mod docutils literal">urllib</code></a> to

handle URLs that use FTP. For more information on FTP (File Transfer Protocol),

see Internet <a class="rfc reference external" href="https://tools.ietf.org/html/rfc959.html">RFC 959</a>.

Here’s a sample session using the <a class="reference internal" href="#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal">ftplib</code></a> module:

<div class="highlight-python"><div class="highlight"><pre>>>> from ftplib import FTP

>>> ftp = FTP('ftp.debian.org') # connect to host, default port

>>> ftp.login() # user anonymous, passwd anonymous@

'230 Login successful.'

>>> ftp.cwd('debian') # change into "debian" directory

>>> ftp.retrlines('LIST') # list directory contents

-rw-rw-r-- 1 1176 1176 1063 Jun 15 10:18 README

...

drwxr-sr-x 5 1176 1176 4096 Dec 19 2000 pool

drwxr-sr-x 4 1176 1176 4096 Nov 17 2008 project

drwxr-xr-x 3 1176 1176 4096 Oct 10 2012 tools

'226 Directory send OK.'

100

>>> ftp.retrbinary('RETR README', open('README', 'wb').write)

101

'226 Transfer complete.'

102

>>> ftp.quit()

103

</pre></div>

104

</div>

105

The module defines the following items:

106

107

108

class <code class="descclassname">ftplib.</code><code class="descname">FTP</code>([host[, user[, passwd[, acct[, timeout]]]]])<a class="headerlink" href="#ftplib.FTP" title="Permalink to this definition">¶</a></dt>

109

<dd>Return a new instance of the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> class. When host is given, the

110

method call <code class="docutils literal">connect(host)</code> is made. When user is given, additionally

111

the method call <code class="docutils literal">login(user, passwd, acct)</code> is made (where passwd and

112

acct default to the empty string when not given). The optional timeout

113

parameter specifies a timeout in seconds for blocking operations like the

114

connection attempt (if is not specified, the global default timeout setting

115

will be used).

116

117

Changed in version 2.6: timeout was added.

118

</div>

119

</dd></dl>

120

121

122

123

class <code class="descclassname">ftplib.</code><code class="descname">FTP_TLS</code>([host[, user[, passwd[, acct[, keyfile[, certfile[, context[, timeout]]]]]]]])<a class="headerlink" href="#ftplib.FTP_TLS" title="Permalink to this definition">¶</a></dt>

124

<dd>A <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> subclass which adds TLS support to FTP as described in

125

<a class="rfc reference external" href="https://tools.ietf.org/html/rfc4217.html">RFC 4217</a>.

126

Connect as usual to port 21 implicitly securing the FTP control connection

127

before authenticating. Securing the data connection requires the user to

128

explicitly ask for it by calling the <a class="reference internal" href="#ftplib.FTP_TLS.prot_p" title="ftplib.FTP_TLS.prot_p"><code class="xref py py-meth docutils literal">prot_p()</code></a> method. context

129

is a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal">ssl.SSLContext</code></a> object which allows bundling SSL configuration

130

options, certificates and private keys into a single (potentially

131

long-lived) structure. Please read <a class="reference internal" href="ssl.html#ssl-security">Security considerations</a> for best practices.

132

keyfile and certfile are a legacy alternative to context – they

133

can point to PEM-formatted private key and certificate chain files

134

(respectively) for the SSL connection.

135

136

New in version 2.7.

137

</div>

138

139

Changed in version 2.7.10: The context parameter was added.

140

</div>

141

Here’s a sample session using the <a class="reference internal" href="#ftplib.FTP_TLS" title="ftplib.FTP_TLS"><code class="xref py py-class docutils literal">FTP_TLS</code></a> class:

142

143

>>> ftps = FTP_TLS('ftp.python.org')

144

>>> ftps.login() # login anonymously before securing control channel

145

>>> ftps.prot_p() # switch to secure data connection

146

>>> ftps.retrlines('LIST') # list directory content securely

147

total 9

148

drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .

149

drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..

150

drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin

151

drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc

152

d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming

153

drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib

154

drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub

155

drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr

156

-rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg

157

'226 Transfer complete.'

158

>>> ftps.quit()

159

>>>

160

</pre></div>

161

</div>

162

</dd></dl>

163

164

165

166

exception <code class="descclassname">ftplib.</code><code class="descname">error_reply</code><a class="headerlink" href="#ftplib.error_reply" title="Permalink to this definition">¶</a></dt>

167

<dd>Exception raised when an unexpected reply is received from the server.

168

</dd></dl>

169

170

171

172

exception <code class="descclassname">ftplib.</code><code class="descname">error_temp</code><a class="headerlink" href="#ftplib.error_temp" title="Permalink to this definition">¶</a></dt>

173

<dd>Exception raised when an error code signifying a temporary error (response

174

codes in the range 400–499) is received.

175

</dd></dl>

176

177

178

179

exception <code class="descclassname">ftplib.</code><code class="descname">error_perm</code><a class="headerlink" href="#ftplib.error_perm" title="Permalink to this definition">¶</a></dt>

180

<dd>Exception raised when an error code signifying a permanent error (response

181

codes in the range 500–599) is received.

182

</dd></dl>

183

184

185

186

exception <code class="descclassname">ftplib.</code><code class="descname">error_proto</code><a class="headerlink" href="#ftplib.error_proto" title="Permalink to this definition">¶</a></dt>

187

<dd>Exception raised when a reply is received from the server that does not fit

188

the response specifications of the File Transfer Protocol, i.e. begin with a

189

digit in the range 1–5.

190

</dd></dl>

191

192

193

194

<code class="descclassname">ftplib.</code><code class="descname">all_errors</code><a class="headerlink" href="#ftplib.all_errors" title="Permalink to this definition">¶</a></dt>

195

<dd>The set of all exceptions (as a tuple) that methods of <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a>

196

instances may raise as a result of problems with the FTP connection (as

197

opposed to programming errors made by the caller). This set includes the

198

four exceptions listed above as well as <a class="reference internal" href="socket.html#socket.error" title="socket.error"><code class="xref py py-exc docutils literal">socket.error</code></a> and

199

<a class="reference internal" href="exceptions.html#exceptions.IOError" title="exceptions.IOError"><code class="xref py py-exc docutils literal">IOError</code></a>.

200

</dd></dl>

201

202

203

See also

204

205

<dt>Module <a class="reference internal" href="netrc.html#module-netrc" title="netrc: Loading of .netrc files."><code class="xref py py-mod docutils literal">netrc</code></a></dt>

206

<dd>Parser for the <code class="file docutils literal">.netrc</code> file format. The file <code class="file docutils literal">.netrc</code> is

207

typically used by FTP clients to load user authentication information

208

before prompting the user.</dd>

209

</dl>

210

The file <code class="file docutils literal">Tools/scripts/ftpmirror.py</code> in the Python source distribution is

211

a script that can mirror FTP sites, or portions thereof, using the <a class="reference internal" href="#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal">ftplib</code></a>

212

module. It can be used as an extended example that applies this module.

213

</div>

214

215

<h2>20.8.1. FTP Objects<a class="headerlink" href="#ftp-objects" title="Permalink to this headline">¶</a></h2>

216

Several methods are available in two flavors: one for handling text files and

217

another for binary files. These are named for the command which is used

218

followed by <code class="docutils literal">lines</code> for the text version or <code class="docutils literal">binary</code> for the binary version.

219

<a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> instances have the following methods:

220

221

222

<code class="descclassname">FTP.</code><code class="descname">set_debuglevel</code>(level)<a class="headerlink" href="#ftplib.FTP.set_debuglevel" title="Permalink to this definition">¶</a></dt>

223

<dd>Set the instance’s debugging level. This controls the amount of debugging

224

output printed. The default, <code class="docutils literal">0</code>, produces no debugging output. A value of

225

<code class="docutils literal">1</code> produces a moderate amount of debugging output, generally a single line

226

per request. A value of <code class="docutils literal">2</code> or higher produces the maximum amount of

227

debugging output, logging each line sent and received on the control connection.

228

</dd></dl>

229

230

231

232

<code class="descclassname">FTP.</code><code class="descname">connect</code>(host[, port[, timeout]])<a class="headerlink" href="#ftplib.FTP.connect" title="Permalink to this definition">¶</a></dt>

233

<dd>Connect to the given host and port. The default port number is <code class="docutils literal">21</code>, as

234

specified by the FTP protocol specification. It is rarely needed to specify a

235

different port number. This function should be called only once for each

236

instance; it should not be called at all if a host was given when the instance

237

was created. All other methods can only be used after a connection has been

238

made.

239

The optional timeout parameter specifies a timeout in seconds for the

240

connection attempt. If no timeout is passed, the global default timeout

241

setting will be used.

242

243

Changed in version 2.6: timeout was added.

244

</div>

245

</dd></dl>

246

247

248

249

<code class="descclassname">FTP.</code><code class="descname">getwelcome</code>()<a class="headerlink" href="#ftplib.FTP.getwelcome" title="Permalink to this definition">¶</a></dt>

250

<dd>Return the welcome message sent by the server in reply to the initial

251

connection. (This message sometimes contains disclaimers or help information

252

that may be relevant to the user.)

253

</dd></dl>

254

255

256

257

<code class="descclassname">FTP.</code><code class="descname">login</code>([user[, passwd[, acct]]])<a class="headerlink" href="#ftplib.FTP.login" title="Permalink to this definition">¶</a></dt>

258

<dd>Log in as the given user. The passwd and acct parameters are optional and

259

default to the empty string. If no user is specified, it defaults to

260

<code class="docutils literal">'anonymous'</code>. If user is <code class="docutils literal">'anonymous'</code>, the default passwd is

261

<code class="docutils literal">'anonymous@'</code>. This function should be called only once for each instance,

262

after a connection has been established; it should not be called at all if a

263

host and user were given when the instance was created. Most FTP commands are

264

only allowed after the client has logged in. The acct parameter supplies

265

“accounting information”; few systems implement this.

266

</dd></dl>

267

268

269

270

<code class="descclassname">FTP.</code><code class="descname">abort</code>()<a class="headerlink" href="#ftplib.FTP.abort" title="Permalink to this definition">¶</a></dt>

271

<dd>Abort a file transfer that is in progress. Using this does not always work, but

272

it’s worth a try.

273

</dd></dl>

274

275

276

277

<code class="descclassname">FTP.</code><code class="descname">sendcmd</code>(command)<a class="headerlink" href="#ftplib.FTP.sendcmd" title="Permalink to this definition">¶</a></dt>

278

<dd>Send a simple command string to the server and return the response string.

279

</dd></dl>

280

281

282

283

<code class="descclassname">FTP.</code><code class="descname">voidcmd</code>(command)<a class="headerlink" href="#ftplib.FTP.voidcmd" title="Permalink to this definition">¶</a></dt>

284

<dd>Send a simple command string to the server and handle the response. Return

285

nothing if a response code corresponding to success (codes in the range

286

200–299) is received. Raise <a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal">error_reply</code></a> otherwise.

287

</dd></dl>

288

289

290

291

<code class="descclassname">FTP.</code><code class="descname">retrbinary</code>(command, callback[, maxblocksize[, rest]])<a class="headerlink" href="#ftplib.FTP.retrbinary" title="Permalink to this definition">¶</a></dt>

292

<dd>Retrieve a file in binary transfer mode. command should be an appropriate

293

<code class="docutils literal">RETR</code> command: <code class="docutils literal">'RETR filename'</code>. The callback function is called for

294

each block of data received, with a single string argument giving the data

295

block. The optional maxblocksize argument specifies the maximum chunk size to

296

read on the low-level socket object created to do the actual transfer (which

297

will also be the largest size of the data blocks passed to callback). A

298

reasonable default is chosen. rest means the same thing as in the

299

<a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a> method.

300

</dd></dl>

301

302

303

304

<code class="descclassname">FTP.</code><code class="descname">retrlines</code>(command[, callback])<a class="headerlink" href="#ftplib.FTP.retrlines" title="Permalink to this definition">¶</a></dt>

305

<dd>Retrieve a file or directory listing in ASCII transfer mode. command

306

should be an appropriate <code class="docutils literal">RETR</code> command (see <a class="reference internal" href="#ftplib.FTP.retrbinary" title="ftplib.FTP.retrbinary"><code class="xref py py-meth docutils literal">retrbinary()</code></a>) or a

307

command such as <code class="docutils literal">LIST</code>, <code class="docutils literal">NLST</code> or <code class="docutils literal">MLSD</code> (usually just the string

308

<code class="docutils literal">'LIST'</code>). <code class="docutils literal">LIST</code> retrieves a list of files and information about those files.

309

<code class="docutils literal">NLST</code> retrieves a list of file names. On some servers, <code class="docutils literal">MLSD</code> retrieves

310

a machine readable list of files and information about those files. The callback

311

function is called for each line with a string argument containing the line with

312

the trailing CRLF stripped. The default callback prints the line to <code class="docutils literal">sys.stdout</code>.

313

</dd></dl>

314

315

316

317

<code class="descclassname">FTP.</code><code class="descname">set_pasv</code>(boolean)<a class="headerlink" href="#ftplib.FTP.set_pasv" title="Permalink to this definition">¶</a></dt>

318

<dd>Enable “passive” mode if boolean is true, other disable passive mode. (In

319

Python 2.0 and before, passive mode was off by default; in Python 2.1 and later,

320

it is on by default.)

321

</dd></dl>

322

323

324

325

<code class="descclassname">FTP.</code><code class="descname">storbinary</code>(command, file[, blocksize, callback, rest])<a class="headerlink" href="#ftplib.FTP.storbinary" title="Permalink to this definition">¶</a></dt>

326

<dd>Store a file in binary transfer mode. command should be an appropriate

327

<code class="docutils literal">STOR</code> command: <code class="docutils literal">"STOR filename"</code>. file is an open file object which is

328

read until EOF using its <code class="xref py py-meth docutils literal">read()</code> method in blocks of size blocksize to

329

provide the data to be stored. The blocksize argument defaults to 8192.

330

callback is an optional single parameter callable that is called

331

on each block of data after it is sent. rest means the same thing as in

332

the <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a> method.

333

334

Changed in version 2.1: default for blocksize added.

335

</div>

336

337

Changed in version 2.6: callback parameter added.

338

</div>

339

340

Changed in version 2.7: rest parameter added.

341

</div>

342

</dd></dl>

343

344

345

346

<code class="descclassname">FTP.</code><code class="descname">storlines</code>(command, file[, callback])<a class="headerlink" href="#ftplib.FTP.storlines" title="Permalink to this definition">¶</a></dt>

347

<dd>Store a file in ASCII transfer mode. command should be an appropriate

348

<code class="docutils literal">STOR</code> command (see <a class="reference internal" href="#ftplib.FTP.storbinary" title="ftplib.FTP.storbinary"><code class="xref py py-meth docutils literal">storbinary()</code></a>). Lines are read until EOF from the

349

open file object file using its <a class="reference internal" href="stdtypes.html#file.readline" title="file.readline"><code class="xref py py-meth docutils literal">readline()</code></a> method to provide

350

the data to be stored. callback is an optional single parameter callable

351

that is called on each line after it is sent.

352

353

Changed in version 2.6: callback parameter added.

354

</div>

355

</dd></dl>

356

357

358

359

<code class="descclassname">FTP.</code><code class="descname">transfercmd</code>(cmd[, rest])<a class="headerlink" href="#ftplib.FTP.transfercmd" title="Permalink to this definition">¶</a></dt>

360

<dd>Initiate a transfer over the data connection. If the transfer is active, send a

361

<code class="docutils literal">EPRT</code> or <code class="docutils literal">PORT</code> command and the transfer command specified by cmd, and

362

accept the connection. If the server is passive, send a <code class="docutils literal">EPSV</code> or <code class="docutils literal">PASV</code>

363

command, connect to it, and start the transfer command. Either way, return the

364

socket for the connection.

365

If optional rest is given, a <code class="docutils literal">REST</code> command is sent to the server, passing

366

rest as an argument. rest is usually a byte offset into the requested file,

367

telling the server to restart sending the file’s bytes at the requested offset,

368

skipping over the initial bytes. Note however that RFC 959 requires only that

369

rest be a string containing characters in the printable range from ASCII code

370

33 to ASCII code 126. The <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a> method, therefore, converts

371

rest to a string, but no check is performed on the string’s contents. If the

372

server does not recognize the <code class="docutils literal">REST</code> command, an <a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal">error_reply</code></a> exception

373

will be raised. If this happens, simply call <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a> without a

374

rest argument.

375

</dd></dl>

376

377

378

379

<code class="descclassname">FTP.</code><code class="descname">ntransfercmd</code>(cmd[, rest])<a class="headerlink" href="#ftplib.FTP.ntransfercmd" title="Permalink to this definition">¶</a></dt>

380

<dd>Like <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a>, but returns a tuple of the data connection and the

381

expected size of the data. If the expected size could not be computed, <code class="docutils literal">None</code>

382

will be returned as the expected size. cmd and rest means the same thing as

383

in <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal">transfercmd()</code></a>.

384

</dd></dl>

385

386

387

388

<code class="descclassname">FTP.</code><code class="descname">nlst</code>(argument[, ...])<a class="headerlink" href="#ftplib.FTP.nlst" title="Permalink to this definition">¶</a></dt>

389

<dd>Return a list of file names as returned by the <code class="docutils literal">NLST</code> command. The

390

optional argument is a directory to list (default is the current server

391

directory). Multiple arguments can be used to pass non-standard options to

392

the <code class="docutils literal">NLST</code> command.

393

</dd></dl>

394

395

396

397

<code class="descclassname">FTP.</code><code class="descname">dir</code>(argument[, ...])<a class="headerlink" href="#ftplib.FTP.dir" title="Permalink to this definition">¶</a></dt>

398

<dd>Produce a directory listing as returned by the <code class="docutils literal">LIST</code> command, printing it to

399

standard output. The optional argument is a directory to list (default is the

400

current server directory). Multiple arguments can be used to pass non-standard

401

options to the <code class="docutils literal">LIST</code> command. If the last argument is a function, it is used

402

as a callback function as for <a class="reference internal" href="#ftplib.FTP.retrlines" title="ftplib.FTP.retrlines"><code class="xref py py-meth docutils literal">retrlines()</code></a>; the default prints to

403

<code class="docutils literal">sys.stdout</code>. This method returns <code class="docutils literal">None</code>.

404

</dd></dl>

405

406

407

408

<code class="descclassname">FTP.</code><code class="descname">rename</code>(fromname, toname)<a class="headerlink" href="#ftplib.FTP.rename" title="Permalink to this definition">¶</a></dt>

409

<dd>Rename file fromname on the server to toname.

410

</dd></dl>

411

412

413

414

<code class="descclassname">FTP.</code><code class="descname">delete</code>(filename)<a class="headerlink" href="#ftplib.FTP.delete" title="Permalink to this definition">¶</a></dt>

415

<dd>Remove the file named filename from the server. If successful, returns the

416

text of the response, otherwise raises <a class="reference internal" href="#ftplib.error_perm" title="ftplib.error_perm"><code class="xref py py-exc docutils literal">error_perm</code></a> on permission errors or

417

<a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal">error_reply</code></a> on other errors.

418

</dd></dl>

419

420

421

422

<code class="descclassname">FTP.</code><code class="descname">cwd</code>(pathname)<a class="headerlink" href="#ftplib.FTP.cwd" title="Permalink to this definition">¶</a></dt>

423

<dd>Set the current directory on the server.

424

</dd></dl>

425

426

427

428

<code class="descclassname">FTP.</code><code class="descname">mkd</code>(pathname)<a class="headerlink" href="#ftplib.FTP.mkd" title="Permalink to this definition">¶</a></dt>

429

<dd>Create a new directory on the server.

430

</dd></dl>

431

432

433

434

435

<dd>Return the pathname of the current directory on the server.

436

</dd></dl>

437

438

439

440

<code class="descclassname">FTP.</code><code class="descname">rmd</code>(dirname)<a class="headerlink" href="#ftplib.FTP.rmd" title="Permalink to this definition">¶</a></dt>

441

<dd>Remove the directory named dirname on the server.

442

</dd></dl>

443

444

445

446

<code class="descclassname">FTP.</code><code class="descname">size</code>(filename)<a class="headerlink" href="#ftplib.FTP.size" title="Permalink to this definition">¶</a></dt>

447

<dd>Request the size of the file named filename on the server. On success, the

448

size of the file is returned as an integer, otherwise <code class="docutils literal">None</code> is returned.

449

Note that the <code class="docutils literal">SIZE</code> command is not standardized, but is supported by many

450

common server implementations.

451

</dd></dl>

452

453

454

455

456

<dd>Send a <code class="docutils literal">QUIT</code> command to the server and close the connection. This is the

457

“polite” way to close a connection, but it may raise an exception if the server

458

responds with an error to the <code class="docutils literal">QUIT</code> command. This implies a call to the

459

<a class="reference internal" href="#ftplib.FTP.close" title="ftplib.FTP.close"><code class="xref py py-meth docutils literal">close()</code></a> method which renders the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> instance useless for

460

subsequent calls (see below).

461

</dd></dl>

462

463

464

465

<code class="descclassname">FTP.</code><code class="descname">close</code>()<a class="headerlink" href="#ftplib.FTP.close" title="Permalink to this definition">¶</a></dt>

466

<dd>Close the connection unilaterally. This should not be applied to an already

467

closed connection such as after a successful call to <a class="reference internal" href="#ftplib.FTP.quit" title="ftplib.FTP.quit"><code class="xref py py-meth docutils literal">quit()</code></a>.

468

After this call the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a> instance should not be used any more (after

469

a call to <a class="reference internal" href="#ftplib.FTP.close" title="ftplib.FTP.close"><code class="xref py py-meth docutils literal">close()</code></a> or <a class="reference internal" href="#ftplib.FTP.quit" title="ftplib.FTP.quit"><code class="xref py py-meth docutils literal">quit()</code></a> you cannot reopen the

470

connection by issuing another <a class="reference internal" href="#ftplib.FTP.login" title="ftplib.FTP.login"><code class="xref py py-meth docutils literal">login()</code></a> method).

471

</dd></dl>

472

473

</div>

474

475

<h2>20.8.2. FTP_TLS Objects<a class="headerlink" href="#ftp-tls-objects" title="Permalink to this headline">¶</a></h2>

476

<a class="reference internal" href="#ftplib.FTP_TLS" title="ftplib.FTP_TLS"><code class="xref py py-class docutils literal">FTP_TLS</code></a> class inherits from <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal">FTP</code></a>, defining these additional objects:

477

478

479

<code class="descclassname">FTP_TLS.</code><code class="descname">ssl_version</code><a class="headerlink" href="#ftplib.FTP_TLS.ssl_version" title="Permalink to this definition">¶</a></dt>

480

<dd>The SSL version to use (defaults to <a class="reference internal" href="ssl.html#ssl.PROTOCOL_SSLv23" title="ssl.PROTOCOL_SSLv23"><code class="xref py py-attr docutils literal">ssl.PROTOCOL_SSLv23</code></a>).

481

</dd></dl>

482

483

484

485

486

<dd>Set up secure control connection by using TLS or SSL, depending on what

487

specified in <a class="reference internal" href="#ftplib.FTP_TLS.ssl_version" title="ftplib.FTP_TLS.ssl_version"><code class="xref py py-meth docutils literal">ssl_version()</code></a> attribute.

488

</dd></dl>

489

490

491

492

493

<dd>Set up secure data connection.

494

</dd></dl>

495

496

497

498

499

<dd>Set up clear text data connection.

500

</dd></dl>

501

502

</div>

503

</div>

504

505

506

</div>

507

</div>

508

</div>

509

510

511

<h3><a href="../contents.html">Table Of Contents</a></h3>

512

<ul>

513

<li><a class="reference internal" href="#">20.8. <code class="docutils literal">ftplib</code> — FTP protocol client</a><ul>

514

<li><a class="reference internal" href="#ftp-objects">20.8.1. FTP Objects</a></li>

515

<li><a class="reference internal" href="#ftp-tls-objects">20.8.2. FTP_TLS Objects</a></li>

516

</ul>

517

</li>

518

</ul>

519

520

<h4>Previous topic</h4>

521

<a href="httplib.html"

522

title="previous chapter">20.7. <code class="docutils literal">httplib</code> — HTTP protocol client</a>

523

<h4>Next topic</h4>

524

<a href="poplib.html"

525

title="next chapter">20.9. <code class="docutils literal">poplib</code> — POP3 protocol client</a>

526

527

528

<li><a href="../bugs.html">Report a Bug</a></li>

529

<li><a href="../_sources/library/ftplib.txt"

530

rel="nofollow">Show Source</a></li>

531

</ul>

532

533

534

<h3>Quick search</h3>

535

536

537

538

539

540

</form>

541

542

Enter search terms or a module, class or function name.

543

544

</div>

545

546

</div>

547

</div>

548

549

</div>

550

551

<h3>Navigation</h3>

552

<ul>

553

554

<a href="../genindex.html" title="General Index"

555

>index</a></li>

556

557

<a href="../py-modindex.html" title="Python Module Index"

558

>modules</a> |</li>

559

560

<a href="poplib.html" title="20.9. poplib — POP3 protocol client"

561

>next</a> |</li>

562

563

<a href="httplib.html" title="20.7. httplib — HTTP protocol client"

564

>previous</a> |</li>

565

<li><img src="../_static/py.png" alt=""

566

style="vertical-align: middle; margin-top: -1px"/></li>

567

<li><a href="https://www.python.org/">Python</a> »</li>

568

<li>

569

2.7.11

570

<a href="../index.html">Documentation</a> »

571

</li>

572

573

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>

574

<li class="nav-item nav-item-2"><a href="internet.html" >20. Internet Protocols and Support</a> »</li>

575

</ul>

576

</div>

577

578

579

580

The Python Software Foundation is a non-profit corporation.

581

<a href="https://www.python.org/psf/donations/">Please donate.</a>

582

583

Last updated on Jan 23, 2016.

584

<a href="../bugs.html">Found a bug</a>?

585

586

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.

587

</div>

588

589

</body>

590

</html>

b'\\ No newline at end of file'

Older »