django-rest-framework/djangorestframework/utils/__init__.py

from django.utils.encoding import smart_unicode
from django.utils.xmlutils import SimplerXMLGenerator
from django.core.urlresolvers import resolve

from djangorestframework.compat import StringIO
from djangorestframework.compat import RequestFactory as DjangoRequestFactory
from djangorestframework.request import Request

import re
import xml.etree.ElementTree as ET


MSIE_USER_AGENT_REGEX = re.compile(r'^Mozilla/[0-9]+\.[0-9]+ \([^)]*; MSIE [0-9]+\.[0-9]+[a-z]?;[^)]*\)(?!.* Opera )')


def as_tuple(obj):
    """
    Given an object which may be a list/tuple, another object, or None,
    return that object in list form.

    IE:
    If the object is already a list/tuple just return it.
    If the object is not None, return it in a list with a single element.
    If the object is None return an empty list.
    """
    if obj is None:
        return ()
    elif isinstance(obj, list):
        return tuple(obj)
    elif isinstance(obj, tuple):
        return obj
    return (obj,)


def url_resolves(url):
    """
    Return True if the given URL is mapped to a view in the urlconf, False otherwise.
    """
    try:
        resolve(url)
    except Exception:
        return False
    return True


# From xml2dict
class XML2Dict(object):

    def __init__(self):
        pass

    def _parse_node(self, node):
        node_tree = {}
        # Save attrs and text, hope there will not be a child with same name
        if node.text:
            node_tree = node.text
        for (k, v) in node.attrib.items():
            k, v = self._namespace_split(k, v)
            node_tree[k] = v
        #Save childrens
        for child in node.getchildren():
            tag, tree = self._namespace_split(child.tag, self._parse_node(child))
            if  tag not in node_tree:  # the first time, so store it in dict
                node_tree[tag] = tree
                continue
            old = node_tree[tag]
            if not isinstance(old, list):
                node_tree.pop(tag)
                node_tree[tag] = [old]  # multi times, so change old dict to a list
            node_tree[tag].append(tree)  # add the new one

        return  node_tree

    def _namespace_split(self, tag, value):
        """
           Split the tag  '{http://cs.sfsu.edu/csc867/myscheduler}patients'
             ns = http://cs.sfsu.edu/csc867/myscheduler
             name = patients
        """
        result = re.compile("\{(.*)\}(.*)").search(tag)
        if result:
            value.namespace, tag = result.groups()
        return (tag, value)

    def parse(self, file):
        """parse a xml file to a dict"""
        f = open(file, 'r')
        return self.fromstring(f.read())

    def fromstring(self, s):
        """parse a string"""
        t = ET.fromstring(s)
        unused_root_tag, root_tree = self._namespace_split(t.tag, self._parse_node(t))
        return root_tree


def xml2dict(input):
    return XML2Dict().fromstring(input)


# Piston:
class XMLRenderer():
    def _to_xml(self, xml, data):
        if isinstance(data, (list, tuple)):
            for item in data:
                xml.startElement("list-item", {})
                self._to_xml(xml, item)
                xml.endElement("list-item")

        elif isinstance(data, dict):
            for key, value in data.iteritems():
                xml.startElement(key, {})
                self._to_xml(xml, value)
                xml.endElement(key)

        elif data is None:
            # Don't output any value
            pass

        else:
            xml.characters(smart_unicode(data))

    def dict2xml(self, data):
        stream = StringIO.StringIO()

        xml = SimplerXMLGenerator(stream, "utf-8")
        xml.startDocument()
        xml.startElement("root", {})

        self._to_xml(xml, data)

        xml.endElement("root")
        xml.endDocument()
        return stream.getvalue()


def dict2xml(input):
    return XMLRenderer().dict2xml(input)


class RequestFactory(DjangoRequestFactory):
    """
    Replicate RequestFactory, but return Request, not HttpRequest.
    """
    def get(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).get(*args, **kwargs)
        return Request(request, parsers)

    def post(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).post(*args, **kwargs)
        return Request(request, parsers)

    def put(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).put(*args, **kwargs)
        return Request(request, parsers)

    def delete(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).delete(*args, **kwargs)
        return Request(request, parsers)

    def head(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).head(*args, **kwargs)
        return Request(request, parsers)

    def options(self, *args, **kwargs):
        parsers = kwargs.pop('parsers', None)
        request = super(RequestFactory, self).options(*args, **kwargs)
        return Request(request, parsers)