pax_global_header00006660000000000000000000000064130010024150014474gustar00rootroot0000000000000052 comment=9a758d1a68ebdb71111dc244acd0a4be42e6bdc8 python-mimeparse-1.6.0/000077500000000000000000000000001300100241500150015ustar00rootroot00000000000000python-mimeparse-1.6.0/.gitignore000066400000000000000000000000641300100241500167710ustar00rootroot00000000000000*.pyc .*.sw[po] .tox *.egg-info dist/ build/ .venv/ python-mimeparse-1.6.0/.travis.yml000066400000000000000000000005711300100241500171150ustar00rootroot00000000000000language: python python: - "2.7" env: - TOXENV=py27 - TOXENV=py34 - TOXENV=pypy3 - TOXENV=flake8 # https://github.com/travis-ci/travis-ci/issues/4794 matrix: include: - python: pypy-5.4 env: TOXENV=pypy - python: 3.5 env: TOXENV=py35 # command to install dependencies install: - pip install tox # command to run tests script: - tox python-mimeparse-1.6.0/LICENSE000066400000000000000000000017771300100241500160220ustar00rootroot00000000000000Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. python-mimeparse-1.6.0/MANIFEST.in000066400000000000000000000000731300100241500165370ustar00rootroot00000000000000include README.rst LICENSE mimeparse_test.py testdata.json python-mimeparse-1.6.0/README.rst000066400000000000000000000031641300100241500164740ustar00rootroot00000000000000Python-MimeParse ================ .. image:: https://travis-ci.org/dbtsai/python-mimeparse.svg?branch=master :target: https://travis-ci.org/dbtsai/python-mimeparse This module provides basic functions for handling mime-types. It can handle matching mime-types against a list of media-ranges. See section 5.3.2 of the HTTP 1.1 Semantics and Content specification [RFC 7231] for a complete explanation: https://tools.ietf.org/html/rfc7231#section-5.3.2 Installation ------------ Use **pip**: .. code-block:: sh $ pip install python-mimeparse It supports Python 2.7 - 3.5 and PyPy. Functions --------- **parse_mime_type()** Parses a mime-type into its component parts. **parse_media_range()** Media-ranges are mime-types with wild-cards and a "q" quality parameter. **quality()** Determines the quality ("q") of a mime-type when compared against a list of media-ranges. **quality_parsed()** Just like ``quality()`` except the second parameter must be pre-parsed. **best_match()** Choose the mime-type with the highest quality ("q") from a list of candidates. Testing ------- Run the tests by typing: ``python mimeparse_test.py``. The tests require Python 2.6. To make sure that the package works in all the supported environments, you can run **tox** tests: .. code-block:: sh $ pip install tox $ tox The format of the JSON test data file is as follows: A top-level JSON object which has a key for each of the functions to be tested. The value corresponding to that key is a list of tests. Each test contains: the argument or arguments to the function being tested, the expected results and an optional description. python-mimeparse-1.6.0/mimeparse.py000066400000000000000000000141461300100241500173430ustar00rootroot00000000000000import cgi __version__ = '1.6.0' __author__ = 'Joe Gregorio' __email__ = 'joe@bitworking.org' __license__ = 'MIT License' __credits__ = '' class MimeTypeParseException(ValueError): pass def parse_mime_type(mime_type): """Parses a mime-type into its component parts. Carves up a mime-type and returns a tuple of the (type, subtype, params) where 'params' is a dictionary of all the parameters for the media range. For example, the media range 'application/xhtml;q=0.5' would get parsed into: ('application', 'xhtml', {'q', '0.5'}) :rtype: (str,str,dict) """ full_type, params = cgi.parse_header(mime_type) # Java URLConnection class sends an Accept header that includes a # single '*'. Turn it into a legal wildcard. if full_type == '*': full_type = '*/*' type_parts = full_type.split('/') if '/' in full_type else None if not type_parts or len(type_parts) > 2: raise MimeTypeParseException( "Can't parse type \"{}\"".format(full_type)) (type, subtype) = type_parts return (type.strip(), subtype.strip(), params) def parse_media_range(range): """Parse a media-range into its component parts. Carves up a media range and returns a tuple of the (type, subtype, params) where 'params' is a dictionary of all the parameters for the media range. For example, the media range 'application/*;q=0.5' would get parsed into: ('application', '*', {'q', '0.5'}) In addition this function also guarantees that there is a value for 'q' in the params dictionary, filling it in with a proper default if necessary. :rtype: (str,str,dict) """ (type, subtype, params) = parse_mime_type(range) params.setdefault('q', params.pop('Q', None)) # q is case insensitive try: if not params['q'] or not 0 <= float(params['q']) <= 1: params['q'] = '1' except ValueError: # from float() params['q'] = '1' return (type, subtype, params) def quality_and_fitness_parsed(mime_type, parsed_ranges): """Find the best match for a mime-type amongst parsed media-ranges. Find the best match for a given mime-type against a list of media_ranges that have already been parsed by parse_media_range(). Returns a tuple of the fitness value and the value of the 'q' quality parameter of the best match, or (-1, 0) if no match was found. Just as for quality_parsed(), 'parsed_ranges' must be a list of parsed media ranges. :rtype: (float,int) """ best_fitness = -1 best_fit_q = 0 (target_type, target_subtype, target_params) = \ parse_media_range(mime_type) for (type, subtype, params) in parsed_ranges: # check if the type and the subtype match type_match = ( type in (target_type, '*') or target_type == '*' ) subtype_match = ( subtype in (target_subtype, '*') or target_subtype == '*' ) # if they do, assess the "fitness" of this mime_type if type_match and subtype_match: # 100 points if the type matches w/o a wildcard fitness = type == target_type and 100 or 0 # 10 points if the subtype matches w/o a wildcard fitness += subtype == target_subtype and 10 or 0 # 1 bonus point for each matching param besides "q" param_matches = sum([ 1 for (key, value) in target_params.items() if key != 'q' and key in params and value == params[key] ]) fitness += param_matches # finally, add the target's "q" param (between 0 and 1) fitness += float(target_params.get('q', 1)) if fitness > best_fitness: best_fitness = fitness best_fit_q = params['q'] return float(best_fit_q), best_fitness def quality_parsed(mime_type, parsed_ranges): """Find the best match for a mime-type amongst parsed media-ranges. Find the best match for a given mime-type against a list of media_ranges that have already been parsed by parse_media_range(). Returns the 'q' quality parameter of the best match, 0 if no match was found. This function behaves the same as quality() except that 'parsed_ranges' must be a list of parsed media ranges. :rtype: float """ return quality_and_fitness_parsed(mime_type, parsed_ranges)[0] def quality(mime_type, ranges): """Return the quality ('q') of a mime-type against a list of media-ranges. Returns the quality 'q' of a mime-type when compared against the media-ranges in ranges. For example: >>> quality('text/html','text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5') 0.7 :rtype: float """ parsed_ranges = [parse_media_range(r) for r in ranges.split(',')] return quality_parsed(mime_type, parsed_ranges) def best_match(supported, header): """Return mime-type with the highest quality ('q') from list of candidates. Takes a list of supported mime-types and finds the best match for all the media-ranges listed in header. The value of header must be a string that conforms to the format of the HTTP Accept: header. The value of 'supported' is a list of mime-types. The list of supported mime-types should be sorted in order of increasing desirability, in case of a situation where there is a tie. >>> best_match(['application/xbel+xml', 'text/xml'], 'text/*;q=0.5,*/*; q=0.1') 'text/xml' :rtype: str """ split_header = _filter_blank(header.split(',')) parsed_header = [parse_media_range(r) for r in split_header] weighted_matches = [] pos = 0 for mime_type in supported: weighted_matches.append(( quality_and_fitness_parsed(mime_type, parsed_header), pos, mime_type )) pos += 1 weighted_matches.sort() return weighted_matches[-1][0][0] and weighted_matches[-1][2] or '' def _filter_blank(i): """Return all non-empty items in the list.""" for s in i: if s.strip(): yield s python-mimeparse-1.6.0/mimeparse_test.py000077500000000000000000000051471300100241500204060ustar00rootroot00000000000000#!/usr/bin/env python """ Python tests for Mime-Type Parser. This module loads a json file and converts the tests specified therein to a set of PyUnitTestCases. Then it uses PyUnit to run them and report their status. """ import json import unittest import mimeparse __version__ = "0.1" __author__ = 'Ade Oshineye' __email__ = "ade@oshineye.com" __credits__ = "" class MimeParseTestCase(unittest.TestCase): def setUp(self): super(MimeParseTestCase, self).setUp() with open("testdata.json") as f: self.test_data = json.load(f) def _test_parse_media_range(self, args, expected): expected = tuple(expected) result = mimeparse.parse_media_range(args) message = "Expected: '%s' but got %s" % (expected, result) self.assertEqual(expected, result, message) def _test_quality(self, args, expected): result = mimeparse.quality(args[0], args[1]) message = "Expected: '%s' but got %s" % (expected, result) self.assertEqual(expected, result, message) def _test_best_match(self, args, expected, description): if expected is None: self.assertRaises(mimeparse.MimeTypeParseException, mimeparse.best_match, args[0], args[1]) else: result = mimeparse.best_match(args[0], args[1]) message = \ "Expected: '%s' but got %s. Description for this test: %s" % \ (expected, result, description) self.assertEqual(expected, result, message) def _test_parse_mime_type(self, args, expected): if expected is None: self.assertRaises(mimeparse.MimeTypeParseException, mimeparse.parse_mime_type, args) else: expected = tuple(expected) result = mimeparse.parse_mime_type(args) message = "Expected: '%s' but got %s" % (expected, result) self.assertEqual(expected, result, message) def test_parse_media_range(self): for args, expected in self.test_data['parse_media_range']: self._test_parse_media_range(args, expected) def test_quality(self): for args, expected in self.test_data['quality']: self._test_quality(args, expected) def test_best_match(self): for args, expected, description in self.test_data['best_match']: self._test_best_match(args, expected, description) def test_parse_mime_type(self): for args, expected in self.test_data['parse_mime_type']: self._test_parse_mime_type(args, expected) if __name__ == '__main__': unittest.main() python-mimeparse-1.6.0/setup.cfg000066400000000000000000000000341300100241500166170ustar00rootroot00000000000000[bdist_wheel] universal = 1 python-mimeparse-1.6.0/setup.py000077500000000000000000000030211300100241500165120ustar00rootroot00000000000000#!/usr/bin/env python import codecs import os import re from setuptools import setup def get_version(filename): """ Return package version as listed in `__version__` in 'filename'. """ with open(filename) as fp: contents = fp.read() return re.search("__version__ = ['\"]([^'\"]+)['\"]", contents).group(1) version = get_version('mimeparse.py') if not version: raise RuntimeError('Cannot find version information') def read(fname): path = os.path.join(os.path.dirname(__file__), fname) with codecs.open(path, encoding='utf-8') as fp: return fp.read() setup( name="python-mimeparse", py_modules=["mimeparse"], version=version, description=("A module provides basic functions for parsing mime-type " "names and matching them against a list of media-ranges."), author="DB Tsai", author_email="dbtsai@dbtsai.com", url="https://github.com/dbtsai/python-mimeparse", download_url=("https://github.com/dbtsai/python-mimeparse/tarball/" + version), keywords=["mime-type"], classifiers=[ "Programming Language :: Python", "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules", ], long_description=read('README.rst') ) python-mimeparse-1.6.0/testdata.json000066400000000000000000000157251300100241500175170ustar00rootroot00000000000000{ "parse_media_range": [ ["application/xml;q=1", ["application", "xml", {"q": "1"}]], ["application/xml", ["application", "xml", {"q": "1"}]], ["application/xml;q=",["application", "xml", {"q": "1"}]], ["application/xml ;q=",["application", "xml", {"q": "1"}]], ["application/xml ;q=-1",["application", "xml", {"q": "1"}]], ["application/xml ; q=1;b=other",["application", "xml", {"q": "1", "b":"other"}]], ["application/xml ; q=2;b=other",["application", "xml", {"q": "1", "b":"other"}]], ["application/xml ; q=0",["application", "xml", {"q": "0"}]], ["application/xml ; q=foo", ["application", "xml", {"q": "1"}]], ["application/xml ; Q=0.6", ["application", "xml", {"q": "0.6"}]], [" *; q=.2", ["*", "*", {"q": ".2"}]] ], "quality": [ [ [ "text/html;level=1", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 1 ], [ [ "text/html", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 0.7 ], [ [ "text/plain", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 0.3 ], [ [ "image/jpeg", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 0.5 ], [ [ "text/html;level=2", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 0.4 ], [ [ "text/html;level=3", "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], 0.7 ], [ [ "text/plain", "text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2" ], 0.2 ] ], "best_match": [ [ [ ["application/json", "text/html"], "application/json, text/javascript, */*" ], "application/json", "common AJAX scenario" ], [ [ ["application/xbel+xml", "application/xml"], "application/xbel+xml" ], "application/xbel+xml", "direct match" ], [ [ ["application/xbel+xml", "application/xml"], "application/xbel+xml; q=1" ], "application/xbel+xml", "direct match with a q parameter" ], [ [ ["application/xbel+xml", "application/xml"], "application/xml; q=1" ], "application/xml", "direct match of our second choice with a q parameter" ], [ [ ["application/xbel+xml", "application/xml"], "application/*; q=1" ], "application/xml", "match using a subtype wildcard" ], [ [ ["application/xbel+xml", "application/xml"], "*/*" ], "application/xml", "match using a type wildcard" ], [ [ ["application/xbel+xml", "text/xml"], "text/*;q=0.5,*/*; q=0.1" ], "text/xml", "match using a type versus a lower weighted subtype" ], [ [ ["application/xbel+xml", "text/xml"], "text/html,application/atom+xml; q=0.9" ], "", "fail to match anything" ], [ [ ["application/json", "text/html"], "application/json, text/html;q=0.9" ], "application/json", "verify fitness ordering" ], [ [ ["image/*", "application/xml"], "image/png" ], "image/*", "match using a type wildcard" ], [ [ ["image/*", "application/xml"], "image/*" ], "image/*", "match using a wildcard for both requested and supported" ], [ [ ["image/jpeg", "text/plain"], "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5" ], "image/jpeg", "media type with highest associated quality factor should win, not necessarily most specific" ], [ [ ["text/html", "application/rdf+xml"], "text/html, application/rdf+xml" ], "application/rdf+xml", "match should use highest order of supported when there is a tie" ], [ [ ["text/plain", "text/plain;format=flowed", "text/html"], "text/*, text/plain, text/plain;format=flowed, */*" ], "text/plain;format=flowed", "most specific reference has precedence" ], [ [ ["application/rdf+xml", "text/html"], "text/html, application/rdf+xml" ], "text/html", "match should use highest order of supported when there is a tie" ], [ [ ["application/json;q=1.0", "text/html;q=0.9", "text/plain;q=0.1"], "*/*" ], "application/json;q=1.0", "*/* match should pick an acceptable type with the highest quality" ], [ [ ["text/html;q=0.9", "application/json", "text/plain;q=0.1"], "*/*" ], "application/json", "*/* match should pick an acceptable type with the highest quality, even if it's implicit" ], [ [ ["application/json", "text/html"], "text" ], null, "match should use the default if an invalid Accept header is passed" ] ], "parse_mime_type": [ [ "application/xhtml;q=0.5", ["application", "xhtml", {"q": "0.5"}] ], [ "application/xhtml;q=0.5;ver=1.2", ["application", "xhtml", {"q": "0.5", "ver": "1.2"}] ], [ "application/xhtml;q=0.5;foo=\"bar quux\"", ["application", "xhtml", {"q": "0.5", "foo": "bar quux"}]], [ "text", null ], [ "text/something/invalid", null ] ] } python-mimeparse-1.6.0/tox.ini000066400000000000000000000010061300100241500163110ustar00rootroot00000000000000[tox] envlist = py35,py34,py32,py27,pypy,pypy3,flake8 [testenv] commands = python --version ./mimeparse_test.py [testenv:py35] basepython = python3.5 [testenv:py34] basepython = python3.4 [testenv:py32] basepython = python3.2 [testenv:py27] basepython = python2.7 [testenv:pypy] basepython = pypy [testenv:pypy3] basepython = pypy3 [testenv:flake8] deps = flake8 flake8-import-order commands = flake8 --statistics --show-source --ignore=E501 --exclude=.venv,.tox,*egg,*.egg-info,build,dist .