drop support for python 3.6 (#1009)

Author: jpinner-lyft

.github/workflows/test.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', 'pypy-3.6']
+        python-version: ['3.7', '3.8', '3.9', '3.10', 'pypy-3.8']
 
     steps:
     - uses: actions/checkout@v2

MANIFEST.in

@@ -1,4 +1,3 @@
 include LICENSE
 include mypy.ini
 include requirements-*.txt
-include tox.ini

README.rst

@@ -183,7 +183,7 @@ the type of data you'd like to stream.
 Features
 ========
 
-* Python >= 3.6 support
+* Python >= 3.7 support
 * An ORM-like interface with query and scan filters
 * Compatible with DynamoDB Local
 * Supports the entire DynamoDB API

docs/release_notes.rst

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+Unreleased
+----------
+* Python 3.6 is no longer supported.
+
+
 v5.2.0
 ----------
 * The ``IndexMeta`` class has been removed. Now ``type(Index) == type`` (#998)

examples/attributes.py

@@ -53,7 +53,7 @@ class Meta:
 
 
 instance = CustomAttributeModel()
-instance.obj = Color('red')
+instance.obj = Color('red')  # type: ignore
 instance.id = 'red'
 instance.save()
 

examples/indexes.py

@@ -41,13 +41,13 @@ class Meta:
     TestModel.create_table(read_capacity_units=1, write_capacity_units=1, wait=True)
 
 # Create an item
-item = TestModel('forum-example', 'thread-example')
-item.view = 1
-item.save()
+test_item = TestModel('forum-example', 'thread-example')
+test_item.view = 1
+test_item.save()
 
 # Indexes can be queried easily using the index's hash key
-for item in TestModel.view_index.query(1):
-    print("Item queried from index: {0}".format(item))
+for test_item in TestModel.view_index.query(1):
+    print("Item queried from index: {0}".format(test_item))
 
 
 class GamePlayerOpponentIndex(LocalSecondaryIndex):

examples/model.py

@@ -6,7 +6,7 @@
 import logging
 from pynamodb.models import Model
 from pynamodb.attributes import (
-    UnicodeAttribute, NumberAttribute, UnicodeSetAttribute, UTCDateTimeAttribute
+    ListAttribute, UnicodeAttribute, NumberAttribute, UnicodeSetAttribute, UTCDateTimeAttribute
 )
 from datetime import datetime
 
@@ -29,7 +29,7 @@ class Meta:
     answered = NumberAttribute(default=0)
     tags = UnicodeSetAttribute()
     last_post_datetime = UTCDateTimeAttribute(null=True)
-    notes = ListAttribute(default=list)
+    notes = ListAttribute(default=list)  # type: ignore  # todo: add ability for basic list types
 
 
 # Delete the table
@@ -60,7 +60,7 @@ class Meta:
     threads = []
     for x in range(100):
         thread = Thread('forum-{0}'.format(x), 'subject-{0}'.format(x))
-        thread.tags = ['tag1', 'tag2']
+        thread.tags = {'tag1', 'tag2'}
         thread.last_post_datetime = datetime.now()
         threads.append(thread)
 
@@ -106,41 +106,41 @@ class Meta:
 if not AliasedModel.exists():
     AliasedModel.create_table(read_capacity_units=1, write_capacity_units=1, wait=True)
 
-# Create a thread
-thread_item = AliasedModel(
+# Create an aliased model
+aliased_item = AliasedModel(
     'Some Forum',
     'Some Subject',
     tags=['foo', 'bar'],
     last_post_datetime=datetime.now()
 )
 
-# Save the thread
-thread_item.save()
+# Save the aliased model
+aliased_item.save()
 
 # Batch write operation
 with AliasedModel.batch_write() as batch:
-    threads = []
+    aliased_items = []
     for x in range(100):
-        thread = AliasedModel('forum-{0}'.format(x), 'subject-{0}'.format(x))
-        thread.tags = ['tag1', 'tag2']
-        thread.last_post_datetime = datetime.now()
-        threads.append(thread)
+        aliased_item = AliasedModel('forum-{0}'.format(x), 'subject-{0}'.format(x))
+        aliased_item.tags = {'tag1', 'tag2'}
+        aliased_item.last_post_datetime = datetime.now()
+        aliased_items.append(aliased_item)
 
-    for thread in threads:
-        batch.save(thread)
+    for aliased_item in aliased_items:
+        batch.save(aliased_item)
 
 # Batch get
 item_keys = [('forum-{0}'.format(x), 'subject-{0}'.format(x)) for x in range(100)]
-for item in AliasedModel.batch_get(item_keys):
-    print("Batch get item: {0}".format(item))
+for aliased_item in AliasedModel.batch_get(item_keys):
+    print("Batch get item: {0}".format(aliased_item))
 
 # Scan
-for item in AliasedModel.scan():
-    print("Scanned item: {0}".format(item))
+for aliased_item in AliasedModel.scan():
+    print("Scanned item: {0}".format(aliased_item))
 
 # Query
-for item in AliasedModel.query('forum-1', AliasedModel.subject.startswith('subject')):
-    print("Query using aliased attribute: {0}".format(item))
+for aliased_item in AliasedModel.query('forum-1', AliasedModel.subject.startswith('subject')):
+    print("Query using aliased attribute: {0}".format(aliased_item))
 
 # Query with filters
 for item in Thread.query('forum-1', (Thread.views == 0) | (Thread.replies == 0)):

examples/optimistic_locking.py

@@ -46,6 +46,7 @@ def assert_condition_check_fails():
     except TransactWriteError as e:
         assert isinstance(e.cause, ClientError)
         assert e.cause_response_code == "TransactionCanceledException"
+        assert e.cause_response_message is not None
         assert "ConditionalCheckFailed" in e.cause_response_message
     else:
         raise AssertionError("The version attribute conditional check should have failed.")

mypy.ini

@@ -10,6 +10,10 @@ warn_incomplete_stub = True
 follow_imports = normal
 show_error_codes = True
 
+# Ignore errors in the docs/conf.py file
+[mypy-conf]
+ignore_errors = True
+
 # TODO: burn these down
 [mypy-tests.*]
 ignore_errors = True

pynamodb/_compat.py

@@ -16,7 +16,6 @@
 from typing import Any, Callable, Dict, Generic, List, Mapping, Optional, TypeVar, Type, Union, Set, overload, Iterable
 from typing import TYPE_CHECKING
 
-from pynamodb._compat import GenericMeta
 from pynamodb.constants import BINARY
 from pynamodb.constants import BINARY_SET
 from pynamodb.constants import BOOLEAN
@@ -229,7 +228,7 @@ def delete(self, *values: Any) -> 'DeleteAction':
         return Path(self).delete(*values)
 
 
-class AttributeContainerMeta(GenericMeta):
+class AttributeContainerMeta(type):
 
     def __new__(cls, name, bases, namespace, discriminator=None):
         # Defined so that the discriminator can be set in the class definition.

pynamodb/attributes.py

@@ -30,7 +30,7 @@ class Index(Generic[_M]):
 
     @classmethod
     def __init_subclass__(cls, **kwargs):
-        super().__init_subclass__(**kwargs)  # type: ignore  # see https://github.com/python/mypy/issues/4660
+        super().__init_subclass__(**kwargs)
         if cls.Meta is not None:
             cls.Meta.attributes = {}
             for name, attribute in getmembers(cls, lambda o: isinstance(o, Attribute)):

pynamodb/indexes.py

@@ -24,7 +24,7 @@
 def _load_module(name, path):
     # https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
     spec = importlib.util.spec_from_file_location(name, path)
-    module = importlib.util.module_from_spec(spec)
+    module = importlib.util.module_from_spec(spec)  # type: ignore
     spec.loader.exec_module(module)  # type: ignore
     return module
 

pynamodb/settings.py

@@ -4,5 +4,5 @@ pytest-mock
 
 # only used in CI
 coveralls
-mypy==0.770;python_version>="3.7"
+mypy==0.930
 pytest-cov

requirements-dev.txt

@@ -9,7 +9,7 @@
 setup(
     name='pynamodb',
     version=__import__('pynamodb').__version__,
-    packages=find_packages(exclude=('tests', 'tests.integration',)),
+    packages=find_packages(exclude=('examples', 'tests', 'tests.integration',)),
     url='http://jlafon.io/pynamodb.html',
     author='Jharrod LaFon',
     author_email='[email protected]',
@@ -18,16 +18,17 @@
     zip_safe=False,
     license='MIT',
     keywords='python dynamodb amazon',
-    python_requires=">=3.6",
+    python_requires=">=3.7",
     install_requires=install_requires,
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Programming Language :: Python',
         'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'License :: OSI Approved :: MIT License',
     ],
     extras_require={

setup.py

@@ -3,7 +3,6 @@
 
 @pytest.fixture
 def assert_mypy_output(pytestconfig):
-    pytest.importorskip('mypy')  # we only install mypy in python>=3.6 tests
     pytest.register_assert_rewrite('tests.mypy_helpers')
 
     from tests.mypy_helpers import assert_mypy_output

tests/conftest.py

@@ -2,6 +2,11 @@
 Note: The expected error strings may change in a future version of mypy.
       Please update as needed.
 """
+import platform
+import pytest
+
+
+pytestmark = pytest.mark.skipif(platform.python_implementation() != "CPython", reason="tests take > 5 minutes to run on pypy")
 
 
 def test_model(assert_mypy_output):
@@ -12,7 +17,7 @@ def test_model(assert_mypy_output):
     class MyModel(Model):
         pass
 
-    reveal_type(MyModel.count('hash', Path('a').between(1, 3)))  # N: Revealed type is 'builtins.int'
+    reveal_type(MyModel.count('hash', Path('a').between(1, 3)))  # N: Revealed type is "builtins.int"
     """)
 
 
@@ -42,9 +47,9 @@ class MyModel(Model):
 
     result_iterator = MyModel.query(123)
     for model in result_iterator:
-        reveal_type(model)  # N: Revealed type is '__main__.MyModel*'
+        reveal_type(model)  # N: Revealed type is "__main__.MyModel*"
     if result_iterator.last_evaluated_key:
-        reveal_type(result_iterator.last_evaluated_key['my_attr'])  # N: Revealed type is 'builtins.dict*[builtins.str, Any]'
+        reveal_type(result_iterator.last_evaluated_key['my_attr'])  # N: Revealed type is "builtins.dict*[builtins.str, Any]"
     """)
 
 
@@ -76,8 +81,8 @@ def test_number_attribute(assert_mypy_output):
     class MyModel(Model):
         my_attr = NumberAttribute()
 
-    reveal_type(MyModel.my_attr)  # N: Revealed type is 'pynamodb.attributes.NumberAttribute'
-    reveal_type(MyModel().my_attr)  # N: Revealed type is 'builtins.float*'
+    reveal_type(MyModel.my_attr)  # N: Revealed type is "pynamodb.attributes.NumberAttribute"
+    reveal_type(MyModel().my_attr)  # N: Revealed type is "builtins.float*"
     """)
 
 
@@ -89,8 +94,8 @@ def test_unicode_attribute(assert_mypy_output):
     class MyModel(Model):
         my_attr = UnicodeAttribute()
 
-    reveal_type(MyModel.my_attr)  # N: Revealed type is 'pynamodb.attributes.UnicodeAttribute'
-    reveal_type(MyModel().my_attr)  # N: Revealed type is 'builtins.str*'
+    reveal_type(MyModel.my_attr)  # N: Revealed type is "pynamodb.attributes.UnicodeAttribute"
+    reveal_type(MyModel().my_attr)  # N: Revealed type is "builtins.str*"
     """)
 
 
@@ -108,18 +113,18 @@ class MyMap(MapAttribute):
     class MyModel(Model):
         m1 = MyMap()
 
-    reveal_type(MyModel.m1)  # N: Revealed type is '__main__.MyMap'
-    reveal_type(MyModel().m1)  # N: Revealed type is '__main__.MyMap'
-    reveal_type(MyModel.m1.m2)  # N: Revealed type is '__main__.MySubMap'
-    reveal_type(MyModel().m1.m2)  # N: Revealed type is '__main__.MySubMap'
-    reveal_type(MyModel.m1.m2.s)  # N: Revealed type is 'builtins.str*'
-    reveal_type(MyModel().m1.m2.s)  # N: Revealed type is 'builtins.str*'
+    reveal_type(MyModel.m1)  # N: Revealed type is "__main__.MyMap"
+    reveal_type(MyModel().m1)  # N: Revealed type is "__main__.MyMap"
+    reveal_type(MyModel.m1.m2)  # N: Revealed type is "__main__.MySubMap"
+    reveal_type(MyModel().m1.m2)  # N: Revealed type is "__main__.MySubMap"
+    reveal_type(MyModel.m1.m2.s)  # N: Revealed type is "builtins.str*"
+    reveal_type(MyModel().m1.m2.s)  # N: Revealed type is "builtins.str*"
 
-    reveal_type(MyMap.m2)  # N: Revealed type is '__main__.MySubMap'
-    reveal_type(MyMap().m2)  # N: Revealed type is '__main__.MySubMap'
+    reveal_type(MyMap.m2)  # N: Revealed type is "__main__.MySubMap"
+    reveal_type(MyMap().m2)  # N: Revealed type is "__main__.MySubMap"
 
-    reveal_type(MySubMap.s)  # N: Revealed type is 'pynamodb.attributes.UnicodeAttribute'
-    reveal_type(MySubMap().s)  # N: Revealed type is 'builtins.str*'
+    reveal_type(MySubMap.s)  # N: Revealed type is "pynamodb.attributes.UnicodeAttribute"
+    reveal_type(MySubMap().s)  # N: Revealed type is "builtins.str*"
     """)
 
 
@@ -133,14 +138,14 @@ class MyMap(MapAttribute):
 
     class MyModel(Model):
         my_list = ListAttribute(of=MyMap)
-        my_untyped_list = ListAttribute()  # E: Need type annotation for 'my_untyped_list'  [var-annotated]
+        my_untyped_list = ListAttribute()  # E: Need type annotation for "my_untyped_list"  [var-annotated]
 
-    reveal_type(MyModel.my_list)  # N: Revealed type is 'pynamodb.attributes.ListAttribute[__main__.MyMap]'
-    reveal_type(MyModel().my_list)  # N: Revealed type is 'builtins.list*[__main__.MyMap*]'
-    reveal_type(MyModel().my_list[0].my_sub_attr)  # N: Revealed type is 'builtins.str*'
+    reveal_type(MyModel.my_list)  # N: Revealed type is "pynamodb.attributes.ListAttribute[__main__.MyMap]"
+    reveal_type(MyModel().my_list)  # N: Revealed type is "builtins.list*[__main__.MyMap*]"
+    reveal_type(MyModel().my_list[0].my_sub_attr)  # N: Revealed type is "builtins.str*"
 
     # Untyped lists are not well supported yet
-    reveal_type(MyModel().my_untyped_list[0].my_sub_attr)  # N: Revealed type is 'Any'
+    reveal_type(MyModel().my_untyped_list[0].my_sub_attr)  # N: Revealed type is "Any"
     """)
 
 
@@ -156,11 +161,11 @@ class MyModel(Model):
         my_list = ListAttribute(of=MyMap)
         my_map = MyMap()
 
-    reveal_type(MyModel.my_list[0])  # N: Revealed type is 'pynamodb.expressions.operand.Path'
-    reveal_type(MyModel.my_list[0] == MyModel())  # N: Revealed type is 'pynamodb.expressions.condition.Comparison'
+    reveal_type(MyModel.my_list[0])  # N: Revealed type is "pynamodb.expressions.operand.Path"
+    reveal_type(MyModel.my_list[0] == MyModel())  # N: Revealed type is "pynamodb.expressions.condition.Comparison"
     # the following string indexing is not type checked - not by mypy nor in runtime
-    reveal_type(MyModel.my_list[0]['my_sub_attr'] == 'foobar')  # N: Revealed type is 'pynamodb.expressions.condition.Comparison'
-    reveal_type(MyModel.my_map == 'foobar')  # N: Revealed type is 'pynamodb.expressions.condition.Comparison'
+    reveal_type(MyModel.my_list[0]['my_sub_attr'] == 'foobar')  # N: Revealed type is "pynamodb.expressions.condition.Comparison"
+    reveal_type(MyModel.my_map == 'foobar')  # N: Revealed type is "pynamodb.expressions.condition.Comparison"
     """)
 
 
@@ -247,5 +252,5 @@ def test_transactions(assert_mypy_output):
     assert_mypy_output("""
     from pynamodb.transactions import TransactWrite
     with TransactWrite() as tx:
-        reveal_type(tx)  # N: Revealed type is 'pynamodb.transactions.TransactWrite*'
+        reveal_type(tx)  # N: Revealed type is "pynamodb.transactions.TransactWrite*"
     """)