aboutsummaryrefslogtreecommitdiffstats
path: root/brevisurl/__init__.py
blob: b929f1f9162877bb446ccd7d093db603639d4796 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
import traceback
try:
    from cStringIO import StringIO
except ImportError:
    from StringIO import StringIO

import brevisurl.settings
from brevisurl.utils import load_object


def get_connection(backend=None, fail_silently=False, **kwargs):
    """Load a brevisurl backend and return an instance of it.

    If backend is None (default) settings.BREVISURL_BACKEND is used.
    Both fail_silently and other keyword arguments are used in the
    constructor of the backend.

    :param backend: path to brevisurl backend
    :type backend: string
    :param fail_silently: whether to fail silently when error intercepted or not
    :type fail_silently: bool
    :returns: instance os BaseBrevisUrlBackend
    :rtype: brevisurl.backends.base.BaseBrevisUrlBackend

    """
    path = backend or brevisurl.settings.DEFAULT_BACKEND
    klass = load_object(path)
    return klass(fail_silently=fail_silently, **kwargs)


def shorten_url(original_url, fail_silently=False, connection=None):
    """Shortcut util for shortening urls using default brevisurl backend if none supplied.

    :param original_url: url that will be shortened
    :type original_url: string
    :param backend: one of brevisurl backends
    :type backend: brevisurl.backends.BaseBrevisUrlBackend
    :returns: shortened url from original url
    :rtype: brevisurl.models.ShortUrl

    """
    connection = connection or get_connection(fail_silently=fail_silently)
    return connection.shorten_url(original_url)


class Error(Exception):
    """Base django-brevisurl Error."""

    def __init__(self, value):
        s = StringIO()
        traceback.print_exc(file=s)
        self.value = (value, s.getvalue())
        s.close()

    def __str__(self):
        return repr(self.value)