Can I access constants in settings py from templates in Django

Question

I have some stuff in settings py that I d like to be able to access from a template  but I can t figure out how to do it  I already tried    CONSTANT NAME     but that doesn t seem to work  Is this possible

User · Answer

I find the simplest approach being a single custom template tag:

from django import template
from django.conf import settings

register = template.Library()

# settings value
@register.simple_tag
def settings_value(name):
    return getattr(settings, name, "")

Usage:

{% settings_value "LANGUAGE_CODE" %}

User · Answer

If it s a value you d like to have for every request  amp  template  using a context processor is more appropriate   Here s how    Make a context processors py file in your app directory  Let s say I want to have the ADMIN PREFIX VALUE value in every context   from django conf import settings   import the settings file  def admin media request         return the value you want as a dictionnary  you may add multiple values in there      return   ADMIN MEDIA URL   settings ADMIN MEDIA PREFIX   add your context processor to your settings py file   TEMPLATES            whatever comes before      OPTIONS              context processors                   whatever comes before              your app context processors admin media                        Use RequestContext in your view to add your context processors in your template  The render shortcut does this automatically   from django shortcuts import render  def my view request       return render request   index html    and finally  in your template        lt a href     ADMIN MEDIA URL     gt path to admin media lt  a gt

User · Answer

I like Berislav s solution  because on simple sites  it is clean and effective   What I do NOT like is exposing all the settings constants willy-nilly   So what I ended up doing was this   from django import template from django conf import settings  register   template Library    ALLOWABLE VALUES     CONSTANT NAME 1    CONSTANT NAME 2       settings value  register simple tag def settings value name       if name in ALLOWABLE VALUES          return getattr settings  name          return      Usage      settings value  CONSTANT NAME 1       This protects any constants that you have not named from use in the template  and if you wanted to get really fancy  you could set a tuple in the settings  and create more than one template tag for different pages  apps or areas  and simply combine a local tuple with the settings tuple as needed  then do the list comprehension to see if the value is acceptable  I agree  on a complex site  this is a bit simplistic  but there are values that would be nice to have universally in templates  and this seems to work nicely  Thanks to Berislav for the original idea

User · Answer

Another way to do this is to create a custom template tag which can let you fish values out of the settings    register tag def value from settings parser  token       try            split contents   knows not to split quoted strings          tag name  var   token split contents       except ValueError          raise template TemplateSyntaxError    r tag requires a single argument    token contents split   0      return ValueFromSettings var   class ValueFromSettings template Node       def   init   self  var           self arg   template Variable var      def render self  context                   return settings   getattr   str self arg     You can then use      value from settings  FQDN       to print it on any page  without jumping through context-processor hoops

User · Answer

I found this to be the simplest approach for Django 1 3    views py  from local settings import BASE URL  def root request       return render to response  hero html     BASE URL   BASE URL    hero html  var BASE URL       JS BASE URL

User · Answer

Another way to do this is to create a custom template tag which can let you fish values out of the settings    register tag def value from settings parser  token       try            split contents   knows not to split quoted strings          tag name  var   token split contents       except ValueError          raise template TemplateSyntaxError    r tag requires a single argument    token contents split   0      return ValueFromSettings var   class ValueFromSettings template Node       def   init   self  var           self arg   template Variable var      def render self  context                   return settings   getattr   str self arg     You can then use      value from settings  FQDN       to print it on any page  without jumping through context-processor hoops

User · Answer

I found this to be the simplest approach for Django 1 3    views py  from local settings import BASE URL  def root request       return render to response  hero html     BASE URL   BASE URL    hero html  var BASE URL       JS BASE URL

User · Answer

If we were to compare context vs  template tags on a single variable  then knowing the more efficient option could be benificial  However  you might be better off to dip into the settings only from templates that need that variable  In that case it doesn t make sense to pass the variable into all templates  But if you are sending the variable into a common template such as the base html template  Then it would not matter as the base html template is rendered on every request  so you can use either methods   If you decide to go with the template tags option  then use the following code as it allows you to pass a default value in  just in case the variable in-question was undefined   Example  get from settings my variable as my context value  Example  get from settings my variable my default as my context value  class SettingsAttrNode Node       def   init   self  variable  default  as value           self variable   getattr settings  variable  default          self cxtname   as value      def render self  context           context self cxtname    self variable         return      def get from setting parser  token       as value   variable   default          bits   token contents split       if len bits     4 and bits 2      as           variable   bits 1          as value   bits 3      elif len bits     5 and bits 3      as           variable       bits 1          default    bits 2          as value   bits 4      else          raise TemplateSyntaxError   usage  get from settings variable default as value                      OR  get from settings variable as value       return SettingsAttrNode variable variable  default default  as value as value   get from setting   register tag get from setting

User · Answer

Both IanSR and bchhun suggested overriding TEMPLATE CONTEXT PROCESSORS in the settings  Be aware that this setting has a default that can cause some screwy things if you override it without re-setting the defaults  The defaults have also changed in recent versions of Django   https   docs djangoproject com en 1 3 ref settings  template-context-processors  The default TEMPLATE CONTEXT PROCESSORS    TEMPLATE CONTEXT PROCESSORS     django contrib auth context processors auth    django core context processors debug    django core context processors i18n    django core context processors media    django core context processors static    django contrib messages context processors messages

User · Answer

Add this code to a file called context processors py   from django conf import settings as django settings   def settings request       return            settings   django settings          And then  in your settings file  include a path such as  speedy core base context processors settings   with your app name and path  in the  context processors  settings in TEMPLATES    You can see for example settings base py and context processors py    Then you can use the specific setting in any template code  For example      if settings SITE ID    settings SPEEDY MATCH SITE ID      Update  The code above exposes all the settings to templates  including sensitive information such as your SECRET KEY  A hacker might abuse this feature to display such information in the templates  If you want to expose only specific settings to the templates  use this code instead   def settings request       settings in templates          for attr in   SITE ID           Write here the settings you want to expose to the templates          if  hasattr django settings  attr                settings in templates attr    getattr django settings  attr      return            settings   settings in templates

User · Answer

Adding an answer with complete instructions for creating a custom template tag that solves this  with Django 2 0   In your app-folder  create a folder called templatetags  In it  create   init   py and custom tags py     In the custom tags py create a custom tag function that provides access to an arbitrary key in the settings constant   from django import template from django conf import settings  register   template Library     register simple tag def get setting name       return getattr settings  name        To understand this code I recommend reading the section on simple tags in the Django docs   Then  you need to make Django aware of this  and any additional  custom tag by loading this file in any template where you will use it  Just like you need to load the built in static tag      load custom tags      With it loaded it can be used just like any other tag  just supply the specific setting you need returned  So if you have a BUILD VERSION variable in your settings      get setting  BUILD VERSION       This solution will not work with arrays  but if you need that you might be putting to much logic in your templates   Note  A more clean and failsafe solution would probably be to make a custom context processor where you add the settings you need to a context available to all templates  This way you reduce the risk of outputting sensitive settings in your templates by mistake

User · Answer

Check out django-settings-export  disclaimer  I m the author of this project    For example       pip install django-settings-export   settings py  TEMPLATES                    OPTIONS                  context processors                      django settings export settings export                                       MY CHEESE    Camembert    SETTINGS EXPORT          MY CHEESE       template html   lt script gt var MY CHEESE       settings MY CHEESE      lt  script gt

User · Answer

Both IanSR and bchhun suggested overriding TEMPLATE CONTEXT PROCESSORS in the settings  Be aware that this setting has a default that can cause some screwy things if you override it without re-setting the defaults  The defaults have also changed in recent versions of Django   https   docs djangoproject com en 1 3 ref settings  template-context-processors  The default TEMPLATE CONTEXT PROCESSORS    TEMPLATE CONTEXT PROCESSORS     django contrib auth context processors auth    django core context processors debug    django core context processors i18n    django core context processors media    django core context processors static    django contrib messages context processors messages

User · Answer

Django provides access to certain  frequently-used settings constants to the template such as settings MEDIA URL and some of the language settings if you use django s built in generic views or pass in a context instance keyword argument in the render to response shortcut function   Here s an example of each case   from django shortcuts import render to response from django template import RequestContext from django views generic simple import direct to template  def my generic view request  template  my template html        return direct to template request  template   def more custom view request  template  my template html        return render to response template      context instance RequestContext request     These views will both have several frequently used settings like settings MEDIA URL available to the template as    MEDIA URL     etc   If you re looking for access to other constants in the settings  then simply unpack the constants you want and add them to the context dictionary you re using in your view function  like so   from django conf import settings from django shortcuts import render to response  def my view function request  template  my template html        context     favorite color   settings FAVORITE COLOR      return render to response template  context    Now you can access settings FAVORITE COLOR on your template as    favorite color

User · Answer

Django provides access to certain  frequently-used settings constants to the template such as settings MEDIA URL and some of the language settings if you use django s built in generic views or pass in a context instance keyword argument in the render to response shortcut function   Here s an example of each case   from django shortcuts import render to response from django template import RequestContext from django views generic simple import direct to template  def my generic view request  template  my template html        return direct to template request  template   def more custom view request  template  my template html        return render to response template      context instance RequestContext request     These views will both have several frequently used settings like settings MEDIA URL available to the template as    MEDIA URL     etc   If you re looking for access to other constants in the settings  then simply unpack the constants you want and add them to the context dictionary you re using in your view function  like so   from django conf import settings from django shortcuts import render to response  def my view function request  template  my template html        context     favorite color   settings FAVORITE COLOR      return render to response template  context    Now you can access settings FAVORITE COLOR on your template as    favorite color

User · Answer

The example above from bchhun is nice except that you need to explicitly build your context dictionary from settings py   Below is an UNTESTED example of how you could auto-build the context dictionary from all upper-case attributes of settings py  re     A-Z0-9         At the end of settings py    context       local context   locals   for  k v  in local context items        if re search    A-Z0-9      k            context k    str v   def settings context context       return  context  TEMPLATE CONTEXT PROCESSORS          myproject settings settings context

User · Answer

If it s a value you d like to have for every request  amp  template  using a context processor is more appropriate   Here s how    Make a context processors py file in your app directory  Let s say I want to have the ADMIN PREFIX VALUE value in every context   from django conf import settings   import the settings file  def admin media request         return the value you want as a dictionnary  you may add multiple values in there      return   ADMIN MEDIA URL   settings ADMIN MEDIA PREFIX   add your context processor to your settings py file   TEMPLATES            whatever comes before      OPTIONS              context processors                   whatever comes before              your app context processors admin media                        Use RequestContext in your view to add your context processors in your template  The render shortcut does this automatically   from django shortcuts import render  def my view request       return render request   index html    and finally  in your template        lt a href     ADMIN MEDIA URL     gt path to admin media lt  a gt

User · Answer

If using a class-based view       in settings py   YOUR CUSTOM SETTING    some value       in views py   from django conf import settings  for getting settings vars  class YourView DetailView    assuming DetailView  whatever though                 def get context data self    kwargs            context   super YourView  self  get context data   kwargs          context  YOUR CUSTOM SETTING     settings YOUR CUSTOM SETTING          return context      in your template html  reference the setting like any other context variable      YOUR CUSTOM SETTING

User · Answer

If we were to compare context vs  template tags on a single variable  then knowing the more efficient option could be benificial  However  you might be better off to dip into the settings only from templates that need that variable  In that case it doesn t make sense to pass the variable into all templates  But if you are sending the variable into a common template such as the base html template  Then it would not matter as the base html template is rendered on every request  so you can use either methods   If you decide to go with the template tags option  then use the following code as it allows you to pass a default value in  just in case the variable in-question was undefined   Example  get from settings my variable as my context value  Example  get from settings my variable my default as my context value  class SettingsAttrNode Node       def   init   self  variable  default  as value           self variable   getattr settings  variable  default          self cxtname   as value      def render self  context           context self cxtname    self variable         return      def get from setting parser  token       as value   variable   default          bits   token contents split       if len bits     4 and bits 2      as           variable   bits 1          as value   bits 3      elif len bits     5 and bits 3      as           variable       bits 1          default    bits 2          as value   bits 4      else          raise TemplateSyntaxError   usage  get from settings variable default as value                      OR  get from settings variable as value       return SettingsAttrNode variable variable  default default  as value as value   get from setting   register tag get from setting

User · Answer

Add this code to a file called context processors py   from django conf import settings as django settings   def settings request       return            settings   django settings          And then  in your settings file  include a path such as  speedy core base context processors settings   with your app name and path  in the  context processors  settings in TEMPLATES    You can see for example settings base py and context processors py    Then you can use the specific setting in any template code  For example      if settings SITE ID    settings SPEEDY MATCH SITE ID      Update  The code above exposes all the settings to templates  including sensitive information such as your SECRET KEY  A hacker might abuse this feature to display such information in the templates  If you want to expose only specific settings to the templates  use this code instead   def settings request       settings in templates          for attr in   SITE ID           Write here the settings you want to expose to the templates          if  hasattr django settings  attr                settings in templates attr    getattr django settings  attr      return            settings   settings in templates

User · Answer

Check out django-settings-export  disclaimer  I m the author of this project    For example       pip install django-settings-export   settings py  TEMPLATES                    OPTIONS                  context processors                      django settings export settings export                                       MY CHEESE    Camembert    SETTINGS EXPORT          MY CHEESE       template html   lt script gt var MY CHEESE       settings MY CHEESE      lt  script gt

User · Answer

The example above from bchhun is nice except that you need to explicitly build your context dictionary from settings py   Below is an UNTESTED example of how you could auto-build the context dictionary from all upper-case attributes of settings py  re     A-Z0-9         At the end of settings py    context       local context   locals   for  k v  in local context items        if re search    A-Z0-9      k            context k    str v   def settings context context       return  context  TEMPLATE CONTEXT PROCESSORS          myproject settings settings context

User · Answer

If it s a value you d like to have for every request  amp  template  using a context processor is more appropriate   Here s how    Make a context processors py file in your app directory  Let s say I want to have the ADMIN PREFIX VALUE value in every context   from django conf import settings   import the settings file  def admin media request         return the value you want as a dictionnary  you may add multiple values in there      return   ADMIN MEDIA URL   settings ADMIN MEDIA PREFIX   add your context processor to your settings py file   TEMPLATES            whatever comes before      OPTIONS              context processors                   whatever comes before              your app context processors admin media                        Use RequestContext in your view to add your context processors in your template  The render shortcut does this automatically   from django shortcuts import render  def my view request       return render request   index html    and finally  in your template        lt a href     ADMIN MEDIA URL     gt path to admin media lt  a gt

User · Answer

I like Berislav s solution  because on simple sites  it is clean and effective   What I do NOT like is exposing all the settings constants willy-nilly   So what I ended up doing was this   from django import template from django conf import settings  register   template Library    ALLOWABLE VALUES     CONSTANT NAME 1    CONSTANT NAME 2       settings value  register simple tag def settings value name       if name in ALLOWABLE VALUES          return getattr settings  name          return      Usage      settings value  CONSTANT NAME 1       This protects any constants that you have not named from use in the template  and if you wanted to get really fancy  you could set a tuple in the settings  and create more than one template tag for different pages  apps or areas  and simply combine a local tuple with the settings tuple as needed  then do the list comprehension to see if the value is acceptable  I agree  on a complex site  this is a bit simplistic  but there are values that would be nice to have universally in templates  and this seems to work nicely  Thanks to Berislav for the original idea

User · Answer

I improved chrisdew s answer  to create your own tag  a little bit   First  create the file yourapp templatetags value from settings py in which you define your own new tag value from settings   from django template import TemplateSyntaxError  Variable  Node  Variable  Library from yourapp import settings  register   Library     I found some tricks in URLNode and url from defaulttags py    https   code djangoproject com browser django trunk django template defaulttags py  register tag def value from settings parser  token     bits   token split contents     if len bits   lt  2      raise TemplateSyntaxError    s  takes at least one            argument  settings constant to retrieve     bits 0     settingsvar   bits 1    settingsvar   settingsvar 1 -1  if settingsvar 0         else settingsvar   asvar   None   bits   bits 2     if len bits   gt   2 and bits -2      as       asvar   bits -1      bits   bits  -2    if len bits       raise TemplateSyntaxError   value from settings  didn t recognise            the arguments   s          join bits     return ValueFromSettings settingsvar  asvar   class ValueFromSettings Node     def   init   self  settingsvar  asvar       self arg   Variable settingsvar      self asvar   asvar   def render self  context       ret val   getattr settings str self arg       if self asvar        context self asvar    ret val       return        else        return ret val   You can use this tag in your Template via      load value from settings             value from settings  FQDN       or via     load value from settings             value from settings  FQDN  as my fqdn      The advantage of the as     notation is that this makes it easy to use in blocktrans blocks via a simple   my fqdn

User · Answer

Adding an answer with complete instructions for creating a custom template tag that solves this  with Django 2 0   In your app-folder  create a folder called templatetags  In it  create   init   py and custom tags py     In the custom tags py create a custom tag function that provides access to an arbitrary key in the settings constant   from django import template from django conf import settings  register   template Library     register simple tag def get setting name       return getattr settings  name        To understand this code I recommend reading the section on simple tags in the Django docs   Then  you need to make Django aware of this  and any additional  custom tag by loading this file in any template where you will use it  Just like you need to load the built in static tag      load custom tags      With it loaded it can be used just like any other tag  just supply the specific setting you need returned  So if you have a BUILD VERSION variable in your settings      get setting  BUILD VERSION       This solution will not work with arrays  but if you need that you might be putting to much logic in your templates   Note  A more clean and failsafe solution would probably be to make a custom context processor where you add the settings you need to a context available to all templates  This way you reduce the risk of outputting sensitive settings in your templates by mistake

User · Answer

Django provides access to certain  frequently-used settings constants to the template such as settings MEDIA URL and some of the language settings if you use django s built in generic views or pass in a context instance keyword argument in the render to response shortcut function   Here s an example of each case   from django shortcuts import render to response from django template import RequestContext from django views generic simple import direct to template  def my generic view request  template  my template html        return direct to template request  template   def more custom view request  template  my template html        return render to response template      context instance RequestContext request     These views will both have several frequently used settings like settings MEDIA URL available to the template as    MEDIA URL     etc   If you re looking for access to other constants in the settings  then simply unpack the constants you want and add them to the context dictionary you re using in your view function  like so   from django conf import settings from django shortcuts import render to response  def my view function request  template  my template html        context     favorite color   settings FAVORITE COLOR      return render to response template  context    Now you can access settings FAVORITE COLOR on your template as    favorite color

User · Answer

If using a class-based view       in settings py   YOUR CUSTOM SETTING    some value       in views py   from django conf import settings  for getting settings vars  class YourView DetailView    assuming DetailView  whatever though                 def get context data self    kwargs            context   super YourView  self  get context data   kwargs          context  YOUR CUSTOM SETTING     settings YOUR CUSTOM SETTING          return context      in your template html  reference the setting like any other context variable      YOUR CUSTOM SETTING

User · Answer

I improved chrisdew s answer  to create your own tag  a little bit   First  create the file yourapp templatetags value from settings py in which you define your own new tag value from settings   from django template import TemplateSyntaxError  Variable  Node  Variable  Library from yourapp import settings  register   Library     I found some tricks in URLNode and url from defaulttags py    https   code djangoproject com browser django trunk django template defaulttags py  register tag def value from settings parser  token     bits   token split contents     if len bits   lt  2      raise TemplateSyntaxError    s  takes at least one            argument  settings constant to retrieve     bits 0     settingsvar   bits 1    settingsvar   settingsvar 1 -1  if settingsvar 0         else settingsvar   asvar   None   bits   bits 2     if len bits   gt   2 and bits -2      as       asvar   bits -1      bits   bits  -2    if len bits       raise TemplateSyntaxError   value from settings  didn t recognise            the arguments   s          join bits     return ValueFromSettings settingsvar  asvar   class ValueFromSettings Node     def   init   self  settingsvar  asvar       self arg   Variable settingsvar      self asvar   asvar   def render self  context       ret val   getattr settings str self arg       if self asvar        context self asvar    ret val       return        else        return ret val   You can use this tag in your Template via      load value from settings             value from settings  FQDN       or via     load value from settings             value from settings  FQDN  as my fqdn      The advantage of the as     notation is that this makes it easy to use in blocktrans blocks via a simple   my fqdn

User · Answer

I find the simplest approach being a single custom template tag:

from django import template
from django.conf import settings

register = template.Library()

# settings value
@register.simple_tag
def settings_value(name):
    return getattr(settings, name, "")

Usage:

{% settings_value "LANGUAGE_CODE" %}

User · Answer

Django provides access to certain  frequently-used settings constants to the template such as settings MEDIA URL and some of the language settings if you use django s built in generic views or pass in a context instance keyword argument in the render to response shortcut function   Here s an example of each case   from django shortcuts import render to response from django template import RequestContext from django views generic simple import direct to template  def my generic view request  template  my template html        return direct to template request  template   def more custom view request  template  my template html        return render to response template      context instance RequestContext request     These views will both have several frequently used settings like settings MEDIA URL available to the template as    MEDIA URL     etc   If you re looking for access to other constants in the settings  then simply unpack the constants you want and add them to the context dictionary you re using in your view function  like so   from django conf import settings from django shortcuts import render to response  def my view function request  template  my template html        context     favorite color   settings FAVORITE COLOR      return render to response template  context    Now you can access settings FAVORITE COLOR on your template as    favorite color

User · Answer

If someone finds this question like I did  then I ll post my solution which works on Django 2 0   This tag assigns some settings py variable value to template s variable   Usage     get settings value template var  SETTINGS VAR      app templatetags my custom tags py   from django import template from django conf import settings  register   template Library    class AssignNode template Node       def   init   self  name  value           self name   name         self value   value      def render self  context           context self name    getattr settings  self value resolve context  True               return      register tag  get settings value   def do assign parser  token       bits   token split contents       if len bits     3          raise template TemplateSyntaxError    s  tag takes two arguments    bits 0       value   parser compile filter bits 2       return AssignNode bits 1   value    Your template      load my custom tags       Set local template variable     get settings value settings debug  DEBUG        Output settings debug variable     settings debug       Use variable in if statement     if settings debug        do something        else        do other stuff        endif      See Django s documentation how to create custom template tags here  https   docs djangoproject com en 2 0 howto custom-template-tags

User · Answer

If someone finds this question like I did  then I ll post my solution which works on Django 2 0   This tag assigns some settings py variable value to template s variable   Usage     get settings value template var  SETTINGS VAR      app templatetags my custom tags py   from django import template from django conf import settings  register   template Library    class AssignNode template Node       def   init   self  name  value           self name   name         self value   value      def render self  context           context self name    getattr settings  self value resolve context  True               return      register tag  get settings value   def do assign parser  token       bits   token split contents       if len bits     3          raise template TemplateSyntaxError    s  tag takes two arguments    bits 0       value   parser compile filter bits 2       return AssignNode bits 1   value    Your template      load my custom tags       Set local template variable     get settings value settings debug  DEBUG        Output settings debug variable     settings debug       Use variable in if statement     if settings debug        do something        else        do other stuff        endif      See Django s documentation how to create custom template tags here  https   docs djangoproject com en 2 0 howto custom-template-tags

User · Answer

If it s a value you d like to have for every request  amp  template  using a context processor is more appropriate   Here s how    Make a context processors py file in your app directory  Let s say I want to have the ADMIN PREFIX VALUE value in every context   from django conf import settings   import the settings file  def admin media request         return the value you want as a dictionnary  you may add multiple values in there      return   ADMIN MEDIA URL   settings ADMIN MEDIA PREFIX   add your context processor to your settings py file   TEMPLATES            whatever comes before      OPTIONS              context processors                   whatever comes before              your app context processors admin media                        Use RequestContext in your view to add your context processors in your template  The render shortcut does this automatically   from django shortcuts import render  def my view request       return render request   index html    and finally  in your template        lt a href     ADMIN MEDIA URL     gt path to admin media lt  a gt

[django] Can I access constants in settings.py from templates in Django?

Examples related to django

Examples related to django-templates

Examples related to django-settings