Merge pull request jazzband#81 from jazzband/python3

Port to Python 3 and get rid of legacy code

Author: matthiask

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+source = dbtemplates
+branch = 1
+
+[report]
+omit = *tests*,*migrations*

.gitignore

@@ -4,7 +4,6 @@ MANIFEST
 build
 dist
 *.egg-info
-example/example.db
 docs/_build
 .tox/
 *.egg/

.travis.yml

@@ -1,34 +1,32 @@
+language: python
+python: 3.5
 sudo: false
 cache: pip
-language: python
-python:
-- 2.6
-- 2.7
-install:
-- pip install -e .
-- pip install -r requirements/tests.txt Django==$DJANGO
-before_script:
-- flake8 dbtemplates --ignore=E501 --exclude=migrations
-script:
-- coverage run --branch --source=dbtemplates `which django-admin.py` test dbtemplates
-- coverage report --omit="dbtemplates/test*,dbtemplates/migrations*"
 env:
-  global:
-    - DJANGO_SETTINGS_MODULE=dbtemplates.test_settings
-  matrix:
-    - DJANGO="1.4.5 importlib"
-    - DJANGO="1.5.1 importlib"
-    - DJANGO=1.7.8
-    - DJANGO=1.8.11
-    - DJANGO=1.9.4
-matrix:
-  exclude:
-  - python: 2.6
-    env: DJANGO=1.7.8
-  - python: 2.6
-    env: DJANGO=1.8.11
-  - python: 2.6
-    env: DJANGO=1.9.4
+  - TOXENV=flake8-py27
+  - TOXENV=flake8-py35
+  - TOXENV=readme-py27
+  - TOXENV=py27-dj18
+  - TOXENV=py27-dj19
+  - TOXENV=py27-dj110
+  - TOXENV=py27-djmaster
+  - TOXENV=py34-dj18
+  - TOXENV=py34-dj19
+  - TOXENV=py34-dj110
+  - TOXENV=py34-djmaster
+  - TOXENV=py35-dj18
+  - TOXENV=py35-dj19
+  - TOXENV=py35-dj110
+  - TOXENV=py35-djmaster
+  - TOXENV=pypy-dj18
+  - TOXENV=pypy-dj19
+  - TOXENV=pypy-dj110
+  - TOXENV=pypy-djmaster
+install:
+  - pip install tox codecov
+script: tox -v
+after_success:
+  - codecov
 deploy:
   provider: pypi
   user: jazzband
@@ -39,4 +37,4 @@ deploy:
     tags: true
     repo: jazzband/django-dbtemplates
     python: "2.7"
-    condition: "$DJANGO = 1.8.11"
+    condition: "$TOXENV = py27-dj110"

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2012, Jannis Leidel and contributors
+Copyright (c) 2007-2016, Jannis Leidel and contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.rst

@@ -1,14 +1,18 @@
 django-dbtemplates
 ==================
 
-.. image:: https://secure.travis-ci.org/jazzband/django-dbtemplates.png
-    :alt: Build Status
-    :target: http://travis-ci.org/jazzband/django-dbtemplates
-
 .. image:: https://jazzband.co/static/img/badge.svg
    :alt: Jazzband
    :target: https://jazzband.co/
 
+.. image:: https://travis-ci.org/jazzband/django-dbtemplates.svg?branch=master
+    :alt: Build Status
+    :target: http://travis-ci.org/jazzband/django-dbtemplates
+
+.. image:: https://codecov.io/github/jazzband/django-dbtemplates/coverage.svg?branch=master
+   :alt: Codecov
+   :target: https://codecov.io/github/jazzband/django-dbtemplates?branch=master
+
 ``dbtemplates`` is a Django app that consists of two parts:
 
 1. It allows you to store templates in your database
@@ -24,10 +28,4 @@ The source code and issue tracker can be found on Github:
 
 https://github.com/jazzband/django-dbtemplates
 
-Compatibility Roadmap
----------------------
-
-- 1.3.2 ``dbtemplates`` dropped support for Django < 1.4
-- 1.4 will be supported only Django >= 1.7, please freeze your requirements on specific version of ``dbtemplates`` !
-
 .. _template loader: http://docs.djangoproject.com/en/dev/ref/templates/api/#loader-types

dbtemplates/__init__.py

@@ -1,2 +1 @@
-# following PEP 386
-__version__ = "1.3.2"
+__version__ = "2.0"

dbtemplates/loader.py

@@ -1,19 +1,14 @@
-import django
 from django.contrib.sites.models import Site
 from django.db import router
 from django.template import TemplateDoesNotExist
+from django.template.loaders.base import Loader as BaseLoader
 
 from dbtemplates.models import Template
 from dbtemplates.utils.cache import (cache, get_cache_key,
                                      set_and_return, get_cache_notfound_key)
 
-if django.get_version() >= '1.8':
-    from django.template.loaders.base import Loader as tLoaderCls
-else:
-    from django.template.loader import BaseLoader as tLoaderCls  # noqa
 
-
-class Loader(tLoaderCls):
+class Loader(BaseLoader):
     """
     A custom template loader to load templates from the database.
 

dbtemplates/management/commands/check_template_syntax.py

@@ -1,13 +1,13 @@
-from django.core.management.base import CommandError, NoArgsCommand
+from django.core.management.base import CommandError, BaseCommand
 
 from dbtemplates.models import Template
 from dbtemplates.utils.template import check_template_syntax
 
 
-class Command(NoArgsCommand):
+class Command(BaseCommand):
     help = "Ensures templates stored in the database don't have syntax errors."
 
-    def handle_noargs(self, **options):
+    def handle(self, **options):
         errors = []
         for template in Template.objects.all():
             valid, error = check_template_syntax(template)
@@ -16,6 +16,4 @@ def handle_noargs(self, **options):
         if errors:
             raise CommandError(
                 'Some templates contained errors\n%s' % '\n'.join(errors))
-        # NOTE: printing instead of using self.stdout.write to maintain
-        # Django 1.2 compatibility
-        print('OK')
+        self.stdout.write('OK')

dbtemplates/management/commands/create_error_templates.py

@@ -1,7 +1,5 @@
 import sys
-from optparse import make_option
-
-from django.core.management.base import CommandError, NoArgsCommand
+from django.core.management.base import CommandError, BaseCommand
 from django.contrib.sites.models import Site
 
 from dbtemplates.models import Template
@@ -26,14 +24,15 @@
 }
 
 
-class Command(NoArgsCommand):
+class Command(BaseCommand):
     help = "Creates the default error templates as database template objects."
-    option_list = NoArgsCommand.option_list + (
-        make_option("-f", "--force", action="store_true", dest="force",
-                    default=False,
-                    help="overwrite existing database templates"),)
 
-    def handle_noargs(self, **options):
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "-f", "--force", action="store_true", dest="force",
+            default=False, help="overwrite existing database templates")
+
+    def handle(self, **options):
         force = options.get('force')
         try:
             site = Site.objects.get_current()

dbtemplates/management/commands/sync_templates.py

@@ -1,56 +1,54 @@
+import io
 import os
-import codecs
-from optparse import make_option
-from django import VERSION
 from django.contrib.sites.models import Site
-from django.core.management.base import CommandError, NoArgsCommand
+from django.core.management.base import CommandError, BaseCommand
+from django.template.utils import get_app_template_dirs
+from django.template.loader import _engine_list
 try:
     from django.utils.six import input as raw_input
 except ImportError:
     pass
 
-from dbtemplates.conf import settings
 from dbtemplates.models import Template
 
 ALWAYS_ASK, FILES_TO_DATABASE, DATABASE_TO_FILES = ('0', '1', '2')
 
 DIRS = []
+for engine in _engine_list():
+    DIRS.extend(engine.dirs)
+app_template_dirs = get_app_template_dirs('templates')
 
-if VERSION[:2] < (1, 8):
-    from django.template.loaders.app_directories import app_template_dirs
-    DIRS = settings.TEMPLATE_DIRS
-else:
-    from django.template.utils import get_app_template_dirs
-    from django.template.loader import _engine_list
-    for engine in _engine_list():
-        DIRS.extend(engine.dirs)
-    app_template_dirs = get_app_template_dirs('templates')
 
-
-class Command(NoArgsCommand):
+class Command(BaseCommand):
     help = "Syncs file system templates with the database bidirectionally."
-    option_list = NoArgsCommand.option_list + (
-        make_option("-e", "--ext",
-                    dest="ext", action="store", default="html",
-                    help="extension of the files you want to "
-                         "sync with the database [default: %default]"),
-        make_option("-f", "--force",
-                    action="store_true", dest="force", default=False,
-                    help="overwrite existing database templates"),
-        make_option("-o", "--overwrite",
-                    action="store", dest="overwrite", default='0',
-                    help="'0' - ask always, '1' - overwrite database "
-                         "templates from template files, '2' - overwrite "
-                         "template files from database templates"),
-        make_option("-a", "--app-first",
-                    action="store_true", dest="app_first", default=False,
-                    help="look for templates in applications "
-                         "directories before project templates"),
-        make_option("-d", "--delete",
-                    action="store_true", dest="delete", default=False,
-                    help="Delete templates after syncing"))
 
-    def handle_noargs(self, **options):
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "-e", "--ext",
+            dest="ext", action="store", default="html",
+            help="extension of the files you want to "
+                 "sync with the database [default: %default]")
+        parser.add_argument(
+            "-f", "--force",
+            action="store_true", dest="force", default=False,
+            help="overwrite existing database templates")
+        parser.add_argument(
+            "-o", "--overwrite",
+            action="store", dest="overwrite", default='0',
+            help="'0' - ask always, '1' - overwrite database "
+                 "templates from template files, '2' - overwrite "
+                 "template files from database templates")
+        parser.add_argument(
+            "-a", "--app-first",
+            action="store_true", dest="app_first", default=False,
+            help="look for templates in applications "
+                 "directories before project templates")
+        parser.add_argument(
+            "-d", "--delete",
+            action="store_true", dest="delete", default=False,
+            help="Delete templates after syncing")
+
+    def handle(self, **options):
         extension = options.get('ext')
         force = options.get('force')
         overwrite = options.get('overwrite')
@@ -66,10 +64,6 @@ def handle_noargs(self, **options):
             raise CommandError("Please make sure to have the sites contrib "
                                "app installed and setup with a site object")
 
-        if not type(settings.TEMPLATE_DIRS) in (tuple, list):
-            raise CommandError("Please make sure settings.TEMPLATE_DIRS is a "
-                               "list or tuple.")
-
         if app_first:
             tpl_dirs = app_template_dirs + DIRS
         else:
@@ -93,8 +87,8 @@ def handle_noargs(self, **options):
                                 "database.\nCreate it with '%s'?"
                                 " (y/[n]): """ % (name, path))
                         if force or confirm.lower().startswith('y'):
-                            t = Template(name=name,
-                                         content=codecs.open(path, "r").read())
+                            with io.open(path, encoding='utf-8') as f:
+                                t = Template(name=name, content=f.read())
                             t.save()
                             t.sites.add(site)
                     else:
@@ -111,21 +105,19 @@ def handle_noargs(self, **options):
                             if confirm in ('', FILES_TO_DATABASE,
                                            DATABASE_TO_FILES):
                                 if confirm == FILES_TO_DATABASE:
-                                    t.content = codecs.open(path, 'r').read()
-                                    t.save()
-                                    t.sites.add(site)
+                                    with io.open(path, encoding='utf-8') as f:
+                                        t.content = f.read()
+                                        t.save()
+                                        t.sites.add(site)
                                     if delete:
                                         try:
                                             os.remove(path)
                                         except OSError:
                                             raise CommandError(
                                                 u"Couldn't delete %s" % path)
                                 elif confirm == DATABASE_TO_FILES:
-                                    f = codecs.open(path, 'w', 'utf-8')
-                                    try:
+                                    with io.open(path, 'w', encoding='utf-8') as f:
                                         f.write(t.content)
-                                    finally:
-                                        f.close()
                                     if delete:
                                         t.delete()
                                 break