pip._vendor.urllib3.fields Namespace Reference

Functions
	guess_content_type (filename, default="application/octet-stream")
	format_header_param_rfc2231 (name, value)

Function Documentation

format_header_param_rfc2231()

format_header_param_rfc2231	(		name,
			value
	)

Helper function to format and quote a single header parameter using the
strategy defined in RFC 2231.

Particularly useful for header parameters which might contain
non-ASCII values, like file names. This follows
`RFC 2388 Section 4.4 <https://tools.ietf.org/html/rfc2388#section-4.4>`_.

:param name:
    The name of the parameter, a string expected to be ASCII only.
:param value:
    The value of the parameter, provided as ``bytes`` or `str``.
:ret:
    An RFC-2231-formatted unicode string.

Definition at line 24 of file fields.py.

def format_header_param_rfc2231(name, value):
    """
    Helper function to format and quote a single header parameter using the
    strategy defined in RFC 2231.
 
    Particularly useful for header parameters which might contain
    non-ASCII values, like file names. This follows
    `RFC 2388 Section 4.4 <https://tools.ietf.org/html/rfc2388#section-4.4>`_.
 
    :param name:
        The name of the parameter, a string expected to be ASCII only.
    :param value:
        The value of the parameter, provided as ``bytes`` or `str``.
    :ret:
        An RFC-2231-formatted unicode string.
    """
    if isinstance(value, six.binary_type):
        value = value.decode("utf-8")
 
    if not any(ch in value for ch in '"\\\r\n'):
        result = u'%s="%s"' % (name, value)
        try:
            result.encode("ascii")
        except (UnicodeEncodeError, UnicodeDecodeError):
            pass
        else:
            return result
 
    if six.PY2:  # Python 2:
        value = value.encode("utf-8")
 
    # encode_rfc2231 accepts an encoded string and returns an ascii-encoded
    # string in Python 2 but accepts and returns unicode strings in Python 3
    value = email.utils.encode_rfc2231(value, "utf-8")
    value = "%s*=%s" % (name, value)
 
    if six.PY2:  # Python 2:
        value = value.decode("utf-8")
 
    return value
 
 

References pip._vendor.urllib3.fields.guess_content_type(), and i.

Here is the call graph for this function:

guess_content_type()

guess_content_type	(		filename,
			default = "application/octet-stream"
	)

Guess the "Content-Type" of a file.

:param filename:
    The filename to guess the "Content-Type" of using :mod:`mimetypes`.
:param default:
    If no "Content-Type" can be guessed, default to `default`.

Definition at line 10 of file fields.py.

def guess_content_type(filename, default="application/octet-stream"):
    """
    Guess the "Content-Type" of a file.
 
    :param filename:
        The filename to guess the "Content-Type" of using :mod:`mimetypes`.
    :param default:
        If no "Content-Type" can be guessed, default to `default`.
    """
    if filename:
        return mimetypes.guess_type(filename)[0] or default
    return default
 
 

References i.

Referenced by pip._vendor.urllib3.fields.format_header_param_rfc2231().

Here is the caller graph for this function: