nntplib
nis — 接口到 Sun 的 NIS (黄页)
nis
源代码： Lib/nntplib.py
Deprecated since version 3.11: The nntplib 模块被弃用 (见 PEP 594 了解细节)。
此模块定义类 NNTP 实现 NNTP (网络新闻传输协议) 客户端侧。可用于实现新闻阅读器或海报，或自动化新闻处理程序。它兼容 RFC 3977 及更旧的 RFC 977 and RFC 2980 .
NNTP
可用性 ：非 Emscripten，非 WASI。
本模块不工作 (或不可用) 于 WebAssembly 平台 wasm32-emscripten and wasm32-wasi 。见 WebAssembly 平台 了解更多信息。
wasm32-emscripten
wasm32-wasi
这里是如何使用它的 2 个小范例。要列出有关新闻组的一些统计和打印最后 10 篇文章的主题：
>>> s = nntplib.NNTP('news.gmane.io') >>> resp, count, first, last, name = s.group('gmane.comp.python.committers') >>> print('Group', name, 'has', count, 'articles, range', first, 'to', last) Group gmane.comp.python.committers has 1096 articles, range 1 to 1096 >>> resp, overviews = s.over((last - 9, last)) >>> for id, over in overviews: ... print(id, nntplib.decode_header(over['subject'])) ... 1087 Re: Commit privileges for Łukasz Langa 1088 Re: 3.2 alpha 2 freeze 1089 Re: 3.2 alpha 2 freeze 1090 Re: Commit privileges for Łukasz Langa 1091 Re: Commit privileges for Łukasz Langa 1092 Updated ssh key 1093 Re: Updated ssh key 1094 Re: Updated ssh key 1095 Hello fellow committers! 1096 Re: Hello fellow committers! >>> s.quit() '205 Bye!'
To post an article from a binary file (this assumes that the article has valid headers, and that you have right to post on the particular newsgroup):
>>> s = nntplib.NNTP('news.gmane.io') >>> f = open('article.txt', 'rb') >>> s.post(f) '240 Article posted successfully.' >>> s.quit() '205 Bye!'
模块自身定义下列类：
返回新的 NNTP object, representing a connection to the NNTP server running on host host , listening at port port 。可选 timeout can be specified for the socket connection. If the optional user and password are provided, or if suitable credentials are present in /.netrc and the optional flag usenetrc is true, the AUTHINFO USER and AUTHINFO PASS commands are used to identify and authenticate the user to the server. If the optional flag readermode is true, then a mode reader command is sent before authentication is performed. Reader mode is sometimes necessary if you are connecting to an NNTP server on the local machine and intend to call reader-specific commands, such as group . If you get unexpected NNTPPermanentError s, you might need to set readermode 。 NNTP 类支持 with statement to unconditionally consume OSError exceptions and to close the NNTP connection when done, e.g.:
/.netrc
AUTHINFO USER
AUTHINFO PASS
mode reader
group
NNTPPermanentError
with
OSError
>>> from nntplib import NNTP >>> with NNTP('news.gmane.io') as n: ... n.group('gmane.comp.python.committers') ... ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers') >>>
引发 审计事件 nntplib.connect 采用自变量 self , host , port .
nntplib.connect
self
host
port
所有命令将引发 审计事件 nntplib.putline 采用自变量 self and line ，其中 line 是即将发送给远程主机的字节。
nntplib.putline
line
3.2 版改变： usenetrc 现为 False 在默认情况下。
False
3.3 版改变： 支持 with 语句被添加。
3.9 版改变： 若 timeout 参数被设为 0，它将引发 ValueError 以阻止非阻塞套接字的创建。
ValueError
返回新的 NNTP_SSL object, representing an encrypted connection to the NNTP server running on host host , listening at port port . NNTP_SSL objects have the same methods as NNTP 对象。若 port is omitted, port 563 (NNTPS) is used. ssl_context is also optional, and is a SSLContext 对象。请阅读 安全注意事项 for best practices. All other parameters behave the same as for NNTP .
NNTP_SSL
SSLContext
注意，SSL-on-563 不受鼓励每 RFC 4642 , in favor of STARTTLS as described below. However, some servers only support the former.
Added in version 3.2.
3.4 版改变： 类现在支持主机名校验采用 ssl.SSLContext.check_hostname and SNI (服务器名称指示) (见 ssl.HAS_SNI ).
ssl.SSLContext.check_hostname
ssl.HAS_SNI
派生自标准异常 Exception , this is the base class for all exceptions raised by the nntplib module. Instances of this class have the following attribute:
Exception
The response of the server if available, as a str 对象。
str
Exception raised when an unexpected reply is received from the server.
Exception raised when a response code in the range 400–499 is received.
Exception raised when a response code in the range 500–599 is received.
Exception raised when a reply is received from the server that does not begin with a digit in the range 1–5.
Exception raised when there is some error in the response data.
当连接时， NNTP and NNTP_SSL 对象支持下列方法和属性。
An integer representing the version of the NNTP protocol supported by the server. In practice, this should be 2 for servers advertising RFC 3977 compliance and 1 for others.
2
1
A string describing the software name and version of the NNTP server, or None if not advertised by the server.
None
The response that is returned as the first item in the return tuple of almost all methods is the server’s response: a string beginning with a three-digit code. If the server’s response indicates an error, the method raises one of the above exceptions.
Many of the following methods take an optional keyword-only argument file 。当 file argument is supplied, it must be either a 文件对象 opened for binary writing, or the name of an on-disk file to be written to. The method will then write any data returned by the server (except for the response line and the terminating dot) to the file; any list of lines, tuples or objects that the method normally returns will be empty.
3.2 版改变： Many of the following methods have been reworked and fixed, which makes them incompatible with their 3.1 counterparts.
发送 QUIT command and close the connection. Once this method has been called, no other methods of the NNTP object should be called.
QUIT
Return the welcome message sent by the server in reply to the initial connection. (This message sometimes contains disclaimers or help information that may be relevant to the user.)
返回 RFC 3977 capabilities advertised by the server, as a dict instance mapping capability names to (possibly empty) lists of values. On legacy servers which don’t understand the CAPABILITIES command, an empty dictionary is returned instead.
dict
CAPABILITIES
>>> s = NNTP('news.gmane.io') >>> 'POST' in s.getcapabilities() True
发送 AUTHINFO commands with the user name and password. If user and password are None and usenetrc is true, credentials from ~/.netrc will be used if possible.
AUTHINFO
~/.netrc
Unless intentionally delayed, login is normally performed during the NNTP object initialization and separately calling this function is unnecessary. To force authentication to be delayed, you must not set user or password when creating the object, and must set usenetrc to False.
发送 STARTTLS command. This will enable encryption on the NNTP connection. The context argument is optional and should be a ssl.SSLContext 对象。请阅读 安全注意事项 了解最佳实践。
STARTTLS
ssl.SSLContext
Note that this may not be done after authentication information has been transmitted, and authentication occurs by default if possible during a NNTP object initialization. See NNTP.login() for information on suppressing this behavior.
NNTP.login()
3.4 版改变： 方法现在支持主机名校验采用 ssl.SSLContext.check_hostname and SNI (服务器名称指示) (见 ssl.HAS_SNI ).
发送 NEWGROUPS 命令。 date argument should be a datetime.date or datetime.datetime object. Return a pair (response, groups) where groups is a list representing the groups that are new since the given date 。若 file is supplied, though, then groups will be empty.
NEWGROUPS
datetime.date
datetime.datetime
(response, groups)
>>> from datetime import date, timedelta >>> resp, groups = s.newgroups(date.today() - timedelta(days=3)) >>> len(groups) 85 >>> groups[0] GroupInfo(group='gmane.network.tor.devel', last='4', first='1', flag='m')
发送 NEWNEWS command. Here, group is a group name or '*' ，和 date has the same meaning as for newgroups() . Return a pair (response, articles) where articles is a list of message ids.
NEWNEWS
'*'
newgroups()
(response, articles)
This command is frequently disabled by NNTP server administrators.
发送 LIST or LIST ACTIVE command. Return a pair (response, list) where list is a list of tuples representing all the groups available from this NNTP server, optionally matching the pattern string group_pattern . Each tuple has the form (group, last, first, flag) ，其中 group is a group name, last and 第一 are the last and first article numbers, and flag usually takes one of these values:
LIST
LIST ACTIVE
(response, list)
(group, last, first, flag)
y : Local postings and articles from peers are allowed.
y
m : The group is moderated and all postings must be approved.
m
n : No local postings are allowed, only articles from peers.
n
j : Articles from peers are filed in the junk group instead.
j
x : No local postings, and articles from peers are ignored.
x
=foo.bar : Articles are filed in the foo.bar group instead.
=foo.bar
foo.bar
若 flag has another value, then the status of the newsgroup should be considered unknown.
This command can return very large results, especially if group_pattern is not specified. It is best to cache the results offline unless you really need to refresh them.
3.2 版改变： group_pattern 被添加。
发送 LIST NEWSGROUPS 命令，其中 grouppattern is a wildmat string as specified in RFC 3977 (it’s essentially the same as DOS or UNIX shell wildcard strings). Return a pair (response, descriptions) ，其中 descriptions is a dictionary mapping group names to textual descriptions.
LIST NEWSGROUPS
(response, descriptions)
>>> resp, descs = s.descriptions('gmane.comp.python.*') >>> len(descs) 295 >>> descs.popitem() ('gmane.comp.python.bio.general', 'BioPython discussion list (Moderated)')
Get a description for a single group group . If more than one group matches (if ‘group’ is a real wildmat string), return the first match. If no group matches, return an empty string.
This elides the response code from the server. If the response code is needed, use descriptions() .
descriptions()
发送 GROUP 命令，其中 name is the group name. The group is selected as the current group, if it exists. Return a tuple (response, count, first, last, name) where count is the (estimated) number of articles in the group, 第一 is the first article number in the group, last is the last article number in the group, and name is the group name.
GROUP
(response, count, first, last, name)
发送 OVER command, or an XOVER command on legacy servers. message_spec can be either a string representing a message id, or a (first, last) tuple of numbers indicating a range of articles in the current group, or a (first, None) tuple indicating a range of articles starting from 第一 to the last article in the current group, or None to select the current article in the current group.
OVER
XOVER
(first, last)
(first, None)
返回一对 (response, overviews) . overviews 是列表化的 (article_number, overview) tuples, one for each article selected by message_spec . Each 概述 is a dictionary with the same number of items, but this number depends on the server. These items are either message headers (the key is then the lower-cased header name) or metadata items (the key is then the metadata name prepended with ":" ). The following items are guaranteed to be present by the NNTP specification:
(response, overviews)
(article_number, overview)
":"
the subject , from , date , message-id and references headers
subject
from
date
message-id
references
the :bytes metadata: the number of bytes in the entire raw article (including headers and body)
:bytes
the :lines metadata: the number of lines in the article body
:lines
The value of each item is either a string, or None if not present.
It is advisable to use the decode_header() function on header values when they may contain non-ASCII characters:
decode_header()
>>> _, _, first, last, _ = s.group('gmane.comp.python.devel') >>> resp, overviews = s.over((last, last)) >>> art_num, over = overviews[0] >>> art_num 117216 >>> list(over.keys()) ['xref', 'from', ':lines', ':bytes', 'references', 'date', 'message-id', 'subject'] >>> over['from'] '=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= <martin@v.loewis.de>' >>> nntplib.decode_header(over['from']) '"Martin v. Löwis" <martin@v.loewis.de>'
发送 HELP command. Return a pair (response, list) where list is a list of help strings.
HELP
发送 STAT 命令，其中 message_spec is either a message id (enclosed in '<' and '>' ) or an article number in the current group. If message_spec 被省略或 None , the current article in the current group is considered. Return a triple (response, number, id) where number is the article number and id is the message id.
STAT
'<'
'>'
(response, number, id)
>>> _, _, first, last, _ = s.group('gmane.comp.python.devel') >>> resp, number, message_id = s.stat(first) >>> number, message_id (9099, '<20030112190404.GE29873@epoch.metaslash.com>')
发送 NEXT 命令。返回作为对于 stat() .
NEXT
stat()
发送 LAST 命令。返回作为对于 stat() .
LAST
发送 ARTICLE 命令，其中 message_spec has the same meaning as for stat() . Return a tuple (response, info) where info 是 namedtuple with three attributes number , message_id and lines (in that order). number is the article number in the group (or 0 if the information is not available), message_id the message id as a string, and lines a list of lines (without terminating newlines) comprising the raw message including headers and body.
ARTICLE
(response, info)
namedtuple
>>> resp, info = s.article('<20030112190404.GE29873@epoch.metaslash.com>') >>> info.number 0 >>> info.message_id '<20030112190404.GE29873@epoch.metaslash.com>' >>> len(info.lines) 65 >>> info.lines[0] b'Path: main.gmane.org!not-for-mail' >>> info.lines[1] b'From: Neal Norwitz <neal@metaslash.com>' >>> info.lines[-3:] [b'There is a patch for 2.3 as well as 2.2.', b'', b'Neal']
如同 article() ，但发送 HEAD 命令。 lines returned (or written to file ) will only contain the message headers, not the body.
article()
HEAD
如同 article() ，但发送 BODY 命令。 lines returned (or written to file ) will only contain the message body, not the headers.
BODY
Post an article using the POST 命令。 data argument is either a 文件对象 opened for binary reading, or any iterable of bytes objects (representing raw lines of the article to be posted). It should represent a well-formed news article, including the required headers. The post() method automatically escapes lines beginning with . and appends the termination line.
POST
post()
.
If the method succeeds, the server’s response is returned. If the server refuses posting, a NNTPReplyError 被引发。
NNTPReplyError
发送 IHAVE 命令。 message_id is the id of the message to send to the server (enclosed in '<' and '>' )。 data parameter and the return value are the same as for post() .
IHAVE
返回一对 (response, date) . date 是 datetime object containing the current date and time of the server.
(response, date)
datetime
发送 SLAVE command. Return the server’s response .
SLAVE
Set the instance’s debugging level. This controls the amount of debugging output printed. The default, 0 , produces no debugging output. A value of 1 produces a moderate amount of debugging output, generally a single line per request or response. A value of 2 or higher produces the maximum amount of debugging output, logging each line sent and received on the connection (including message text).
0
The following are optional NNTP extensions defined in RFC 2980 . Some of them have been superseded by newer commands in RFC 3977 .
发送 XHDR 命令。 hdr argument is a header keyword, e.g. 'subject' 。 str argument should have the form 'first-last' where 第一 and last are the first and last article numbers to search. Return a pair (response, list) ，其中 list is a list of pairs (id, text) ，其中 id is an article number (as a string) and text is the text of the requested header for that article. If the file parameter is supplied, then the output of the XHDR command is stored in a file. If file is a string, then the method will open a file with that name, write to it then close it. If file 是 文件对象 , then it will start calling write() on it to store the lines of the command output. If file is supplied, then the returned list 是空列表。
XHDR
'subject'
'first-last'
(id, text)
write()
发送 XOVER 命令。 start and end are article numbers delimiting the range of articles to select. The return value is the same of for over() . It is recommended to use over() instead, since it will automatically use the newer OVER command if available.
over()
The module also defines the following utility function:
Decode a header value, un-escaping any escaped non-ASCII characters. header_str 必须为 str object. The unescaped value is returned. Using this function is recommended to display some headers in a human readable form:
>>> decode_header("Some subject") 'Some subject' >>> decode_header("=?ISO-8859-15?Q?D=E9buter_en_Python?=") 'Débuter en Python' >>> decode_header("Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=") 'Re: problème de matrice'
optparse — 命令行选项剖析器
optparse
键入搜索术语或模块、类、函数名称。