Mr.Combet Webshell 🔥

Edit File Name : ftplib.html

<!DOCTYPE html>

<title>ftplib — FTP protocol client &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="poplib — POP3 protocol client" href="poplib.html" />
 <link rel="prev" title="http.client — HTTP protocol client" href="http.client.html" />
 <link rel="canonical" href="https://docs.python.org/3/library/ftplib.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <input type="submit" value="Go"/>
 </form>
 
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">ftplib</code> — FTP protocol client</a><ul>
<li><a class="reference internal" href="#reference">Reference</a><ul>
<li><a class="reference internal" href="#ftp-objects">FTP objects</a></li>
<li><a class="reference internal" href="#ftp-tls-objects">FTP_TLS objects</a></li>
<li><a class="reference internal" href="#module-variables">Module variables</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="http.client.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">http.client</code> — HTTP protocol client</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="poplib.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">poplib</code> — POP3 protocol client</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/main/Doc/library/ftplib.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="poplib.html" title="poplib — POP3 protocol client"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="http.client.html" title="http.client — HTTP protocol client"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">ftplib</code> — FTP protocol client</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-ftplib">
<h1><a class="reference internal" href="#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate">ftplib</code></a> — FTP protocol client<a class="headerlink" href="#module-ftplib" title="Link to this heading">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/ftplib.py">Lib/ftplib.py</a>
<hr class="docutils" id="index-0" />
This module defines the class <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">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 notranslate">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.request.html#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</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://datatracker.ietf.org/doc/html/rfc959.html">RFC 959</a>.
The default encoding is UTF-8, following <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2640.html">RFC 2640</a>.
<div class="availability docutils container">
<a class="reference internal" href="intro.html#availability">Availability</a>: not Emscripten, not WASI.
This module does not work or is not available on WebAssembly platforms
<code class="docutils literal notranslate">wasm32-emscripten</code> and <code class="docutils literal notranslate">wasm32-wasi</code>. See
<a class="reference internal" href="intro.html#wasm-availability">WebAssembly platforms</a> for more information.
</div>
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 notranslate">ftplib</code></a> module:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from ftplib import FTP
&gt;&gt;&gt; ftp = FTP(&#39;ftp.us.debian.org&#39;) # connect to host, default port
&gt;&gt;&gt; ftp.login() # user anonymous, passwd anonymous@
&#39;230 Login successful.&#39;
&gt;&gt;&gt; ftp.cwd(&#39;debian&#39;) # change into &quot;debian&quot; directory
&#39;250 Directory successfully changed.&#39;
&gt;&gt;&gt; ftp.retrlines(&#39;LIST&#39;) # 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
&#39;226 Directory send OK.&#39;
&gt;&gt;&gt; with open(&#39;README&#39;, &#39;wb&#39;) as fp:
&gt;&gt;&gt; ftp.retrbinary(&#39;RETR README&#39;, fp.write)
&#39;226 Transfer complete.&#39;
&gt;&gt;&gt; ftp.quit()
&#39;221 Goodbye.&#39;
</pre></div>
</div>
<section id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Link to this heading">¶</a></h2>
<section id="ftp-objects">
<h3>FTP objects<a class="headerlink" href="#ftp-objects" title="Link to this heading">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="ftplib.FTP">
class ftplib.FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None, *, encoding='utf-8')<a class="headerlink" href="#ftplib.FTP" title="Link to this definition">¶</a></dt>
<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 notranslate">FTP</code></a> class.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>host (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The hostname to connect to.
If given, <code class="code docutils literal notranslate">connect(host)</code> is implicitly called by the constructor.</li>
<li>user (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The username to log in with (default: <code class="docutils literal notranslate">'anonymous'</code>).
If given, <code class="code docutils literal notranslate">login(host, passwd, acct)</code> is implicitly called
by the constructor.</li>
<li>passwd (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The password to use when logging in.
If not given, and if passwd is the empty string or <code class="docutils literal notranslate">&quot;-&quot;</code>,
a password will be automatically generated.</li>
<li>acct (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – Account information to be used for the <code class="docutils literal notranslate">ACCT</code> FTP command.
Few systems implement this.
See <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc959.html">RFC-959</a>
for more details.</li>
<li>timeout (<a class="reference internal" href="functions.html#float" title="float">float</a> | None) – A timeout in seconds for blocking operations like <a class="reference internal" href="#ftplib.FTP.connect" title="ftplib.FTP.connect"><code class="xref py py-meth docutils literal notranslate">connect()</code></a>
(default: the global default timeout setting).</li>
<li>source_address (<a class="reference internal" href="stdtypes.html#tuple" title="tuple">tuple</a> | None) – A 2-tuple <code class="docutils literal notranslate">(host, port)</code> for the socket to bind to as its
source address before connecting.</li>
<li>encoding (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The encoding for directories and filenames (default: <code class="docutils literal notranslate">'utf-8'</code>).</li>
</ul>
</dd>
</dl>
The <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> class supports the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, e.g.:
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from ftplib import FTP
&gt;&gt;&gt; with FTP(&quot;ftp1.at.proftpd.org&quot;) as ftp:
... ftp.login()
... ftp.dir()
... 
&#39;230 Anonymous login ok, restrictions apply.&#39;
dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
&gt;&gt;&gt;
</pre></div>
</div>
<div class="versionchanged">
Changed in version 3.2: Support for the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement was added.
</div>
<div class="versionchanged">
Changed in version 3.3: source_address parameter was added.
</div>
<div class="versionchanged">
Changed in version 3.9: If the timeout parameter is set to be zero, it will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-class docutils literal notranslate">ValueError</code></a> to prevent the creation of a non-blocking socket.
The encoding parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2640.html">RFC 2640</a>.
</div>
Several <code class="xref py py-class docutils literal notranslate">FTP</code> methods are available in two flavors:
one for handling text files and another for binary files.
The methods are named for the command which is used followed by
<code class="docutils literal notranslate">lines</code> for the text version or <code class="docutils literal notranslate">binary</code> for the binary version.
<a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> instances have the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.set_debuglevel">
set_debuglevel(level)<a class="headerlink" href="#ftplib.FTP.set_debuglevel" title="Link to this definition">¶</a></dt>
<dd>Set the instance’s debugging level as an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>.
This controls the amount of debugging output printed.
The debug levels are:
<ul class="simple">
<li><code class="docutils literal notranslate">0</code> (default): No debug output.</li>
<li><code class="docutils literal notranslate">1</code>: Produce a moderate amount of debug output,
generally a single line per request.</li>
<li><code class="docutils literal notranslate">2</code> or higher: Produce the maximum amount of debugging output,
logging each line sent and received on the control connection.</li>
</ul>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.connect">
connect(host='', port=0, timeout=None, source_address=None)<a class="headerlink" href="#ftplib.FTP.connect" title="Link to this definition">¶</a></dt>
<dd>Connect to the given host and port.
This function should be called only once for each instance;
it should not be called if a host argument was given
when the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> instance was created.
All other <code class="xref py py-class docutils literal notranslate">FTP</code> methods can only be called
after a connection has successfully been made.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>host (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The host to connect to.</li>
<li>port (<a class="reference internal" href="functions.html#int" title="int">int</a>) – The TCP port to connect to (default: <code class="docutils literal notranslate">21</code>,
as specified by the FTP protocol specification).
It is rarely needed to specify a different port number.</li>
<li>timeout (<a class="reference internal" href="functions.html#float" title="float">float</a> | None) – A timeout in seconds for the connection attempt
(default: the global default timeout setting).</li>
<li>source_address (<a class="reference internal" href="stdtypes.html#tuple" title="tuple">tuple</a> | None) – A 2-tuple <code class="docutils literal notranslate">(host, port)</code> for the socket to bind to as its
source address before connecting.</li>
</ul>
</dd>
</dl>
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">ftplib.connect</code> with arguments <code class="docutils literal notranslate">self</code>, <code class="docutils literal notranslate">host</code>, <code class="docutils literal notranslate">port</code>.
<div class="versionchanged">
Changed in version 3.3: source_address parameter was added.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.getwelcome">
getwelcome()<a class="headerlink" href="#ftplib.FTP.getwelcome" title="Link to this definition">¶</a></dt>
<dd>Return the welcome message sent by the server in reply to the initial
connection. (This message sometimes contains disclaimers or help information
that may be relevant to the user.)
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.login">
login(user='anonymous', passwd='', acct='')<a class="headerlink" href="#ftplib.FTP.login" title="Link to this definition">¶</a></dt>
<dd>Log on to the connected FTP server.
This function should be called only once for each instance,
after a connection has been established;
it should not be called if the host and user arguments were given
when the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> instance was created.
Most FTP commands are only allowed after the client has logged in.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>user (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The username to log in with (default: <code class="docutils literal notranslate">'anonymous'</code>).</li>
<li>passwd (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The password to use when logging in.
If not given, and if passwd is the empty string or <code class="docutils literal notranslate">&quot;-&quot;</code>,
a password will be automatically generated.</li>
<li>acct (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – Account information to be used for the <code class="docutils literal notranslate">ACCT</code> FTP command.
Few systems implement this.
See <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc959.html">RFC-959</a>
for more details.</li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.abort">
abort()<a class="headerlink" href="#ftplib.FTP.abort" title="Link to this definition">¶</a></dt>
<dd>Abort a file transfer that is in progress. Using this does not always work, but
it’s worth a try.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.sendcmd">
sendcmd(cmd)<a class="headerlink" href="#ftplib.FTP.sendcmd" title="Link to this definition">¶</a></dt>
<dd>Send a simple command string to the server and return the response string.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">ftplib.sendcmd</code> with arguments <code class="docutils literal notranslate">self</code>, <code class="docutils literal notranslate">cmd</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.voidcmd">
voidcmd(cmd)<a class="headerlink" href="#ftplib.FTP.voidcmd" title="Link to this definition">¶</a></dt>
<dd>Send a simple command string to the server and handle the response. Return
the response string if the response code corresponds to success (codes in
the range 200–299). Raise <a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal notranslate">error_reply</code></a> otherwise.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">ftplib.sendcmd</code> with arguments <code class="docutils literal notranslate">self</code>, <code class="docutils literal notranslate">cmd</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.retrbinary">
retrbinary(cmd, callback, blocksize=8192, rest=None)<a class="headerlink" href="#ftplib.FTP.retrbinary" title="Link to this definition">¶</a></dt>
<dd>Retrieve a file in binary transfer mode.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>cmd (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – An appropriate <code class="docutils literal notranslate">STOR</code> command: <code class="samp docutils literal notranslate">&quot;STOR filename&quot;</code>.</li>
<li>callback (<a class="reference internal" href="../glossary.html#term-callable">callable</a>) – A single parameter callable that is called
for each block of data received,
with its single argument being the data as <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>.</li>
<li>blocksize (<a class="reference internal" href="functions.html#int" title="int">int</a>) – The maximum chunk size to read on the low-level
<a class="reference internal" href="socket.html#socket.socket" title="socket.socket"><code class="xref py py-class docutils literal notranslate">socket</code></a> object created to do the actual transfer.
This also corresponds to the largest size of data
that will be passed to callback.
Defaults to <code class="docutils literal notranslate">8192</code>.</li>
<li>rest (<a class="reference internal" href="functions.html#int" title="int">int</a>) – A <code class="docutils literal notranslate">REST</code> command to be sent to the server.
See the documentation for the rest parameter of the <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal notranslate">transfercmd()</code></a> method.</li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.retrlines">
retrlines(cmd, callback=None)<a class="headerlink" href="#ftplib.FTP.retrlines" title="Link to this definition">¶</a></dt>
<dd>Retrieve a file or directory listing in the encoding specified by the
encoding parameter at initialization.
cmd should be an appropriate <code class="docutils literal notranslate">RETR</code> command (see <a class="reference internal" href="#ftplib.FTP.retrbinary" title="ftplib.FTP.retrbinary"><code class="xref py py-meth docutils literal notranslate">retrbinary()</code></a>) or
a command such as <code class="docutils literal notranslate">LIST</code> or <code class="docutils literal notranslate">NLST</code> (usually just the string <code class="docutils literal notranslate">'LIST'</code>).
<code class="docutils literal notranslate">LIST</code> retrieves a list of files and information about those files.
<code class="docutils literal notranslate">NLST</code> retrieves a list of file names.
The callback function is called for each line with a string argument
containing the line with the trailing CRLF stripped. The default callback
prints the line to <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.set_pasv">
set_pasv(val)<a class="headerlink" href="#ftplib.FTP.set_pasv" title="Link to this definition">¶</a></dt>
<dd>Enable “passive” mode if val is true, otherwise disable passive mode.
Passive mode is on by default.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.storbinary">
storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)<a class="headerlink" href="#ftplib.FTP.storbinary" title="Link to this definition">¶</a></dt>
<dd>Store a file in binary transfer mode.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>cmd (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – An appropriate <code class="docutils literal notranslate">STOR</code> command: <code class="samp docutils literal notranslate">&quot;STOR filename&quot;</code>.</li>
<li>fp (<a class="reference internal" href="../glossary.html#term-file-object">file object</a>) – A file object (opened in binary mode) which is read until EOF,
using its <a class="reference internal" href="io.html#io.RawIOBase.read" title="io.RawIOBase.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> method in blocks of size blocksize
to provide the data to be stored.</li>
<li>blocksize (<a class="reference internal" href="functions.html#int" title="int">int</a>) – The read block size.
Defaults to <code class="docutils literal notranslate">8192</code>.</li>
<li>callback (<a class="reference internal" href="../glossary.html#term-callable">callable</a>) – A single parameter callable that is called
for each block of data sent,
with its single argument being the data as <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>.</li>
<li>rest (<a class="reference internal" href="functions.html#int" title="int">int</a>) – A <code class="docutils literal notranslate">REST</code> command to be sent to the server.
See the documentation for the rest parameter of the <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal notranslate">transfercmd()</code></a> method.</li>
</ul>
</dd>
</dl>
<div class="versionchanged">
Changed in version 3.2: The rest parameter was added.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.storlines">
storlines(cmd, fp, callback=None)<a class="headerlink" href="#ftplib.FTP.storlines" title="Link to this definition">¶</a></dt>
<dd>Store a file in line mode. cmd should be an appropriate
<code class="docutils literal notranslate">STOR</code> command (see <a class="reference internal" href="#ftplib.FTP.storbinary" title="ftplib.FTP.storbinary"><code class="xref py py-meth docutils literal notranslate">storbinary()</code></a>). Lines are read until EOF from the
<a class="reference internal" href="../glossary.html#term-file-object">file object</a> fp (opened in binary mode) using its <a class="reference internal" href="io.html#io.IOBase.readline" title="io.IOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a>
method to provide the data to be stored. callback is an optional single
parameter callable that is called on each line after it is sent.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.transfercmd">
transfercmd(cmd, rest=None)<a class="headerlink" href="#ftplib.FTP.transfercmd" title="Link to this definition">¶</a></dt>
<dd>Initiate a transfer over the data connection. If the transfer is active, send an
<code class="docutils literal notranslate">EPRT</code> or <code class="docutils literal notranslate">PORT</code> command and the transfer command specified by cmd, and
accept the connection. If the server is passive, send an <code class="docutils literal notranslate">EPSV</code> or <code class="docutils literal notranslate">PASV</code>
command, connect to it, and start the transfer command. Either way, return the
socket for the connection.
If optional rest is given, a <code class="docutils literal notranslate">REST</code> command is sent to the server, passing
rest as an argument. rest is usually a byte offset into the requested file,
telling the server to restart sending the file’s bytes at the requested offset,
skipping over the initial bytes. Note however that the <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal notranslate">transfercmd()</code></a>
method converts rest to a string with the encoding parameter specified
at initialization, but no check is performed on the string’s contents. If the
server does not recognize the <code class="docutils literal notranslate">REST</code> command, an <a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal notranslate">error_reply</code></a> exception
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 notranslate">transfercmd()</code></a> without a
rest argument.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.ntransfercmd">
ntransfercmd(cmd, rest=None)<a class="headerlink" href="#ftplib.FTP.ntransfercmd" title="Link to this definition">¶</a></dt>
<dd>Like <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal notranslate">transfercmd()</code></a>, but returns a tuple of the data connection and the
expected size of the data. If the expected size could not be computed, <code class="docutils literal notranslate">None</code>
will be returned as the expected size. cmd and rest means the same thing as
in <a class="reference internal" href="#ftplib.FTP.transfercmd" title="ftplib.FTP.transfercmd"><code class="xref py py-meth docutils literal notranslate">transfercmd()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.mlsd">
mlsd(path='', facts=[])<a class="headerlink" href="#ftplib.FTP.mlsd" title="Link to this definition">¶</a></dt>
<dd>List a directory in a standardized format by using <code class="docutils literal notranslate">MLSD</code> command
(<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3659.html">RFC 3659</a>). If path is omitted the current directory is assumed.
facts is a list of strings representing the type of information desired
(e.g. <code class="docutils literal notranslate">[&quot;type&quot;, &quot;size&quot;, &quot;perm&quot;]</code>). Return a generator object yielding a
tuple of two elements for every file found in path. First element is the
file name, the second one is a dictionary containing facts about the file
name. Content of this dictionary might be limited by the facts argument
but server is not guaranteed to return all requested facts.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.nlst">
nlst(argument[, ...])<a class="headerlink" href="#ftplib.FTP.nlst" title="Link to this definition">¶</a></dt>
<dd>Return a list of file names as returned by the <code class="docutils literal notranslate">NLST</code> command. The
optional argument is a directory to list (default is the current server
directory). Multiple arguments can be used to pass non-standard options to
the <code class="docutils literal notranslate">NLST</code> command.
<div class="admonition note">
Note
If your server supports the command, <a class="reference internal" href="#ftplib.FTP.mlsd" title="ftplib.FTP.mlsd"><code class="xref py py-meth docutils literal notranslate">mlsd()</code></a> offers a better API.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.dir">
dir(argument[, ...])<a class="headerlink" href="#ftplib.FTP.dir" title="Link to this definition">¶</a></dt>
<dd>Produce a directory listing as returned by the <code class="docutils literal notranslate">LIST</code> command, printing it to
standard output. The optional argument is a directory to list (default is the
current server directory). Multiple arguments can be used to pass non-standard
options to the <code class="docutils literal notranslate">LIST</code> command. If the last argument is a function, it is used
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 notranslate">retrlines()</code></a>; the default prints to
<a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a>. This method returns <code class="docutils literal notranslate">None</code>.
<div class="admonition note">
Note
If your server supports the command, <a class="reference internal" href="#ftplib.FTP.mlsd" title="ftplib.FTP.mlsd"><code class="xref py py-meth docutils literal notranslate">mlsd()</code></a> offers a better API.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.rename">
rename(fromname, toname)<a class="headerlink" href="#ftplib.FTP.rename" title="Link to this definition">¶</a></dt>
<dd>Rename file fromname on the server to toname.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.delete">
delete(filename)<a class="headerlink" href="#ftplib.FTP.delete" title="Link to this definition">¶</a></dt>
<dd>Remove the file named filename from the server. If successful, returns the
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 notranslate">error_perm</code></a> on permission errors or
<a class="reference internal" href="#ftplib.error_reply" title="ftplib.error_reply"><code class="xref py py-exc docutils literal notranslate">error_reply</code></a> on other errors.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.cwd">
cwd(pathname)<a class="headerlink" href="#ftplib.FTP.cwd" title="Link to this definition">¶</a></dt>
<dd>Set the current directory on the server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.mkd">
mkd(pathname)<a class="headerlink" href="#ftplib.FTP.mkd" title="Link to this definition">¶</a></dt>
<dd>Create a new directory on the server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.pwd">
pwd()<a class="headerlink" href="#ftplib.FTP.pwd" title="Link to this definition">¶</a></dt>
<dd>Return the pathname of the current directory on the server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.rmd">
rmd(dirname)<a class="headerlink" href="#ftplib.FTP.rmd" title="Link to this definition">¶</a></dt>
<dd>Remove the directory named dirname on the server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.size">
size(filename)<a class="headerlink" href="#ftplib.FTP.size" title="Link to this definition">¶</a></dt>
<dd>Request the size of the file named filename on the server. On success, the
size of the file is returned as an integer, otherwise <code class="docutils literal notranslate">None</code> is returned.
Note that the <code class="docutils literal notranslate">SIZE</code> command is not standardized, but is supported by many
common server implementations.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.quit">
quit()<a class="headerlink" href="#ftplib.FTP.quit" title="Link to this definition">¶</a></dt>
<dd>Send a <code class="docutils literal notranslate">QUIT</code> command to the server and close the connection. This is the
“polite” way to close a connection, but it may raise an exception if the server
responds with an error to the <code class="docutils literal notranslate">QUIT</code> command. This implies a call to the
<a class="reference internal" href="#ftplib.FTP.close" title="ftplib.FTP.close"><code class="xref py py-meth docutils literal notranslate">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 notranslate">FTP</code></a> instance useless for
subsequent calls (see below).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP.close">
close()<a class="headerlink" href="#ftplib.FTP.close" title="Link to this definition">¶</a></dt>
<dd>Close the connection unilaterally. This should not be applied to an already
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 notranslate">quit()</code></a>.
After this call the <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> instance should not be used any more (after
a call to <a class="reference internal" href="#ftplib.FTP.close" title="ftplib.FTP.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> or <a class="reference internal" href="#ftplib.FTP.quit" title="ftplib.FTP.quit"><code class="xref py py-meth docutils literal notranslate">quit()</code></a> you cannot reopen the
connection by issuing another <a class="reference internal" href="#ftplib.FTP.login" title="ftplib.FTP.login"><code class="xref py py-meth docutils literal notranslate">login()</code></a> method).
</dd></dl>

</dd></dl>

</section>
<section id="ftp-tls-objects">
<h3>FTP_TLS objects<a class="headerlink" href="#ftp-tls-objects" title="Link to this heading">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="ftplib.FTP_TLS">
class ftplib.FTP_TLS(host='', user='', passwd='', acct='', *, context=None, timeout=None, source_address=None, encoding='utf-8')<a class="headerlink" href="#ftplib.FTP_TLS" title="Link to this definition">¶</a></dt>
<dd>An <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a> subclass which adds TLS support to FTP as described in
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4217.html">RFC 4217</a>.
Connect to port 21 implicitly securing the FTP control connection
before authenticating.
<div class="admonition note">
Note
The user must explicitly secure the data connection
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 notranslate">prot_p()</code></a> method.
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>host (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The hostname to connect to.
If given, <code class="code docutils literal notranslate">connect(host)</code> is implicitly called by the constructor.</li>
<li>user (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The username to log in with (default: <code class="docutils literal notranslate">'anonymous'</code>).
If given, <code class="code docutils literal notranslate">login(host, passwd, acct)</code> is implicitly called
by the constructor.</li>
<li>passwd (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The password to use when logging in.
If not given, and if passwd is the empty string or <code class="docutils literal notranslate">&quot;-&quot;</code>,
a password will be automatically generated.</li>
<li>acct (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – Account information to be used for the <code class="docutils literal notranslate">ACCT</code> FTP command.
Few systems implement this.
See <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc959.html">RFC-959</a>
for more details.</li>
<li>context (<a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate">ssl.SSLContext</code></a>) – An SSL context object which allows bundling SSL configuration options,
certificates and private keys into a single, potentially long-lived,
structure.
Please read <a class="reference internal" href="ssl.html#ssl-security">Security considerations</a> for best practices.</li>
<li>timeout (<a class="reference internal" href="functions.html#float" title="float">float</a> | None) – A timeout in seconds for blocking operations like <a class="reference internal" href="#ftplib.FTP.connect" title="ftplib.FTP.connect"><code class="xref py py-meth docutils literal notranslate">connect()</code></a>
(default: the global default timeout setting).</li>
<li>source_address (<a class="reference internal" href="stdtypes.html#tuple" title="tuple">tuple</a> | None) – A 2-tuple <code class="docutils literal notranslate">(host, port)</code> for the socket to bind to as its
source address before connecting.</li>
<li>encoding (<a class="reference internal" href="stdtypes.html#str" title="str">str</a>) – The encoding for directories and filenames (default: <code class="docutils literal notranslate">'utf-8'</code>).</li>
</ul>
</dd>
</dl>
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.3: Added the source_address parameter.
</div>
<div class="versionchanged">
Changed in version 3.4: The class now supports hostname check with
<a class="reference internal" href="ssl.html#ssl.SSLContext.check_hostname" title="ssl.SSLContext.check_hostname"><code class="xref py py-attr docutils literal notranslate">ssl.SSLContext.check_hostname</code></a> and Server Name Indication (see
<a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-const docutils literal notranslate">ssl.HAS_SNI</code></a>).
</div>
<div class="versionchanged">
Changed in version 3.9: If the timeout parameter is set to be zero, it will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-class docutils literal notranslate">ValueError</code></a> to prevent the creation of a non-blocking socket.
The encoding parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2640.html">RFC 2640</a>.
</div>
<div class="versionchanged">
Changed in version 3.12: The deprecated keyfile and certfile parameters have been removed.
</div>
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 notranslate">FTP_TLS</code></a> class:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ftps = FTP_TLS(&#39;ftp.pureftpd.org&#39;)
&gt;&gt;&gt; ftps.login()
&#39;230 Anonymous user logged in&#39;
&gt;&gt;&gt; ftps.prot_p()
&#39;200 Data protection level set to &quot;private&quot;&#39;
&gt;&gt;&gt; ftps.nlst()
[&#39;6jack&#39;, &#39;OpenBSD&#39;, &#39;antilink&#39;, &#39;blogbench&#39;, &#39;bsdcam&#39;, &#39;clockspeed&#39;, &#39;djbdns-jedi&#39;, &#39;docs&#39;, &#39;eaccelerator-jedi&#39;, &#39;favicon.ico&#39;, &#39;francotone&#39;, &#39;fugu&#39;, &#39;ignore&#39;, &#39;libpuzzle&#39;, &#39;metalog&#39;, &#39;minidentd&#39;, &#39;misc&#39;, &#39;mysql-udf-global-user-variables&#39;, &#39;php-jenkins-hash&#39;, &#39;php-skein-hash&#39;, &#39;php-webdav&#39;, &#39;phpaudit&#39;, &#39;phpbench&#39;, &#39;pincaster&#39;, &#39;ping&#39;, &#39;posto&#39;, &#39;pub&#39;, &#39;public&#39;, &#39;public_keys&#39;, &#39;pure-ftpd&#39;, &#39;qscan&#39;, &#39;qtc&#39;, &#39;sharedance&#39;, &#39;skycache&#39;, &#39;sound&#39;, &#39;tmp&#39;, &#39;ucarp&#39;]
</pre></div>
</div>
<code class="xref py py-class docutils literal notranslate">FTP_TLS</code> class inherits from <a class="reference internal" href="#ftplib.FTP" title="ftplib.FTP"><code class="xref py py-class docutils literal notranslate">FTP</code></a>,
defining these additional methods and attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="ftplib.FTP_TLS.ssl_version">
ssl_version<a class="headerlink" href="#ftplib.FTP_TLS.ssl_version" title="Link to this definition">¶</a></dt>
<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-data docutils literal notranslate">ssl.PROTOCOL_SSLv23</code></a>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP_TLS.auth">
auth()<a class="headerlink" href="#ftplib.FTP_TLS.auth" title="Link to this definition">¶</a></dt>
<dd>Set up a secure control connection by using TLS or SSL, depending on what
is specified in the <a class="reference internal" href="#ftplib.FTP_TLS.ssl_version" title="ftplib.FTP_TLS.ssl_version"><code class="xref py py-attr docutils literal notranslate">ssl_version</code></a> attribute.
<div class="versionchanged">
Changed in version 3.4: The method now supports hostname check with
<a class="reference internal" href="ssl.html#ssl.SSLContext.check_hostname" title="ssl.SSLContext.check_hostname"><code class="xref py py-attr docutils literal notranslate">ssl.SSLContext.check_hostname</code></a> and Server Name Indication (see
<a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-const docutils literal notranslate">ssl.HAS_SNI</code></a>).
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP_TLS.ccc">
ccc()<a class="headerlink" href="#ftplib.FTP_TLS.ccc" title="Link to this definition">¶</a></dt>
<dd>Revert control channel back to plaintext. This can be useful to take
advantage of firewalls that know how to handle NAT with non-secure FTP
without opening fixed ports.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP_TLS.prot_p">
prot_p()<a class="headerlink" href="#ftplib.FTP_TLS.prot_p" title="Link to this definition">¶</a></dt>
<dd>Set up secure data connection.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ftplib.FTP_TLS.prot_c">
prot_c()<a class="headerlink" href="#ftplib.FTP_TLS.prot_c" title="Link to this definition">¶</a></dt>
<dd>Set up clear text data connection.
</dd></dl>

</dd></dl>

</section>
<section id="module-variables">
<h3>Module variables<a class="headerlink" href="#module-variables" title="Link to this heading">¶</a></h3>
<dl class="py exception">
<dt class="sig sig-object py" id="ftplib.error_reply">
exception ftplib.error_reply<a class="headerlink" href="#ftplib.error_reply" title="Link to this definition">¶</a></dt>
<dd>Exception raised when an unexpected reply is received from the server.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ftplib.error_temp">
exception ftplib.error_temp<a class="headerlink" href="#ftplib.error_temp" title="Link to this definition">¶</a></dt>
<dd>Exception raised when an error code signifying a temporary error (response
codes in the range 400–499) is received.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ftplib.error_perm">
exception ftplib.error_perm<a class="headerlink" href="#ftplib.error_perm" title="Link to this definition">¶</a></dt>
<dd>Exception raised when an error code signifying a permanent error (response
codes in the range 500–599) is received.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ftplib.error_proto">
exception ftplib.error_proto<a class="headerlink" href="#ftplib.error_proto" title="Link to this definition">¶</a></dt>
<dd>Exception raised when a reply is received from the server that does not fit
the response specifications of the File Transfer Protocol, i.e. begin with a
digit in the range 1–5.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="ftplib.all_errors">
ftplib.all_errors<a class="headerlink" href="#ftplib.all_errors" title="Link to this definition">¶</a></dt>
<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 notranslate">FTP</code></a>
instances may raise as a result of problems with the FTP connection (as
opposed to programming errors made by the caller). This set includes the
four exceptions listed above as well as <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> and <a class="reference internal" href="exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>.
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<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 notranslate">netrc</code></a></dt><dd>Parser for the <code class="file docutils literal notranslate">.netrc</code> file format. The file <code class="file docutils literal notranslate">.netrc</code> is
typically used by FTP clients to load user authentication information
before prompting the user.
</dd>
</dl>
</div>
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">ftplib</code> — FTP protocol client</a><ul>
<li><a class="reference internal" href="#reference">Reference</a><ul>
<li><a class="reference internal" href="#ftp-objects">FTP objects</a></li>
<li><a class="reference internal" href="#ftp-tls-objects">FTP_TLS objects</a></li>
<li><a class="reference internal" href="#module-variables">Module variables</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="poplib.html" title="poplib — POP3 protocol client"
 >next</a> |</li>
 <li class="right" >
 <a href="http.client.html" title="http.client — HTTP protocol client"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">ftplib</code> — FTP protocol client</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 
 Last updated on Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>

</body>
</html>