Django settings helpers
Project description
Just a collection of Django settings helpers.
Requirements
- Python 2.6, 2.7, 3.2, 3.3
- Django 1.4-1.6
Settings
Settings class - adds ability to group Django settings with classes. As many text editors and IDEs indexes code symbols, with such approach you can easily navigate to any group and any line of your settings file.
class Apps(Settings): def DJANGO_APPS(self): return ( 'django.contrib.auth', ... ) def THIRD_PARTY_APPS(self): return ( 'rest_framework', 'south', ) def OWN_APPS(self): return ( 'app1', 'app2', ) def INSTALLED_APPS(self): return self.DJANGO_APPS() + self.THIRD_PARTY_APPS() + self.OWN_APPS()
With Sublime Text 3 press Cmd+Shift+R
and type “THIRD”.
Same thing could be done with TEMPLATE_CONTEXT_PROCESSORS, MIDDLEWARE_CLASSES etc.
Config class - injects dictionary of variables into module’s scope:
from classsettings import Config class REST_FRAMEWORK(Config): def DEFAULT_FILTER_BACKENDS(self): return ( 'rest_framework.filters.DjangoFilterBackend', ) DEFAULT_RENDERER_CLASSES = ('rest_framework.renderers.YAMLRenderer',)
Will result in
REST_FRAMEWORK = { 'DEFAULT_FILTER_BACKENDS': ( 'rest_framework.filter.DjangoFilterBackend', ), 'DEFAULT_RENDERER_CLASSES': ( 'rest_framework.renderers.YAMLRenderer', ) }
And some decorators may be found usefull:
from classsettings import Settings, from_env class MySettingsGroup(Settings): # Will look for `EMAIL_HOST` key in `os.environ` # and use `smtp.gmail.com` if such key was not found @from_env def EMAIL_HOST(self): return 'smtp.gmail.com' # Will raise Django's `ImproperlyConfigured` exception # if such key was not found @from_env def SECRET_KEY(self): pass # Will look for specified key @from_env(key='CUSTOM_ENV_VAR_NAME') def variable(self): pass # Will apply `through` callable to result @from_env(through=dj_database_url.parse) def DATABASE_URL(self): return 'sqlite://'
urlconfs helpers
Sample urlconf:
from django.conf.urls import patterns, url import views urlpatterns = patterns('', url(r'^$', views.ProjectList.as_view(), name='projects_project_list'), url(r'^create/$', views.ProjectCreate.as_view(), name='projects_project_create'), url(r'^view/(?P<pk>\w+)/$', views.ProjectDetail.as_view(), name='projects_project_view'), url(r'^update/(?P<pk>\w+)/$', views.ProjectUpdate.as_view(), name='projects_project_update'), url(r'^delete/(?P<pk>\w+)/$', views.ProjectDelete.as_view(), name='projects_project_delete'), url('^accounts/(?P<pk>\d+)/$', 'project.accounts.profile_info', name='users_info') url('^accounts/edit/$', 'project.accounts.profile_edit', name='users_edit') )
is equivalent to
from classsettings.urls import Scope, url import views # # Define url pattern, views or view name prefix: # # Views resolution: # # some.module, 'string' => getattr(module, 'string') # 'scope_str', 'string' => 'string'.format('scope_str', ...) # with Scope(regex='^', views=views, name='projects') as root: # # Strings are formatted with `str.format`: # # value.format(value_of_parent_scope, **scope.context) # # Additional context variables can be defined and used with `{variable}` with Scope(name='{}_project', pk=r'(?P<pk>\w+)') as project: # Also supported project['pk'] = r'(?P<pk>\w+)' # For CBV `.as_view()` is called automatically url('{}$', 'ProjectList', name='{}_list') # url => '^$', name => 'projects_project_list' url('{}create/$', 'ProjectCreate', name='{}_create') url('{}view/{pk}/$', 'ProjectDetail', name='{}_detail') url('{}update/{pk}/$', 'ProjectUpdate', name='{}_update') url('{}delete/{pk}/$', 'ProjectDelete', name='{}_delete') with Scope(regex='{}accounts/', views='project.accounts', name='users', user_id=r'(?P<pk>\d+)'): url('{}{user_id}?/$', '{}.profile_info', name='{}_info') url('{}edit/$', '{}.profile_edit', name='{}_edit') urlpatterns = root.urls
For urls defined outside Scope object native django’s url function is used.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size django-classsettings-1.0.2.tar.gz (6.7 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for django-classsettings-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b15e09dabb69c9ee713a6f6993ccaa4883e6361a1556df29171a2b74d6380caa |
|
MD5 | 227e6e17ca94d5c28d1c0427d281ccae |
|
BLAKE2-256 | a17bd32ac7bc22eae354c0329e839001d40b150dcdc34f3a773bc227e27ce479 |