Added Django support.

This commit is contained in:
Quantum 2017-08-13 18:50:47 -04:00
parent aa8453966a
commit 4f5fd4ff52
9 changed files with 259 additions and 0 deletions

View file

@ -0,0 +1,2 @@
# Make this usable as a Django application.
default_app_config = 'optimize_later.apps.OptimizeLaterConfig'

37
optimize_later/apps.py Normal file
View file

@ -0,0 +1,37 @@
# For Django applications.
import logging
from django.apps import AppConfig
from django.conf import settings
from django.utils.module_loading import import_string
from optimize_later import config
log = logging.getLogger(__name__.rpartition('.')[0] or __name__)
django_callbacks = []
class OptimizeLaterConfig(AppConfig):
name = 'optimize_later'
verbose_name = 'Optimize Later'
def ready(self):
initialize_django_callbacks()
def django_callback(result):
for callback in django_callbacks:
try:
callback(result)
except Exception:
log.exception('Failed to invoke Django callback: %r', callback)
def initialize_django_callbacks():
global django_callbacks
django_callbacks = []
for callback in getattr(settings, 'OPTIMIZE_LATER_CALLBACKS', None) or []:
django_callbacks.append(import_string(callback))
config.register_callback(django_callback)

24
testproject/manage.py Normal file
View file

@ -0,0 +1,24 @@
#!/usr/bin/env python
import os
import sys
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testproject.settings")
try:
from django.core.management import execute_from_command_line
except ImportError:
# The above import may fail for some other reason. Ensure that the
# issue is really that Django is missing to avoid masking other
# exceptions on Python 2.
try:
import django
except ImportError:
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?"
)
raise
execute_from_command_line(sys.argv)

View file

View file

@ -0,0 +1,37 @@
import imp
import sys
import uuid
from optimize_later.core import optimize_later, OptimizeReport
try:
import django
except ImportError:
pass
else:
from django.test import TestCase
from optimize_later import apps
class DjangoCallbackTest(TestCase):
def make_module_path(self, function):
name = 'id_%s' % (uuid.uuid4().hex,)
module = imp.new_module(name)
module.function = function
sys.modules[name] = module
return '%s.function' % (name,)
def test_no_callbacks(self):
apps.initialize_django_callbacks()
self.assertEqual(apps.django_callbacks, [])
def test_callbacks(self):
reports = []
with self.settings(OPTIMIZE_LATER_CALLBACKS=[
self.make_module_path(reports.append),
]):
apps.initialize_django_callbacks()
with optimize_later('test'):
pass
self.assertEqual(len(reports), 1)
self.assertIsInstance(reports[0], OptimizeReport)

View file

View file

@ -0,0 +1,122 @@
"""
Django settings for testproject project.
Generated by 'django-admin startproject' using Django 1.11.2.
For more information on this file, see
https://docs.djangoproject.com/en/1.11/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/1.11/ref/settings/
"""
import os
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '5mhki6-)ki$7go#g2cblm7t$m2325z&chy=r#e8#)@b+reb=4u'
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
ALLOWED_HOSTS = []
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'optimize_later',
'testapp',
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
ROOT_URLCONF = 'testproject.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
WSGI_APPLICATION = 'testproject.wsgi.application'
# Database
# https://docs.djangoproject.com/en/1.11/ref/settings/#databases
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
# Password validation
# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# Internationalization
# https://docs.djangoproject.com/en/1.11/topics/i18n/
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/1.11/howto/static-files/
STATIC_URL = '/static/'

View file

@ -0,0 +1,21 @@
"""testproject URL Configuration
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/1.11/topics/http/urls/
Examples:
Function views
1. Add an import: from my_app import views
2. Add a URL to urlpatterns: url(r'^$', views.home, name='home')
Class-based views
1. Add an import: from other_app.views import Home
2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home')
Including another URLconf
1. Import the include() function: from django.conf.urls import url, include
2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls'))
"""
from django.conf.urls import url
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
]

View file

@ -0,0 +1,16 @@
"""
WSGI config for testproject project.
It exposes the WSGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/
"""
import os
from django.core.wsgi import get_wsgi_application
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testproject.settings")
application = get_wsgi_application()