Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
90 lines (46 sloc) 2.21 KB

Various utils

import_app_module

etc.toolbox.import_app_module imports and returns a module from a specific app by its name.

If your application provides some kind of tooling for others and you know that configuration for this tooling could be found in a certain module within a thirdparty app you can use this function to load such a module by its name.

from etc.toolbox import import_app_module


module = import_app_module('someapp', 'mymodule')  # Get `mymodule` module from `someapp` application.

import_project_modules

etc.toolbox.import_project_modules imports modules from registered apps using given module name and returns them as a list.

This is an automation for import_app_module() described above to load all modules from every app in a project.

from etc.toolbox import import_project_modules


all_modules = import_project_modules('mymodule')  # Get `mymodule` module from every app in a project.

get_site_url

etc.toolbox.get_site_url does its best to provide you with a site URL where request object is unavailable.

On occasions when you do not have a request object to get current site URL from (e.g. background tasks) this function tries to get it from environment and settings, using the following order:

  1. (SITE_PROTO or SITE_SCHEME) + SITE_DOMAIN
  2. SITE_URL
  3. Django Sites contrib
  4. Request object (if available)
from etc.toolbox import get_site_url


my_url = get_site_url()

etc_misc Template Tags

  • site_url tag.

    Does its best to provide you with a site URL whether request object is unavailable or not. See get_site_url description above.

    {% load etc_misc %}
    {% site_url %}
  • include_ tag.

    Similar to built-in include template tag, but allowing template variables to be used in template name and a fallback template, thus making the tag more dynamic.

    Warning

    Requires Django 1.8+

    {% load etc_misc %}
    {% include_ "sub_{{ postfix_var }}.html" fallback "default.html" %}
You can’t perform that action at this time.