GitLocker: The Coding Marketplace

Description:

djangoserviceurls 1.7

django-service-urls
django-service-urls is a setting helper for django to represent databases, caches and email settings via a single string.
This work is based on dj-database-url and https://github.com/django/django/pull/8562.
Example
Original config:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'mydb',
'HOST': 'localhost',
'PORT': 5432,
'USER': 'myuser',
'PASSWORD': 'mypasswd',
},
}

CACHES = {
'default': {
'BACKEND' : 'django.core.cache.backends.memcached.MemcachedCache',
'LOCATION': '127.0.0.1:11211',
},
}

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
HOST = 'localhost'
PORT = 2525
HOST_USER = ''
HOST_PASSWORD = ''
USE_TLS = True
USE_SSL = False
SSL_CERTFILE = '/etc/ssl/cert'
SSL_KEYFILE = '/etc/ssl/key'
TIMEOUT = 600
USE_LOCALTIME = False

Replace with:
DATABASES = {
'default': os.environ.get('DATABASE_DEFAULT', 'postgres://myuser:mypasswd@localhost:5432/mydb'),
}

CACHES = {
'default': os.environ.get('CACHE_DEFAULT', 'memcached://127.0.0.1:11211'),
}

EMAIL_BACKEND = os.environ.get('EMAIL_BACKEND', 'smtps://localhost:2525?ssl_certfile=/etc/ssl/cert&ssl_keyfile=/etc/ssl/key&timeout=600')

Backends
Currently django-service-urls supports three different services:
DATABASES (django_service_urls.db)

Service
Backend
URLString

Postgresql
django.db.backends.postgresql
postgres://user:passws@host:port/db

Postgresql Socket
django.db.backends.postgresql
postgres://%2Fvar%2Frun%2Fpostgresql/db

Postgresql (dj-database-url compat alias)
django.db.backends.postgresql
postgresql://user:passwd@host:port/db

Postgresql (dj-database-url compat alias)
django.db.backends.postgresql
pgsql://user:passwd@host:port/db

Postgis
django.contrib.gis.db.backends.postgis
postgis://user:passwd@host:port/db

Sqlite (memory)
django.db.backends.sqlite3
sqlite://:memory: or sqlite://

Sqlite (file)
django.db.backends.sqlite3
sqlite:///var/db/database.db

Spatialite (memory)
django.contrib.gis.db.backends.spatialite
spatialite://:memory: or spatialite://

Spatialite (file)
django.contrib.gis.db.backends.spatialite
spatialite:///var/db/database.db

Mysql
django.db.backends.mysql
mysql://user:passwd@host:port/db

Mysql + GIS
django.contrib.gis.db.backends.mysql
mysql+gis://user:passwd@host:port/db

Oracle
django.db.backends.oracle
oracle://user:passwd@host:port/db

Oracle + GIS
django.contrib.gis.db.backends.oracle
oracle+gis://user:passwd@host:port/db

CACHES (django_service_urls.cache)

Service
Backend
URLString

Memory
django.core.cache.backends.locmem.LocMemCache
memory://

Memory
django.core.cache.backends.locmem.LocMemCache
memory://abc

Database
django.core.cache.backends.db.DatabaseCache
db://table-name

Dummy
django.core.cache.backends.dummy.DummyCache
dummy://

Dummy
django.core.cache.backends.dummy.DummyCache
dummy://abc

PyMemcached: single ip
django.core.cache.backends.memcached.PyMemcachedCache
pymemcached://1.2.3.4:1567

PyLibMCCache: single ip
django.core.cache.backends.memcached.PyLibMCCache
pylibmccache://1.2.3.4:1567

Memcached: single ip
django.core.cache.backends.memcached.MemcachedCache
memcached://1.2.3.4:1567

PyMemcached multiple ips
django.core.cache.backends.memcached.PyMemcachedCache
pymemcached://1.2.3.4:1567,1.2.3.5:1568

PyLibMCCache multiple ips
django.core.cache.backends.memcached.PyLibMCCache
pylibmccache://1.2.3.4:1567,1.2.3.5:1568

Memcached multiple ips
django.core.cache.backends.memcached.MemcachedCache
memcached://1.2.3.4:1567,1.2.3.5:1568

PyMemcached no port
django.core.cache.backends.memcached.PyMemcachedCache
pymemcached://1.2.3.4

PyLibMCCache no port
django.core.cache.backends.memcached.PyLibMCCache
pylibmccache://1.2.3.4

Memcached no port
django.core.cache.backends.memcached.MemcachedCache
memcached://1.2.3.4

PyMemcached unix socket
django.core.cache.backends.memcached.PyMemcachedCache
pymemcached:///tmp/memcached.sock

PyLibMCCache unix socket
django.core.cache.backends.memcached.PyLibMCCache
pylibmccache:///tmp/memcached.sock

Memcached unix socket
django.core.cache.backends.memcached.MemcachedCache
memcached:///tmp/memcached.sock

File
django.core.cache.backends.filebased.FileBasedCache
file://C:/abc/def/xyz

File
django.core.cache.backends.filebased.FileBasedCache
file:///abc/def/xyz

EMAIL (django_service_urls.email)

Service
Backend
URLString

Console
django.core.mail.backends.console.EmailBackend
console://

SMTP
django.core.mail.backends.smtp.EmailBackend
smtp://localhost:25

SMTPS (smtp+tls alias)
django.core.mail.backends.smtp.EmailBackend
smtps://localhost:465

SMTP+TLS
django.core.mail.backends.smtp.EmailBackend
smtp+tls://localhost:465

SMTP+SSL
django.core.mail.backends.smtp.EmailBackend
smtp+ssl://localhost:587

File
django.core.mail.backends.filebased.EmailBackend
file:///var/log/emails

Memory
django.core.mail.backends.locmem.EmailBackend
memory://

Dummy
django.core.mail.backends.dummy.EmailBackend
dummy://

Installation
Install package
$ python3 -m pip install django-service-urls

add import django_service_urls.loads in your manage.py
#!/usr/bin/env python
import os
import sys

import django_service_urls.loads

def main():
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project_name.settings')
try:
from django.core.management import execute_from_command_line
except ImportError as exc:
raise ImportError(
"Couldn't import Django. Are you sure it's installed and "
"available on your PYTHONPATH environment variable? Did you "
"forget to activate a virtual environment?"
) from exc
execute_from_command_line(sys.argv)

if __name__ == '__main__':
main()

and in wsgi.py
import os
import django_service_urls.loads

from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project_name.settings')

application = get_wsgi_application()

Extend django-service-urls
Add another handler
You can add another handler to an already existing handler:
my_postgres_backend/service_url.py
from django_service_urls.services import db, postgresql_config_from_url

# postgresql fork
postgresql_config_from_url = db.register(('mypgbackend', 'my_postgres_backend'))(postgresql_config_from_url)

yourapp/settings.py
import my_postgres_backend.service_url

DATABASES = {'default': 'mypgbackend://user:pwd@:/mydb'}

Add another service
from django_service_urls import Service

class SearchService(Service):
def config_from_url(self, engine, scheme, url):
parsed = self.parse_url(url)
return {
'ENGINE': engine,
# here all options from parsed
}

search = SearchService()

@search.register(('myengine', 'my_search_engine'))
def search_config_from_url(backend, engine, scheme, url):
return backend.config_from_url(engine, scheme, url)

mypy integration
If you need to load the initializer from mypy you could add
[mypy]
plugins = django_service_urls.mypy

in your mypy.ini or setup.cfg file.
pyproject.toml configuration is also supported:
[tool.mypy]
plugins = ["django_service_urls.mypy"]