refactored to improve code completion

Author: dantownsend

docs/src/piccolo/design-decisions.rst

@@ -24,7 +24,7 @@ At any time you can access the __str__ method of a query, to see the underlying
 
 .. code-block:: python
 
-    query = Band.select.columns(Band.name).where(Band.popularity >= 100)
+    query = Band.select().columns(Band.name).where(Band.popularity >= 100)
 
     print(query)
     'SELECT name from band where popularity > 100'

docs/src/piccolo/transactions.rst

@@ -12,6 +12,6 @@ Usage
 .. code-block:: python
 
     transaction = Band.Meta.db.transaction()
-    transaction.add(Manager.create)
-    transaction.add(Concert.create)
+    transaction.add(Manager.create())
+    transaction.add(Concert.create())
     await transaction.run()

piccolo/columns/column_types.py

@@ -92,7 +92,7 @@ class ForeignKey(Integer):
 
     Can also use it to perform joins:
 
-        Band.select.columns(Band.manager.name)
+        Band.select().columns(Band.manager.name)
 
     To get a referenced row as an object:
 

piccolo/commands/playground.py

@@ -56,13 +56,13 @@ def populate():
     """
     for _table in reversed(TABLES):
         try:
-            _table.drop.run_sync()
+            _table.drop().run_sync()
         except Exception as e:
             print(e)
 
     for _table in TABLES:
         try:
-            _table.create.run_sync()
+            _table.create().run_sync()
         except Exception as e:
             print(e)
 

piccolo/engine/postgres.py

@@ -16,7 +16,7 @@ class Transaction():
     Usage:
 
     transaction = engine.Transaction()
-    transaction.add(Foo.create)
+    transaction.add(Foo.create())
     transaction.run_sync()
     """
 

piccolo/extensions/user.py

@@ -22,7 +22,7 @@ class BaseUser(Table):
     class Meta():
         # This is required because 'user' is a reserved keyword in SQL, so
         # using it as a tablename causes issues.
-        tablename = 'a_user'
+        tablename = 'piccolo_user'
 
     def __init__(self, **kwargs):
         """
@@ -70,10 +70,11 @@ async def login(cls, username: str, password: str) -> t.Optional[int]:
         """
         Returns the user_id if a match is found.
         """
+        query = cls.select().columns(cls.id, cls.password).where(
+            (cls.username == username)
+        ).first()
         try:
-            response = await cls.select.columns(cls.id, cls.password).where(
-                (cls.username == username)
-            ).first.run()
+            response = await query.run()
         except ValueError:
             # No match found
             return None

piccolo/main.py

@@ -62,8 +62,8 @@ def _create_migration_table() -> bool:
     Creates the migration table in the database. Returns True/False depending
     on whether it was created or not.
     """
-    if not Migration.table_exists.run_sync():
-        Migration.create.run_sync()
+    if not Migration.table_exists().run_sync():
+        Migration.create().run_sync()
         return True
     return False
 
@@ -74,7 +74,7 @@ def _get_migrations_which_ran() -> t.List[str]:
     database.
     """
     return [
-        i['name'] for i in Migration.select.columns(Migration.name).run_sync()
+        i['name'] for i in Migration.select().columns(Migration.name).run_sync()
     ]
 
 
@@ -195,7 +195,7 @@ def backwards(migration_name: str):
                 MIGRATION_MODULES[s].backwards()  # type: ignore
             )
 
-            Migration.delete.where(
+            Migration.delete().where(
                 Migration.name == s
             ).run_sync()
     else:

piccolo/query/base.py

@@ -22,8 +22,12 @@ def __init__(
     ) -> None:
         self.base = base
         self.table = table
+        self.setup_delegates()
         super().__init__()
 
+    def setup_delegates(self):
+        pass
+
     @property
     def engine_type(self) -> str:
         return self.table.Meta.db.engine_type
@@ -55,18 +59,18 @@ async def run(self, as_dict=True, in_pool=False):
         # Might try and merge them.
         raw = self.response_handler(raw)
 
-        output = getattr(self, '_output', None)
+        output = getattr(self, 'output_delegate', None)
 
         if output:
-            if output.as_objects:
+            if output._output.as_objects:
                 # When using .first() we get a single row, not a list
                 # of rows.
                 if type(raw) is list:
                     raw = [self.table(**columns) for columns in raw]
                 else:
                     raw = self.table(**raw)
             elif type(raw) is list:
-                if output.as_list:
+                if output._output.as_list:
                     if len(raw[0].keys()) != 1:
                         raise ValueError(
                             'Each row returned more than one value'
@@ -75,7 +79,7 @@ async def run(self, as_dict=True, in_pool=False):
                         raw = list(
                             itertools.chain(*[j.values() for j in raw])
                         )
-                if output.as_json:
+                if output._output.as_json:
                     raw = json.dumps(raw)
 
         return raw

piccolo/query/methods/alter.py

@@ -10,7 +10,7 @@
 @dataclasses.dataclass
 class Rename():
     """
-    Band.alter.rename(Band.popularity, ‘rating’)
+    Band.alter().rename(Band.popularity, ‘rating’)
     """
     column: Column
     new_name: str
@@ -28,7 +28,7 @@ def __str__(self) -> str:
 @dataclasses.dataclass
 class Drop():
     """
-    Band.alter.drop('popularity')
+    Band.alter().drop('popularity')
     """
     column: Column
 
@@ -45,7 +45,7 @@ def __str__(self) -> str:
 @dataclasses.dataclass
 class Add():
     """
-    Band.alter.add(‘members’, Integer())
+    Band.alter().add(‘members’, Integer())
     """
     name: str
     column: Column

piccolo/query/methods/delete.py

@@ -1,26 +1,34 @@
 from __future__ import annotations
 
+from piccolo.custom_types import Combinable
 from piccolo.query.base import Query
-from piccolo.query.mixins import WhereMixin
+from piccolo.query.mixins import WhereDelegate
 from piccolo.querystring import QueryString
 
 
-class Delete(Query, WhereMixin):
+class Delete(Query):
+
+    def setup_delegates(self):
+        self.where_delegate = WhereDelegate()
+
+    def where(self, where: Combinable) -> Delete:
+        self.where_delegate.where(where)
+        return self
 
     @property
     def querystring(self) -> QueryString:
         query = f'DELETE FROM {self.table.Meta.tablename}'
-        if self._where:
+        if self.where_delegate._where:
             query += ' WHERE {}'
             return QueryString(
                 query,
-                self._where.querystring
+                self.where_delegate._where.querystring
             )
         else:
             return QueryString(query)
 
     def __str__(self) -> str:
         query = f'DELETE FROM {self.table.Meta.tablename}'
-        if self._where:
-            query += f' WHERE {self._where.__str__()}'
+        if self.where_delegate._where:
+            query += f' WHERE {self.where_delegate._where.__str__()}'
         return query