django-hosts¶

Included callbacks¶

django-hosts includes the following callbacks:

Fully qualified domain names (FQDN)¶

In case you want to append a default domain name to the domain part of the rendered URL you can simply set the PARENT_HOST, e.g:

PARENT_HOST = 'example.com'

This would render the link of the previous section as:

<a href="//admin.example.com/dashboard/">Admin dashboard</a>

Alternatively – in case you don’t want to append this parent domain to all URLs you can also spell out the domain in the host pattern:

from django.conf import settings
from django_hosts import patterns, host

host_patterns = patterns('',
    host(r'admin\.example\.com', settings.ROOT_URLCONF, name='admin'),
)

If your host pattern contains an argument (or key argument), like:

from django.conf import settings
from django_hosts import patterns, host

host_patterns = patterns('',
    host(r'www', settings.ROOT_URLCONF, name='homepage'),
    host(r'(\w+)', 'path.to.support_urls', name='wildcard'),
    host(r'(?P<username>\w+)', 'path.to.user_urls', name='user-area'),
)

you can also easily pass arguments to the host_url() template tag:

{% load hosts %}

<a href="{% host_url user-dashboard on user-area username='johndoe' %}">John's dashboard</a>
<a href="{% host_url faq-index on wildcard 'help' %}">FAQ</a>

Which will be rendered (with a PARENT_HOST of 'example.com') as:

<a href="//johndoe.example.com/">John's dashboard</a>
<a href="//help.example.com/faq/">FAQ</a>

hosts and patterns¶

django_hosts.defaults.patterns(prefix, *args)¶

The function to define the list of hosts (aka host confs), e.g.:

from django_hosts import patterns

host_patterns = patterns('path.to',
    (r'www', 'urls.default', 'default'),
    (r'api', 'urls.api', 'api'),
)

Parameters:	prefix (str) – the URLconf prefix to pass to the host object *args – a list of hosts instances or an iterable thereof

class django_hosts.defaults.host(regex, urlconf, name, callback=None, prefix='')¶

The host object used in host conf together with the django_hosts.defaults.patterns() function, e.g.:

from django_hosts import patterns, host

host_patterns = patterns('path.to',
    host(r'www', 'urls.default', name='default'),
    host(r'api', 'urls.api', name='api'),
)

Parameters:	regex (str) – a regular expression to be used to match the request’s host. urlconf (str) – the dotted path of a URLconf module of the host callback (callable or str) – a callable or the dotted path of a callable to be used when matching has happened prefix (str) – the prefix to apply to the urlconf parameter

add_prefix(prefix='')¶

Adds the prefix string to a string-based urlconf.

Reversal with reverse_host and reverse_full¶

django_hosts.reverse.reverse_full(host, view, host_args=None, host_kwargs=None, view_args=None, view_kwargs=None)¶

Given the host and view name and the appropriate parameters, reverses the fully qualified URL, e.g.:

>>> from django.conf import settings
>>> settings.ROOT_HOSTCONF = 'mysite.hosts'
>>> settings.PARENT_HOST = 'example.com'
>>> from django_hosts.reverse import reverse_full
>>> reverse_full('www', 'about')
'//www.example.com/about/'

Parameters:	host – the name of the host view – the name of the view
Host_args:	the host arguments
Host_kwargs:	the host keyed arguments
View_args:	the arguments of the view
View_kwargs:	the keyed arguments of the view
Return type:	fully qualified URL with path

django_hosts.reverse.reverse_host(host, args=None, kwargs=None)¶

Given the host name and the appropriate parameters, reverses the host, e.g.:

>>> from django.conf import settings
>>> settings.ROOT_HOSTCONF = 'mysite.hosts'
>>> settings.PARENT_HOST = 'example.com'
>>> from django_hosts.reverse import reverse_host
>>> reverse_host('with_username', 'jezdez')
'jezdez.example.com'

Parameters:	name – the name of the host as specified in the hostconf
Args:	the host arguments to use to find a matching entry in the hostconf
Kwargs:	similar to args but key value arguments
Raises django.core.urlresolvers.NoReverseMatch:
	if no host matches
Return type:	reversed hostname

HostSiteManager model manager¶

0.3 (2011/09/30)¶

• Consolidated reversal internals.
• Removed unfinished support for the Django Debug Toolbar.
• Added a custom callback which uses Django’s sites app to retrieve a Site instance matching the current host, setting request.site.
• Extended tests dramatically (100% coverage).
• Added docs at http://django-hosts.rtfd.org
• Stopped preventing the name ‘default’ for hosts.

0.2.1 (2011/05/31)¶

• Fixed issue related to the PARENT_HOST setting when used with empty host patterns.
• Stopped automatically emulating hosts in debug mode.

0.2 (2011/05/31)¶

• BACKWARDS INCOMPATIBLE Renamed the package to django_hosts

  Please change your import from:

  from hosts import patterns, hosts
  

  to:

  from django_hosts import patterns, hosts
  

• BACKWARDS INCOMPATIBLE Changed the data type that the django_hosts.patterns function returns to be a list instead of a SortedDict to follow conventions of Django’s URL patterns. You can use that for easy extension of the patterns, e.g.:

  from django_hosts import patterns, host
  from mytemplateproject.hosts import host_patterns
  
  host_patterns += patterns('',
      host('www2', 'mysite.urls.www2', name='www2')
  )
  

• Extended tests to have full coverage.

• Fixed prefix handling.

0.1.1 (2011/05/30)¶

• Fixed docs issues.
• Use absolute imports where possible.

0.1 (2011/05/29)¶

• Initial release with middleware, reverse and templatetags.