Merge branch 'master' into original_master

Author: tobiasmcnulty

.travis.yml

@@ -1,15 +1,10 @@
+dist: xenial
 language: python
 services:
   - memcached
   - redis-server
-python:
-# python selected by tox, so specify only one version here
-  - "3.6"
 addons:
-  postgresql: "9.5"
-before_install:
-  # work around https://github.com/travis-ci/travis-ci/issues/8363
-  - pyenv global system 3.5
+  postgresql: "10"
 before_script:
   - psql -c 'create database travis_ci_test;' -U postgres
   - psql -c 'create database travis_ci_test2;' -U postgres
@@ -22,12 +17,19 @@ script:
   - tox -e $TOX_ENV
 after_success:
   - coveralls
-env:
-  - TOX_ENV="dj18-py27,dj18-py34,dj18-py35"
-  - TOX_ENV="dj19-py27,dj19-py34,dj19-py35,dj19-py36"
-  - TOX_ENV="dj110-py27,dj110-py34,dj110-py35,dj110-py36"
-  - TOX_ENV="dj111-py27,dj111-py34,dj111-py35,dj111-py36"
-  - TOX_ENV="py27-flake8,py36-flake8"
-  - TOX_ENV="docs"
+
+matrix:
+  include:
+    - python: 2.7
+      env: TOX_ENV="dj111-py27,py27-flake8"
+    - python: 3.4
+      env: TOX_ENV="dj111-py34,dj200-py34"
+    - python: 3.5
+      env: TOX_ENV="dj111-py35,dj200-py35,dj210-py35,dj220-py35"
+    - python: 3.6
+      env: TOX_ENV="dj111-py36,dj200-py36,dj210-py36,dj220-py36"
+    - python: 3.7
+      env: TOX_ENV="dj111-py37,dj200-py37,dj210-py37,dj220-py37,py37-flake8,docs"
+
 # Adding sudo: False tells Travis to use their container-based infrastructure, which is somewhat faster.
 sudo: False

README.rst

@@ -17,7 +17,7 @@ For full docs, see https://cache-machine.readthedocs.org/en/latest/.
 Requirements
 ------------
 
-Cache Machine works with Django 1.8-1.11 and Python 2.7, 3.4, 3.5 and 3.6.
+Cache Machine works with Django 1.11-2.2 and Python 2.7, 3.4, 3.5, 3.6, and 3.7.
 
 
 Installation

caching/__init__.py

@@ -1,4 +1,4 @@
 from __future__ import unicode_literals
 
-VERSION = ('1', '0', '1')
+VERSION = ('1', '1', '0')
 __version__ = '.'.join(VERSION)

caching/base.py

@@ -3,14 +3,15 @@
 import functools
 import logging
 
+import django
 from django.core.cache.backends.base import DEFAULT_TIMEOUT
 from django.db import models
 from django.db.models import signals
-from django.db.models.sql import query, EmptyResultSet
+from django.db.models.sql import EmptyResultSet, query
 from django.utils import encoding
 
 from caching import config
-from caching.invalidation import invalidator, flush_key, make_key, byid, cache
+from caching.invalidation import byid, cache, flush_key, invalidator, make_key
 
 try:
     # ModelIterable is defined in Django 1.9+, and if it's present, we use it
@@ -30,7 +31,8 @@ def __iter__(self):
 
 class CachingManager(models.Manager):
 
-    # Tell Django to use this manager when resolving foreign keys.
+    # This option removed in Django 2.0
+    # Tell Django to use this manager when resolving foreign keys. (Django < 2.0)
     use_for_related_fields = True
 
     def get_queryset(self):
@@ -289,15 +291,25 @@ def _cache_keys(self, incl_db=True):
         """Return the cache key for self plus all related foreign keys."""
         fks = dict((f, getattr(self, f.attname)) for f in self._meta.fields
                    if isinstance(f, models.ForeignKey))
-        keys = [fk.rel.to._cache_key(val, incl_db and self._state.db or None)
-                for fk, val in list(fks.items())
-                if val is not None and hasattr(fk.rel.to, '_cache_key')]
+
+        keys = []
+        for fk, val in list(fks.items()):
+            related_model = self._get_fk_related_model(fk)
+            if val is not None and hasattr(related_model, '_cache_key'):
+                keys.append(related_model._cache_key(val, incl_db and self._state.db or None))
+
         return (self.get_cache_key(incl_db=incl_db),) + tuple(keys)
 
     def _flush_keys(self):
         """Return the flush key for self plus all related foreign keys."""
         return map(flush_key, self._cache_keys(incl_db=False))
 
+    def _get_fk_related_model(self, fk):
+        if django.VERSION[0] >= 2:
+            return fk.remote_field.model
+        else:
+            return fk.rel.to
+
 
 class CachingRawQuerySet(models.query.RawQuerySet):
 
@@ -311,7 +323,10 @@ def __iter__(self):
         if self.timeout == config.NO_CACHE:
             iterator = iterator()
             while True:
-                yield next(iterator)
+                try:
+                    yield next(iterator)
+                except StopIteration:
+                    return
         else:
             for obj in CachingModelIterable(self, iter_function=iterator, timeout=self.timeout):
                 yield obj

caching/ext.py

@@ -2,7 +2,6 @@
 
 from django.conf import settings
 from django.utils import encoding
-
 from jinja2 import nodes
 from jinja2.ext import Extension
 

caching/invalidation.py

@@ -10,7 +10,7 @@
 from django.core.cache import cache as default_cache
 from django.core.cache import caches
 from django.core.cache.backends.base import InvalidCacheBackendError
-from django.utils import encoding, translation, six
+from django.utils import encoding, six, translation
 from django.utils.six.moves.urllib.parse import parse_qsl
 
 from caching import config

docs/index.rst

@@ -76,6 +76,10 @@ Here's what a minimal cached model looks like::
 
         objects = CachingManager()
 
+        # if you use Django 2.0 or later, you must set base_manager_name
+        class Meta:
+            base_manager_name = 'objects'  # Attribute name of CachingManager(), above
+
 Whenever you run a query, ``CachingQuerySet`` will try to find that query in
 the cache.  Queries are keyed by ``{prefix}:{sql}``. If it's there, we return
 the cached result set and everyone is happy.  If the query isn't in the cache,

docs/releases.rst

@@ -3,6 +3,14 @@
 Release Notes
 ==================
 
+v1.1.0 (2019-02-17)
+-------------------
+
+- Drop official support for unsupported Django versions (1.8, 1.9, and 1.10)
+- Add support for Django 2.0, 2.1, and 2.2 (thanks, @JungleKim and @wetneb!)
+- Add support for Python 3.7
+- Fix Travis
+
 v1.0.0 (2017-10-13)
 -------------------
 

examples/cache_machine/custom_backend.py

@@ -1,4 +1,5 @@
-from .settings import *  # flake8: noqa
+# flake8: noqa
+from .settings import *
 
 CACHES = {
     'default': {

examples/cache_machine/django_redis_settings.py

@@ -1,4 +1,5 @@
-from .redis_settings import *  # flake8: noqa
+# flake8: noqa
+from .redis_settings import *
 
 CACHES = {
     'default': {

examples/cache_machine/locmem_settings.py

@@ -1,4 +1,5 @@
-from .settings import *  # flake8: noqa
+# flake8: noqa
+from .settings import *
 
 CACHES = {
     'default': {

examples/cache_machine/memcache_byid.py

@@ -1,3 +1,4 @@
-from .settings import *  # flake8: noqa
+# flake8: noqa
+from .settings import *
 
 FETCH_BY_ID = True

examples/cache_machine/redis_byid.py

@@ -1,3 +1,4 @@
-from .redis_settings import *  # flake8: noqa
+# flake8: noqa
+from .redis_settings import *
 
 FETCH_BY_ID = True

examples/cache_machine/redis_settings.py

@@ -1,4 +1,5 @@
-from .settings import *  # flake8: noqa
+# flake8: noqa
+from .settings import *
 
 CACHE_MACHINE_USE_REDIS = True
 REDIS_BACKEND = 'redis://'

examples/cache_machine/settings.py

@@ -1,5 +1,7 @@
 import os
 
+import django
+
 CACHES = {
     'default': {
         'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
@@ -46,3 +48,6 @@
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 )
+
+if django.VERSION[0] >= 2:
+    MIDDLEWARE = MIDDLEWARE_CLASSES

run_tests.py

@@ -4,9 +4,9 @@
 DJANGO_SETTINGS_MODULE, so I run these commands which get the right env
 automatically.
 """
+import argparse
 import os
 import sys
-import argparse
 from subprocess import call, check_output
 
 NAME = os.path.basename(os.path.dirname(__file__))

setup.py

@@ -2,7 +2,6 @@
 
 import caching
 
-
 setup(
     name='django-cache-machine',
     version=caching.__version__,
@@ -31,6 +30,7 @@
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Topic :: Software Development :: Libraries :: Python Modules',
     ]
 )

tests/testapp/models.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
 
+import django
 from django.db import models
 from django.utils import six
 from caching.base import CachingMixin, CachingManager, cached_method
@@ -19,11 +20,16 @@ class User(CachingMixin, models.Model):
 
     objects = CachingManager()
 
+    if django.VERSION[0] >= 2:
+        class Meta:
+            # Tell Django to use this manager when resolving foreign keys. (Django >= 2.0)
+            base_manager_name = 'objects'
+
 
 class Addon(CachingMixin, models.Model):
     val = models.IntegerField()
-    author1 = models.ForeignKey(User)
-    author2 = models.ForeignKey(User, related_name='author2_set')
+    author1 = models.ForeignKey(User, on_delete=models.CASCADE)
+    author2 = models.ForeignKey(User, related_name='author2_set', on_delete=models.CASCADE)
 
     objects = CachingManager()
 

tox.ini

@@ -5,9 +5,11 @@
 
 [tox]
 envlist =
-    dj{18}-py{27,34,35}
-    dj{19,110,111}-py{27,34,35,36}
-    py{27,36}-flake8
+    dj{111}-py{27,34,35,36,37}
+    dj{200}-py{34,35,36,37}
+    dj{210}-py{35,36,37}
+    dj{220}-py{35,36,37}
+    py{27,37}-flake8
     docs
 
 [testenv]
@@ -16,17 +18,18 @@ basepython =
     py34: python3.4
     py35: python3.5
     py36: python3.6
+    py37: python3.7
 commands = {envpython} run_tests.py --with-coverage
 deps =
-    py{26,27}: -rrequirements/py2.txt
-    py{34,35,36}: -rrequirements/py3.txt
-    dj18: Django>=1.8,<1.9
-    dj19: Django>=1.9,<1.10
-    dj110: Django>=1.10,<1.11
+    py27: -rrequirements/py2.txt
+    py{34,35,36,37}: -rrequirements/py3.txt
     dj111: Django>=1.11,<2.0
+    dj200: Django>=2.0,<2.1
+    dj210: Django>=2.1,<2.2
+    dj220: Django==2.2b1
 
 [testenv:docs]
-basepython = python3.6
+basepython = python3.7
 deps =
     Sphinx
     Django
@@ -40,6 +43,6 @@ commands = /usr/bin/make html
 deps = flake8
 commands = flake8
 
-[testenv:py36-flake8]
+[testenv:py37-flake8]
 deps = flake8
 commands = flake8