Attributes

NNTP.nntp_version

表示NNTP协议版本的整数由服务器支持。在实践中，这应该是2用于服务器广告 RFC 3977 遵守和1为其他人.

新版本3.2.

NNTP.nntp_implementation

描述NNTP服务器软件名称和版本的字符串，或None如果服务器没有公布的话

新版本3.2.

Methods

作为几乎所有方法的返回元组中的第一项返回的response是服务器的响应：以三个digitcode开头的字符串。如果服务器的响应指示错误，则该方法引发上述异常之一.

以下许多方法采用可选的仅关键字参数file。当提供file参数时，它必须是文件对象打开以进行二进制写入，或者写入要写入的磁盘文件的名称。然后，该方法将服务器返回的任何数据（响应行和终止点除外）写入文件;方法通常返回的任何行，元组或对象列表都将为空.

NNTP.quit ( )

寄一个 QUIT命令并关闭连接。一旦调用了这个方法，就不应该调用NNTP对象的其他方法.

NNTP.getwelcome ( )

返回服务器发送的欢迎消息以回复初始连接。（此消息有时包含可能与用户相关的免责声明或帮助信息。）

NNTP.getcapabilities（）

返回 RFC 3977 服务器通告的功能，作为dict实例映射功能命名为（可能为空）值列表。在不了解CAPABILITIES命令，返回一个空字典.

>>> s = NNTP("news.gmane.org")>>> "POST" in s.getcapabilities()True

版本3.2.

NNTP.login（user=None, password=None, usenetrc=True）

发送AUTHINFO用户名和密码的命令。如果user和password是 None和usenetrc如果可能，将使用来自~/.netrc的凭据.

除非故意延迟，否则通常在NNTP对象初始化和单独调用此函数是不必要的。要强制进行身份验证，在创建对象时不能设置user或password，并且必须设置usenetrctoFalse.

新版本3.2.

NNTP.starttls (context=None)

发一个STARTTLS命令。这将启用NNTP连接上的加密。context参数是可选的，应该是ssl.SSLContext宾语。请阅读安全考虑以获得最佳实践.

请注意，在传输身份验证信息后可能无法执行此操作，并且在NNTP对象初始化期间，如果可能，默认情况下会进行身份验证。见NNTP.login()有关抑制此行为的信息.

版本3.2.

版本3.4更改：该方法现在支持使用ssl.SSLContext.check_hostname和Server Name Indication（看到ssl.HAS_SNI）.

NNTP.newgroups（date, *, file=None）

发送NEWGROUPS命令。date参数应该是datetime.date或datetime.datetime对象。返回一对(response, groups)其中groups是一个表示新组的列表既然给定了date。如果file然后提供groups将是空的.

>>> from datetime import date, timedelta>>> resp, groups = s.newgroups(date.today() - timedelta(days=3))>>> len(groups) # doctest: +SKIP85>>> groups[0] # doctest: +SKIPGroupInfo(group="gmane.network.tor.devel", last="4", first="1", flag="m")

NNTP.newnews（group, date, *, file=None）

寄一个 NEWNEWS命令。这里， group是一个组名或"*"，和date与具有相同的含义newgroups()。返回一对(response, articles)其中articles是一个消息ID列表.

这个命令经常被NNTP服务器管理员禁用.

NNTP.list (group_pattern=None, *, file=None)

发送LIST或LIST ACTIVE命令。返回一对(response, list) list是表示此NNTP服务器中可用的所有组的元组列表，可选地匹配模式字符串group_pattern。每个元组都有(group, last, first, flag)的形式，其中group是一个组名，last和first是最后和第一个文章编号，flag通常取这些值中的一个：

• y：允许来自同行的本地帖子和文章.
• m：小组被审核，所有帖子必须被批准.
• n：否允许本地帖子，只允许来自同行的文章.
• j：来自同行的文章反而在垃圾集团中提交.
• x：没有本地帖子，同行的文章被忽略了
• =foo.bar//：文章是在foo.bar组中提交的.

如果flag有另一个值，那么新闻组的状态应该被认为是未知的.

此命令可以返回非常大的结果，尤其是在未指定group_pattern的情况下。最好是离线缓存结果，除非你真的需要刷新它们.

在版本3.2中更改：group_pattern添加了

NNTP.descriptions// (grouppattern)

寄一个 LIST NEWSGROUPS命令，其中grouppattern是 RFC 3977 中指定的wildmat字符串（它与DOS或UNIX shell通配符串基本相同）。返回一对(response, descriptions)，其中descriptions是一个字典映射组名称到文本描述.

>>> resp, descs = s.descriptions("gmane.comp.python.*")>>> len(descs) # doctest: +SKIP295>>> descs.popitem() # doctest: +SKIP("gmane.comp.python.bio.general", "BioPython discussion list (Moderated)")

NNTP.description (group)

获取单个组的描述group。如果多个组匹配（如果’group’是真正的wildmat字符串），则返回第一个匹配项。如果没有组匹配，则返回一个空字符串.

这省略了服务器的响应代码。如果需要响应代码，请使用descriptions().

NNTP.group（name）

发送GROUP命令，其中name是组名。如果存在，则选择该组作为当前组。返回一个元组(response, count, first, last, name)其中count是该组中的（估计）文章数量，first是组中的第一个文章编号，last是组中的最后一个文章编号，而name是组名.

NNTP.over (message_spec, *, file=None）

发送OVER命令，或XOVER遗留服务器上的命令.message_spec可以是表示消息ID的字符串，ora (first, last)表示当前组中文章范围的数字元组，或者(first, None)元组表示从开始的一系列文章first到当前组的最后一篇文章，或None选择当前组中的当前文章.

返回一对(response, overviews). overviews是的列表(article_number, overview)元组，每个文章一个由message_spec选择。每个overview是一个具有相同项目数的字典，但这个数字取决于服务器。这些项目是消息标题（密钥是较低的标题名称）或metadataitems（然后是密钥是":"）。NNTP规范保证以下项目存在：

• subject, from, date, message-id和references标题
• :bytes元数据：整个原始文章中的字节数（包括标题和正文）
• :lines元数据：文章正文中的行数

每个项的值是一个字符串，如果不存在则None。

当它们可能包含非ASCII字符时，建议在headervalues上使用decode_header()函数：

>>> _, _, first, last, _ = s.group("gmane.comp.python.devel")>>> resp, overviews = s.over((last, last))>>> art_num, over = overviews[0]>>> art_num117216>>> list(over.keys())["xref", "from", ":lines", ":bytes", "references", "date", "message-id", "subject"]>>> over["from"]"=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= <[email protected]>">>> nntplib.decode_header(over["from"])""Martin v. Löwis" <[email protected]>"

版本3.2.

NNTP.help（*, file=None）

寄一个 HELP命令。返回一对(response, list)/list是一个帮助字符串列表.

NNTP.stat（message_spec=None）

寄一个 STAT命令，message_spec是一个消息ID（包含在"<"和">"中）或当前组中的文章编号。如果message_spec被省略或None，考虑当前小组的当前文章。返回三个(response, number, id)其中number是文章编号而id是信息id .

>>> _, _, first, last, _ = s.group("gmane.comp.python.devel")>>> resp, number, message_id = s.stat(first)>>> number, message_id(9099, "<[email protected]>")

NNTP.next ()

寄一个 NEXT命令。返回stat().

NNTP.last（）

寄一个 LAST命令。返回stat().

NNTP.article（message_spec=None, *, file=None）

发送ARTICLE命令，message_spec与具有相同的含义stat()。返回一个元组(response, info)其中info是namedtuple，有三个属性number,message_id和lines（按此顺序）。number是组中的文章编号（如果信息不可用，则为0），message_idthemessage id as a string，和lines一个行列表（没有终止新行），包括包含标题和正文的原始消息.

>>> resp, info = s.article("<[email protected]>")>>> info.number0>>> info.message_id"<[email protected]>">>> len(info.lines)65>>> info.lines[0]b"Path: main.gmane.org!not-for-mail">>> info.lines[1]b"From: Neal Norwitz <[email protected]>">>> info.lines[-3:][b"There is a patch for 2.3 as well as 2.2.", b"", b"Neal"]

NNTP.head (message_spec=None, *, file=None)

与article()相同，但发送HEAD命令。lines返回（或写入file）只包含邮件标题，而不是正文.

NNTP.body(message_spec=None, *, file=None)

同名如article()，但发送一个BODY命令。lines返回（或写入file）只包含消息正文，而不是theheaders.

NNTP.post(data)

Post一篇使用POST命令的文章。data参数是eithera 文件对象为二进制读取打开，或者任何可迭代的bytesobjects（表示要发布的文章的原始行）。它应该代表一个结构良好的新闻文章，包括所需的标题。post()方法自动转义以.开头的行，并显示终止行.

如果方法成功，则返回服务器的响应。如果服务器拒绝发布，则会引发NNTPReplyError.

NNTP.ihave(message_id, data)

发送IHAVE命令。message_id是要发送到服务器的消息的id（包含在"<"和">"中）。data参数和返回值与post().

NNTP.date（）相同

返回一对(response, date). date是datetime包含服务器当前日期和时间的对象.

NNTP.slave()

发送SLAVE命令。返回服务器的response.

NNTP.set_debuglevel（level）

设置实例的调试级别。这可以控制打印的debuggingoutput数量。默认值0不产生调试输出。值1产生适量的调试输出，通常是单个线路请求或响应。值2或更高版本产生最大调试输出量，记录连接上发送和接收的每一行（包括消息文本）.

以下是RFC 2980 。其中一些已被 RFC 3977 .

NNTP.xhdr（hdr, str, *, file=None）

发送XHDR命令中的新命令所取代。hdrargument是一个标题关键字，例如"subject"。str参数的格式应为"first-last"，其中first和last是要查找的第一个和最后一个文章编号。返回一对(response, list)，其中list是对的列表(id,text)，其中id是文章编号（作为字符串），text是请求标题的文本那篇文章。如果提供了file参数，则XHDR命令的输出存储在文件中。如果file是一个字符串，那么该方法将打开一个具有该名称的文件，写入然后关闭它。如果file是文件对象，然后它将开始调用write() onit来存储命令输出的行。如果提供了file，那么list就是一个空列表

NNTP.xover（start, end, *, file=None)

发一个XOVER命令。start和end是文章编号，用于界定要选择的文章范围。返回值与over()相同。建议使用over()代替，因为它会自动使用较新的OVER命令.

NNTP.xpath（id）

返回一对(resp, path)，其中path是具有消息ID id的文章的目录路径。大多数情况下，NNTP服务器管理员无法启用此扩展.

自版本3.3以后删除： XPATH扩展未被主动使用.