Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-08 16:32:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

#10839: raise an error on add of duplicate unique headers in new email policies

Browse source 
This feature was supposed to be part of the initial email6 checkin, but it got
lost in my big refactoring.

In this patch I'm not providing an easy way to turn off the errors, but they
only happen when a header is added programmatically, and it is almost never
the right thing to do to allow the duplicate to be added.  An application that
needs to add duplicates of unique headers can create a policy subclass to
allow it.
This commit is contained in:
R David Murray 2012-05-29 09:14:44 -04:00
parent 6066fe1258
commit abfc37491c
4 changed files with 62 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/library/email.policy.rst
View file

@ -196,6 +196,25 @@ added matters. To illustrate::
custom ``Message`` objects) should also provide such an attribute,
otherwise defects in parsed messages will raise unexpected errors.
.. method:: header_max_count(name)
Return the maximum allowed number of headers named *name*.
Called when a header is added to a :class:`~email.message.Message`
object. If the returned value is not ``0`` or ``None``, and there are
already a number of headers with the name *name* equal to the value
returned, a :exc:`ValueError` is raised.
Because the default behavior of ``Message.__setitem__`` is to append the
value to the list of headers, it is easy to create duplicate headers
without realizing it. This method allows certain headers to be limited
in the number of instances of that header that may be added to a
``Message`` programmatically. (The limit is not observed by the parser,
which will faithfully produce as many headers as exist in the message
being parsed.)
The default implementation returns ``None`` for all header names.
.. method:: header_source_parse(sourcelines)
The email package calls this method with a list of strings, each string
@ -366,6 +385,12 @@ added matters. To illustrate::
The class provides the following concrete implementations of the abstract
methods of :class:`Policy`:
.. method:: header_max_count(name)
Returns the value of the
:attr:`~email.headerregistry.BaseHeader.max_count` attribute of the
specialized class used to represent the header with the given name.
.. method:: header_source_parse(sourcelines)
The implementation of this method is the same as that for the