summaryrefslogtreecommitdiffstats
path: root/Lib/email/Message.py
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2002-07-19 22:24:55 (GMT)
committerBarry Warsaw <barry@python.org>2002-07-19 22:24:55 (GMT)
commitc10686426edd6883b88950a754335b678750bf67 (patch)
tree70739ad0c77c79f1233a7e4226227a1559246a24 /Lib/email/Message.py
parentd43857455e0f1b33a5b5abfe384c7738f10a63f1 (diff)
downloadcpython-c10686426edd6883b88950a754335b678750bf67.zip
cpython-c10686426edd6883b88950a754335b678750bf67.tar.gz
cpython-c10686426edd6883b88950a754335b678750bf67.tar.bz2
To better support default content types, fix an API wart, and preserve
backwards compatibility, we're silently deprecating get_type(), get_subtype() and get_main_type(). We may eventually noisily deprecate these. For now, we'll just fix a bug in the splitting of the main and subtypes. get_content_type(), get_content_maintype(), get_content_subtype(): New methods which replace the above. These /always/ return a content type string and do not take a failobj, because an email message always at least has a default content type. set_default_type(): Someday there may be additional default content types, so don't hard code an assertion about the value of the ctype argument.
Diffstat (limited to 'Lib/email/Message.py')
-rw-r--r--Lib/email/Message.py75
1 files changed, 62 insertions, 13 deletions
diff --git a/Lib/email/Message.py b/Lib/email/Message.py
index fb121a9..89ace24 100644
--- a/Lib/email/Message.py
+++ b/Lib/email/Message.py
@@ -362,6 +362,11 @@ class Message:
parts.insert(0, _value)
self._headers.append((_name, SEMISPACE.join(parts)))
+ #
+ # These methods are silently deprecated in favor of get_content_type() and
+ # friends (see below). They will be noisily deprecated in email 3.0.
+ #
+
def get_type(self, failobj=None):
"""Returns the message's content type.
@@ -381,10 +386,9 @@ class Message:
ctype = self.get_type(missing)
if ctype is missing:
return failobj
- parts = ctype.split('/')
- if len(parts) > 0:
- return ctype.split('/')[0]
- return failobj
+ if ctype.count('/') <> 1:
+ return failobj
+ return ctype.split('/')[0]
def get_subtype(self, failobj=None):
"""Return the message's content subtype if present."""
@@ -392,10 +396,57 @@ class Message:
ctype = self.get_type(missing)
if ctype is missing:
return failobj
- parts = ctype.split('/')
- if len(parts) > 1:
- return ctype.split('/')[1]
- return failobj
+ if ctype.count('/') <> 1:
+ return failobj
+ return ctype.split('/')[1]
+
+ #
+ # Use these three methods instead of the three above.
+ #
+
+ def get_content_type(self):
+ """Returns the message's content type.
+
+ The returned string is coerced to lowercase and returned as a ingle
+ string of the form `maintype/subtype'. If there was no Content-Type:
+ header in the message, the default type as give by get_default_type()
+ will be returned. Since messages always have a default type this will
+ always return a value.
+
+ The current state of RFC standards define a message's default type to
+ be text/plain unless it appears inside a multipart/digest container,
+ in which case it would be message/rfc822.
+ """
+ missing = []
+ value = self.get('content-type', missing)
+ if value is missing:
+ # This should have no parameters
+ return self.get_default_type()
+ return paramre.split(value)[0].lower().strip()
+
+ def get_content_maintype(self):
+ """Returns the message's main content type.
+
+ This is the `maintype' part of the string returned by
+ get_content_type(). If no slash is found in the full content type, a
+ ValueError is raised.
+ """
+ ctype = self.get_content_type()
+ if ctype.count('/') <> 1:
+ raise ValueError, 'No maintype found in: %s' % ctype
+ return ctype.split('/')[0]
+
+ def get_content_subtype(self):
+ """Returns the message's sub content type.
+
+ This is the `subtype' part of the string returned by
+ get_content_type(). If no slash is found in the full content type, a
+ ValueError is raised.
+ """
+ ctype = self.get_content_type()
+ if ctype.count('/') <> 1:
+ raise ValueError, 'No subtype found in: %s' % ctype
+ return ctype.split('/')[1]
def get_default_type(self):
"""Return the `default' content type.
@@ -409,12 +460,10 @@ class Message:
def set_default_type(self, ctype):
"""Set the `default' content type.
- ctype must be either "text/plain" or "message/rfc822". The default
- content type is not stored in the Content-Type: header.
+ ctype should be either "text/plain" or "message/rfc822", although this
+ is not enforced. The default content type is not stored in the
+ Content-Type: header.
"""
- if ctype not in ('text/plain', 'message/rfc822'):
- raise ValueError(
- 'first arg must be either "text/plain" or "message/rfc822"')
self._default_type = ctype
def _get_params_preserve(self, failobj, header):