1210

pending completion

Build # 1210

Build Type

Pull #204

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/shotgunsoftware/python-api/commit/<a class=hub.com/shotgunsoftware/python-api/commit/<a class="double-link" href="https://git"><a class=hub.com/shotgunsoftware/python-api/commit/13ddcb311e878d8bd4a9c1d25e2e2ca1c9e8027b">13ddcb311">&lt;a href=&quot;https://github.com/shotgunsoftware/python-api/commit/</a><a class="double-link" href="https://github.com/shotgunsoftware/python-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/shotgunsoftware/python-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/shotgunsoftware/python-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/shotgunsoftware/python-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/shotgunsoftware/python-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/shotgunsoftware/python-api/commit/13ddcb311e878d8bd4a9c1d25e2e2ca1c9e8027b">13ddcb311</a><a href="https://github.com/shotgunsoftware/python-api/commit/13ddcb311e878d8bd4a9c1d25e2e2ca1c9e8027b">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/shotgunsoftware/python-api/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/shotgunsoftware/python-api/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/shotgunsoftware/python-api/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/shotgunsoftware/python-api/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/shotgunsoftware/python-api/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/shotgunsoftware/python-api/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/shotgunsoftware/python-api/commit/13ddcb311e878d8bd4... (continued)

Pull Request Pull Request #204: SG-12945: Added localized param to Shotgun object

Run Details

24 of 24 new or added lines in 2 files covered. (100.0%)

1367 of 1965 relevant lines covered (69.57%)

3.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/shotgun_api3/lib/mimetypes.py

"""Guess the MIME type of a file.

This module defines two useful functions:

guess_type(url, strict=1) -- guess the MIME type and encoding of a URL.

guess_extension(type, strict=1) -- guess the extension for a given MIME type.

It also contains the following, for tuning the behavior:

Data:

knownfiles -- list of files to parse
inited -- flag set when init() has been called
suffix_map -- dictionary mapping suffixes to suffixes
encodings_map -- dictionary mapping suffixes to encodings
types_map -- dictionary mapping suffixes to types

Functions:

init([files]) -- parse a list of files, default knownfiles (on Windows, the
  default values are taken from the registry)
read_mime_types(file) -- parse one file, return a dictionary or None

Note that this code has not been updated for python 3 compatibility, as it is
a patched version of the native mimetypes module and is used only in Python
versions 2.7.0 - 2.7.9, which included a broken version of the mimetypes module.
"""

import os
import sys
import posixpath
import urllib
try:
    import _winreg
except ImportError:
    _winreg = None

__all__ = [
    "guess_type","guess_extension","guess_all_extensions",
    "add_type","read_mime_types","init"
]

knownfiles = [
    "/etc/mime.types",
    "/etc/httpd/mime.types",                    # Mac OS X
    "/etc/httpd/conf/mime.types",               # Apache
    "/etc/apache/mime.types",                   # Apache 1
    "/etc/apache2/mime.types",                  # Apache 2
    "/usr/local/etc/httpd/conf/mime.types",
    "/usr/local/lib/netscape/mime.types",
    "/usr/local/etc/httpd/conf/mime.types",     # Apache 1.2
    "/usr/local/etc/mime.types",                # Apache 1.3
    ]

inited = False
_db = None


class MimeTypes:
    """MIME-types datastore.

    This datastore can handle information from mime.types-style files
    and supports basic determination of MIME type from a filename or
    URL, and can guess a reasonable extension given a MIME type.
    """

    def __init__(self, filenames=(), strict=True):
        if not inited:
            init()
        self.encodings_map = encodings_map.copy()
        self.suffix_map = suffix_map.copy()
        self.types_map = ({}, {}) # dict for (non-strict, strict)
        self.types_map_inv = ({}, {})
        for (ext, type) in types_map.items():
            self.add_type(type, ext, True)
        for (ext, type) in common_types.items():
            self.add_type(type, ext, False)
        for name in filenames:
            self.read(name, strict)

    def add_type(self, type, ext, strict=True):
        """Add a mapping between a type and an extension.

        When the extension is already known, the new
        type will replace the old one. When the type
        is already known the extension will be added
        to the list of known extensions.

        If strict is true, information will be added to
        list of standard types, else to the list of non-standard
        types.
        """
        self.types_map[strict][ext] = type
        exts = self.types_map_inv[strict].setdefault(type, [])
        if ext not in exts:
            exts.append(ext)

    def guess_type(self, url, strict=True):
        """Guess the type of a file based on its URL.

        Return value is a tuple (type, encoding) where type is None if
        the type can't be guessed (no or unknown suffix) or a string
        of the form type/subtype, usable for a MIME Content-type
        header; and encoding is None for no encoding or the name of
        the program used to encode (e.g. compress or gzip).  The
        mappings are table driven.  Encoding suffixes are case
        sensitive; type suffixes are first tried case sensitive, then
        case insensitive.

        The suffixes .tgz, .taz and .tz (case sensitive!) are all
        mapped to '.tar.gz'.  (This is table-driven too, using the
        dictionary suffix_map.)

        Optional `strict' argument when False adds a bunch of commonly found,
        but non-standard types.
        """
        scheme, url = urllib.splittype(url)
        if scheme == 'data':
            # syntax of data URLs:
            # dataurl   := "data:" [ mediatype ] [ ";base64" ] "," data
            # mediatype := [ type "/" subtype ] *( ";" parameter )
            # data      := *urlchar
            # parameter := attribute "=" value
            # type/subtype defaults to "text/plain"
            comma = url.find(',')
            if comma < 0:
                # bad data URL
                return None, None
            semi = url.find(';', 0, comma)
            if semi >= 0:
                type = url[:semi]
            else:
                type = url[:comma]
            if '=' in type or '/' not in type:
                type = 'text/plain'
            return type, None           # never compressed, so encoding is None
        base, ext = posixpath.splitext(url)
        while ext in self.suffix_map:
            base, ext = posixpath.splitext(base + self.suffix_map[ext])
        if ext in self.encodings_map:
            encoding = self.encodings_map[ext]
            base, ext = posixpath.splitext(base)
        else:
            encoding = None
        types_map = self.types_map[True]
        if ext in types_map:
            return types_map[ext], encoding
        elif ext.lower() in types_map:
            return types_map[ext.lower()], encoding
        elif strict:
            return None, encoding
        types_map = self.types_map[False]
        if ext in types_map:
            return types_map[ext], encoding
        elif ext.lower() in types_map:
            return types_map[ext.lower()], encoding
        else:
            return None, encoding

    def guess_all_extensions(self, type, strict=True):
        """Guess the extensions for a file based on its MIME type.

        Return value is a list of strings giving the possible filename
        extensions, including the leading dot ('.').  The extension is not
        guaranteed to have been associated with any particular data stream,
        but would be mapped to the MIME type `type' by guess_type().

        Optional `strict' argument when false adds a bunch of commonly found,
        but non-standard types.
        """
        type = type.lower()
        extensions = self.types_map_inv[True].get(type, [])
        if not strict:
            for ext in self.types_map_inv[False].get(type, []):
                if ext not in extensions:
                    extensions.append(ext)
        return extensions

    def guess_extension(self, type, strict=True):
        """Guess the extension for a file based on its MIME type.

        Return value is a string giving a filename extension,
        including the leading dot ('.').  The extension is not
        guaranteed to have been associated with any particular data
        stream, but would be mapped to the MIME type `type' by
        guess_type().  If no extension can be guessed for `type', None
        is returned.

        Optional `strict' argument when false adds a bunch of commonly found,
        but non-standard types.
        """
        extensions = self.guess_all_extensions(type, strict)
        if not extensions:
            return None
        return extensions[0]

    def read(self, filename, strict=True):
        """
        Read a single mime.types-format file, specified by pathname.

        If strict is true, information will be added to
        list of standard types, else to the list of non-standard
        types.
        """
        with open(filename) as fp:
            self.readfp(fp, strict)

    def readfp(self, fp, strict=True):
        """
        Read a single mime.types-format file.

        If strict is true, information will be added to
        list of standard types, else to the list of non-standard
        types.
        """
        while 1:
            line = fp.readline()
            if not line:
                break
            words = line.split()
            for i in range(len(words)):
                if words[i][0] == '#':
                    del words[i:]
                    break
            if not words:
                continue
            type, suffixes = words[0], words[1:]
            for suff in suffixes:
                self.add_type(type, '.' + suff, strict)

    def read_windows_registry(self, strict=True):
        """
        Load the MIME types database from Windows registry.

        If strict is true, information will be added to
        list of standard types, else to the list of non-standard
        types.
        """

        # Windows only
        if not _winreg:
            return

        def enum_types(mimedb):
            i = 0
            while True:
                try:
                    ctype = _winreg.EnumKey(mimedb, i)
                except EnvironmentError:
                    break
                else:
                    if '\0' not in ctype:
                        yield ctype
                i += 1

        default_encoding = sys.getdefaultencoding()
        with _winreg.OpenKey(_winreg.HKEY_CLASSES_ROOT, '') as hkcr:
            for subkeyname in enum_types(hkcr):
                try:
                    with _winreg.OpenKey(hkcr, subkeyname) as subkey:
                        # Only check file extensions
                        if not subkeyname.startswith("."):
                            continue
                        # raises EnvironmentError if no 'Content Type' value
                        mimetype, datatype = _winreg.QueryValueEx(
                            subkey, 'Content Type')
                        if datatype != _winreg.REG_SZ:
                            continue
                        try:
                            mimetype = mimetype.encode(default_encoding)
                        except UnicodeEncodeError:
                            continue
                        self.add_type(mimetype, subkeyname, strict)
                except EnvironmentError:
                    continue

def guess_type(url, strict=True):
    """Guess the type of a file based on its URL.

    Return value is a tuple (type, encoding) where type is None if the
    type can't be guessed (no or unknown suffix) or a string of the
    form type/subtype, usable for a MIME Content-type header; and
    encoding is None for no encoding or the name of the program used
    to encode (e.g. compress or gzip).  The mappings are table
    driven.  Encoding suffixes are case sensitive; type suffixes are
    first tried case sensitive, then case insensitive.

    The suffixes .tgz, .taz and .tz (case sensitive!) are all mapped
    to ".tar.gz".  (This is table-driven too, using the dictionary
    suffix_map).

    Optional `strict' argument when false adds a bunch of commonly found, but
    non-standard types.
    """
    if _db is None:
        init()
    return _db.guess_type(url, strict)


def guess_all_extensions(type, strict=True):
    """Guess the extensions for a file based on its MIME type.

    Return value is a list of strings giving the possible filename
    extensions, including the leading dot ('.').  The extension is not
    guaranteed to have been associated with any particular data
    stream, but would be mapped to the MIME type `type' by
    guess_type().  If no extension can be guessed for `type', None
    is returned.

    Optional `strict' argument when false adds a bunch of commonly found,
    but non-standard types.
    """
    if _db is None:
        init()
    return _db.guess_all_extensions(type, strict)

def guess_extension(type, strict=True):
    """Guess the extension for a file based on its MIME type.

    Return value is a string giving a filename extension, including the
    leading dot ('.').  The extension is not guaranteed to have been
    associated with any particular data stream, but would be mapped to the
    MIME type `type' by guess_type().  If no extension can be guessed for
    `type', None is returned.

    Optional `strict' argument when false adds a bunch of commonly found,
    but non-standard types.
    """
    if _db is None:
        init()
    return _db.guess_extension(type, strict)

def add_type(type, ext, strict=True):
    """Add a mapping between a type and an extension.

    When the extension is already known, the new
    type will replace the old one. When the type
    is already known the extension will be added
    to the list of known extensions.

    If strict is true, information will be added to
    list of standard types, else to the list of non-standard
    types.
    """
    if _db is None:
        init()
    return _db.add_type(type, ext, strict)


def init(files=None):
    global suffix_map, types_map, encodings_map, common_types
    global inited, _db
    inited = True    # so that MimeTypes.__init__() doesn't call us again
    db = MimeTypes()
    if files is None:
        if _winreg:
            db.read_windows_registry()
        files = knownfiles
    for file in files:
        if os.path.isfile(file):
            db.read(file)
    encodings_map = db.encodings_map
    suffix_map = db.suffix_map
    types_map = db.types_map[True]
    common_types = db.types_map[False]
    # Make the DB a global variable now that it is fully initialized
    _db = db


def read_mime_types(file):
    try:
        f = open(file)
    except IOError:
        return None
    with f:
        db = MimeTypes()
        db.readfp(f, True)
        return db.types_map[True]


def _default_mime_types():
    global suffix_map
    global encodings_map
    global types_map
    global common_types

    suffix_map = {
        '.tgz': '.tar.gz',
        '.taz': '.tar.gz',
        '.tz': '.tar.gz',
        '.tbz2': '.tar.bz2',
        '.txz': '.tar.xz',
        }

    encodings_map = {
        '.gz': 'gzip',
        '.Z': 'compress',
        '.bz2': 'bzip2',
        '.xz': 'xz',
        }

    # Before adding new types, make sure they are either registered with IANA,
    # at http://www.isi.edu/in-notes/iana/assignments/media-types
    # or extensions, i.e. using the x- prefix

    # If you add to these, please keep them sorted!
    types_map = {
        '.a'      : 'application/octet-stream',
        '.ai'     : 'application/postscript',
        '.aif'    : 'audio/x-aiff',
        '.aifc'   : 'audio/x-aiff',
        '.aiff'   : 'audio/x-aiff',
        '.au'     : 'audio/basic',
        '.avi'    : 'video/x-msvideo',
        '.bat'    : 'text/plain',
        '.bcpio'  : 'application/x-bcpio',
        '.bin'    : 'application/octet-stream',
        '.bmp'    : 'image/x-ms-bmp',
        '.c'      : 'text/plain',
        # Duplicates :(
        '.cdf'    : 'application/x-cdf',
        '.cdf'    : 'application/x-netcdf',
        '.cpio'   : 'application/x-cpio',
        '.csh'    : 'application/x-csh',
        '.css'    : 'text/css',
        '.dll'    : 'application/octet-stream',
        '.doc'    : 'application/msword',
        '.dot'    : 'application/msword',
        '.dvi'    : 'application/x-dvi',
        '.eml'    : 'message/rfc822',
        '.eps'    : 'application/postscript',
        '.etx'    : 'text/x-setext',
        '.exe'    : 'application/octet-stream',
        '.gif'    : 'image/gif',
        '.gtar'   : 'application/x-gtar',
        '.h'      : 'text/plain',
        '.hdf'    : 'application/x-hdf',
        '.htm'    : 'text/html',
        '.html'   : 'text/html',
        '.ico'    : 'image/vnd.microsoft.icon',
        '.ief'    : 'image/ief',
        '.jpe'    : 'image/jpeg',
        '.jpeg'   : 'image/jpeg',
        '.jpg'    : 'image/jpeg',
        '.js'     : 'application/javascript',
        '.ksh'    : 'text/plain',
        '.latex'  : 'application/x-latex',
        '.m1v'    : 'video/mpeg',
        '.man'    : 'application/x-troff-man',
        '.me'     : 'application/x-troff-me',
        '.mht'    : 'message/rfc822',
        '.mhtml'  : 'message/rfc822',
        '.mif'    : 'application/x-mif',
        '.mov'    : 'video/quicktime',
        '.movie'  : 'video/x-sgi-movie',
        '.mp2'    : 'audio/mpeg',
        '.mp3'    : 'audio/mpeg',
        '.mp4'    : 'video/mp4',
        '.mpa'    : 'video/mpeg',
        '.mpe'    : 'video/mpeg',
        '.mpeg'   : 'video/mpeg',
        '.mpg'    : 'video/mpeg',
        '.ms'     : 'application/x-troff-ms',
        '.nc'     : 'application/x-netcdf',
        '.nws'    : 'message/rfc822',
        '.o'      : 'application/octet-stream',
        '.obj'    : 'application/octet-stream',
        '.oda'    : 'application/oda',
        '.p12'    : 'application/x-pkcs12',
        '.p7c'    : 'application/pkcs7-mime',
        '.pbm'    : 'image/x-portable-bitmap',
        '.pdf'    : 'application/pdf',
        '.pfx'    : 'application/x-pkcs12',
        '.pgm'    : 'image/x-portable-graymap',
        '.pl'     : 'text/plain',
        '.png'    : 'image/png',
        '.pnm'    : 'image/x-portable-anymap',
        '.pot'    : 'application/vnd.ms-powerpoint',
        '.ppa'    : 'application/vnd.ms-powerpoint',
        '.ppm'    : 'image/x-portable-pixmap',
        '.pps'    : 'application/vnd.ms-powerpoint',
        '.ppt'    : 'application/vnd.ms-powerpoint',
        '.ps'     : 'application/postscript',
        '.pwz'    : 'application/vnd.ms-powerpoint',
        '.py'     : 'text/x-python',
        '.pyc'    : 'application/x-python-code',
        '.pyo'    : 'application/x-python-code',
        '.qt'     : 'video/quicktime',
        '.ra'     : 'audio/x-pn-realaudio',
        '.ram'    : 'application/x-pn-realaudio',
        '.ras'    : 'image/x-cmu-raster',
        '.rdf'    : 'application/xml',
        '.rgb'    : 'image/x-rgb',
        '.roff'   : 'application/x-troff',
        '.rtx'    : 'text/richtext',
        '.sgm'    : 'text/x-sgml',
        '.sgml'   : 'text/x-sgml',
        '.sh'     : 'application/x-sh',
        '.shar'   : 'application/x-shar',
        '.snd'    : 'audio/basic',
        '.so'     : 'application/octet-stream',
        '.src'    : 'application/x-wais-source',
        '.sv4cpio': 'application/x-sv4cpio',
        '.sv4crc' : 'application/x-sv4crc',
        '.swf'    : 'application/x-shockwave-flash',
        '.t'      : 'application/x-troff',
        '.tar'    : 'application/x-tar',
        '.tcl'    : 'application/x-tcl',
        '.tex'    : 'application/x-tex',
        '.texi'   : 'application/x-texinfo',
        '.texinfo': 'application/x-texinfo',
        '.tif'    : 'image/tiff',
        '.tiff'   : 'image/tiff',
        '.tr'     : 'application/x-troff',
        '.tsv'    : 'text/tab-separated-values',
        '.txt'    : 'text/plain',
        '.ustar'  : 'application/x-ustar',
        '.vcf'    : 'text/x-vcard',
        '.wav'    : 'audio/x-wav',
        '.wiz'    : 'application/msword',
        '.wsdl'   : 'application/xml',
        '.xbm'    : 'image/x-xbitmap',
        '.xlb'    : 'application/vnd.ms-excel',
        # Duplicates :(
        '.xls'    : 'application/excel',
        '.xls'    : 'application/vnd.ms-excel',
        '.xml'    : 'text/xml',
        '.xpdl'   : 'application/xml',
        '.xpm'    : 'image/x-xpixmap',
        '.xsl'    : 'application/xml',
        '.xwd'    : 'image/x-xwindowdump',
        '.zip'    : 'application/zip',
        }

    # These are non-standard types, commonly found in the wild.  They will
    # only match if strict=0 flag is given to the API methods.

    # Please sort these too
    common_types = {
        '.jpg' : 'image/jpg',
        '.mid' : 'audio/midi',
        '.midi': 'audio/midi',
        '.pct' : 'image/pict',
        '.pic' : 'image/pict',
        '.pict': 'image/pict',
        '.rtf' : 'application/rtf',
        '.xul' : 'text/xul'
        }


_default_mime_types()


if __name__ == '__main__':
    import getopt

    USAGE = """\
Usage: mimetypes.py [options] type

Options:
    --help / -h       -- print this message and exit
    --lenient / -l    -- additionally search of some common, but non-standard
                         types.
    --extension / -e  -- guess extension instead of type

More than one type argument may be given.
"""

    def usage(code, msg=''):
        print USAGE
        if msg: print msg
        sys.exit(code)

    try:
        opts, args = getopt.getopt(sys.argv[1:], 'hle',
                                   ['help', 'lenient', 'extension'])
    except getopt.error, msg:
        usage(1, msg)

    strict = 1
    extension = 0
    for opt, arg in opts:
        if opt in ('-h', '--help'):
            usage(0)
        elif opt in ('-l', '--lenient'):
            strict = 0
        elif opt in ('-e', '--extension'):
            extension = 1
    for gtype in args:
        if extension:
            guess = guess_extension(gtype, strict)
            if not guess: print "I don't know anything about type", gtype
            else: print guess
        else:
            guess, encoding = guess_type(gtype, strict)
            if not guess: print "I don't know anything about type", gtype
            else: print 'type:', guess, 'encoding:', encoding

1	"""Guess the MIME type of a file.
2
3	This module defines two useful functions:
4
5	guess_type(url, strict=1) -- guess the MIME type and encoding of a URL.
6
7	guess_extension(type, strict=1) -- guess the extension for a given MIME type.
8
9	It also contains the following, for tuning the behavior:
10
11	Data:
12
13	knownfiles -- list of files to parse
14	inited -- flag set when init() has been called
15	suffix_map -- dictionary mapping suffixes to suffixes
16	encodings_map -- dictionary mapping suffixes to encodings
17	types_map -- dictionary mapping suffixes to types
18
19	Functions:
20
21	init([files]) -- parse a list of files, default knownfiles (on Windows, the
22	default values are taken from the registry)
23	read_mime_types(file) -- parse one file, return a dictionary or None
24
25	Note that this code has not been updated for python 3 compatibility, as it is
26	a patched version of the native mimetypes module and is used only in Python
27	versions 2.7.0 - 2.7.9, which included a broken version of the mimetypes module.
28	"""
29
30	import os	×
31	import sys	×
32	import posixpath	×
33	import urllib	×
34	try:	×
35	import _winreg	×
36	except ImportError:	×
37	_winreg = None	×
38
39	__all__ = [	×
40	"guess_type","guess_extension","guess_all_extensions",
41	"add_type","read_mime_types","init"
42	]
43
44	knownfiles = [	×
45	"/etc/mime.types",
46	"/etc/httpd/mime.types", # Mac OS X
47	"/etc/httpd/conf/mime.types", # Apache
48	"/etc/apache/mime.types", # Apache 1
49	"/etc/apache2/mime.types", # Apache 2
50	"/usr/local/etc/httpd/conf/mime.types",
51	"/usr/local/lib/netscape/mime.types",
52	"/usr/local/etc/httpd/conf/mime.types", # Apache 1.2
53	"/usr/local/etc/mime.types", # Apache 1.3
54	]
55
56	inited = False	×
57	_db = None	×
58
59
60	class MimeTypes:	×
61	"""MIME-types datastore.
62
63	This datastore can handle information from mime.types-style files
64	and supports basic determination of MIME type from a filename or
65	URL, and can guess a reasonable extension given a MIME type.
66	"""
67
68	def __init__(self, filenames=(), strict=True):	×
69	if not inited:	×
70	init()	×
71	self.encodings_map = encodings_map.copy()	×
72	self.suffix_map = suffix_map.copy()	×
73	self.types_map = ({}, {}) # dict for (non-strict, strict)	×
74	self.types_map_inv = ({}, {})	×
75	for (ext, type) in types_map.items():	×
76	self.add_type(type, ext, True)	×
77	for (ext, type) in common_types.items():	×
78	self.add_type(type, ext, False)	×
79	for name in filenames:	×
80	self.read(name, strict)	×
81
82	def add_type(self, type, ext, strict=True):	×
83	"""Add a mapping between a type and an extension.
84
85	When the extension is already known, the new
86	type will replace the old one. When the type
87	is already known the extension will be added
88	to the list of known extensions.
89
90	If strict is true, information will be added to
91	list of standard types, else to the list of non-standard
92	types.
93	"""
94	self.types_map[strict][ext] = type	×
95	exts = self.types_map_inv[strict].setdefault(type, [])	×
96	if ext not in exts:	×
97	exts.append(ext)	×
98
99	def guess_type(self, url, strict=True):	×
100	"""Guess the type of a file based on its URL.
101
102	Return value is a tuple (type, encoding) where type is None if
103	the type can't be guessed (no or unknown suffix) or a string
104	of the form type/subtype, usable for a MIME Content-type
105	header; and encoding is None for no encoding or the name of
106	the program used to encode (e.g. compress or gzip). The
107	mappings are table driven. Encoding suffixes are case
108	sensitive; type suffixes are first tried case sensitive, then
109	case insensitive.
110
111	The suffixes .tgz, .taz and .tz (case sensitive!) are all
112	mapped to '.tar.gz'. (This is table-driven too, using the
113	dictionary suffix_map.)
114
115	Optional `strict' argument when False adds a bunch of commonly found,
116	but non-standard types.
117	"""
118	scheme, url = urllib.splittype(url)	×
119	if scheme == 'data':	×
120	# syntax of data URLs:
121	# dataurl := "data:" [ mediatype ] [ ";base64" ] "," data
122	# mediatype := [ type "/" subtype ] *( ";" parameter )
123	# data := *urlchar
124	# parameter := attribute "=" value
125	# type/subtype defaults to "text/plain"
126	comma = url.find(',')	×
127	if comma < 0:	×
128	# bad data URL
129	return None, None	×
130	semi = url.find(';', 0, comma)	×
131	if semi >= 0:	×
132	type = url[:semi]	×
133	else:
134	type = url[:comma]	×
135	if '=' in type or '/' not in type:	×
136	type = 'text/plain'	×
137	return type, None # never compressed, so encoding is None	×
138	base, ext = posixpath.splitext(url)	×
139	while ext in self.suffix_map:	×
140	base, ext = posixpath.splitext(base + self.suffix_map[ext])	×
141	if ext in self.encodings_map:	×
142	encoding = self.encodings_map[ext]	×
143	base, ext = posixpath.splitext(base)	×
144	else:
145	encoding = None	×
146	types_map = self.types_map[True]	×
147	if ext in types_map:	×
148	return types_map[ext], encoding	×
149	elif ext.lower() in types_map:	×
150	return types_map[ext.lower()], encoding	×
151	elif strict:	×
152	return None, encoding	×
153	types_map = self.types_map[False]	×
154	if ext in types_map:	×
155	return types_map[ext], encoding	×
156	elif ext.lower() in types_map:	×
157	return types_map[ext.lower()], encoding	×
158	else:
159	return None, encoding	×
160
161	def guess_all_extensions(self, type, strict=True):	×
162	"""Guess the extensions for a file based on its MIME type.
163
164	Return value is a list of strings giving the possible filename
165	extensions, including the leading dot ('.'). The extension is not
166	guaranteed to have been associated with any particular data stream,
167	but would be mapped to the MIME type `type' by guess_type().
168
169	Optional `strict' argument when false adds a bunch of commonly found,
170	but non-standard types.
171	"""
172	type = type.lower()	×
173	extensions = self.types_map_inv[True].get(type, [])	×
174	if not strict:	×
175	for ext in self.types_map_inv[False].get(type, []):	×
176	if ext not in extensions:	×
177	extensions.append(ext)	×
178	return extensions	×
179
180	def guess_extension(self, type, strict=True):	×
181	"""Guess the extension for a file based on its MIME type.
182
183	Return value is a string giving a filename extension,
184	including the leading dot ('.'). The extension is not
185	guaranteed to have been associated with any particular data
186	stream, but would be mapped to the MIME type `type' by
187	guess_type(). If no extension can be guessed for `type', None
188	is returned.
189
190	Optional `strict' argument when false adds a bunch of commonly found,
191	but non-standard types.
192	"""
193	extensions = self.guess_all_extensions(type, strict)	×
194	if not extensions:	×
195	return None	×
196	return extensions[0]	×
197
198	def read(self, filename, strict=True):	×
199	"""
200	Read a single mime.types-format file, specified by pathname.
201
202	If strict is true, information will be added to
203	list of standard types, else to the list of non-standard
204	types.
205	"""
206	with open(filename) as fp:	×
207	self.readfp(fp, strict)	×
208
209	def readfp(self, fp, strict=True):	×
210	"""
211	Read a single mime.types-format file.
212
213	If strict is true, information will be added to
214	list of standard types, else to the list of non-standard
215	types.
216	"""
217	while 1:	×
218	line = fp.readline()	×
219	if not line:	×
220	break	×
221	words = line.split()	×
222	for i in range(len(words)):	×
223	if words[i][0] == '#':	×
224	del words[i:]	×
225	break	×
226	if not words:	×
227	continue	×
228	type, suffixes = words[0], words[1:]	×
229	for suff in suffixes:	×
230	self.add_type(type, '.' + suff, strict)	×
231
232	def read_windows_registry(self, strict=True):	×
233	"""
234	Load the MIME types database from Windows registry.
235
236	If strict is true, information will be added to
237	list of standard types, else to the list of non-standard
238	types.
239	"""
240
241	# Windows only
242	if not _winreg:	×
243	return	×
244
245	def enum_types(mimedb):	×
246	i = 0	×
247	while True:	×
248	try:	×
249	ctype = _winreg.EnumKey(mimedb, i)	×
250	except EnvironmentError:	×
251	break	×
252	else:
253	if '\0' not in ctype:	×
254	yield ctype	×
255	i += 1	×
256
257	default_encoding = sys.getdefaultencoding()	×
258	with _winreg.OpenKey(_winreg.HKEY_CLASSES_ROOT, '') as hkcr:	×
259	for subkeyname in enum_types(hkcr):	×
260	try:	×
261	with _winreg.OpenKey(hkcr, subkeyname) as subkey:	×
262	# Only check file extensions
263	if not subkeyname.startswith("."):	×
264	continue	×
265	# raises EnvironmentError if no 'Content Type' value
266	mimetype, datatype = _winreg.QueryValueEx(	×
267	subkey, 'Content Type')
268	if datatype != _winreg.REG_SZ:	×
269	continue	×
270	try:	×
271	mimetype = mimetype.encode(default_encoding)	×
272	except UnicodeEncodeError:	×
273	continue	×
274	self.add_type(mimetype, subkeyname, strict)	×
275	except EnvironmentError:	×
276	continue	×
277
278	def guess_type(url, strict=True):	×
279	"""Guess the type of a file based on its URL.
280
281	Return value is a tuple (type, encoding) where type is None if the
282	type can't be guessed (no or unknown suffix) or a string of the
283	form type/subtype, usable for a MIME Content-type header; and
284	encoding is None for no encoding or the name of the program used
285	to encode (e.g. compress or gzip). The mappings are table
286	driven. Encoding suffixes are case sensitive; type suffixes are
287	first tried case sensitive, then case insensitive.
288
289	The suffixes .tgz, .taz and .tz (case sensitive!) are all mapped
290	to ".tar.gz". (This is table-driven too, using the dictionary
291	suffix_map).
292
293	Optional `strict' argument when false adds a bunch of commonly found, but
294	non-standard types.
295	"""
296	if _db is None:	×
297	init()	×
298	return _db.guess_type(url, strict)	×
299
300
301	def guess_all_extensions(type, strict=True):	×
302	"""Guess the extensions for a file based on its MIME type.
303
304	Return value is a list of strings giving the possible filename
305	extensions, including the leading dot ('.'). The extension is not
306	guaranteed to have been associated with any particular data
307	stream, but would be mapped to the MIME type `type' by
308	guess_type(). If no extension can be guessed for `type', None
309	is returned.
310
311	Optional `strict' argument when false adds a bunch of commonly found,
312	but non-standard types.
313	"""
314	if _db is None:	×
315	init()	×
316	return _db.guess_all_extensions(type, strict)	×
317
318	def guess_extension(type, strict=True):	×
319	"""Guess the extension for a file based on its MIME type.
320
321	Return value is a string giving a filename extension, including the
322	leading dot ('.'). The extension is not guaranteed to have been
323	associated with any particular data stream, but would be mapped to the
324	MIME type `type' by guess_type(). If no extension can be guessed for
325	`type', None is returned.
326
327	Optional `strict' argument when false adds a bunch of commonly found,
328	but non-standard types.
329	"""
330	if _db is None:	×
331	init()	×
332	return _db.guess_extension(type, strict)	×
333
334	def add_type(type, ext, strict=True):	×
335	"""Add a mapping between a type and an extension.
336
337	When the extension is already known, the new
338	type will replace the old one. When the type
339	is already known the extension will be added
340	to the list of known extensions.
341
342	If strict is true, information will be added to
343	list of standard types, else to the list of non-standard
344	types.
345	"""
346	if _db is None:	×
347	init()	×
348	return _db.add_type(type, ext, strict)	×
349
350
351	def init(files=None):	×
352	global suffix_map, types_map, encodings_map, common_types
353	global inited, _db
354	inited = True # so that MimeTypes.__init__() doesn't call us again	×
355	db = MimeTypes()	×
356	if files is None:	×
357	if _winreg:	×
358	db.read_windows_registry()	×
359	files = knownfiles	×
360	for file in files:	×
361	if os.path.isfile(file):	×
362	db.read(file)	×
363	encodings_map = db.encodings_map	×
364	suffix_map = db.suffix_map	×
365	types_map = db.types_map[True]	×
366	common_types = db.types_map[False]	×
367	# Make the DB a global variable now that it is fully initialized
368	_db = db	×
369
370
371	def read_mime_types(file):	×
372	try:	×
373	f = open(file)	×
374	except IOError:	×
375	return None	×
376	with f:	×
377	db = MimeTypes()	×
378	db.readfp(f, True)	×
379	return db.types_map[True]	×
380
381
382	def _default_mime_types():	×
383	global suffix_map
384	global encodings_map
385	global types_map
386	global common_types
387
388	suffix_map = {	×
389	'.tgz': '.tar.gz',
390	'.taz': '.tar.gz',
391	'.tz': '.tar.gz',
392	'.tbz2': '.tar.bz2',
393	'.txz': '.tar.xz',
394	}
395
396	encodings_map = {	×
397	'.gz': 'gzip',
398	'.Z': 'compress',
399	'.bz2': 'bzip2',
400	'.xz': 'xz',
401	}
402
403	# Before adding new types, make sure they are either registered with IANA,
404	# at http://www.isi.edu/in-notes/iana/assignments/media-types
405	# or extensions, i.e. using the x- prefix
406
407	# If you add to these, please keep them sorted!
408	types_map = {	×
409	'.a' : 'application/octet-stream',
410	'.ai' : 'application/postscript',
411	'.aif' : 'audio/x-aiff',
412	'.aifc' : 'audio/x-aiff',
413	'.aiff' : 'audio/x-aiff',
414	'.au' : 'audio/basic',
415	'.avi' : 'video/x-msvideo',
416	'.bat' : 'text/plain',
417	'.bcpio' : 'application/x-bcpio',
418	'.bin' : 'application/octet-stream',
419	'.bmp' : 'image/x-ms-bmp',
420	'.c' : 'text/plain',
421	# Duplicates :(
422	'.cdf' : 'application/x-cdf',
423	'.cdf' : 'application/x-netcdf',
424	'.cpio' : 'application/x-cpio',
425	'.csh' : 'application/x-csh',
426	'.css' : 'text/css',
427	'.dll' : 'application/octet-stream',
428	'.doc' : 'application/msword',
429	'.dot' : 'application/msword',
430	'.dvi' : 'application/x-dvi',
431	'.eml' : 'message/rfc822',
432	'.eps' : 'application/postscript',
433	'.etx' : 'text/x-setext',
434	'.exe' : 'application/octet-stream',
435	'.gif' : 'image/gif',
436	'.gtar' : 'application/x-gtar',
437	'.h' : 'text/plain',
438	'.hdf' : 'application/x-hdf',
439	'.htm' : 'text/html',
440	'.html' : 'text/html',
441	'.ico' : 'image/vnd.microsoft.icon',
442	'.ief' : 'image/ief',
443	'.jpe' : 'image/jpeg',
444	'.jpeg' : 'image/jpeg',
445	'.jpg' : 'image/jpeg',
446	'.js' : 'application/javascript',
447	'.ksh' : 'text/plain',
448	'.latex' : 'application/x-latex',
449	'.m1v' : 'video/mpeg',
450	'.man' : 'application/x-troff-man',
451	'.me' : 'application/x-troff-me',
452	'.mht' : 'message/rfc822',
453	'.mhtml' : 'message/rfc822',
454	'.mif' : 'application/x-mif',
455	'.mov' : 'video/quicktime',
456	'.movie' : 'video/x-sgi-movie',
457	'.mp2' : 'audio/mpeg',
458	'.mp3' : 'audio/mpeg',
459	'.mp4' : 'video/mp4',
460	'.mpa' : 'video/mpeg',
461	'.mpe' : 'video/mpeg',
462	'.mpeg' : 'video/mpeg',
463	'.mpg' : 'video/mpeg',
464	'.ms' : 'application/x-troff-ms',
465	'.nc' : 'application/x-netcdf',
466	'.nws' : 'message/rfc822',
467	'.o' : 'application/octet-stream',
468	'.obj' : 'application/octet-stream',
469	'.oda' : 'application/oda',
470	'.p12' : 'application/x-pkcs12',
471	'.p7c' : 'application/pkcs7-mime',
472	'.pbm' : 'image/x-portable-bitmap',
473	'.pdf' : 'application/pdf',
474	'.pfx' : 'application/x-pkcs12',
475	'.pgm' : 'image/x-portable-graymap',
476	'.pl' : 'text/plain',
477	'.png' : 'image/png',
478	'.pnm' : 'image/x-portable-anymap',
479	'.pot' : 'application/vnd.ms-powerpoint',
480	'.ppa' : 'application/vnd.ms-powerpoint',
481	'.ppm' : 'image/x-portable-pixmap',
482	'.pps' : 'application/vnd.ms-powerpoint',
483	'.ppt' : 'application/vnd.ms-powerpoint',
484	'.ps' : 'application/postscript',
485	'.pwz' : 'application/vnd.ms-powerpoint',
486	'.py' : 'text/x-python',
487	'.pyc' : 'application/x-python-code',
488	'.pyo' : 'application/x-python-code',
489	'.qt' : 'video/quicktime',
490	'.ra' : 'audio/x-pn-realaudio',
491	'.ram' : 'application/x-pn-realaudio',
492	'.ras' : 'image/x-cmu-raster',
493	'.rdf' : 'application/xml',
494	'.rgb' : 'image/x-rgb',
495	'.roff' : 'application/x-troff',
496	'.rtx' : 'text/richtext',
497	'.sgm' : 'text/x-sgml',
498	'.sgml' : 'text/x-sgml',
499	'.sh' : 'application/x-sh',
500	'.shar' : 'application/x-shar',
501	'.snd' : 'audio/basic',
502	'.so' : 'application/octet-stream',
503	'.src' : 'application/x-wais-source',
504	'.sv4cpio': 'application/x-sv4cpio',
505	'.sv4crc' : 'application/x-sv4crc',
506	'.swf' : 'application/x-shockwave-flash',
507	'.t' : 'application/x-troff',
508	'.tar' : 'application/x-tar',
509	'.tcl' : 'application/x-tcl',
510	'.tex' : 'application/x-tex',
511	'.texi' : 'application/x-texinfo',
512	'.texinfo': 'application/x-texinfo',
513	'.tif' : 'image/tiff',
514	'.tiff' : 'image/tiff',
515	'.tr' : 'application/x-troff',
516	'.tsv' : 'text/tab-separated-values',
517	'.txt' : 'text/plain',
518	'.ustar' : 'application/x-ustar',
519	'.vcf' : 'text/x-vcard',
520	'.wav' : 'audio/x-wav',
521	'.wiz' : 'application/msword',
522	'.wsdl' : 'application/xml',
523	'.xbm' : 'image/x-xbitmap',
524	'.xlb' : 'application/vnd.ms-excel',
525	# Duplicates :(
526	'.xls' : 'application/excel',
527	'.xls' : 'application/vnd.ms-excel',
528	'.xml' : 'text/xml',
529	'.xpdl' : 'application/xml',
530	'.xpm' : 'image/x-xpixmap',
531	'.xsl' : 'application/xml',
532	'.xwd' : 'image/x-xwindowdump',
533	'.zip' : 'application/zip',
534	}
535
536	# These are non-standard types, commonly found in the wild. They will
537	# only match if strict=0 flag is given to the API methods.
538
539	# Please sort these too
540	common_types = {	×
541	'.jpg' : 'image/jpg',
542	'.mid' : 'audio/midi',
543	'.midi': 'audio/midi',
544	'.pct' : 'image/pict',
545	'.pic' : 'image/pict',
546	'.pict': 'image/pict',
547	'.rtf' : 'application/rtf',
548	'.xul' : 'text/xul'
549	}
550
551
552	_default_mime_types()	×
553
554
555	if __name__ == '__main__':	×
556	import getopt	×
557
558	USAGE = """\	×
559	Usage: mimetypes.py [options] type
560
561	Options:
562	--help / -h -- print this message and exit
563	--lenient / -l -- additionally search of some common, but non-standard
564	types.
565	--extension / -e -- guess extension instead of type
566
567	More than one type argument may be given.
568	"""
569
570	def usage(code, msg=''):	×
571	print USAGE	×
572	if msg: print msg	×
573	sys.exit(code)	×
574
575	try:	×
576	opts, args = getopt.getopt(sys.argv[1:], 'hle',	×
577	['help', 'lenient', 'extension'])
578	except getopt.error, msg:	×
579	usage(1, msg)	×
580
581	strict = 1	×
582	extension = 0	×
583	for opt, arg in opts:	×
584	if opt in ('-h', '--help'):	×
585	usage(0)	×
586	elif opt in ('-l', '--lenient'):	×
587	strict = 0	×
588	elif opt in ('-e', '--extension'):	×
589	extension = 1	×
590	for gtype in args:	×
591	if extension:	×
592	guess = guess_extension(gtype, strict)	×
593	if not guess: print "I don't know anything about type", gtype	×
594	else: print guess	×
595	else:
596	guess, encoding = guess_type(gtype, strict)	×
597	if not guess: print "I don't know anything about type", gtype	×
598	else: print 'type:', guess, 'encoding:', encoding	×

shotgunsoftware / python-api / 1210

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous