Refs #351, make none_as_none default and prepare 0.8 release

Author: fantix

AUTHORS.rst

@@ -28,6 +28,7 @@ Contributors
 * Denys Badzo <[email protected]>
 * Pavol Vargovcik <[email protected]>
 * Mykyta Holubakha <[email protected]>
+* Jekel <[email protected]>
 
 
 Special thanks to my wife Daisy and her outsourcing company `DecentFoX Studio`_,

HISTORY.rst

@@ -2,6 +2,61 @@
 History
 =======
 
+GINO 0.8
+--------
+
+This is also version 1.0 release candidate.
+
+Migrating to GINO 0.8
+^^^^^^^^^^^^^^^^^^^^^
+
+1. contextvars
+""""""""""""""
+
+We introduced aiocontextvars_ 0.2.0 which is revamped to be compatible with
+PEP-567 without manual interference by a few simple implicit patches. To
+upgrade to GINO 0.8, please remove the ``enable_inherit()`` or
+``disable_inherit()`` calls, because they are the default behavior now thus
+no longer exist. However, you'll need to confirm that the event loop in use is
+always created **after** importing ``gino`` or ``aiocontextvars``, or the patch
+won't work correctly.
+
+There is nothing to worry about in Python 3.7.
+
+2. none_as_none
+"""""""""""""""
+
+When GINO tries to load a row with all ``NULL`` values into an instance, it
+will now by default return ``None`` instead of an instance with all ``None``
+attributes. To recover the default behavior of 0.7, please specify
+``none_as_none(False)`` in affected model loader.
+
+This is especially applicable to relationship sub-loaders - if the sub-loader
+found it all ``NULL``, no instance will be set to parent instance. For
+example::
+
+    child = await Child.load(parent=Parent).query.gino.first()
+
+If ``child.parent_id`` is ``NULL`` in database, then the ``child`` instance
+won't be called with any ``setattr(child, 'parent', ...)`` at all. (If you need
+``child.parent == None`` in this case, consider setting default value
+``parent = None`` in child model.)
+
+Please note, it is deprecated to disable ``none_as_none``, and disabling will
+be removed in GINO 1.0.
+
+0.8.0 (2018-00-00)
+^^^^^^^^^^^^^^^^^^
+
+* Welcome Tony Wang to the maintenance team (#335)
+* Allowed custom column names (#261 #297)
+* Allowed column instance in ``model.load()`` (Contributed by Jekel in #323)
+* [Breaking] Upgraded to aiocontextvars 0.2.0 (#333)
+* Fixed bug that the same empty stack is shared between sub-tasks (#313 #334)
+* [Breaking] Made ``none_as_none()`` the default behavior (#351)
+* Bug fixes and docs update
+
+
 GINO 0.7
 --------
 

gino/loader.py

@@ -76,15 +76,11 @@ def __init__(self, model, *columns, **extras):
         self.extras = dict((key, self.get(value))
                            for key, value in extras.items())
         self.on_clause = None
-        self._none_as_none = None
+        self._none_as_none = True
 
     def _do_load(self, row, *, none_as_none=None):
         if none_as_none is None:
             none_as_none = self._none_as_none
-        if none_as_none is None:
-            warnings.warn(
-                'The none_as_none feature will be enabled by default in 0.8',
-                DeprecationWarning)
         values = dict((c.name, row[c]) for c in self.columns if c in row)
         if none_as_none and all((v is None) for v in values.values()):
             return None
@@ -154,7 +150,7 @@ def distinct(self, *columns):
     def none_as_none(self, enabled=True):
         if not enabled:
             warnings.warn(
-                'The none_as_none feature will be always enabled in 0.9',
+                'The none_as_none feature will be always enabled in 1.0',
                 PendingDeprecationWarning)
         self._none_as_none = enabled
         return self

tests/test_loader.py

@@ -235,11 +235,21 @@ async def test_distinct_none(bind):
     u = await User.create()
 
     query = User.outerjoin(Team).select().where(User.id == u.id)
-    loader = User.load(team=Team)
+    loader = User.load(team=Team.none_as_none(False))
 
+    # TODO: this should fail in 1.0, please remove by then
     u = await query.gino.load(loader).first()
     assert u.team.id is None
 
+    query = User.outerjoin(Team).select().where(User.id == u.id)
+    loader = User.load(team=Team)
+
+    u = await query.gino.load(loader).first()
+    assert not hasattr(u, 'team')
+
+    u = await User.load(team=Team).query.where(User.id == u.id).gino.first()
+    assert not hasattr(u, 'team')
+
     query = User.outerjoin(Team).select().where(User.id == u.id)
     loader = User.load(team=Team.distinct(Team.id))