mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Make headerregistry fully part of the provisional api.

Browse source 
When I made the checkin of the provisional email policy, I knew that
Address and Group needed to be made accessible from somewhere.  The more
I looked at it, though, the more it became clear that since this is a
provisional API anyway, there's no good reason to hide headerregistry as
a private API.  It was designed to ultimately be part of the public API,
and so it should be part of the provisional API.

This patch fully documents the headerregistry API, and deletes the
abbreviated version of those docs I had added to the provisional policy
docs.
This commit is contained in:
R David Murray 2012-05-27 15:03:38 -04:00
parent 393da3240a
commit ea9766897b
7 changed files with 429 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

57
Lib/test/test_email/test__headerregistry.py → Lib/test/test_email/test_headerregistry.py
View file

@ -5,72 +5,71 @@ from email import errors
from email import policy
from email.message import Message
from test.test_email import TestEmailBase
from email import _headerregistry
# Address and Group are public but I'm not sure where to put them yet.
from email._headerregistry import Address, Group
from email import headerregistry
from email.headerregistry import Address, Group
class TestHeaderRegistry(TestEmailBase):
def test_arbitrary_name_unstructured(self):
factory = _headerregistry.HeaderRegistry()
factory = headerregistry.HeaderRegistry()
h = factory('foobar', 'test')
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.UnstructuredHeader)
def test_name_case_ignored(self):
factory = _headerregistry.HeaderRegistry()
factory = headerregistry.HeaderRegistry()
# Whitebox check that test is valid
self.assertNotIn('Subject', factory.registry)
h = factory('Subject', 'test')
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, _headerregistry.UniqueUnstructuredHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.UniqueUnstructuredHeader)
class FooBase:
def __init__(self, *args, **kw):
pass
def test_override_default_base_class(self):
factory = _headerregistry.HeaderRegistry(base_class=self.FooBase)
factory = headerregistry.HeaderRegistry(base_class=self.FooBase)
h = factory('foobar', 'test')
self.assertIsInstance(h, self.FooBase)
self.assertIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h, headerregistry.UnstructuredHeader)
class FooDefault:
parse = _headerregistry.UnstructuredHeader.parse
parse = headerregistry.UnstructuredHeader.parse
def test_override_default_class(self):
factory = _headerregistry.HeaderRegistry(default_class=self.FooDefault)
factory = headerregistry.HeaderRegistry(default_class=self.FooDefault)
h = factory('foobar', 'test')
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
self.assertIsInstance(h, self.FooDefault)
def test_override_default_class_only_overrides_default(self):
factory = _headerregistry.HeaderRegistry(default_class=self.FooDefault)
factory = headerregistry.HeaderRegistry(default_class=self.FooDefault)
h = factory('subject', 'test')
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, _headerregistry.UniqueUnstructuredHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.UniqueUnstructuredHeader)
def test_dont_use_default_map(self):
factory = _headerregistry.HeaderRegistry(use_default_map=False)
factory = headerregistry.HeaderRegistry(use_default_map=False)
h = factory('subject', 'test')
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.UnstructuredHeader)
def test_map_to_type(self):
factory = _headerregistry.HeaderRegistry()
factory = headerregistry.HeaderRegistry()
h1 = factory('foobar', 'test')
factory.map_to_type('foobar', _headerregistry.UniqueUnstructuredHeader)
factory.map_to_type('foobar', headerregistry.UniqueUnstructuredHeader)
h2 = factory('foobar', 'test')
self.assertIsInstance(h1, _headerregistry.BaseHeader)
self.assertIsInstance(h1, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h2, _headerregistry.BaseHeader)
self.assertIsInstance(h2, _headerregistry.UniqueUnstructuredHeader)
self.assertIsInstance(h1, headerregistry.BaseHeader)
self.assertIsInstance(h1, headerregistry.UnstructuredHeader)
self.assertIsInstance(h2, headerregistry.BaseHeader)
self.assertIsInstance(h2, headerregistry.UniqueUnstructuredHeader)
class TestHeaderBase(TestEmailBase):
factory = _headerregistry.HeaderRegistry()
factory = headerregistry.HeaderRegistry()
def make_header(self, name, value):
return self.factory(name, value)
@ -149,13 +148,13 @@ class TestDateHeader(TestHeaderBase):
def test_date_header_properties(self):
h = self.make_header('date', self.datestring)
self.assertIsInstance(h, _headerregistry.UniqueDateHeader)
self.assertIsInstance(h, headerregistry.UniqueDateHeader)
self.assertEqual(h.max_count, 1)
self.assertEqual(h.defects, ())
def test_resent_date_header_properties(self):
h = self.make_header('resent-date', self.datestring)
self.assertIsInstance(h, _headerregistry.DateHeader)
self.assertIsInstance(h, headerregistry.DateHeader)
self.assertEqual(h.max_count, None)
self.assertEqual(h.defects, ())

2
Lib/test/test_email/test_pickleable.py
View file

@ -4,7 +4,7 @@ import copy
import pickle
from email import policy
from email import message_from_string
from email._headerregistry import HeaderRegistry
from email.headerregistry import HeaderRegistry
from test.test_email import TestEmailBase
class TestPickleCopyHeader(TestEmailBase):

12
Lib/test/test_email/test_policy.py
View file

@ -5,7 +5,7 @@ import unittest
import email.policy
import email.parser
import email.generator
from email import _headerregistry
from email import headerregistry
def make_defaults(base_defaults, differences):
defaults = base_defaults.copy()
@ -185,11 +185,11 @@ class PolicyAPITests(unittest.TestCase):
def test_default_header_factory(self):
h = email.policy.default.header_factory('Test', 'test')
self.assertEqual(h.name, 'Test')
self.assertIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h, _headerregistry.BaseHeader)
self.assertIsInstance(h, headerregistry.UnstructuredHeader)
self.assertIsInstance(h, headerregistry.BaseHeader)
class Foo:
parse = _headerregistry.UnstructuredHeader.parse
parse = headerregistry.UnstructuredHeader.parse
def test_each_Policy_gets_unique_factory(self):
policy1 = email.policy.EmailPolicy()
@ -197,10 +197,10 @@ class PolicyAPITests(unittest.TestCase):
policy1.header_factory.map_to_type('foo', self.Foo)
h = policy1.header_factory('foo', 'test')
self.assertIsInstance(h, self.Foo)
self.assertNotIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertNotIsInstance(h, headerregistry.UnstructuredHeader)
h = policy2.header_factory('foo', 'test')
self.assertNotIsInstance(h, self.Foo)
self.assertIsInstance(h, _headerregistry.UnstructuredHeader)
self.assertIsInstance(h, headerregistry.UnstructuredHeader)
def test_clone_copies_factory(self):
policy1 = email.policy.EmailPolicy()