### 导航
- [索引](../genindex.xhtml "总目录")
- [模块](../py-modindex.xhtml "Python 模块索引") |
- [下一页](mimetypes.xhtml "mimetypes --- Map filenames to MIME types") |
- [上一页](mailcap.xhtml "mailcap --- Mailcap file handling") |
- 
- [Python](https://www.python.org/) »
- zh\_CN 3.7.3 [文档](../index.xhtml) »
- [Python 标准库](index.xhtml) »
- [互联网数据处理](netdata.xhtml) »
- $('.inline-search').show(0); |
# [`mailbox`](#module-mailbox "mailbox: Manipulate mailboxes in various formats") --- Manipulate mailboxes in various formats
**Source code:** [Lib/mailbox.py](https://github.com/python/cpython/tree/3.7/Lib/mailbox.py) \[https://github.com/python/cpython/tree/3.7/Lib/mailbox.py\]
- - - - - -
This module defines two classes, [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") and [`Message`](#mailbox.Message "mailbox.Message"), for accessing and manipulating on-disk mailboxes and the messages they contain. [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") offers a dictionary-like mapping from keys to messages. [`Message`](#mailbox.Message "mailbox.Message") extends the [`email.message`](email.compat32-message.xhtml#module-email.message "email.message: The base class representing email messages in a fashion backward compatible with Python 3.2") module's [`Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") class with format-specific state and behavior. Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
参见
Module [`email`](email.xhtml#module-email "email: Package supporting the parsing, manipulating, and generating email messages.")Represent and manipulate messages.
## [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") objects
*class* `mailbox.``Mailbox`A mailbox, which may be inspected and modified.
The [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") class defines an interface and is not intended to be instantiated. Instead, format-specific subclasses should inherit from [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") and your code should instantiate a particular subclass.
The [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") interface is dictionary-like, with small keys corresponding to messages. Keys are issued by the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance with which they will be used and are only meaningful to that [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox")instance. A key continues to identify a message even if the corresponding message is modified, such as by replacing it with another message.
Messages may be added to a [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance using the set-like method [`add()`](#mailbox.Mailbox.add "mailbox.Mailbox.add") and removed using a `del` statement or the set-like methods [`remove()`](#mailbox.Mailbox.remove "mailbox.Mailbox.remove") and [`discard()`](#mailbox.Mailbox.discard "mailbox.Mailbox.discard").
[`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") interface semantics differ from dictionary semantics in some noteworthy ways. Each time a message is requested, a new representation (typically a [`Message`](#mailbox.Message "mailbox.Message") instance) is generated based upon the current state of the mailbox. Similarly, when a message is added to a [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance, the provided message representation's contents are copied. In neither case is a reference to the message representation kept by the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance.
The default [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") iterator iterates over message representations, not keys as the default dictionary iterator does. Moreover, modification of a mailbox during iteration is safe and well-defined. Messages added to the mailbox after an iterator is created will not be seen by the iterator. Messages removed from the mailbox before the iterator yields them will be silently skipped, though using a key from an iterator may result in a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if the corresponding message is subsequently removed.
警告
Be very cautious when modifying mailboxes that might be simultaneously changed by some other process. The safest mailbox format to use for such tasks is Maildir; try to avoid using single-file formats such as mbox for concurrent writing. If you're modifying a mailbox, you *must* lock it by calling the [`lock()`](#mailbox.Mailbox.lock "mailbox.Mailbox.lock") and [`unlock()`](#mailbox.Mailbox.unlock "mailbox.Mailbox.unlock") methods *before* reading any messages in the file or making any changes by adding or deleting a message. Failing to lock the mailbox runs the risk of losing messages or corrupting the entire mailbox.
[`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instances have the following methods:
`add`(*message*)Add *message* to the mailbox and return the key that has been assigned to it.
Parameter *message* may be a [`Message`](#mailbox.Message "mailbox.Message") instance, an [`email.message.Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") instance, a string, a byte string, or a file-like object (which should be open in binary mode). If *message* is an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass (e.g., if it's an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance and this is an [`mbox`](#mailbox.mbox "mailbox.mbox") instance), its format-specific information is used. Otherwise, reasonable defaults for format-specific information are used.
在 3.2 版更改: Support for binary input was added.
`remove`(*key*)`__delitem__`(*key*)`discard`(*key*)Delete the message corresponding to *key* from the mailbox.
If no such message exists, a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception is raised if the method was called as [`remove()`](#mailbox.Mailbox.remove "mailbox.Mailbox.remove") or [`__delitem__()`](#mailbox.Mailbox.__delitem__ "mailbox.Mailbox.__delitem__") but no exception is raised if the method was called as [`discard()`](#mailbox.Mailbox.discard "mailbox.Mailbox.discard"). The behavior of [`discard()`](#mailbox.Mailbox.discard "mailbox.Mailbox.discard") may be preferred if the underlying mailbox format supports concurrent modification by other processes.
`__setitem__`(*key*, *message*)Replace the message corresponding to *key* with *message*. Raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if no message already corresponds to *key*.
As with [`add()`](#mailbox.Mailbox.add "mailbox.Mailbox.add"), parameter *message* may be a [`Message`](#mailbox.Message "mailbox.Message")instance, an [`email.message.Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") instance, a string, a byte string, or a file-like object (which should be open in binary mode). If *message* is an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass (e.g., if it's an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance and this is an [`mbox`](#mailbox.mbox "mailbox.mbox") instance), its format-specific information is used. Otherwise, the format-specific information of the message that currently corresponds to *key* is left unchanged.
`iterkeys`()`keys`()Return an iterator over all keys if called as [`iterkeys()`](#mailbox.Mailbox.iterkeys "mailbox.Mailbox.iterkeys") or return a list of keys if called as [`keys()`](#mailbox.Mailbox.keys "mailbox.Mailbox.keys").
`itervalues`()`__iter__`()`values`()Return an iterator over representations of all messages if called as [`itervalues()`](#mailbox.Mailbox.itervalues "mailbox.Mailbox.itervalues") or [`__iter__()`](#mailbox.Mailbox.__iter__ "mailbox.Mailbox.__iter__") or return a list of such representations if called as [`values()`](#mailbox.Mailbox.values "mailbox.Mailbox.values"). The messages are represented as instances of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass unless a custom message factory was specified when the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox")instance was initialized.
注解
The behavior of [`__iter__()`](#mailbox.Mailbox.__iter__ "mailbox.Mailbox.__iter__") is unlike that of dictionaries, which iterate over keys.
`iteritems`()`items`()Return an iterator over (*key*, *message*) pairs, where *key* is a key and *message* is a message representation, if called as [`iteritems()`](#mailbox.Mailbox.iteritems "mailbox.Mailbox.iteritems") or return a list of such pairs if called as [`items()`](#mailbox.Mailbox.items "mailbox.Mailbox.items"). The messages are represented as instances of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass unless a custom message factory was specified when the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance was initialized.
`get`(*key*, *default=None*)`__getitem__`(*key*)Return a representation of the message corresponding to *key*. If no such message exists, *default* is returned if the method was called as [`get()`](#mailbox.Mailbox.get "mailbox.Mailbox.get") and a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception is raised if the method was called as [`__getitem__()`](#mailbox.Mailbox.__getitem__ "mailbox.Mailbox.__getitem__"). The message is represented as an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass unless a custom message factory was specified when the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance was initialized.
`get_message`(*key*)Return a representation of the message corresponding to *key* as an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass, or raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if no such message exists.
`get_bytes`(*key*)Return a byte representation of the message corresponding to *key*, or raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if no such message exists.
3\.2 新版功能.
`get_string`(*key*)Return a string representation of the message corresponding to *key*, or raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if no such message exists. The message is processed through [`email.message.Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") to convert it to a 7bit clean representation.
`get_file`(*key*)Return a file-like representation of the message corresponding to *key*, or raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception if no such message exists. The file-like object behaves as if open in binary mode. This file should be closed once it is no longer needed.
在 3.2 版更改: The file object really is a binary file; previously it was incorrectly returned in text mode. Also, the file-like object now supports the context management protocol: you can use a [`with`](../reference/compound_stmts.xhtml#with) statement to automatically close it.
注解
Unlike other representations of messages, file-like representations are not necessarily independent of the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance that created them or of the underlying mailbox. More specific documentation is provided by each subclass.
`__contains__`(*key*)Return `True` if *key* corresponds to a message, `False` otherwise.
`__len__`()Return a count of messages in the mailbox.
`clear`()Delete all messages from the mailbox.
`pop`(*key*, *default=None*)Return a representation of the message corresponding to *key* and delete the message. If no such message exists, return *default*. The message is represented as an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass unless a custom message factory was specified when the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance was initialized.
`popitem`()Return an arbitrary (*key*, *message*) pair, where *key* is a key and *message* is a message representation, and delete the corresponding message. If the mailbox is empty, raise a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception. The message is represented as an instance of the appropriate format-specific [`Message`](#mailbox.Message "mailbox.Message") subclass unless a custom message factory was specified when the [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance was initialized.
`update`(*arg*)Parameter *arg* should be a *key*-to-*message* mapping or an iterable of (*key*, *message*) pairs. Updates the mailbox so that, for each given *key* and *message*, the message corresponding to *key* is set to *message* as if by using [`__setitem__()`](#mailbox.Mailbox.__setitem__ "mailbox.Mailbox.__setitem__"). As with [`__setitem__()`](#mailbox.Mailbox.__setitem__ "mailbox.Mailbox.__setitem__"), each *key* must already correspond to a message in the mailbox or else a [`KeyError`](exceptions.xhtml#KeyError "KeyError") exception will be raised, so in general it is incorrect for *arg* to be a [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance.
注解
Unlike with dictionaries, keyword arguments are not supported.
`flush`()Write any pending changes to the filesystem. For some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox")subclasses, changes are always written immediately and [`flush()`](#mailbox.Mailbox.flush "mailbox.Mailbox.flush") does nothing, but you should still make a habit of calling this method.
`lock`()Acquire an exclusive advisory lock on the mailbox so that other processes know not to modify it. An [`ExternalClashError`](#mailbox.ExternalClashError "mailbox.ExternalClashError") is raised if the lock is not available. The particular locking mechanisms used depend upon the mailbox format. You should *always* lock the mailbox before making any modifications to its contents.
`unlock`()Release the lock on the mailbox, if any.
`close`()Flush the mailbox, unlock it if necessary, and close any open files. For some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") subclasses, this method does nothing.
### [`Maildir`](#mailbox.Maildir "mailbox.Maildir")
*class* `mailbox.``Maildir`(*dirname*, *factory=None*, *create=True*)A subclass of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") for mailboxes in Maildir format. Parameter *factory* is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If *factory* is `None`, [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") is used as the default message representation. If *create* is `True`, the mailbox is created if it does not exist.
It is for historical reasons that *dirname* is named as such rather than *path*.
Maildir is a directory-based mailbox format invented for the qmail mail transfer agent and now widely supported by other programs. Messages in a Maildir mailbox are stored in separate files within a common directory structure. This design allows Maildir mailboxes to be accessed and modified by multiple unrelated programs without data corruption, so file locking is unnecessary.
Maildir mailboxes contain three subdirectories, namely: `tmp`, `new`, and `cur`. Messages are created momentarily in the `tmp` subdirectory and then moved to the `new` subdirectory to finalize delivery. A mail user agent may subsequently move the message to the `cur` subdirectory and store information about the state of the message in a special "info" section appended to its file name.
Folders of the style introduced by the Courier mail transfer agent are also supported. Any subdirectory of the main mailbox is considered a folder if `'.'` is the first character in its name. Folder names are represented by [`Maildir`](#mailbox.Maildir "mailbox.Maildir") without the leading `'.'`. Each folder is itself a Maildir mailbox but should not contain other folders. Instead, a logical nesting is indicated using `'.'` to delimit levels, e.g., "Archived.2005.07".
注解
The Maildir specification requires the use of a colon (`':'`) in certain message file names. However, some operating systems do not permit this character in file names, If you wish to use a Maildir-like format on such an operating system, you should specify another character to use instead. The exclamation point (`'!'`) is a popular choice. For example:
```
import mailbox
mailbox.Maildir.colon = '!'
```
The `colon` attribute may also be set on a per-instance basis.
[`Maildir`](#mailbox.Maildir "mailbox.Maildir") instances have all of the methods of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") in addition to the following:
`list_folders`()Return a list of the names of all folders.
`get_folder`(*folder*)Return a [`Maildir`](#mailbox.Maildir "mailbox.Maildir") instance representing the folder whose name is *folder*. A [`NoSuchMailboxError`](#mailbox.NoSuchMailboxError "mailbox.NoSuchMailboxError") exception is raised if the folder does not exist.
`add_folder`(*folder*)Create a folder whose name is *folder* and return a [`Maildir`](#mailbox.Maildir "mailbox.Maildir")instance representing it.
`remove_folder`(*folder*)Delete the folder whose name is *folder*. If the folder contains any messages, a [`NotEmptyError`](#mailbox.NotEmptyError "mailbox.NotEmptyError") exception will be raised and the folder will not be deleted.
`clean`()Delete temporary files from the mailbox that have not been accessed in the last 36 hours. The Maildir specification says that mail-reading programs should do this occasionally.
Some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") methods implemented by [`Maildir`](#mailbox.Maildir "mailbox.Maildir") deserve special remarks:
`add`(*message*)`__setitem__`(*key*, *message*)`update`(*arg*)警告
These methods generate unique file names based upon the current process ID. When using multiple threads, undetected name clashes may occur and cause corruption of the mailbox unless threads are coordinated to avoid using these methods to manipulate the same mailbox simultaneously.
`flush`()All changes to Maildir mailboxes are immediately applied, so this method does nothing.
`lock`()`unlock`()Maildir mailboxes do not support (or require) locking, so these methods do nothing.
`close`()[`Maildir`](#mailbox.Maildir "mailbox.Maildir") instances do not keep any open files and the underlying mailboxes do not support locking, so this method does nothing.
`get_file`(*key*)Depending upon the host platform, it may not be possible to modify or remove the underlying message while the returned file remains open.
参见
[maildir man page from qmail](http://www.qmail.org/man/man5/maildir.html) \[http://www.qmail.org/man/man5/maildir.html\]The original specification of the format.
[Using maildir format](https://cr.yp.to/proto/maildir.html) \[https://cr.yp.to/proto/maildir.html\]Notes on Maildir by its inventor. Includes an updated name-creation scheme and details on "info" semantics.
[maildir man page from Courier](http://www.courier-mta.org/maildir.html) \[http://www.courier-mta.org/maildir.html\]Another specification of the format. Describes a common extension for supporting folders.
### [`mbox`](#mailbox.mbox "mailbox.mbox")
*class* `mailbox.``mbox`(*path*, *factory=None*, *create=True*)A subclass of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") for mailboxes in mbox format. Parameter *factory*is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If *factory* is `None`, [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") is used as the default message representation. If *create* is `True`, the mailbox is created if it does not exist.
The mbox format is the classic format for storing mail on Unix systems. All messages in an mbox mailbox are stored in a single file with the beginning of each message indicated by a line whose first five characters are "From ".
Several variations of the mbox format exist to address perceived shortcomings in the original. In the interest of compatibility, [`mbox`](#mailbox.mbox "mailbox.mbox") implements the original format, which is sometimes referred to as *mboxo*. This means that the *Content-Length* header, if present, is ignored and that any occurrences of "From " at the beginning of a line in a message body are transformed to ">From " when storing the message, although occurrences of ">From " are not transformed to "From " when reading the message.
Some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") methods implemented by [`mbox`](#mailbox.mbox "mailbox.mbox") deserve special remarks:
`get_file`(*key*)Using the file after calling `flush()` or `close()` on the [`mbox`](#mailbox.mbox "mailbox.mbox") instance may yield unpredictable results or raise an exception.
`lock`()`unlock`()Three locking mechanisms are used---dot locking and, if available, the `flock()` and `lockf()` system calls.
参见
[mbox man page from qmail](http://www.qmail.org/man/man5/mbox.html) \[http://www.qmail.org/man/man5/mbox.html\]A specification of the format and its variations.
[mbox man page from tin](http://www.tin.org/bin/man.cgi?section=5&topic=mbox) \[http://www.tin.org/bin/man.cgi?section=5&topic=mbox\]Another specification of the format, with details on locking.
[Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad](https://www.jwz.org/doc/content-length.html) \[https://www.jwz.org/doc/content-length.html\]An argument for using the original mbox format rather than a variation.
["mbox" is a family of several mutually incompatible mailbox formats](https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml) \[https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml\]A history of mbox variations.
### [`MH`](#mailbox.MH "mailbox.MH")
*class* `mailbox.``MH`(*path*, *factory=None*, *create=True*)A subclass of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") for mailboxes in MH format. Parameter *factory*is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If *factory* is `None`, [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") is used as the default message representation. If *create* is `True`, the mailbox is created if it does not exist.
MH is a directory-based mailbox format invented for the MH Message Handling System, a mail user agent. Each message in an MH mailbox resides in its own file. An MH mailbox may contain other MH mailboxes (called *folders*) in addition to messages. Folders may be nested indefinitely. MH mailboxes also support *sequences*, which are named lists used to logically group messages without moving them to sub-folders. Sequences are defined in a file called `.mh_sequences` in each folder.
The [`MH`](#mailbox.MH "mailbox.MH") class manipulates MH mailboxes, but it does not attempt to emulate all of **mh**'s behaviors. In particular, it does not modify and is not affected by the `context` or `.mh_profile` files that are used by **mh** to store its state and configuration.
[`MH`](#mailbox.MH "mailbox.MH") instances have all of the methods of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") in addition to the following:
`list_folders`()Return a list of the names of all folders.
`get_folder`(*folder*)Return an [`MH`](#mailbox.MH "mailbox.MH") instance representing the folder whose name is *folder*. A [`NoSuchMailboxError`](#mailbox.NoSuchMailboxError "mailbox.NoSuchMailboxError") exception is raised if the folder does not exist.
`add_folder`(*folder*)Create a folder whose name is *folder* and return an [`MH`](#mailbox.MH "mailbox.MH") instance representing it.
`remove_folder`(*folder*)Delete the folder whose name is *folder*. If the folder contains any messages, a [`NotEmptyError`](#mailbox.NotEmptyError "mailbox.NotEmptyError") exception will be raised and the folder will not be deleted.
`get_sequences`()Return a dictionary of sequence names mapped to key lists. If there are no sequences, the empty dictionary is returned.
`set_sequences`(*sequences*)Re-define the sequences that exist in the mailbox based upon *sequences*, a dictionary of names mapped to key lists, like returned by [`get_sequences()`](#mailbox.MH.get_sequences "mailbox.MH.get_sequences").
`pack`()Rename messages in the mailbox as necessary to eliminate gaps in numbering. Entries in the sequences list are updated correspondingly.
注解
Already-issued keys are invalidated by this operation and should not be subsequently used.
Some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") methods implemented by [`MH`](#mailbox.MH "mailbox.MH") deserve special remarks:
`remove`(*key*)`__delitem__`(*key*)`discard`(*key*)These methods immediately delete the message. The MH convention of marking a message for deletion by prepending a comma to its name is not used.
`lock`()`unlock`()Three locking mechanisms are used---dot locking and, if available, the `flock()` and `lockf()` system calls. For MH mailboxes, locking the mailbox means locking the `.mh_sequences` file and, only for the duration of any operations that affect them, locking individual message files.
`get_file`(*key*)Depending upon the host platform, it may not be possible to remove the underlying message while the returned file remains open.
`flush`()All changes to MH mailboxes are immediately applied, so this method does nothing.
`close`()[`MH`](#mailbox.MH "mailbox.MH") instances do not keep any open files, so this method is equivalent to [`unlock()`](#mailbox.MH.unlock "mailbox.MH.unlock").
参见
[nmh - Message Handling System](http://www.nongnu.org/nmh/) \[http://www.nongnu.org/nmh/\]Home page of **nmh**, an updated version of the original **mh**.
[MH & nmh: Email for Users & Programmers](https://rand-mh.sourceforge.io/book/) \[https://rand-mh.sourceforge.io/book/\]A GPL-licensed book on **mh** and **nmh**, with some information on the mailbox format.
### [`Babyl`](#mailbox.Babyl "mailbox.Babyl")
*class* `mailbox.``Babyl`(*path*, *factory=None*, *create=True*)A subclass of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") for mailboxes in Babyl format. Parameter *factory* is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If *factory* is `None`, [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") is used as the default message representation. If *create* is `True`, the mailbox is created if it does not exist.
Babyl is a single-file mailbox format used by the Rmail mail user agent included with Emacs. The beginning of a message is indicated by a line containing the two characters Control-Underscore (`'\037'`) and Control-L (`'\014'`). The end of a message is indicated by the start of the next message or, in the case of the last message, a line containing a Control-Underscore (`'\037'`) character.
Messages in a Babyl mailbox have two sets of headers, original headers and so-called visible headers. Visible headers are typically a subset of the original headers that have been reformatted or abridged to be more attractive. Each message in a Babyl mailbox also has an accompanying list of *labels*, or short strings that record extra information about the message, and a list of all user-defined labels found in the mailbox is kept in the Babyl options section.
[`Babyl`](#mailbox.Babyl "mailbox.Babyl") instances have all of the methods of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") in addition to the following:
`get_labels`()Return a list of the names of all user-defined labels used in the mailbox.
注解
The actual messages are inspected to determine which labels exist in the mailbox rather than consulting the list of labels in the Babyl options section, but the Babyl section is updated whenever the mailbox is modified.
Some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") methods implemented by [`Babyl`](#mailbox.Babyl "mailbox.Babyl") deserve special remarks:
`get_file`(*key*)In Babyl mailboxes, the headers of a message are not stored contiguously with the body of the message. To generate a file-like representation, the headers and body are copied together into an [`io.BytesIO`](io.xhtml#io.BytesIO "io.BytesIO") instance, which has an API identical to that of a file. As a result, the file-like object is truly independent of the underlying mailbox but does not save memory compared to a string representation.
`lock`()`unlock`()Three locking mechanisms are used---dot locking and, if available, the `flock()` and `lockf()` system calls.
参见
[Format of Version 5 Babyl Files](https://quimby.gnus.org/notes/BABYL) \[https://quimby.gnus.org/notes/BABYL\]A specification of the Babyl format.
[Reading Mail with Rmail](https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html) \[https://www.gnu.org/software/emacs/manual/html\_node/emacs/Rmail.html\]The Rmail manual, with some information on Babyl semantics.
### [`MMDF`](#mailbox.MMDF "mailbox.MMDF")
*class* `mailbox.``MMDF`(*path*, *factory=None*, *create=True*)A subclass of [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") for mailboxes in MMDF format. Parameter *factory*is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If *factory* is `None`, [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") is used as the default message representation. If *create* is `True`, the mailbox is created if it does not exist.
MMDF is a single-file mailbox format invented for the Multichannel Memorandum Distribution Facility, a mail transfer agent. Each message is in the same form as an mbox message but is bracketed before and after by lines containing four Control-A (`'\001'`) characters. As with the mbox format, the beginning of each message is indicated by a line whose first five characters are "From ", but additional occurrences of "From " are not transformed to ">From " when storing messages because the extra message separator lines prevent mistaking such occurrences for the starts of subsequent messages.
Some [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") methods implemented by [`MMDF`](#mailbox.MMDF "mailbox.MMDF") deserve special remarks:
`get_file`(*key*)Using the file after calling `flush()` or `close()` on the [`MMDF`](#mailbox.MMDF "mailbox.MMDF") instance may yield unpredictable results or raise an exception.
`lock`()`unlock`()Three locking mechanisms are used---dot locking and, if available, the `flock()` and `lockf()` system calls.
参见
[mmdf man page from tin](http://www.tin.org/bin/man.cgi?section=5&topic=mmdf) \[http://www.tin.org/bin/man.cgi?section=5&topic=mmdf\]A specification of MMDF format from the documentation of tin, a newsreader.
[MMDF](https://en.wikipedia.org/wiki/MMDF) \[https://en.wikipedia.org/wiki/MMDF\]A Wikipedia article describing the Multichannel Memorandum Distribution Facility.
## [`Message`](#mailbox.Message "mailbox.Message") objects
*class* `mailbox.``Message`(*message=None*)A subclass of the [`email.message`](email.compat32-message.xhtml#module-email.message "email.message: The base class representing email messages in a fashion backward compatible with Python 3.2") module's [`Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message"). Subclasses of [`mailbox.Message`](#mailbox.Message "mailbox.Message") add mailbox-format-specific state and behavior.
If *message* is omitted, the new instance is created in a default, empty state. If *message* is an [`email.message.Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") instance, its contents are copied; furthermore, any format-specific information is converted insofar as possible if *message* is a [`Message`](#mailbox.Message "mailbox.Message") instance. If *message* is a string, a byte string, or a file, it should contain an [**RFC 2822**](https://tools.ietf.org/html/rfc2822.html) \[https://tools.ietf.org/html/rfc2822.html\]-compliant message, which is read and parsed. Files should be open in binary mode, but text mode files are accepted for backward compatibility.
The format-specific state and behaviors offered by subclasses vary, but in general it is only the properties that are not specific to a particular mailbox that are supported (although presumably the properties are specific to a particular mailbox format). For example, file offsets for single-file mailbox formats and file names for directory-based mailbox formats are not retained, because they are only applicable to the original mailbox. But state such as whether a message has been read by the user or marked as important is retained, because it applies to the message itself.
There is no requirement that [`Message`](#mailbox.Message "mailbox.Message") instances be used to represent messages retrieved using [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instances. In some situations, the time and memory required to generate [`Message`](#mailbox.Message "mailbox.Message") representations might not be acceptable. For such situations, [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instances also offer string and file-like representations, and a custom message factory may be specified when a [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") instance is initialized.
### [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage")
*class* `mailbox.``MaildirMessage`(*message=None*)A message with Maildir-specific behaviors. Parameter *message* has the same meaning as with the [`Message`](#mailbox.Message "mailbox.Message") constructor.
Typically, a mail user agent application moves all of the messages in the `new` subdirectory to the `cur` subdirectory after the first time the user opens and closes the mailbox, recording that the messages are old whether or not they've actually been read. Each message in `cur` has an "info" section added to its file name to store information about its state. (Some mail readers may also add an "info" section to messages in `new`.) The "info" section may take one of two forms: it may contain "2," followed by a list of standardized flags (e.g., "2,FR") or it may contain "1," followed by so-called experimental information. Standard flags for Maildir messages are as follows:
标志
意义
解释
D
Draft
Under composition
F
Flagged
Marked as important
P
Passed
Forwarded, resent, or bounced
R
Replied
Replied to
S
Seen
Read
T
Trashed
Marked for subsequent deletion
[`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instances offer the following methods:
`get_subdir`()Return either "new" (if the message should be stored in the `new`subdirectory) or "cur" (if the message should be stored in the `cur`subdirectory).
注解
A message is typically moved from `new` to `cur` after its mailbox has been accessed, whether or not the message is has been read. A message `msg` has been read if `"S" in msg.get_flags()` is `True`.
`set_subdir`(*subdir*)Set the subdirectory the message should be stored in. Parameter *subdir*must be either "new" or "cur".
`get_flags`()Return a string specifying the flags that are currently set. If the message complies with the standard Maildir format, the result is the concatenation in alphabetical order of zero or one occurrence of each of `'D'`, `'F'`, `'P'`, `'R'`, `'S'`, and `'T'`. The empty string is returned if no flags are set or if "info" contains experimental semantics.
`set_flags`(*flags*)Set the flags specified by *flags* and unset all others.
`add_flag`(*flag*)Set the flag(s) specified by *flag* without changing other flags. To add more than one flag at a time, *flag* may be a string of more than one character. The current "info" is overwritten whether or not it contains experimental information rather than flags.
`remove_flag`(*flag*)Unset the flag(s) specified by *flag* without changing other flags. To remove more than one flag at a time, *flag* maybe a string of more than one character. If "info" contains experimental information rather than flags, the current "info" is not modified.
`get_date`()Return the delivery date of the message as a floating-point number representing seconds since the epoch.
`set_date`(*date*)Set the delivery date of the message to *date*, a floating-point number representing seconds since the epoch.
`get_info`()Return a string containing the "info" for a message. This is useful for accessing and modifying "info" that is experimental (i.e., not a list of flags).
`set_info`(*info*)Set "info" to *info*, which should be a string.
When a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance is created based upon an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance, the *Status*and *X-Status* headers are omitted and the following conversions take place:
Resulting state
[`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage")state
"cur" subdirectory
O flag
F flag
F flag
R flag
A flag
S flag
R flag
T flag
D flag
When a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance is created based upon an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance, the following conversions take place:
Resulting state
[`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") state
"cur" subdirectory
"unseen" sequence
"cur" subdirectory and S flag
no "unseen" sequence
F flag
"flagged" sequence
R flag
"replied" sequence
When a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance is created based upon a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance, the following conversions take place:
Resulting state
[`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") state
"cur" subdirectory
"unseen" label
"cur" subdirectory and S flag
no "unseen" label
P flag
"forwarded" or "resent" label
R flag
"answered" label
T flag
"deleted" label
### [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage")
*class* `mailbox.``mboxMessage`(*message=None*)A message with mbox-specific behaviors. Parameter *message* has the same meaning as with the [`Message`](#mailbox.Message "mailbox.Message") constructor.
Messages in an mbox mailbox are stored together in a single file. The sender's envelope address and the time of delivery are typically stored in a line beginning with "From " that is used to indicate the start of a message, though there is considerable variation in the exact format of this data among mbox implementations. Flags that indicate the state of the message, such as whether it has been read or marked as important, are typically stored in *Status* and *X-Status* headers.
Conventional flags for mbox messages are as follows:
标志
意义
解释
R
Read
Read
O
Old
Previously detected by MUA
D
Deleted
Marked for subsequent deletion
F
Flagged
Marked as important
A
Answered
Replied to
The "R" and "O" flags are stored in the *Status* header, and the "D", "F", and "A" flags are stored in the *X-Status* header. The flags and headers typically appear in the order mentioned.
[`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instances offer the following methods:
`get_from`()Return a string representing the "From " line that marks the start of the message in an mbox mailbox. The leading "From " and the trailing newline are excluded.
`set_from`(*from\_*, *time\_=None*)Set the "From " line to *from\_*, which should be specified without a leading "From " or trailing newline. For convenience, *time\_* may be specified and will be formatted appropriately and appended to *from\_*. If *time\_* is specified, it should be a [`time.struct_time`](time.xhtml#time.struct_time "time.struct_time") instance, a tuple suitable for passing to [`time.strftime()`](time.xhtml#time.strftime "time.strftime"), or `True` (to use [`time.gmtime()`](time.xhtml#time.gmtime "time.gmtime")).
`get_flags`()Return a string specifying the flags that are currently set. If the message complies with the conventional format, the result is the concatenation in the following order of zero or one occurrence of each of `'R'`, `'O'`, `'D'`, `'F'`, and `'A'`.
`set_flags`(*flags*)Set the flags specified by *flags* and unset all others. Parameter *flags*should be the concatenation in any order of zero or more occurrences of each of `'R'`, `'O'`, `'D'`, `'F'`, and `'A'`.
`add_flag`(*flag*)Set the flag(s) specified by *flag* without changing other flags. To add more than one flag at a time, *flag* may be a string of more than one character.
`remove_flag`(*flag*)Unset the flag(s) specified by *flag* without changing other flags. To remove more than one flag at a time, *flag* maybe a string of more than one character.
When an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance is created based upon a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance, a "From " line is generated based upon the [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance's delivery date, and the following conversions take place:
Resulting state
[`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") state
R flag
S flag
O flag
"cur" subdirectory
D flag
T flag
F flag
F flag
A flag
R flag
When an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance is created based upon an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance, the following conversions take place:
Resulting state
[`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") state
R flag and O flag
no "unseen" sequence
O flag
"unseen" sequence
F flag
"flagged" sequence
A flag
"replied" sequence
When an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance is created based upon a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance, the following conversions take place:
Resulting state
[`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") state
R flag and O flag
no "unseen" label
O flag
"unseen" label
D flag
"deleted" label
A flag
"answered" label
When a [`Message`](#mailbox.Message "mailbox.Message") instance is created based upon an [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage")instance, the "From " line is copied and all flags directly correspond:
Resulting state
[`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") state
R flag
R flag
O flag
O flag
D flag
D flag
F flag
F flag
A flag
A flag
### [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage")
*class* `mailbox.``MHMessage`(*message=None*)A message with MH-specific behaviors. Parameter *message* has the same meaning as with the [`Message`](#mailbox.Message "mailbox.Message") constructor.
MH messages do not support marks or flags in the traditional sense, but they do support sequences, which are logical groupings of arbitrary messages. Some mail reading programs (although not the standard **mh** and **nmh**) use sequences in much the same way flags are used with other formats, as follows:
Sequence
解释
unseen
Not read, but previously detected by MUA
replied
Replied to
flagged
Marked as important
[`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instances offer the following methods:
`get_sequences`()Return a list of the names of sequences that include this message.
`set_sequences`(*sequences*)Set the list of sequences that include this message.
`add_sequence`(*sequence*)Add *sequence* to the list of sequences that include this message.
`remove_sequence`(*sequence*)Remove *sequence* from the list of sequences that include this message.
When an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance is created based upon a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance, the following conversions take place:
Resulting state
[`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") state
"unseen" sequence
no S flag
"replied" sequence
R flag
"flagged" sequence
F flag
When an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance is created based upon an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance, the *Status*and *X-Status* headers are omitted and the following conversions take place:
Resulting state
[`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage")state
"unseen" sequence
no R flag
"replied" sequence
A flag
"flagged" sequence
F flag
When an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance is created based upon a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance, the following conversions take place:
Resulting state
[`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") state
"unseen" sequence
"unseen" label
"replied" sequence
"answered" label
### [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage")
*class* `mailbox.``BabylMessage`(*message=None*)A message with Babyl-specific behaviors. Parameter *message* has the same meaning as with the [`Message`](#mailbox.Message "mailbox.Message") constructor.
Certain message labels, called *attributes*, are defined by convention to have special meanings. The attributes are as follows:
Label
解释
unseen
Not read, but previously detected by MUA
deleted
Marked for subsequent deletion
filed
Copied to another file or mailbox
answered
Replied to
forwarded
Forwarded
edited
Modified by the user
resent
Resent
By default, Rmail displays only visible headers. The [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage")class, though, uses the original headers because they are more complete. Visible headers may be accessed explicitly if desired.
[`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instances offer the following methods:
`get_labels`()Return a list of labels on the message.
`set_labels`(*labels*)Set the list of labels on the message to *labels*.
`add_label`(*label*)Add *label* to the list of labels on the message.
`remove_label`(*label*)Remove *label* from the list of labels on the message.
`get_visible`()Return an [`Message`](#mailbox.Message "mailbox.Message") instance whose headers are the message's visible headers and whose body is empty.
`set_visible`(*visible*)Set the message's visible headers to be the same as the headers in *message*. Parameter *visible* should be a [`Message`](#mailbox.Message "mailbox.Message") instance, an [`email.message.Message`](email.compat32-message.xhtml#email.message.Message "email.message.Message") instance, a string, or a file-like object (which should be open in text mode).
`update_visible`()When a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance's original headers are modified, the visible headers are not automatically modified to correspond. This method updates the visible headers as follows: each visible header with a corresponding original header is set to the value of the original header, each visible header without a corresponding original header is removed, and any of *Date*, *From*, *Reply-To*, *To*, *CC*, and *Subject* that are present in the original headers but not the visible headers are added to the visible headers.
When a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance is created based upon a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance, the following conversions take place:
Resulting state
[`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") state
"unseen" label
no S flag
"deleted" label
T flag
"answered" label
R flag
"forwarded" label
P flag
When a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance is created based upon an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance, the *Status*and *X-Status* headers are omitted and the following conversions take place:
Resulting state
[`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") or [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage")state
"unseen" label
no R flag
"deleted" label
D flag
"answered" label
A flag
When a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance is created based upon an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance, the following conversions take place:
Resulting state
[`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") state
"unseen" label
"unseen" sequence
"answered" label
"replied" sequence
### [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage")
*class* `mailbox.``MMDFMessage`(*message=None*)A message with MMDF-specific behaviors. Parameter *message* has the same meaning as with the [`Message`](#mailbox.Message "mailbox.Message") constructor.
As with message in an mbox mailbox, MMDF messages are stored with the sender's address and the delivery date in an initial line beginning with "From ". Likewise, flags that indicate the state of the message are typically stored in *Status* and *X-Status* headers.
Conventional flags for MMDF messages are identical to those of mbox message and are as follows:
标志
意义
解释
R
Read
Read
O
Old
Previously detected by MUA
D
Deleted
Marked for subsequent deletion
F
Flagged
Marked as important
A
Answered
Replied to
The "R" and "O" flags are stored in the *Status* header, and the "D", "F", and "A" flags are stored in the *X-Status* header. The flags and headers typically appear in the order mentioned.
[`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instances offer the following methods, which are identical to those offered by [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage"):
`get_from`()Return a string representing the "From " line that marks the start of the message in an mbox mailbox. The leading "From " and the trailing newline are excluded.
`set_from`(*from\_*, *time\_=None*)Set the "From " line to *from\_*, which should be specified without a leading "From " or trailing newline. For convenience, *time\_* may be specified and will be formatted appropriately and appended to *from\_*. If *time\_* is specified, it should be a [`time.struct_time`](time.xhtml#time.struct_time "time.struct_time") instance, a tuple suitable for passing to [`time.strftime()`](time.xhtml#time.strftime "time.strftime"), or `True` (to use [`time.gmtime()`](time.xhtml#time.gmtime "time.gmtime")).
`get_flags`()Return a string specifying the flags that are currently set. If the message complies with the conventional format, the result is the concatenation in the following order of zero or one occurrence of each of `'R'`, `'O'`, `'D'`, `'F'`, and `'A'`.
`set_flags`(*flags*)Set the flags specified by *flags* and unset all others. Parameter *flags*should be the concatenation in any order of zero or more occurrences of each of `'R'`, `'O'`, `'D'`, `'F'`, and `'A'`.
`add_flag`(*flag*)Set the flag(s) specified by *flag* without changing other flags. To add more than one flag at a time, *flag* may be a string of more than one character.
`remove_flag`(*flag*)Unset the flag(s) specified by *flag* without changing other flags. To remove more than one flag at a time, *flag* maybe a string of more than one character.
When an [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance is created based upon a [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance, a "From " line is generated based upon the [`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") instance's delivery date, and the following conversions take place:
Resulting state
[`MaildirMessage`](#mailbox.MaildirMessage "mailbox.MaildirMessage") state
R flag
S flag
O flag
"cur" subdirectory
D flag
T flag
F flag
F flag
A flag
R flag
When an [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance is created based upon an [`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") instance, the following conversions take place:
Resulting state
[`MHMessage`](#mailbox.MHMessage "mailbox.MHMessage") state
R flag and O flag
no "unseen" sequence
O flag
"unseen" sequence
F flag
"flagged" sequence
A flag
"replied" sequence
When an [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance is created based upon a [`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") instance, the following conversions take place:
Resulting state
[`BabylMessage`](#mailbox.BabylMessage "mailbox.BabylMessage") state
R flag and O flag
no "unseen" label
O flag
"unseen" label
D flag
"deleted" label
A flag
"answered" label
When an [`MMDFMessage`](#mailbox.MMDFMessage "mailbox.MMDFMessage") instance is created based upon an [`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") instance, the "From " line is copied and all flags directly correspond:
Resulting state
[`mboxMessage`](#mailbox.mboxMessage "mailbox.mboxMessage") state
R flag
R flag
O flag
O flag
D flag
D flag
F flag
F flag
A flag
A flag
## 异常
The following exception classes are defined in the [`mailbox`](#module-mailbox "mailbox: Manipulate mailboxes in various formats") module:
*exception* `mailbox.``Error`The based class for all other module-specific exceptions.
*exception* `mailbox.``NoSuchMailboxError`Raised when a mailbox is expected but is not found, such as when instantiating a [`Mailbox`](#mailbox.Mailbox "mailbox.Mailbox") subclass with a path that does not exist (and with the *create*parameter set to `False`), or when opening a folder that does not exist.
*exception* `mailbox.``NotEmptyError`Raised when a mailbox is not empty but is expected to be, such as when deleting a folder that contains messages.
*exception* `mailbox.``ExternalClashError`Raised when some mailbox-related condition beyond the control of the program causes it to be unable to proceed, such as when failing to acquire a lock that another program already holds a lock, or when a uniquely-generated file name already exists.
*exception* `mailbox.``FormatError`Raised when the data in a file cannot be parsed, such as when an [`MH`](#mailbox.MH "mailbox.MH")instance attempts to read a corrupted `.mh_sequences` file.
## 示例
A simple example of printing the subjects of all messages in a mailbox that seem interesting:
```
import mailbox
for message in mailbox.mbox('~/mbox'):
subject = message['subject'] # Could possibly be None.
if subject and 'python' in subject.lower():
print(subject)
```
To copy all mail from a Babyl mailbox to an MH mailbox, converting all of the format-specific information that can be converted:
```
import mailbox
destination = mailbox.MH('~/Mail')
destination.lock()
for message in mailbox.Babyl('~/RMAIL'):
destination.add(mailbox.MHMessage(message))
destination.flush()
destination.unlock()
```
This example sorts mail from several mailing lists into different mailboxes, being careful to avoid mail corruption due to concurrent modification by other programs, mail loss due to interruption of the program, or premature termination due to malformed messages in the mailbox:
```
import mailbox
import email.errors
list_names = ('python-list', 'python-dev', 'python-bugs')
boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names}
inbox = mailbox.Maildir('~/Maildir', factory=None)
for key in inbox.iterkeys():
try:
message = inbox[key]
except email.errors.MessageParseError:
continue # The message is malformed. Just leave it.
for name in list_names:
list_id = message['list-id']
if list_id and name in list_id:
# Get mailbox to use
box = boxes[name]
# Write copy to disk before removing original.
# If there's a crash, you might duplicate a message, but
# that's better than losing a message completely.
box.lock()
box.add(message)
box.flush()
box.unlock()
# Remove original message
inbox.lock()
inbox.discard(key)
inbox.flush()
inbox.unlock()
break # Found destination, so stop looking.
for box in boxes.itervalues():
box.close()
```
### 导航
- [索引](../genindex.xhtml "总目录")
- [模块](../py-modindex.xhtml "Python 模块索引") |
- [下一页](mimetypes.xhtml "mimetypes --- Map filenames to MIME types") |
- [上一页](mailcap.xhtml "mailcap --- Mailcap file handling") |
- 
- [Python](https://www.python.org/) »
- zh\_CN 3.7.3 [文档](../index.xhtml) »
- [Python 标准库](index.xhtml) »
- [互联网数据处理](netdata.xhtml) »
- $('.inline-search').show(0); |
© [版权所有](../copyright.xhtml) 2001-2019, Python Software Foundation.
Python 软件基金会是一个非盈利组织。 [请捐助。](https://www.python.org/psf/donations/)
最后更新于 5月 21, 2019. [发现了问题](../bugs.xhtml)？
使用[Sphinx](http://sphinx.pocoo.org/)1.8.4 创建。
- Python文档内容
- Python 有什么新变化？
- Python 3.7 有什么新变化
- 摘要 - 发布重点
- 新的特性
- 其他语言特性修改
- 新增模块
- 改进的模块
- C API 的改变
- 构建的改变
- 性能优化
- 其他 CPython 实现的改变
- 已弃用的 Python 行为
- 已弃用的 Python 模块、函数和方法
- 已弃用的 C API 函数和类型
- 平台支持的移除
- API 与特性的移除
- 移除的模块
- Windows 专属的改变
- 移植到 Python 3.7
- Python 3.7.1 中的重要变化
- Python 3.7.2 中的重要变化
- Python 3.6 有什么新变化A
- 摘要 - 发布重点
- 新的特性
- 其他语言特性修改
- 新增模块
- 改进的模块
- 性能优化
- Build and C API Changes
- 其他改进
- 弃用
- 移除
- 移植到Python 3.6
- Python 3.6.2 中的重要变化
- Python 3.6.4 中的重要变化
- Python 3.6.5 中的重要变化
- Python 3.6.7 中的重要变化
- Python 3.5 有什么新变化
- 摘要 - 发布重点
- 新的特性
- 其他语言特性修改
- 新增模块
- 改进的模块
- Other module-level changes
- 性能优化
- Build and C API Changes
- 弃用
- 移除
- Porting to Python 3.5
- Notable changes in Python 3.5.4
- What's New In Python 3.4
- 摘要 - 发布重点
- 新的特性
- 新增模块
- 改进的模块
- CPython Implementation Changes
- 弃用
- 移除
- Porting to Python 3.4
- Changed in 3.4.3
- What's New In Python 3.3
- 摘要 - 发布重点
- PEP 405: Virtual Environments
- PEP 420: Implicit Namespace Packages
- PEP 3118: New memoryview implementation and buffer protocol documentation
- PEP 393: Flexible String Representation
- PEP 397: Python Launcher for Windows
- PEP 3151: Reworking the OS and IO exception hierarchy
- PEP 380: Syntax for Delegating to a Subgenerator
- PEP 409: Suppressing exception context
- PEP 414: Explicit Unicode literals
- PEP 3155: Qualified name for classes and functions
- PEP 412: Key-Sharing Dictionary
- PEP 362: Function Signature Object
- PEP 421: Adding sys.implementation
- Using importlib as the Implementation of Import
- 其他语言特性修改
- A Finer-Grained Import Lock
- Builtin functions and types
- 新增模块
- 改进的模块
- 性能优化
- Build and C API Changes
- 弃用
- Porting to Python 3.3
- What's New In Python 3.2
- PEP 384: Defining a Stable ABI
- PEP 389: Argparse Command Line Parsing Module
- PEP 391: Dictionary Based Configuration for Logging
- PEP 3148: The concurrent.futures module
- PEP 3147: PYC Repository Directories
- PEP 3149: ABI Version Tagged .so Files
- PEP 3333: Python Web Server Gateway Interface v1.0.1
- 其他语言特性修改
- New, Improved, and Deprecated Modules
- 多线程
- 性能优化
- Unicode
- Codecs
- 文档
- IDLE
- Code Repository
- Build and C API Changes
- Porting to Python 3.2
- What's New In Python 3.1
- PEP 372: Ordered Dictionaries
- PEP 378: Format Specifier for Thousands Separator
- 其他语言特性修改
- New, Improved, and Deprecated Modules
- 性能优化
- IDLE
- Build and C API Changes
- Porting to Python 3.1
- What's New In Python 3.0
- Common Stumbling Blocks
- Overview Of Syntax Changes
- Changes Already Present In Python 2.6
- Library Changes
- PEP 3101: A New Approach To String Formatting
- Changes To Exceptions
- Miscellaneous Other Changes
- Build and C API Changes
- 性能
- Porting To Python 3.0
- What's New in Python 2.7
- The Future for Python 2.x
- Changes to the Handling of Deprecation Warnings
- Python 3.1 Features
- PEP 372: Adding an Ordered Dictionary to collections
- PEP 378: Format Specifier for Thousands Separator
- PEP 389: The argparse Module for Parsing Command Lines
- PEP 391: Dictionary-Based Configuration For Logging
- PEP 3106: Dictionary Views
- PEP 3137: The memoryview Object
- 其他语言特性修改
- New and Improved Modules
- Build and C API Changes
- Other Changes and Fixes
- Porting to Python 2.7
- New Features Added to Python 2.7 Maintenance Releases
- Acknowledgements
- Python 2.6 有什么新变化
- Python 3.0
- Changes to the Development Process
- PEP 343: The 'with' statement
- PEP 366: Explicit Relative Imports From a Main Module
- PEP 370: Per-user site-packages Directory
- PEP 371: The multiprocessing Package
- PEP 3101: Advanced String Formatting
- PEP 3105: print As a Function
- PEP 3110: Exception-Handling Changes
- PEP 3112: Byte Literals
- PEP 3116: New I/O Library
- PEP 3118: Revised Buffer Protocol
- PEP 3119: Abstract Base Classes
- PEP 3127: Integer Literal Support and Syntax
- PEP 3129: Class Decorators
- PEP 3141: A Type Hierarchy for Numbers
- 其他语言特性修改
- New and Improved Modules
- Deprecations and Removals
- Build and C API Changes
- Porting to Python 2.6
- Acknowledgements
- What's New in Python 2.5
- PEP 308: Conditional Expressions
- PEP 309: Partial Function Application
- PEP 314: Metadata for Python Software Packages v1.1
- PEP 328: Absolute and Relative Imports
- PEP 338: Executing Modules as Scripts
- PEP 341: Unified try/except/finally
- PEP 342: New Generator Features
- PEP 343: The 'with' statement
- PEP 352: Exceptions as New-Style Classes
- PEP 353: Using ssize_t as the index type
- PEP 357: The 'index' method
- 其他语言特性修改
- New, Improved, and Removed Modules
- Build and C API Changes
- Porting to Python 2.5
- Acknowledgements
- What's New in Python 2.4
- PEP 218: Built-In Set Objects
- PEP 237: Unifying Long Integers and Integers
- PEP 289: Generator Expressions
- PEP 292: Simpler String Substitutions
- PEP 318: Decorators for Functions and Methods
- PEP 322: Reverse Iteration
- PEP 324: New subprocess Module
- PEP 327: Decimal Data Type
- PEP 328: Multi-line Imports
- PEP 331: Locale-Independent Float/String Conversions
- 其他语言特性修改
- New, Improved, and Deprecated Modules
- Build and C API Changes
- Porting to Python 2.4
- Acknowledgements
- What's New in Python 2.3
- PEP 218: A Standard Set Datatype
- PEP 255: Simple Generators
- PEP 263: Source Code Encodings
- PEP 273: Importing Modules from ZIP Archives
- PEP 277: Unicode file name support for Windows NT
- PEP 278: Universal Newline Support
- PEP 279: enumerate()
- PEP 282: The logging Package
- PEP 285: A Boolean Type
- PEP 293: Codec Error Handling Callbacks
- PEP 301: Package Index and Metadata for Distutils
- PEP 302: New Import Hooks
- PEP 305: Comma-separated Files
- PEP 307: Pickle Enhancements
- Extended Slices
- 其他语言特性修改
- New, Improved, and Deprecated Modules
- Pymalloc: A Specialized Object Allocator
- Build and C API Changes
- Other Changes and Fixes
- Porting to Python 2.3
- Acknowledgements
- What's New in Python 2.2
- 概述
- PEPs 252 and 253: Type and Class Changes
- PEP 234: Iterators
- PEP 255: Simple Generators
- PEP 237: Unifying Long Integers and Integers
- PEP 238: Changing the Division Operator
- Unicode Changes
- PEP 227: Nested Scopes
- New and Improved Modules
- Interpreter Changes and Fixes
- Other Changes and Fixes
- Acknowledgements
- What's New in Python 2.1
- 概述
- PEP 227: Nested Scopes
- PEP 236: future Directives
- PEP 207: Rich Comparisons
- PEP 230: Warning Framework
- PEP 229: New Build System
- PEP 205: Weak References
- PEP 232: Function Attributes
- PEP 235: Importing Modules on Case-Insensitive Platforms
- PEP 217: Interactive Display Hook
- PEP 208: New Coercion Model
- PEP 241: Metadata in Python Packages
- New and Improved Modules
- Other Changes and Fixes
- Acknowledgements
- What's New in Python 2.0
- 概述
- What About Python 1.6?
- New Development Process
- Unicode
- 列表推导式
- Augmented Assignment
- 字符串的方法
- Garbage Collection of Cycles
- Other Core Changes
- Porting to 2.0
- Extending/Embedding Changes
- Distutils: Making Modules Easy to Install
- XML Modules
- Module changes
- New modules
- IDLE Improvements
- Deleted and Deprecated Modules
- Acknowledgements
- 更新日志
- Python 下一版
- Python 3.7.3 最终版
- Python 3.7.3 发布候选版 1
- Python 3.7.2 最终版
- Python 3.7.2 发布候选版 1
- Python 3.7.1 最终版
- Python 3.7.1 RC 2版本
- Python 3.7.1 发布候选版 1
- Python 3.7.0 正式版
- Python 3.7.0 release candidate 1
- Python 3.7.0 beta 5
- Python 3.7.0 beta 4
- Python 3.7.0 beta 3
- Python 3.7.0 beta 2
- Python 3.7.0 beta 1
- Python 3.7.0 alpha 4
- Python 3.7.0 alpha 3
- Python 3.7.0 alpha 2
- Python 3.7.0 alpha 1
- Python 3.6.6 final
- Python 3.6.6 RC 1
- Python 3.6.5 final
- Python 3.6.5 release candidate 1
- Python 3.6.4 final
- Python 3.6.4 release candidate 1
- Python 3.6.3 final
- Python 3.6.3 release candidate 1
- Python 3.6.2 final
- Python 3.6.2 release candidate 2
- Python 3.6.2 release candidate 1
- Python 3.6.1 final
- Python 3.6.1 release candidate 1
- Python 3.6.0 final
- Python 3.6.0 release candidate 2
- Python 3.6.0 release candidate 1
- Python 3.6.0 beta 4
- Python 3.6.0 beta 3
- Python 3.6.0 beta 2
- Python 3.6.0 beta 1
- Python 3.6.0 alpha 4
- Python 3.6.0 alpha 3
- Python 3.6.0 alpha 2
- Python 3.6.0 alpha 1
- Python 3.5.5 final
- Python 3.5.5 release candidate 1
- Python 3.5.4 final
- Python 3.5.4 release candidate 1
- Python 3.5.3 final
- Python 3.5.3 release candidate 1
- Python 3.5.2 final
- Python 3.5.2 release candidate 1
- Python 3.5.1 final
- Python 3.5.1 release candidate 1
- Python 3.5.0 final
- Python 3.5.0 release candidate 4
- Python 3.5.0 release candidate 3
- Python 3.5.0 release candidate 2
- Python 3.5.0 release candidate 1
- Python 3.5.0 beta 4
- Python 3.5.0 beta 3
- Python 3.5.0 beta 2
- Python 3.5.0 beta 1
- Python 3.5.0 alpha 4
- Python 3.5.0 alpha 3
- Python 3.5.0 alpha 2
- Python 3.5.0 alpha 1
- Python 教程
- 课前甜点
- 使用 Python 解释器
- 调用解释器
- 解释器的运行环境
- Python 的非正式介绍
- Python 作为计算器使用
- 走向编程的第一步
- 其他流程控制工具
- if 语句
- for 语句
- range() 函数
- break 和 continue 语句，以及循环中的 else 子句
- pass 语句
- 定义函数
- 函数定义的更多形式
- 小插曲：编码风格
- 数据结构
- 列表的更多特性
- del 语句
- 元组和序列
- 集合
- 字典
- 循环的技巧
- 深入条件控制
- 序列和其它类型的比较
- 模块
- 有关模块的更多信息
- 标准模块
- dir() 函数
- 包
- 输入输出
- 更漂亮的输出格式
- 读写文件
- 错误和异常
- 语法错误
- 异常
- 处理异常
- 抛出异常
- 用户自定义异常
- 定义清理操作
- 预定义的清理操作
- 类
- 名称和对象
- Python 作用域和命名空间
- 初探类
- 补充说明
- 继承
- 私有变量
- 杂项说明
- 迭代器
- 生成器
- 生成器表达式
- 标准库简介
- 操作系统接口
- 文件通配符
- 命令行参数
- 错误输出重定向和程序终止
- 字符串模式匹配
- 数学
- 互联网访问
- 日期和时间
- 数据压缩
- 性能测量
- 质量控制
- 自带电池
- 标准库简介 —— 第二部分
- 格式化输出
- 模板
- 使用二进制数据记录格式
- 多线程
- 日志
- 弱引用
- 用于操作列表的工具
- 十进制浮点运算
- 虚拟环境和包
- 概述
- 创建虚拟环境
- 使用pip管理包
- 接下来？
- 交互式编辑和编辑历史
- Tab 补全和编辑历史
- 默认交互式解释器的替代品
- 浮点算术：争议和限制
- 表示性错误
- 附录
- 交互模式
- 安装和使用 Python
- 命令行与环境
- 命令行
- 环境变量
- 在Unix平台中使用Python
- 获取最新版本的Python
- 构建Python
- 与Python相关的路径和文件
- 杂项
- 编辑器和集成开发环境
- 在Windows上使用 Python
- 完整安装程序
- Microsoft Store包
- nuget.org 安装包
- 可嵌入的包
- 替代捆绑包
- 配置Python
- 适用于Windows的Python启动器
- 查找模块
- 附加模块
- 在Windows上编译Python
- 其他平台
- 在苹果系统上使用 Python
- 获取和安装 MacPython
- IDE
- 安装额外的 Python 包
- Mac 上的图形界面编程
- 在 Mac 上分发 Python 应用程序
- 其他资源
- Python 语言参考
- 概述
- 其他实现
- 标注
- 词法分析
- 行结构
- 其他形符
- 标识符和关键字
- 字面值
- 运算符
- 分隔符
- 数据模型
- 对象、值与类型
- 标准类型层级结构
- 特殊方法名称
- 协程
- 执行模型
- 程序的结构
- 命名与绑定
- 异常
- 导入系统
- importlib
- 包
- 搜索
- 加载
- 基于路径的查找器
- 替换标准导入系统
- Package Relative Imports
- 有关 main 的特殊事项
- 开放问题项
- 参考文献
- 表达式
- 算术转换
- 原子
- 原型
- await 表达式
- 幂运算符
- 一元算术和位运算
- 二元算术运算符
- 移位运算
- 二元位运算
- 比较运算
- 布尔运算
- 条件表达式
- lambda 表达式
- 表达式列表
- 求值顺序
- 运算符优先级
- 简单语句
- 表达式语句
- 赋值语句
- assert 语句
- pass 语句
- del 语句
- return 语句
- yield 语句
- raise 语句
- break 语句
- continue 语句
- import 语句
- global 语句
- nonlocal 语句
- 复合语句
- if 语句
- while 语句
- for 语句
- try 语句
- with 语句
- 函数定义
- 类定义
- 协程
- 最高层级组件
- 完整的 Python 程序
- 文件输入
- 交互式输入
- 表达式输入
- 完整的语法规范
- Python 标准库
- 概述
- 可用性注释
- 内置函数
- 内置常量
- 由 site 模块添加的常量
- 内置类型
- 逻辑值检测
- 布尔运算 — and, or, not
- 比较
- 数字类型 — int, float, complex
- 迭代器类型
- 序列类型 — list, tuple, range
- 文本序列类型 — str
- 二进制序列类型 — bytes, bytearray, memoryview
- 集合类型 — set, frozenset
- 映射类型 — dict
- 上下文管理器类型
- 其他内置类型
- 特殊属性
- 内置异常
- 基类
- 具体异常
- 警告
- 异常层次结构
- 文本处理服务
- string — 常见的字符串操作
- re — 正则表达式操作
- 模块 difflib 是一个计算差异的助手
- textwrap — Text wrapping and filling
- unicodedata — Unicode 数据库
- stringprep — Internet String Preparation
- readline — GNU readline interface
- rlcompleter — GNU readline的完成函数
- 二进制数据服务
- struct — Interpret bytes as packed binary data
- codecs — Codec registry and base classes
- 数据类型
- datetime — 基础日期/时间数据类型
- calendar — General calendar-related functions
- collections — 容器数据类型
- collections.abc — 容器的抽象基类
- heapq — 堆队列算法
- bisect — Array bisection algorithm
- array — Efficient arrays of numeric values
- weakref — 弱引用
- types — Dynamic type creation and names for built-in types
- copy — 浅层 (shallow) 和深层 (deep) 复制操作
- pprint — 数据美化输出
- reprlib — Alternate repr() implementation
- enum — Support for enumerations
- 数字和数学模块
- numbers — 数字的抽象基类
- math — 数学函数
- cmath — Mathematical functions for complex numbers
- decimal — 十进制定点和浮点运算
- fractions — 分数
- random — 生成伪随机数
- statistics — Mathematical statistics functions
- 函数式编程模块
- itertools — 为高效循环而创建迭代器的函数
- functools — 高阶函数和可调用对象上的操作
- operator — 标准运算符替代函数
- 文件和目录访问
- pathlib — 面向对象的文件系统路径
- os.path — 常见路径操作
- fileinput — Iterate over lines from multiple input streams
- stat — Interpreting stat() results
- filecmp — File and Directory Comparisons
- tempfile — Generate temporary files and directories
- glob — Unix style pathname pattern expansion
- fnmatch — Unix filename pattern matching
- linecache — Random access to text lines
- shutil — High-level file operations
- macpath — Mac OS 9 路径操作函数
- 数据持久化
- pickle —— Python 对象序列化
- copyreg — Register pickle support functions
- shelve — Python object persistence
- marshal — Internal Python object serialization
- dbm — Interfaces to Unix “databases”
- sqlite3 — SQLite 数据库 DB-API 2.0 接口模块
- 数据压缩和存档
- zlib — 与 gzip 兼容的压缩
- gzip — 对 gzip 格式的支持
- bz2 — 对 bzip2 压缩算法的支持
- lzma — 用 LZMA 算法压缩
- zipfile — 在 ZIP 归档中工作
- tarfile — Read and write tar archive files
- 文件格式
- csv — CSV 文件读写
- configparser — Configuration file parser
- netrc — netrc file processing
- xdrlib — Encode and decode XDR data
- plistlib — Generate and parse Mac OS X .plist files
- 加密服务
- hashlib — 安全哈希与消息摘要
- hmac — 基于密钥的消息验证
- secrets — Generate secure random numbers for managing secrets
- 通用操作系统服务
- os — 操作系统接口模块
- io — 处理流的核心工具
- time — 时间的访问和转换
- argparse — 命令行选项、参数和子命令解析器
- getopt — C-style parser for command line options
- 模块 logging — Python 的日志记录工具
- logging.config — 日志记录配置
- logging.handlers — Logging handlers
- getpass — 便携式密码输入工具
- curses — 终端字符单元显示的处理
- curses.textpad — Text input widget for curses programs
- curses.ascii — Utilities for ASCII characters
- curses.panel — A panel stack extension for curses
- platform — Access to underlying platform's identifying data
- errno — Standard errno system symbols
- ctypes — Python 的外部函数库
- 并发执行
- threading — 基于线程的并行
- multiprocessing — 基于进程的并行
- concurrent 包
- concurrent.futures — 启动并行任务
- subprocess — 子进程管理
- sched — 事件调度器
- queue — 一个同步的队列类
- _thread — 底层多线程 API
- _dummy_thread — _thread 的替代模块
- dummy_threading — 可直接替代 threading 模块。
- contextvars — Context Variables
- Context Variables
- Manual Context Management
- asyncio support
- 网络和进程间通信
- asyncio — 异步 I/O
- socket — 底层网络接口
- ssl — TLS/SSL wrapper for socket objects
- select — Waiting for I/O completion
- selectors — 高级 I/O 复用库
- asyncore — 异步socket处理器
- asynchat — 异步 socket 指令/响应 处理器
- signal — Set handlers for asynchronous events
- mmap — Memory-mapped file support
- 互联网数据处理
- email — 电子邮件与 MIME 处理包
- json — JSON 编码和解码器
- mailcap — Mailcap file handling
- mailbox — Manipulate mailboxes in various formats
- mimetypes — Map filenames to MIME types
- base64 — Base16, Base32, Base64, Base85 数据编码
- binhex — 对binhex4文件进行编码和解码
- binascii — 二进制和 ASCII 码互转
- quopri — Encode and decode MIME quoted-printable data
- uu — Encode and decode uuencode files
- 结构化标记处理工具
- html — 超文本标记语言支持
- html.parser — 简单的 HTML 和 XHTML 解析器
- html.entities — HTML 一般实体的定义
- XML处理模块
- xml.etree.ElementTree — The ElementTree XML API
- xml.dom — The Document Object Model API
- xml.dom.minidom — Minimal DOM implementation
- xml.dom.pulldom — Support for building partial DOM trees
- xml.sax — Support for SAX2 parsers
- xml.sax.handler — Base classes for SAX handlers
- xml.sax.saxutils — SAX Utilities
- xml.sax.xmlreader — Interface for XML parsers
- xml.parsers.expat — Fast XML parsing using Expat
- 互联网协议和支持
- webbrowser — 方便的Web浏览器控制器
- cgi — Common Gateway Interface support
- cgitb — Traceback manager for CGI scripts
- wsgiref — WSGI Utilities and Reference Implementation
- urllib — URL 处理模块
- urllib.request — 用于打开 URL 的可扩展库
- urllib.response — Response classes used by urllib
- urllib.parse — Parse URLs into components
- urllib.error — Exception classes raised by urllib.request
- urllib.robotparser — Parser for robots.txt
- http — HTTP 模块
- http.client — HTTP协议客户端
- ftplib — FTP protocol client
- poplib — POP3 protocol client
- imaplib — IMAP4 protocol client
- nntplib — NNTP protocol client
- smtplib —SMTP协议客户端
- smtpd — SMTP Server
- telnetlib — Telnet client
- uuid — UUID objects according to RFC 4122
- socketserver — A framework for network servers
- http.server — HTTP 服务器
- http.cookies — HTTP state management
- http.cookiejar — Cookie handling for HTTP clients
- xmlrpc — XMLRPC 服务端与客户端模块
- xmlrpc.client — XML-RPC client access
- xmlrpc.server — Basic XML-RPC servers
- ipaddress — IPv4/IPv6 manipulation library
- 多媒体服务
- audioop — Manipulate raw audio data
- aifc — Read and write AIFF and AIFC files
- sunau — 读写 Sun AU 文件
- wave — 读写WAV格式文件
- chunk — Read IFF chunked data
- colorsys — Conversions between color systems
- imghdr — 推测图像类型
- sndhdr — 推测声音文件的类型
- ossaudiodev — Access to OSS-compatible audio devices
- 国际化
- gettext — 多语种国际化服务
- locale — 国际化服务
- 程序框架
- turtle — 海龟绘图
- cmd — 支持面向行的命令解释器
- shlex — Simple lexical analysis
- Tk图形用户界面(GUI)
- tkinter — Tcl/Tk的Python接口
- tkinter.ttk — Tk themed widgets
- tkinter.tix — Extension widgets for Tk
- tkinter.scrolledtext — 滚动文字控件
- IDLE
- 其他图形用户界面（GUI）包
- 开发工具
- typing — 类型标注支持
- pydoc — Documentation generator and online help system
- doctest — Test interactive Python examples
- unittest — 单元测试框架
- unittest.mock — mock object library
- unittest.mock 上手指南
- 2to3 - 自动将 Python 2 代码转为 Python 3 代码
- test — Regression tests package for Python
- test.support — Utilities for the Python test suite
- test.support.script_helper — Utilities for the Python execution tests
- 调试和分析
- bdb — Debugger framework
- faulthandler — Dump the Python traceback
- pdb — The Python Debugger
- The Python Profilers
- timeit — 测量小代码片段的执行时间
- trace — Trace or track Python statement execution
- tracemalloc — Trace memory allocations
- 软件打包和分发
- distutils — 构建和安装 Python 模块
- ensurepip — Bootstrapping the pip installer
- venv — 创建虚拟环境
- zipapp — Manage executable Python zip archives
- Python运行时服务
- sys — 系统相关的参数和函数
- sysconfig — Provide access to Python's configuration information
- builtins — 内建对象
- main — 顶层脚本环境
- warnings — Warning control
- dataclasses — 数据类
- contextlib — Utilities for with-statement contexts
- abc — 抽象基类
- atexit — 退出处理器
- traceback — Print or retrieve a stack traceback
- future — Future 语句定义
- gc — 垃圾回收器接口
- inspect — 检查对象
- site — Site-specific configuration hook
- 自定义 Python 解释器
- code — Interpreter base classes
- codeop — Compile Python code
- 导入模块
- zipimport — Import modules from Zip archives
- pkgutil — Package extension utility
- modulefinder — 查找脚本使用的模块
- runpy — Locating and executing Python modules
- importlib — The implementation of import
- Python 语言服务
- parser — Access Python parse trees
- ast — 抽象语法树
- symtable — Access to the compiler's symbol tables
- symbol — 与 Python 解析树一起使用的常量
- token — 与Python解析树一起使用的常量
- keyword — 检验Python关键字
- tokenize — Tokenizer for Python source
- tabnanny — 模糊缩进检测
- pyclbr — Python class browser support
- py_compile — Compile Python source files
- compileall — Byte-compile Python libraries
- dis — Python 字节码反汇编器
- pickletools — Tools for pickle developers
- 杂项服务
- formatter — Generic output formatting
- Windows系统相关模块
- msilib — Read and write Microsoft Installer files
- msvcrt — Useful routines from the MS VC++ runtime
- winreg — Windows 注册表访问
- winsound — Sound-playing interface for Windows
- Unix 专有服务
- posix — The most common POSIX system calls
- pwd — 用户密码数据库
- spwd — The shadow password database
- grp — The group database
- crypt — Function to check Unix passwords
- termios — POSIX style tty control
- tty — 终端控制功能
- pty — Pseudo-terminal utilities
- fcntl — The fcntl and ioctl system calls
- pipes — Interface to shell pipelines
- resource — Resource usage information
- nis — Interface to Sun's NIS (Yellow Pages)
- Unix syslog 库例程
- 被取代的模块
- optparse — Parser for command line options
- imp — Access the import internals
- 未创建文档的模块
- 平台特定模块
- 扩展和嵌入 Python 解释器
- 推荐的第三方工具
- 不使用第三方工具创建扩展
- 使用 C 或 C++ 扩展 Python
- 自定义扩展类型：教程
- 定义扩展类型：已分类主题
- 构建C/C++扩展
- 在Windows平台编译C和C++扩展
- 在更大的应用程序中嵌入 CPython 运行时
- Embedding Python in Another Application
- Python/C API 参考手册
- 概述
- 代码标准
- 包含文件
- 有用的宏
- 对象、类型和引用计数
- 异常
- 嵌入Python
- 调试构建
- 稳定的应用程序二进制接口
- The Very High Level Layer
- Reference Counting
- 异常处理
- Printing and clearing
- 抛出异常
- Issuing warnings
- Querying the error indicator
- Signal Handling
- Exception Classes
- Exception Objects
- Unicode Exception Objects
- Recursion Control
- 标准异常
- 标准警告类别
- 工具
- 操作系统实用程序
- 系统功能
- 过程控制
- 导入模块
- Data marshalling support
- 语句解释及变量编译
- 字符串转换与格式化
- 反射
- 编解码器注册与支持功能
- 抽象对象层
- Object Protocol
- 数字协议
- Sequence Protocol
- Mapping Protocol
- 迭代器协议
- 缓冲协议
- Old Buffer Protocol
- 具体的对象层
- 基本对象
- 数值对象
- 序列对象
- 容器对象
- 函数对象
- 其他对象
- Initialization, Finalization, and Threads
- 在Python初始化之前
- 全局配置变量
- Initializing and finalizing the interpreter
- Process-wide parameters
- Thread State and the Global Interpreter Lock
- Sub-interpreter support
- Asynchronous Notifications
- Profiling and Tracing
- Advanced Debugger Support
- Thread Local Storage Support
- 内存管理
- 概述
- 原始内存接口
- Memory Interface
- 对象分配器
- 默认内存分配器
- Customize Memory Allocators
- The pymalloc allocator
- tracemalloc C API
- 示例
- 对象实现支持
- 在堆中分配对象
- Common Object Structures
- Type 对象
- Number Object Structures
- Mapping Object Structures
- Sequence Object Structures
- Buffer Object Structures
- Async Object Structures
- 使对象类型支持循环垃圾回收
- API 和 ABI 版本管理
- 分发 Python 模块
- 关键术语
- 开源许可与协作
- 安装工具
- 阅读指南
- 我该如何...？
- ...为我的项目选择一个名字？
- ...创建和分发二进制扩展？
- 安装 Python 模块
- 关键术语
- 基本使用
- 我应如何 ...？
- ... 在 Python 3.4 之前的 Python 版本中安装 pip ？
- ... 只为当前用户安装软件包？
- ... 安装科学计算类 Python 软件包？
- ... 使用并行安装的多个 Python 版本？
- 常见的安装问题
- 在 Linux 的系统 Python 版本上安装
- 未安装 pip
- 安装二进制编译扩展
- Python 常用指引
- 将 Python 2 代码迁移到 Python 3
- 简要说明
- 详情
- 将扩展模块移植到 Python 3
- 条件编译
- 对象API的更改
- 模块初始化和状态
- CObject 替换为 Capsule
- 其他选项
- Curses Programming with Python
- What is curses?
- Starting and ending a curses application
- Windows and Pads
- Displaying Text
- User Input
- For More Information
- 实现描述器
- 摘要
- 定义和简介
- 描述器协议
- 发起调用描述符
- 描述符示例
- Properties
- 函数和方法
- Static Methods and Class Methods
- 函数式编程指引
- 概述
- 迭代器
- 生成器表达式和列表推导式
- 生成器
- 内置函数
- itertools 模块
- The functools module
- Small functions and the lambda expression
- Revision History and Acknowledgements
- 引用文献
- 日志 HOWTO
- 日志基础教程
- 进阶日志教程
- 日志级别
- 有用的处理程序
- 记录日志中引发的异常
- 使用任意对象作为消息
- 优化
- 日志操作手册
- 在多个模块中使用日志
- 在多线程中使用日志
- 使用多个日志处理器和多种格式化
- 在多个地方记录日志
- 日志服务器配置示例
- 处理日志处理器的阻塞
- Sending and receiving logging events across a network
- Adding contextual information to your logging output
- Logging to a single file from multiple processes
- Using file rotation
- Use of alternative formatting styles
- Customizing LogRecord
- Subclassing QueueHandler - a ZeroMQ example
- Subclassing QueueListener - a ZeroMQ example
- An example dictionary-based configuration
- Using a rotator and namer to customize log rotation processing
- A more elaborate multiprocessing example
- Inserting a BOM into messages sent to a SysLogHandler
- Implementing structured logging
- Customizing handlers with dictConfig()
- Using particular formatting styles throughout your application
- Configuring filters with dictConfig()
- Customized exception formatting
- Speaking logging messages
- Buffering logging messages and outputting them conditionally
- Formatting times using UTC (GMT) via configuration
- Using a context manager for selective logging
- 正则表达式HOWTO
- 概述
- 简单模式
- 使用正则表达式
- 更多模式能力
- 修改字符串
- 常见问题
- 反馈
- 套接字编程指南
- 套接字
- 创建套接字
- 使用一个套接字
- 断开连接
- 非阻塞的套接字
- 排序指南
- 基本排序
- 关键函数
- Operator 模块函数
- 升序和降序
- 排序稳定性和排序复杂度
- 使用装饰-排序-去装饰的旧方法
- 使用 cmp 参数的旧方法
- 其它
- Unicode 指南
- Unicode 概述
- Python's Unicode Support
- Reading and Writing Unicode Data
- Acknowledgements
- 如何使用urllib包获取网络资源
- 概述
- Fetching URLs
- 处理异常
- info and geturl
- Openers and Handlers
- Basic Authentication
- Proxies
- Sockets and Layers
- 脚注
- Argparse 教程
- 概念
- 基础
- 位置参数介绍
- Introducing Optional arguments
- Combining Positional and Optional arguments
- Getting a little more advanced
- Conclusion
- ipaddress模块介绍
- 创建 Address/Network/Interface 对象
- 审查 Address/Network/Interface 对象
- Network 作为 Address 列表
- 比较
- 将IP地址与其他模块一起使用
- 实例创建失败时获取更多详细信息
- Argument Clinic How-To
- The Goals Of Argument Clinic
- Basic Concepts And Usage
- Converting Your First Function
- Advanced Topics
- 使用 DTrace 和 SystemTap 检测CPython
- Enabling the static markers
- Static DTrace probes
- Static SystemTap markers
- Available static markers
- SystemTap Tapsets
- 示例
- Python 常见问题
- Python常见问题
- 一般信息
- 现实世界中的 Python
- 编程常见问题
- 一般问题
- 核心语言
- 数字和字符串
- 性能
- 序列（元组/列表）
- 对象
- 模块
- 设计和历史常见问题
- 为什么Python使用缩进来分组语句？
- 为什么简单的算术运算得到奇怪的结果？
- 为什么浮点计算不准确？
- 为什么Python字符串是不可变的？
- 为什么必须在方法定义和调用中显式使用“self”？
- 为什么不能在表达式中赋值？
- 为什么Python对某些功能（例如list.index()）使用方法来实现，而其他功能（例如len(List)）使用函数实现？
- 为什么 join()是一个字符串方法而不是列表或元组方法？
- 异常有多快？
- 为什么Python中没有switch或case语句？
- 难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？
- 为什么lambda表达式不能包含语句？
- 可以将Python编译为机器代码，C或其他语言吗？
- Python如何管理内存？
- 为什么CPython不使用更传统的垃圾回收方案？
- CPython退出时为什么不释放所有内存？
- 为什么有单独的元组和列表数据类型？
- 列表是如何在CPython中实现的？
- 字典是如何在CPython中实现的？
- 为什么字典key必须是不可变的？
- 为什么 list.sort() 没有返回排序列表？
- 如何在Python中指定和实施接口规范？
- 为什么没有goto？
- 为什么原始字符串（r-strings）不能以反斜杠结尾？
- 为什么Python没有属性赋值的“with”语句？
- 为什么 if/while/def/class语句需要冒号？
- 为什么Python在列表和元组的末尾允许使用逗号？
- 代码库和插件 FAQ
- 通用的代码库问题
- 通用任务
- 线程相关
- 输入输出
- 网络 / Internet 编程
- 数据库
- 数学和数字
- 扩展/嵌入常见问题
- 可以使用C语言中创建自己的函数吗？
- 可以使用C++语言中创建自己的函数吗？
- C很难写，有没有其他选择？
- 如何从C执行任意Python语句？
- 如何从C中评估任意Python表达式？
- 如何从Python对象中提取C的值？
- 如何使用Py_BuildValue()创建任意长度的元组？
- 如何从C调用对象的方法？
- 如何捕获PyErr_Print()（或打印到stdout / stderr的任何内容）的输出？
- 如何从C访问用Python编写的模块？
- 如何从Python接口到C ++对象？
- 我使用Setup文件添加了一个模块，为什么make失败了？
- 如何调试扩展？
- 我想在Linux系统上编译一个Python模块，但是缺少一些文件。为什么?
- 如何区分“输入不完整”和“输入无效”？
- 如何找到未定义的g++符号__builtin_new或__pure_virtual？
- 能否创建一个对象类，其中部分方法在C中实现，而其他方法在Python中实现（例如通过继承）？
- Python在Windows上的常见问题
- 我怎样在Windows下运行一个Python程序？
- 我怎么让 Python 脚本可执行？
- 为什么有时候 Python 程序会启动缓慢？
- 我怎样使用Python脚本制作可执行文件？
- *.pyd 文件和DLL文件相同吗？
- 我怎样将Python嵌入一个Windows程序？
- 如何让编辑器不要在我的 Python 源代码中插入 tab ？
- 如何在不阻塞的情况下检查按键？
- 图形用户界面（GUI）常见问题
- 图形界面常见问题
- Python 是否有平台无关的图形界面工具包？
- 有哪些Python的GUI工具是某个平台专用的？
- 有关Tkinter的问题
- “为什么我的电脑上安装了 Python ？”
- 什么是Python？
- 为什么我的电脑上安装了 Python ？
- 我能删除 Python 吗？
- 术语对照表
- 文档说明
- Python 文档贡献者
- 解决 Bug
- 文档错误
- 使用 Python 的错误追踪系统
- 开始为 Python 贡献您的知识
- 版权
- 历史和许可证
- 软件历史
- 访问Python或以其他方式使用Python的条款和条件
- Python 3.7.3 的 PSF 许可协议
- Python 2.0 的 BeOpen.com 许可协议
- Python 1.6.1 的 CNRI 许可协议
- Python 0.9.0 至 1.2 的 CWI 许可协议
- 集成软件的许可和认可
- Mersenne Twister
- 套接字
- Asynchronous socket services
- Cookie management
- Execution tracing
- UUencode and UUdecode functions
- XML Remote Procedure Calls
- test_epoll
- Select kqueue
- SipHash24
- strtod and dtoa
- OpenSSL
- expat
- libffi
- zlib
- cfuhash
- libmpdec