Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Obserwuj 1
Polub 0
Wiki 捐赠
gooderp18绿色标准版
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
Gałąź: master
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/nntplib.html

933 lines
88KB
Czysty Bezpośredni odnośnik Wina Historia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="nntplib — NNTP protocol client" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/nntplib.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/nntplib.py This module defines the class NNTP which implements the client side of the Network News Transfer Protocol. It can be used to implement a news reader or poster, or automa..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/nntplib.py This module defines the class NNTP which implements the client side of the Network News Transfer Protocol. It can be used to implement a news reader or poster, or automa..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>nntplib — NNTP protocol client &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="optparse — Parser for command line options" href="optparse.html" />

  39.     <link rel="prev" title="nis — Interface to Sun’s NIS (Yellow Pages)" href="nis.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/nntplib.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <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>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

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

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code> — NNTP protocol client</a><ul>

  99. <li><a class="reference internal" href="#nntp-objects">NNTP Objects</a><ul>

  100. <li><a class="reference internal" href="#attributes">Attributes</a></li>

  101. <li><a class="reference internal" href="#methods">Methods</a></li>

  102. </ul>

  103. </li>

  104. <li><a class="reference internal" href="#utility-functions">Utility functions</a></li>

  105. </ul>

  106. </li>

  107. </ul>

  108. 

  109.   </div>

  110.   <div>

  111.     <h4>Previous topic</h4>

  112.     <p class="topless"><a href="nis.html"

  113.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nis</span></code> — Interface to Sun’s NIS (Yellow Pages)</a></p>

  114.   </div>

  115.   <div>

  116.     <h4>Next topic</h4>

  117.     <p class="topless"><a href="optparse.html"

  118.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">optparse</span></code> — Parser for command line options</a></p>

  119.   </div>

  120.   <div role="note" aria-label="source link">

  121.     <h3>This Page</h3>

  122.     <ul class="this-page-menu">

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

  124.       <li>

  125.         <a href="https://github.com/python/cpython/blob/main/Doc/library/nntplib.rst"

  126.             rel="nofollow">Show Source

  127.         </a>

  128.       </li>

  129.     </ul>

  130.   </div>

  131.         </nav>

  132.     </div>

  133. </div>

  134. 

  135.   

  136.     <div class="related" role="navigation" aria-label="related navigation">

  137.       <h3>Navigation</h3>

  138.       <ul>

  139.         <li class="right" style="margin-right: 10px">

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

  141.              accesskey="I">index</a></li>

  142.         <li class="right" >

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

  144.              >modules</a> |</li>

  145.         <li class="right" >

  146.           <a href="optparse.html" title="optparse — Parser for command line options"

  147.              accesskey="N">next</a> |</li>

  148.         <li class="right" >

  149.           <a href="nis.html" title="nis — Interface to Sun’s NIS (Yellow Pages)"

  150.              accesskey="P">previous</a> |</li>

  151. 

  152.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  153.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  154.           <li class="switchers">

  155.             <div class="language_switcher_placeholder"></div>

  156.             <div class="version_switcher_placeholder"></div>

  157.           </li>

  158.           <li>

  159.               

  160.           </li>

  161.     <li id="cpython-language-and-version">

  162.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  163.     </li>

  164. 

  165.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  166.           <li class="nav-item nav-item-2"><a href="superseded.html" accesskey="U">Superseded Modules</a> &#187;</li>

  167.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code> — NNTP protocol client</a></li>

  168.                 <li class="right">

  169.                     

  170. 

  171.     <div class="inline-search" role="search">

  172.         <form class="inline-search" action="../search.html" method="get">

  173.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  174.           <input type="submit" value="Go" />

  175.         </form>

  176.     </div>

  177.                      |

  178.                 </li>

  179.             <li class="right">

  180. <label class="theme-selector-label">

  181.     Theme

  182.     <select class="theme-selector" oninput="activateTheme(this.value)">

  183.         <option value="auto" selected>Auto</option>

  184.         <option value="light">Light</option>

  185.         <option value="dark">Dark</option>

  186.     </select>

  187. </label> |</li>

  188.             

  189.       </ul>

  190.     </div>    

  191. 

  192.     <div class="document">

  193.       <div class="documentwrapper">

  194.         <div class="bodywrapper">

  195.           <div class="body" role="main">

  196.             

  197.   <section id="module-nntplib">

  198. <span id="nntplib-nntp-protocol-client"></span><h1><a class="reference internal" href="#module-nntplib" title="nntplib: NNTP protocol client (requires sockets). (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code></a> — NNTP protocol client<a class="headerlink" href="#module-nntplib" title="Link to this heading">¶</a></h1>

  199. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/nntplib.py">Lib/nntplib.py</a></p>

  200. <div class="deprecated" id="index-0">

  201. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>The <a class="reference internal" href="#module-nntplib" title="nntplib: NNTP protocol client (requires sockets). (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code></a> module is deprecated (see <span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0594/"><strong>PEP 594</strong></a> for details).</p>

  202. </div>

  203. <hr class="docutils" />

  204. <p>This module defines the class <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> which implements the client side of

  205. the Network News Transfer Protocol.  It can be used to implement a news reader

  206. or poster, or automated news processors.  It is compatible with <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3977.html"><strong>RFC 3977</strong></a>

  207. as well as the older <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc977.html"><strong>RFC 977</strong></a> and <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2980.html"><strong>RFC 2980</strong></a>.</p>

  208. <div class="availability docutils container">

  209. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: not Emscripten, not WASI.</p>

  210. <p>This module does not work or is not available on WebAssembly platforms

  211. <code class="docutils literal notranslate"><span class="pre">wasm32-emscripten</span></code> and <code class="docutils literal notranslate"><span class="pre">wasm32-wasi</span></code>. See

  212. <a class="reference internal" href="intro.html#wasm-availability"><span class="std std-ref">WebAssembly platforms</span></a> for more information.</p>

  213. </div>

  214. <p>Here are two small examples of how it can be used.  To list some statistics

  215. about a newsgroup and print the subjects of the last 10 articles:</p>

  216. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">nntplib</span><span class="o">.</span><span class="n">NNTP</span><span class="p">(</span><span class="s1">&#39;news.gmane.io&#39;</span><span class="p">)</span>

  217. <span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;gmane.comp.python.committers&#39;</span><span class="p">)</span>

  218. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Group&#39;</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="s1">&#39;has&#39;</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="s1">&#39;articles, range&#39;</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="s1">&#39;to&#39;</span><span class="p">,</span> <span class="n">last</span><span class="p">)</span>

  219. <span class="go">Group gmane.comp.python.committers has 1096 articles, range 1 to 1096</span>

  220. <span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">overviews</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">over</span><span class="p">((</span><span class="n">last</span> <span class="o">-</span> <span class="mi">9</span><span class="p">,</span> <span class="n">last</span><span class="p">))</span>

  221. <span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="nb">id</span><span class="p">,</span> <span class="n">over</span> <span class="ow">in</span> <span class="n">overviews</span><span class="p">:</span>

  222. <span class="gp">... </span>    <span class="nb">print</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="n">nntplib</span><span class="o">.</span><span class="n">decode_header</span><span class="p">(</span><span class="n">over</span><span class="p">[</span><span class="s1">&#39;subject&#39;</span><span class="p">]))</span>

  223. <span class="gp">...</span>

  224. <span class="go">1087 Re: Commit privileges for Łukasz Langa</span>

  225. <span class="go">1088 Re: 3.2 alpha 2 freeze</span>

  226. <span class="go">1089 Re: 3.2 alpha 2 freeze</span>

  227. <span class="go">1090 Re: Commit privileges for Łukasz Langa</span>

  228. <span class="go">1091 Re: Commit privileges for Łukasz Langa</span>

  229. <span class="go">1092 Updated ssh key</span>

  230. <span class="go">1093 Re: Updated ssh key</span>

  231. <span class="go">1094 Re: Updated ssh key</span>

  232. <span class="go">1095 Hello fellow committers!</span>

  233. <span class="go">1096 Re: Hello fellow committers!</span>

  234. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>

  235. <span class="go">&#39;205 Bye!&#39;</span>

  236. </pre></div>

  237. </div>

  238. <p>To post an article from a binary file (this assumes that the article has valid

  239. headers, and that you have right to post on the particular newsgroup):</p>

  240. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">nntplib</span><span class="o">.</span><span class="n">NNTP</span><span class="p">(</span><span class="s1">&#39;news.gmane.io&#39;</span><span class="p">)</span>

  241. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;article.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span>

  242. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>

  243. <span class="go">&#39;240 Article posted successfully.&#39;</span>

  244. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>

  245. <span class="go">&#39;205 Bye!&#39;</span>

  246. </pre></div>

  247. </div>

  248. <p>The module itself defines the following classes:</p>

  249. <dl class="py class">

  250. <dt class="sig sig-object py" id="nntplib.NNTP">

  251. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port=119</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readermode=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usenetrc=False</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP" title="Link to this definition">¶</a></dt>

  252. <dd><p>Return a new <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> object, representing a connection

  253. to the NNTP server running on host <em>host</em>, listening at port <em>port</em>.

  254. An optional <em>timeout</em> can be specified for the socket connection.

  255. If the optional <em>user</em> and <em>password</em> are provided, or if suitable

  256. credentials are present in <code class="file docutils literal notranslate"><span class="pre">/.netrc</span></code> and the optional flag <em>usenetrc</em>

  257. is true, the <code class="docutils literal notranslate"><span class="pre">AUTHINFO</span> <span class="pre">USER</span></code> and <code class="docutils literal notranslate"><span class="pre">AUTHINFO</span> <span class="pre">PASS</span></code> commands are used

  258. to identify and authenticate the user to the server.  If the optional

  259. flag <em>readermode</em> is true, then a <code class="docutils literal notranslate"><span class="pre">mode</span> <span class="pre">reader</span></code> command is sent before

  260. authentication is performed.  Reader mode is sometimes necessary if you are

  261. connecting to an NNTP server on the local machine and intend to call

  262. reader-specific commands, such as <code class="docutils literal notranslate"><span class="pre">group</span></code>.  If you get unexpected

  263. <a class="reference internal" href="#nntplib.NNTPPermanentError" title="nntplib.NNTPPermanentError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NNTPPermanentError</span></code></a>s, you might need to set <em>readermode</em>.

  264. The <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> class supports the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement to

  265. unconditionally consume <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> exceptions and to close the NNTP

  266. connection when done, e.g.:</p>

  267. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">nntplib</span> <span class="kn">import</span> <span class="n">NNTP</span>

  268. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">NNTP</span><span class="p">(</span><span class="s1">&#39;news.gmane.io&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">n</span><span class="p">:</span>

  269. <span class="gp">... </span>    <span class="n">n</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;gmane.comp.python.committers&#39;</span><span class="p">)</span>

  270. <span class="gp">... </span>

  271. <span class="go">(&#39;211 1755 1 1755 gmane.comp.python.committers&#39;, 1755, 1, 1755, &#39;gmane.comp.python.committers&#39;)</span>

  272. <span class="gp">&gt;&gt;&gt;</span>

  273. </pre></div>

  274. </div>

  275. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">nntplib.connect</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">host</span></code>, <code class="docutils literal notranslate"><span class="pre">port</span></code>.</p>

  276. <p class="audit-hook"><p>All commands will raise an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a>

  277. <code class="docutils literal notranslate"><span class="pre">nntplib.putline</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code> and <code class="docutils literal notranslate"><span class="pre">line</span></code>,

  278. where <code class="docutils literal notranslate"><span class="pre">line</span></code> is the bytes about to be sent to the remote host.</p>

  279. </p>

  280. <div class="versionchanged">

  281. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>usenetrc</em> is now <code class="docutils literal notranslate"><span class="pre">False</span></code> by default.</p>

  282. </div>

  283. <div class="versionchanged">

  284. <p><span class="versionmodified changed">Changed in version 3.3: </span>Support for the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement was added.</p>

  285. </div>

  286. <div class="versionchanged">

  287. <p><span class="versionmodified changed">Changed in version 3.9: </span>If the <em>timeout</em> parameter is set to be zero, it will raise a

  288. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a> to prevent the creation of a non-blocking socket.</p>

  289. </div>

  290. </dd></dl>

  291. 

  292. <dl class="py class">

  293. <dt class="sig sig-object py" id="nntplib.NNTP_SSL">

  294. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTP_SSL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port=563</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_context=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readermode=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usenetrc=False</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP_SSL" title="Link to this definition">¶</a></dt>

  295. <dd><p>Return a new <a class="reference internal" href="#nntplib.NNTP_SSL" title="nntplib.NNTP_SSL"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP_SSL</span></code></a> object, representing an encrypted

  296. connection to the NNTP server running on host <em>host</em>, listening at

  297. port <em>port</em>.  <a class="reference internal" href="#nntplib.NNTP_SSL" title="nntplib.NNTP_SSL"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP_SSL</span></code></a> objects have the same methods as

  298. <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> objects.  If <em>port</em> is omitted, port 563 (NNTPS) is used.

  299. <em>ssl_context</em> is also optional, and is a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSLContext</span></code></a> object.

  300. Please read <a class="reference internal" href="ssl.html#ssl-security"><span class="std std-ref">Security considerations</span></a> for best practices.

  301. All other parameters behave the same as for <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a>.</p>

  302. <p>Note that SSL-on-563 is discouraged per <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4642.html"><strong>RFC 4642</strong></a>, in favor of

  303. STARTTLS as described below.  However, some servers only support the

  304. former.</p>

  305. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">nntplib.connect</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">host</span></code>, <code class="docutils literal notranslate"><span class="pre">port</span></code>.</p>

  306. <p class="audit-hook"><p>All commands will raise an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a>

  307. <code class="docutils literal notranslate"><span class="pre">nntplib.putline</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code> and <code class="docutils literal notranslate"><span class="pre">line</span></code>,

  308. where <code class="docutils literal notranslate"><span class="pre">line</span></code> is the bytes about to be sent to the remote host.</p>

  309. </p>

  310. <div class="versionadded">

  311. <p><span class="versionmodified added">New in version 3.2.</span></p>

  312. </div>

  313. <div class="versionchanged">

  314. <p><span class="versionmodified changed">Changed in version 3.4: </span>The class now supports hostname check with

  315. <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"><span class="pre">ssl.SSLContext.check_hostname</span></code></a> and <em>Server Name Indication</em> (see

  316. <a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-data docutils literal notranslate"><span class="pre">ssl.HAS_SNI</span></code></a>).</p>

  317. </div>

  318. <div class="versionchanged">

  319. <p><span class="versionmodified changed">Changed in version 3.9: </span>If the <em>timeout</em> parameter is set to be zero, it will raise a

  320. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a> to prevent the creation of a non-blocking socket.</p>

  321. </div>

  322. </dd></dl>

  323. 

  324. <dl class="py exception">

  325. <dt class="sig sig-object py" id="nntplib.NNTPError">

  326. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPError</span></span><a class="headerlink" href="#nntplib.NNTPError" title="Link to this definition">¶</a></dt>

  327. <dd><p>Derived from the standard exception <a class="reference internal" href="exceptions.html#Exception" title="Exception"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Exception</span></code></a>, this is the base

  328. class for all exceptions raised by the <a class="reference internal" href="#module-nntplib" title="nntplib: NNTP protocol client (requires sockets). (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code></a> module.  Instances

  329. of this class have the following attribute:</p>

  330. <dl class="py attribute">

  331. <dt class="sig sig-object py" id="nntplib.NNTPError.response">

  332. <span class="sig-name descname"><span class="pre">response</span></span><a class="headerlink" href="#nntplib.NNTPError.response" title="Link to this definition">¶</a></dt>

  333. <dd><p>The response of the server if available, as a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> object.</p>

  334. </dd></dl>

  335. 

  336. </dd></dl>

  337. 

  338. <dl class="py exception">

  339. <dt class="sig sig-object py" id="nntplib.NNTPReplyError">

  340. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPReplyError</span></span><a class="headerlink" href="#nntplib.NNTPReplyError" title="Link to this definition">¶</a></dt>

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

  342. </dd></dl>

  343. 

  344. <dl class="py exception">

  345. <dt class="sig sig-object py" id="nntplib.NNTPTemporaryError">

  346. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPTemporaryError</span></span><a class="headerlink" href="#nntplib.NNTPTemporaryError" title="Link to this definition">¶</a></dt>

  347. <dd><p>Exception raised when a response code in the range 400–499 is received.</p>

  348. </dd></dl>

  349. 

  350. <dl class="py exception">

  351. <dt class="sig sig-object py" id="nntplib.NNTPPermanentError">

  352. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPPermanentError</span></span><a class="headerlink" href="#nntplib.NNTPPermanentError" title="Link to this definition">¶</a></dt>

  353. <dd><p>Exception raised when a response code in the range 500–599 is received.</p>

  354. </dd></dl>

  355. 

  356. <dl class="py exception">

  357. <dt class="sig sig-object py" id="nntplib.NNTPProtocolError">

  358. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPProtocolError</span></span><a class="headerlink" href="#nntplib.NNTPProtocolError" title="Link to this definition">¶</a></dt>

  359. <dd><p>Exception raised when a reply is received from the server that does not begin

  360. with a digit in the range 1–5.</p>

  361. </dd></dl>

  362. 

  363. <dl class="py exception">

  364. <dt class="sig sig-object py" id="nntplib.NNTPDataError">

  365. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">NNTPDataError</span></span><a class="headerlink" href="#nntplib.NNTPDataError" title="Link to this definition">¶</a></dt>

  366. <dd><p>Exception raised when there is some error in the response data.</p>

  367. </dd></dl>

  368. 

  369. <section id="nntp-objects">

  370. <span id="id1"></span><h2>NNTP Objects<a class="headerlink" href="#nntp-objects" title="Link to this heading">¶</a></h2>

  371. <p>When connected, <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> and <a class="reference internal" href="#nntplib.NNTP_SSL" title="nntplib.NNTP_SSL"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP_SSL</span></code></a> objects support the

  372. following methods and attributes.</p>

  373. <section id="attributes">

  374. <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h3>

  375. <dl class="py attribute">

  376. <dt class="sig sig-object py" id="nntplib.NNTP.nntp_version">

  377. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">nntp_version</span></span><a class="headerlink" href="#nntplib.NNTP.nntp_version" title="Link to this definition">¶</a></dt>

  378. <dd><p>An integer representing the version of the NNTP protocol supported by the

  379. server.  In practice, this should be <code class="docutils literal notranslate"><span class="pre">2</span></code> for servers advertising

  380. <span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3977.html"><strong>RFC 3977</strong></a> compliance and <code class="docutils literal notranslate"><span class="pre">1</span></code> for others.</p>

  381. <div class="versionadded">

  382. <p><span class="versionmodified added">New in version 3.2.</span></p>

  383. </div>

  384. </dd></dl>

  385. 

  386. <dl class="py attribute">

  387. <dt class="sig sig-object py" id="nntplib.NNTP.nntp_implementation">

  388. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">nntp_implementation</span></span><a class="headerlink" href="#nntplib.NNTP.nntp_implementation" title="Link to this definition">¶</a></dt>

  389. <dd><p>A string describing the software name and version of the NNTP server,

  390. or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a> if not advertised by the server.</p>

  391. <div class="versionadded">

  392. <p><span class="versionmodified added">New in version 3.2.</span></p>

  393. </div>

  394. </dd></dl>

  395. 

  396. </section>

  397. <section id="methods">

  398. <h3>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶</a></h3>

  399. <p>The <em>response</em> that is returned as the first item in the return tuple of almost

  400. all methods is the server’s response: a string beginning with a three-digit

  401. code.  If the server’s response indicates an error, the method raises one of

  402. the above exceptions.</p>

  403. <p>Many of the following methods take an optional keyword-only argument <em>file</em>.

  404. When the <em>file</em> argument is supplied, it must be either a <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a>

  405. opened for binary writing, or the name of an on-disk file to be written to.

  406. The method will then write any data returned by the server (except for the

  407. response line and the terminating dot) to the file; any list of lines,

  408. tuples or objects that the method normally returns will be empty.</p>

  409. <div class="versionchanged">

  410. <p><span class="versionmodified changed">Changed in version 3.2: </span>Many of the following methods have been reworked and fixed, which makes

  411. them incompatible with their 3.1 counterparts.</p>

  412. </div>

  413. <dl class="py method">

  414. <dt class="sig sig-object py" id="nntplib.NNTP.quit">

  415. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.quit" title="Link to this definition">¶</a></dt>

  416. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">QUIT</span></code> command and close the connection.  Once this method has been

  417. called, no other methods of the NNTP object should be called.</p>

  418. </dd></dl>

  419. 

  420. <dl class="py method">

  421. <dt class="sig sig-object py" id="nntplib.NNTP.getwelcome">

  422. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">getwelcome</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.getwelcome" title="Link to this definition">¶</a></dt>

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

  424. connection.  (This message sometimes contains disclaimers or help information

  425. that may be relevant to the user.)</p>

  426. </dd></dl>

  427. 

  428. <dl class="py method">

  429. <dt class="sig sig-object py" id="nntplib.NNTP.getcapabilities">

  430. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">getcapabilities</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.getcapabilities" title="Link to this definition">¶</a></dt>

  431. <dd><p>Return the <span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3977.html"><strong>RFC 3977</strong></a> capabilities advertised by the server, as a

  432. <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> instance mapping capability names to (possibly empty) lists

  433. of values. On legacy servers which don’t understand the <code class="docutils literal notranslate"><span class="pre">CAPABILITIES</span></code>

  434. command, an empty dictionary is returned instead.</p>

  435. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">NNTP</span><span class="p">(</span><span class="s1">&#39;news.gmane.io&#39;</span><span class="p">)</span>

  436. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;POST&#39;</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">getcapabilities</span><span class="p">()</span>

  437. <span class="go">True</span>

  438. </pre></div>

  439. </div>

  440. <div class="versionadded">

  441. <p><span class="versionmodified added">New in version 3.2.</span></p>

  442. </div>

  443. </dd></dl>

  444. 

  445. <dl class="py method">

  446. <dt class="sig sig-object py" id="nntplib.NNTP.login">

  447. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usenetrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.login" title="Link to this definition">¶</a></dt>

  448. <dd><p>Send <code class="docutils literal notranslate"><span class="pre">AUTHINFO</span></code> commands with the user name and password.  If <em>user</em>

  449. and <em>password</em> are <code class="docutils literal notranslate"><span class="pre">None</span></code> and <em>usenetrc</em> is true, credentials from

  450. <code class="docutils literal notranslate"><span class="pre">~/.netrc</span></code> will be used if possible.</p>

  451. <p>Unless intentionally delayed, login is normally performed during the

  452. <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> object initialization and separately calling this function

  453. is unnecessary.  To force authentication to be delayed, you must not set

  454. <em>user</em> or <em>password</em> when creating the object, and must set <em>usenetrc</em> to

  455. False.</p>

  456. <div class="versionadded">

  457. <p><span class="versionmodified added">New in version 3.2.</span></p>

  458. </div>

  459. </dd></dl>

  460. 

  461. <dl class="py method">

  462. <dt class="sig sig-object py" id="nntplib.NNTP.starttls">

  463. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">starttls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.starttls" title="Link to this definition">¶</a></dt>

  464. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">STARTTLS</span></code> command.  This will enable encryption on the NNTP

  465. connection.  The <em>context</em> argument is optional and should be a

  466. <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ssl.SSLContext</span></code></a> object.  Please read <a class="reference internal" href="ssl.html#ssl-security"><span class="std std-ref">Security considerations</span></a> for best

  467. practices.</p>

  468. <p>Note that this may not be done after authentication information has

  469. been transmitted, and authentication occurs by default if possible during a

  470. <a class="reference internal" href="#nntplib.NNTP" title="nntplib.NNTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTP</span></code></a> object initialization.  See <a class="reference internal" href="#nntplib.NNTP.login" title="nntplib.NNTP.login"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NNTP.login()</span></code></a> for information

  471. on suppressing this behavior.</p>

  472. <div class="versionadded">

  473. <p><span class="versionmodified added">New in version 3.2.</span></p>

  474. </div>

  475. <div class="versionchanged">

  476. <p><span class="versionmodified changed">Changed in version 3.4: </span>The method now supports hostname check with

  477. <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"><span class="pre">ssl.SSLContext.check_hostname</span></code></a> and <em>Server Name Indication</em> (see

  478. <a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-data docutils literal notranslate"><span class="pre">ssl.HAS_SNI</span></code></a>).</p>

  479. </div>

  480. </dd></dl>

  481. 

  482. <dl class="py method">

  483. <dt class="sig sig-object py" id="nntplib.NNTP.newgroups">

  484. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">newgroups</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.newgroups" title="Link to this definition">¶</a></dt>

  485. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEWGROUPS</span></code> command.  The <em>date</em> argument should be a

  486. <a class="reference internal" href="datetime.html#datetime.date" title="datetime.date"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.date</span></code></a> or <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> object.

  487. Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">groups)</span></code> where <em>groups</em> is a list representing

  488. the groups that are new since the given <em>date</em>. If <em>file</em> is supplied,

  489. though, then <em>groups</em> will be empty.</p>

  490. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">date</span><span class="p">,</span> <span class="n">timedelta</span>

  491. <span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">groups</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">newgroups</span><span class="p">(</span><span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">3</span><span class="p">))</span>

  492. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">groups</span><span class="p">)</span> 

  493. <span class="go">85</span>

  494. <span class="gp">&gt;&gt;&gt; </span><span class="n">groups</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> 

  495. <span class="go">GroupInfo(group=&#39;gmane.network.tor.devel&#39;, last=&#39;4&#39;, first=&#39;1&#39;, flag=&#39;m&#39;)</span>

  496. </pre></div>

  497. </div>

  498. </dd></dl>

  499. 

  500. <dl class="py method">

  501. <dt class="sig sig-object py" id="nntplib.NNTP.newnews">

  502. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">newnews</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.newnews" title="Link to this definition">¶</a></dt>

  503. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEWNEWS</span></code> command.  Here, <em>group</em> is a group name or <code class="docutils literal notranslate"><span class="pre">'*'</span></code>, and

  504. <em>date</em> has the same meaning as for <a class="reference internal" href="#nntplib.NNTP.newgroups" title="nntplib.NNTP.newgroups"><code class="xref py py-meth docutils literal notranslate"><span class="pre">newgroups()</span></code></a>.  Return a pair

  505. <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">articles)</span></code> where <em>articles</em> is a list of message ids.</p>

  506. <p>This command is frequently disabled by NNTP server administrators.</p>

  507. </dd></dl>

  508. 

  509. <dl class="py method">

  510. <dt class="sig sig-object py" id="nntplib.NNTP.list">

  511. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.list" title="Link to this definition">¶</a></dt>

  512. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LIST</span></code> or <code class="docutils literal notranslate"><span class="pre">LIST</span> <span class="pre">ACTIVE</span></code> command.  Return a pair

  513. <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code> where <em>list</em> is a list of tuples representing all

  514. the groups available from this NNTP server, optionally matching the

  515. pattern string <em>group_pattern</em>.  Each tuple has the form

  516. <code class="docutils literal notranslate"><span class="pre">(group,</span> <span class="pre">last,</span> <span class="pre">first,</span> <span class="pre">flag)</span></code>, where <em>group</em> is a group name, <em>last</em>

  517. and <em>first</em> are the last and first article numbers, and <em>flag</em> usually

  518. takes one of these values:</p>

  519. <ul class="simple">

  520. <li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: Local postings and articles from peers are allowed.</p></li>

  521. <li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: The group is moderated and all postings must be approved.</p></li>

  522. <li><p><code class="docutils literal notranslate"><span class="pre">n</span></code>: No local postings are allowed, only articles from peers.</p></li>

  523. <li><p><code class="docutils literal notranslate"><span class="pre">j</span></code>: Articles from peers are filed in the junk group instead.</p></li>

  524. <li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: No local postings, and articles from peers are ignored.</p></li>

  525. <li><p><code class="docutils literal notranslate"><span class="pre">=foo.bar</span></code>: Articles are filed in the <code class="docutils literal notranslate"><span class="pre">foo.bar</span></code> group instead.</p></li>

  526. </ul>

  527. <p>If <em>flag</em> has another value, then the status of the newsgroup should be

  528. considered unknown.</p>

  529. <p>This command can return very large results, especially if <em>group_pattern</em>

  530. is not specified.  It is best to cache the results offline unless you

  531. really need to refresh them.</p>

  532. <div class="versionchanged">

  533. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>group_pattern</em> was added.</p>

  534. </div>

  535. </dd></dl>

  536. 

  537. <dl class="py method">

  538. <dt class="sig sig-object py" id="nntplib.NNTP.descriptions">

  539. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">descriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grouppattern</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.descriptions" title="Link to this definition">¶</a></dt>

  540. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LIST</span> <span class="pre">NEWSGROUPS</span></code> command, where <em>grouppattern</em> is a wildmat string as

  541. specified in <span class="target" id="index-8"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3977.html"><strong>RFC 3977</strong></a> (it’s essentially the same as DOS or UNIX shell wildcard

  542. strings).  Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">descriptions)</span></code>, where <em>descriptions</em>

  543. is a dictionary mapping group names to textual descriptions.</p>

  544. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">descs</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">descriptions</span><span class="p">(</span><span class="s1">&#39;gmane.comp.python.*&#39;</span><span class="p">)</span>

  545. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">descs</span><span class="p">)</span> 

  546. <span class="go">295</span>

  547. <span class="gp">&gt;&gt;&gt; </span><span class="n">descs</span><span class="o">.</span><span class="n">popitem</span><span class="p">()</span> 

  548. <span class="go">(&#39;gmane.comp.python.bio.general&#39;, &#39;BioPython discussion list (Moderated)&#39;)</span>

  549. </pre></div>

  550. </div>

  551. </dd></dl>

  552. 

  553. <dl class="py method">

  554. <dt class="sig sig-object py" id="nntplib.NNTP.description">

  555. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">description</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.description" title="Link to this definition">¶</a></dt>

  556. <dd><p>Get a description for a single group <em>group</em>.  If more than one group matches

  557. (if ‘group’ is a real wildmat string), return the first match.   If no group

  558. matches, return an empty string.</p>

  559. <p>This elides the response code from the server.  If the response code is needed,

  560. use <a class="reference internal" href="#nntplib.NNTP.descriptions" title="nntplib.NNTP.descriptions"><code class="xref py py-meth docutils literal notranslate"><span class="pre">descriptions()</span></code></a>.</p>

  561. </dd></dl>

  562. 

  563. <dl class="py method">

  564. <dt class="sig sig-object py" id="nntplib.NNTP.group">

  565. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.group" title="Link to this definition">¶</a></dt>

  566. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">GROUP</span></code> command, where <em>name</em> is the group name.  The group is

  567. selected as the current group, if it exists.  Return a tuple

  568. <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">count,</span> <span class="pre">first,</span> <span class="pre">last,</span> <span class="pre">name)</span></code> where <em>count</em> is the (estimated)

  569. number of articles in the group, <em>first</em> is the first article number in

  570. the group, <em>last</em> is the last article number in the group, and <em>name</em>

  571. is the group name.</p>

  572. </dd></dl>

  573. 

  574. <dl class="py method">

  575. <dt class="sig sig-object py" id="nntplib.NNTP.over">

  576. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">over</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_spec</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.over" title="Link to this definition">¶</a></dt>

  577. <dd><p>Send an <code class="docutils literal notranslate"><span class="pre">OVER</span></code> command, or an <code class="docutils literal notranslate"><span class="pre">XOVER</span></code> command on legacy servers.

  578. <em>message_spec</em> can be either a string representing a message id, or

  579. a <code class="docutils literal notranslate"><span class="pre">(first,</span> <span class="pre">last)</span></code> tuple of numbers indicating a range of articles in

  580. the current group, or a <code class="docutils literal notranslate"><span class="pre">(first,</span> <span class="pre">None)</span></code> tuple indicating a range of

  581. articles starting from <em>first</em> to the last article in the current group,

  582. or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a> to select the current article in the current group.</p>

  583. <p>Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">overviews)</span></code>.  <em>overviews</em> is a list of

  584. <code class="docutils literal notranslate"><span class="pre">(article_number,</span> <span class="pre">overview)</span></code> tuples, one for each article selected

  585. by <em>message_spec</em>.  Each <em>overview</em> is a dictionary with the same number

  586. of items, but this number depends on the server.  These items are either

  587. message headers (the key is then the lower-cased header name) or metadata

  588. items (the key is then the metadata name prepended with <code class="docutils literal notranslate"><span class="pre">&quot;:&quot;</span></code>).  The

  589. following items are guaranteed to be present by the NNTP specification:</p>

  590. <ul class="simple">

  591. <li><p>the <code class="docutils literal notranslate"><span class="pre">subject</span></code>, <code class="docutils literal notranslate"><span class="pre">from</span></code>, <code class="docutils literal notranslate"><span class="pre">date</span></code>, <code class="docutils literal notranslate"><span class="pre">message-id</span></code> and <code class="docutils literal notranslate"><span class="pre">references</span></code>

  592. headers</p></li>

  593. <li><p>the <code class="docutils literal notranslate"><span class="pre">:bytes</span></code> metadata: the number of bytes in the entire raw article

  594. (including headers and body)</p></li>

  595. <li><p>the <code class="docutils literal notranslate"><span class="pre">:lines</span></code> metadata: the number of lines in the article body</p></li>

  596. </ul>

  597. <p>The value of each item is either a string, or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a> if not present.</p>

  598. <p>It is advisable to use the <a class="reference internal" href="#nntplib.decode_header" title="nntplib.decode_header"><code class="xref py py-func docutils literal notranslate"><span class="pre">decode_header()</span></code></a> function on header

  599. values when they may contain non-ASCII characters:</p>

  600. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;gmane.comp.python.devel&#39;</span><span class="p">)</span>

  601. <span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">overviews</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">over</span><span class="p">((</span><span class="n">last</span><span class="p">,</span> <span class="n">last</span><span class="p">))</span>

  602. <span class="gp">&gt;&gt;&gt; </span><span class="n">art_num</span><span class="p">,</span> <span class="n">over</span> <span class="o">=</span> <span class="n">overviews</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  603. <span class="gp">&gt;&gt;&gt; </span><span class="n">art_num</span>

  604. <span class="go">117216</span>

  605. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">over</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

  606. <span class="go">[&#39;xref&#39;, &#39;from&#39;, &#39;:lines&#39;, &#39;:bytes&#39;, &#39;references&#39;, &#39;date&#39;, &#39;message-id&#39;, &#39;subject&#39;]</span>

  607. <span class="gp">&gt;&gt;&gt; </span><span class="n">over</span><span class="p">[</span><span class="s1">&#39;from&#39;</span><span class="p">]</span>

  608. <span class="go">&#39;=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= &lt;martin@v.loewis.de&gt;&#39;</span>

  609. <span class="gp">&gt;&gt;&gt; </span><span class="n">nntplib</span><span class="o">.</span><span class="n">decode_header</span><span class="p">(</span><span class="n">over</span><span class="p">[</span><span class="s1">&#39;from&#39;</span><span class="p">])</span>

  610. <span class="go">&#39;&quot;Martin v. Löwis&quot; &lt;martin@v.loewis.de&gt;&#39;</span>

  611. </pre></div>

  612. </div>

  613. <div class="versionadded">

  614. <p><span class="versionmodified added">New in version 3.2.</span></p>

  615. </div>

  616. </dd></dl>

  617. 

  618. <dl class="py method">

  619. <dt class="sig sig-object py" id="nntplib.NNTP.help">

  620. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.help" title="Link to this definition">¶</a></dt>

  621. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">HELP</span></code> command.  Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code> where <em>list</em> is a

  622. list of help strings.</p>

  623. </dd></dl>

  624. 

  625. <dl class="py method">

  626. <dt class="sig sig-object py" id="nntplib.NNTP.stat">

  627. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">stat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.stat" title="Link to this definition">¶</a></dt>

  628. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">STAT</span></code> command, where <em>message_spec</em> is either a message id

  629. (enclosed in <code class="docutils literal notranslate"><span class="pre">'&lt;'</span></code> and <code class="docutils literal notranslate"><span class="pre">'&gt;'</span></code>) or an article number in the current group.

  630. If <em>message_spec</em> is omitted or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a>, the current article in the

  631. current group is considered.  Return a triple <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">number,</span> <span class="pre">id)</span></code>

  632. where <em>number</em> is the article number and <em>id</em> is the message id.</p>

  633. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;gmane.comp.python.devel&#39;</span><span class="p">)</span>

  634. <span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">number</span><span class="p">,</span> <span class="n">message_id</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">first</span><span class="p">)</span>

  635. <span class="gp">&gt;&gt;&gt; </span><span class="n">number</span><span class="p">,</span> <span class="n">message_id</span>

  636. <span class="go">(9099, &#39;&lt;20030112190404.GE29873@epoch.metaslash.com&gt;&#39;)</span>

  637. </pre></div>

  638. </div>

  639. </dd></dl>

  640. 

  641. <dl class="py method">

  642. <dt class="sig sig-object py" id="nntplib.NNTP.next">

  643. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">next</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.next" title="Link to this definition">¶</a></dt>

  644. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">NEXT</span></code> command.  Return as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.</p>

  645. </dd></dl>

  646. 

  647. <dl class="py method">

  648. <dt class="sig sig-object py" id="nntplib.NNTP.last">

  649. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.last" title="Link to this definition">¶</a></dt>

  650. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">LAST</span></code> command.  Return as for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.</p>

  651. </dd></dl>

  652. 

  653. <dl class="py method">

  654. <dt class="sig sig-object py" id="nntplib.NNTP.article">

  655. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">article</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.article" title="Link to this definition">¶</a></dt>

  656. <dd><p>Send an <code class="docutils literal notranslate"><span class="pre">ARTICLE</span></code> command, where <em>message_spec</em> has the same meaning as

  657. for <a class="reference internal" href="#nntplib.NNTP.stat" title="nntplib.NNTP.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stat()</span></code></a>.  Return a tuple <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">info)</span></code> where <em>info</em>

  658. is a <a class="reference internal" href="collections.html#collections.namedtuple" title="collections.namedtuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">namedtuple</span></code></a> with three attributes <em>number</em>,

  659. <em>message_id</em> and <em>lines</em> (in that order).  <em>number</em> is the article number

  660. in the group (or 0 if the information is not available), <em>message_id</em> the

  661. message id as a string, and <em>lines</em> a list of lines (without terminating

  662. newlines) comprising the raw message including headers and body.</p>

  663. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">resp</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">article</span><span class="p">(</span><span class="s1">&#39;&lt;20030112190404.GE29873@epoch.metaslash.com&gt;&#39;</span><span class="p">)</span>

  664. <span class="gp">&gt;&gt;&gt; </span><span class="n">info</span><span class="o">.</span><span class="n">number</span>

  665. <span class="go">0</span>

  666. <span class="gp">&gt;&gt;&gt; </span><span class="n">info</span><span class="o">.</span><span class="n">message_id</span>

  667. <span class="go">&#39;&lt;20030112190404.GE29873@epoch.metaslash.com&gt;&#39;</span>

  668. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">info</span><span class="o">.</span><span class="n">lines</span><span class="p">)</span>

  669. <span class="go">65</span>

  670. <span class="gp">&gt;&gt;&gt; </span><span class="n">info</span><span class="o">.</span><span class="n">lines</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  671. <span class="go">b&#39;Path: main.gmane.org!not-for-mail&#39;</span>

  672. <span class="gp">&gt;&gt;&gt; </span><span class="n">info</span><span class="o">.</span><span class="n">lines</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  673. <span class="go">b&#39;From: Neal Norwitz &lt;neal@metaslash.com&gt;&#39;</span>

  674. <span class="gp">&gt;&gt;&gt; </span><span class="n">info</span><span class="o">.</span><span class="n">lines</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">:]</span>

  675. <span class="go">[b&#39;There is a patch for 2.3 as well as 2.2.&#39;, b&#39;&#39;, b&#39;Neal&#39;]</span>

  676. </pre></div>

  677. </div>

  678. </dd></dl>

  679. 

  680. <dl class="py method">

  681. <dt class="sig sig-object py" id="nntplib.NNTP.head">

  682. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">head</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.head" title="Link to this definition">¶</a></dt>

  683. <dd><p>Same as <a class="reference internal" href="#nntplib.NNTP.article" title="nntplib.NNTP.article"><code class="xref py py-meth docutils literal notranslate"><span class="pre">article()</span></code></a>, but sends a <code class="docutils literal notranslate"><span class="pre">HEAD</span></code> command.  The <em>lines</em>

  684. returned (or written to <em>file</em>) will only contain the message headers, not

  685. the body.</p>

  686. </dd></dl>

  687. 

  688. <dl class="py method">

  689. <dt class="sig sig-object py" id="nntplib.NNTP.body">

  690. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.body" title="Link to this definition">¶</a></dt>

  691. <dd><p>Same as <a class="reference internal" href="#nntplib.NNTP.article" title="nntplib.NNTP.article"><code class="xref py py-meth docutils literal notranslate"><span class="pre">article()</span></code></a>, but sends a <code class="docutils literal notranslate"><span class="pre">BODY</span></code> command.  The <em>lines</em>

  692. returned (or written to <em>file</em>) will only contain the message body, not the

  693. headers.</p>

  694. </dd></dl>

  695. 

  696. <dl class="py method">

  697. <dt class="sig sig-object py" id="nntplib.NNTP.post">

  698. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.post" title="Link to this definition">¶</a></dt>

  699. <dd><p>Post an article using the <code class="docutils literal notranslate"><span class="pre">POST</span></code> command.  The <em>data</em> argument is either

  700. a <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a> opened for binary reading, or any iterable of bytes

  701. objects (representing raw lines of the article to be posted).  It should

  702. represent a well-formed news article, including the required headers.  The

  703. <a class="reference internal" href="#nntplib.NNTP.post" title="nntplib.NNTP.post"><code class="xref py py-meth docutils literal notranslate"><span class="pre">post()</span></code></a> method automatically escapes lines beginning with <code class="docutils literal notranslate"><span class="pre">.</span></code> and

  704. appends the termination line.</p>

  705. <p>If the method succeeds, the server’s response is returned.  If the server

  706. refuses posting, a <a class="reference internal" href="#nntplib.NNTPReplyError" title="nntplib.NNTPReplyError"><code class="xref py py-class docutils literal notranslate"><span class="pre">NNTPReplyError</span></code></a> is raised.</p>

  707. </dd></dl>

  708. 

  709. <dl class="py method">

  710. <dt class="sig sig-object py" id="nntplib.NNTP.ihave">

  711. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">ihave</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.ihave" title="Link to this definition">¶</a></dt>

  712. <dd><p>Send an <code class="docutils literal notranslate"><span class="pre">IHAVE</span></code> command. <em>message_id</em> is the id of the message to send

  713. to the server (enclosed in  <code class="docutils literal notranslate"><span class="pre">'&lt;'</span></code> and <code class="docutils literal notranslate"><span class="pre">'&gt;'</span></code>).  The <em>data</em> parameter

  714. and the return value are the same as for <a class="reference internal" href="#nntplib.NNTP.post" title="nntplib.NNTP.post"><code class="xref py py-meth docutils literal notranslate"><span class="pre">post()</span></code></a>.</p>

  715. </dd></dl>

  716. 

  717. <dl class="py method">

  718. <dt class="sig sig-object py" id="nntplib.NNTP.date">

  719. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">date</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.date" title="Link to this definition">¶</a></dt>

  720. <dd><p>Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">date)</span></code>.  <em>date</em> is a <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a>

  721. object containing the current date and time of the server.</p>

  722. </dd></dl>

  723. 

  724. <dl class="py method">

  725. <dt class="sig sig-object py" id="nntplib.NNTP.slave">

  726. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">slave</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.slave" title="Link to this definition">¶</a></dt>

  727. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">SLAVE</span></code> command.  Return the server’s <em>response</em>.</p>

  728. </dd></dl>

  729. 

  730. <dl class="py method">

  731. <dt class="sig sig-object py" id="nntplib.NNTP.set_debuglevel">

  732. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">set_debuglevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.set_debuglevel" title="Link to this definition">¶</a></dt>

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

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

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

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

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

  738. (including message text).</p>

  739. </dd></dl>

  740. 

  741. <p>The following are optional NNTP extensions defined in <span class="target" id="index-9"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2980.html"><strong>RFC 2980</strong></a>.  Some of

  742. them have been superseded by newer commands in <span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3977.html"><strong>RFC 3977</strong></a>.</p>

  743. <dl class="py method">

  744. <dt class="sig sig-object py" id="nntplib.NNTP.xhdr">

  745. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">xhdr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hdr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xhdr" title="Link to this definition">¶</a></dt>

  746. <dd><p>Send an <code class="docutils literal notranslate"><span class="pre">XHDR</span></code> command.  The <em>hdr</em> argument is a header keyword, e.g.

  747. <code class="docutils literal notranslate"><span class="pre">'subject'</span></code>.  The <em>str</em> argument should have the form <code class="docutils literal notranslate"><span class="pre">'first-last'</span></code>

  748. where <em>first</em> and <em>last</em> are the first and last article numbers to search.

  749. Return a pair <code class="docutils literal notranslate"><span class="pre">(response,</span> <span class="pre">list)</span></code>, where <em>list</em> is a list of pairs <code class="docutils literal notranslate"><span class="pre">(id,</span>

  750. <span class="pre">text)</span></code>, where <em>id</em> is an article number (as a string) and <em>text</em> is the text of

  751. the requested header for that article. If the <em>file</em> parameter is supplied, then

  752. the output of the  <code class="docutils literal notranslate"><span class="pre">XHDR</span></code> command is stored in a file.  If <em>file</em> is a string,

  753. then the method will open a file with that name, write to it  then close it.

  754. If <em>file</em> is a <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a>, then it will start calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> on

  755. it to store the lines of the command output. If <em>file</em> is supplied, then the

  756. returned <em>list</em> is an empty list.</p>

  757. </dd></dl>

  758. 

  759. <dl class="py method">

  760. <dt class="sig sig-object py" id="nntplib.NNTP.xover">

  761. <span class="sig-prename descclassname"><span class="pre">NNTP.</span></span><span class="sig-name descname"><span class="pre">xover</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.NNTP.xover" title="Link to this definition">¶</a></dt>

  762. <dd><p>Send an <code class="docutils literal notranslate"><span class="pre">XOVER</span></code> command.  <em>start</em> and <em>end</em> are article numbers

  763. delimiting the range of articles to select.  The return value is the

  764. same of for <a class="reference internal" href="#nntplib.NNTP.over" title="nntplib.NNTP.over"><code class="xref py py-meth docutils literal notranslate"><span class="pre">over()</span></code></a>.  It is recommended to use <a class="reference internal" href="#nntplib.NNTP.over" title="nntplib.NNTP.over"><code class="xref py py-meth docutils literal notranslate"><span class="pre">over()</span></code></a>

  765. instead, since it will automatically use the newer <code class="docutils literal notranslate"><span class="pre">OVER</span></code> command

  766. if available.</p>

  767. </dd></dl>

  768. 

  769. </section>

  770. </section>

  771. <section id="utility-functions">

  772. <h2>Utility functions<a class="headerlink" href="#utility-functions" title="Link to this heading">¶</a></h2>

  773. <p>The module also defines the following utility function:</p>

  774. <dl class="py function">

  775. <dt class="sig sig-object py" id="nntplib.decode_header">

  776. <span class="sig-prename descclassname"><span class="pre">nntplib.</span></span><span class="sig-name descname"><span class="pre">decode_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header_str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nntplib.decode_header" title="Link to this definition">¶</a></dt>

  777. <dd><p>Decode a header value, un-escaping any escaped non-ASCII characters.

  778. <em>header_str</em> must be a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> object.  The unescaped value is

  779. returned.  Using this function is recommended to display some headers

  780. in a human readable form:</p>

  781. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">decode_header</span><span class="p">(</span><span class="s2">&quot;Some subject&quot;</span><span class="p">)</span>

  782. <span class="go">&#39;Some subject&#39;</span>

  783. <span class="gp">&gt;&gt;&gt; </span><span class="n">decode_header</span><span class="p">(</span><span class="s2">&quot;=?ISO-8859-15?Q?D=E9buter_en_Python?=&quot;</span><span class="p">)</span>

  784. <span class="go">&#39;Débuter en Python&#39;</span>

  785. <span class="gp">&gt;&gt;&gt; </span><span class="n">decode_header</span><span class="p">(</span><span class="s2">&quot;Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=&quot;</span><span class="p">)</span>

  786. <span class="go">&#39;Re: problème de matrice&#39;</span>

  787. </pre></div>

  788. </div>

  789. </dd></dl>

  790. 

  791. </section>

  792. </section>

  793. 

  794. 

  795.             <div class="clearer"></div>

  796.           </div>

  797.         </div>

  798.       </div>

  799.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  800.         <div class="sphinxsidebarwrapper">

  801.   <div>

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

  803.     <ul>

  804. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code> — NNTP protocol client</a><ul>

  805. <li><a class="reference internal" href="#nntp-objects">NNTP Objects</a><ul>

  806. <li><a class="reference internal" href="#attributes">Attributes</a></li>

  807. <li><a class="reference internal" href="#methods">Methods</a></li>

  808. </ul>

  809. </li>

  810. <li><a class="reference internal" href="#utility-functions">Utility functions</a></li>

  811. </ul>

  812. </li>

  813. </ul>

  814. 

  815.   </div>

  816.   <div>

  817.     <h4>Previous topic</h4>

  818.     <p class="topless"><a href="nis.html"

  819.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nis</span></code> — Interface to Sun’s NIS (Yellow Pages)</a></p>

  820.   </div>

  821.   <div>

  822.     <h4>Next topic</h4>

  823.     <p class="topless"><a href="optparse.html"

  824.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">optparse</span></code> — Parser for command line options</a></p>

  825.   </div>

  826.   <div role="note" aria-label="source link">

  827.     <h3>This Page</h3>

  828.     <ul class="this-page-menu">

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

  830.       <li>

  831.         <a href="https://github.com/python/cpython/blob/main/Doc/library/nntplib.rst"

  832.             rel="nofollow">Show Source

  833.         </a>

  834.       </li>

  835.     </ul>

  836.   </div>

  837.         </div>

  838. <div id="sidebarbutton" title="Collapse sidebar">

  839. <span>«</span>

  840. </div>

  841. 

  842.       </div>

  843.       <div class="clearer"></div>

  844.     </div>  

  845.     <div class="related" role="navigation" aria-label="related navigation">

  846.       <h3>Navigation</h3>

  847.       <ul>

  848.         <li class="right" style="margin-right: 10px">

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

  850.              >index</a></li>

  851.         <li class="right" >

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

  853.              >modules</a> |</li>

  854.         <li class="right" >

  855.           <a href="optparse.html" title="optparse — Parser for command line options"

  856.              >next</a> |</li>

  857.         <li class="right" >

  858.           <a href="nis.html" title="nis — Interface to Sun’s NIS (Yellow Pages)"

  859.              >previous</a> |</li>

  860. 

  861.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  862.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  863.           <li class="switchers">

  864.             <div class="language_switcher_placeholder"></div>

  865.             <div class="version_switcher_placeholder"></div>

  866.           </li>

  867.           <li>

  868.               

  869.           </li>

  870.     <li id="cpython-language-and-version">

  871.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  872.     </li>

  873. 

  874.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  875.           <li class="nav-item nav-item-2"><a href="superseded.html" >Superseded Modules</a> &#187;</li>

  876.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">nntplib</span></code> — NNTP protocol client</a></li>

  877.                 <li class="right">

  878.                     

  879. 

  880.     <div class="inline-search" role="search">

  881.         <form class="inline-search" action="../search.html" method="get">

  882.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  883.           <input type="submit" value="Go" />

  884.         </form>

  885.     </div>

  886.                      |

  887.                 </li>

  888.             <li class="right">

  889. <label class="theme-selector-label">

  890.     Theme

  891.     <select class="theme-selector" oninput="activateTheme(this.value)">

  892.         <option value="auto" selected>Auto</option>

  893.         <option value="light">Light</option>

  894.         <option value="dark">Dark</option>

  895.     </select>

  896. </label> |</li>

  897.             

  898.       </ul>

  899.     </div>  

  900.     <div class="footer">

  901.     &copy; 

  902.       <a href="../copyright.html">

  903.     

  904.     Copyright

  905.     

  906.       </a>

  907.      2001-2024, Python Software Foundation.

  908.     <br />

  909.     This page is licensed under the Python Software Foundation License Version 2.

  910.     <br />

  911.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  912.     <br />

  913.     

  914.       See <a href="/license.html">History and License</a> for more information.<br />

  915.     

  916.     

  917.     <br />

  918. 

  919.     The Python Software Foundation is a non-profit corporation.

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

  921. <br />

  922.     <br />

  923.       Last updated on Apr 09, 2024 (13:47 UTC).

  924.     

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

  926.     

  927.     <br />

  928. 

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

  930.     </div>

  931. 

  932.   </body>

  933. </html>
上海开阖软件有限公司 沪ICP备12045867号-1