piccolo 1.26.1__tar.gz → 1.27.0__tar.gz

{piccolo-1.26.1 → piccolo-1.27.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: piccolo
-Version: 1.26.1
+Version: 1.27.0
 Summary: A fast, user friendly ORM and query builder which supports asyncio.
 Home-page: https://github.com/piccolo-orm/piccolo
 Author: Daniel Townsend

piccolo-1.27.0/piccolo/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = "1.27.0"

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/apps/migrations/auto/serialisation.py

@@ -61,7 +61,7 @@ class UniqueGlobalNamesMeta(type):
 
     @staticmethod
     def get_unique_class_attribute_values(
-        class_attributes: t.Dict[str, t.Any]
+        class_attributes: t.Dict[str, t.Any],
     ) -> t.Set[t.Any]:
         """
         Return class attribute values.

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/apps/user/piccolo_migrations/2019-11-14T21-52-21.py

@@ -15,8 +15,7 @@ async def forwards():
             "length": 100,
             "default": "",
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": True,
             "index": False,
         },
@@ -30,8 +29,7 @@ async def forwards():
             "length": 255,
             "default": "",
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },
@@ -45,8 +43,7 @@ async def forwards():
             "length": 255,
             "default": "",
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": True,
             "index": False,
         },
@@ -59,8 +56,7 @@ async def forwards():
         params={
             "default": False,
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },
@@ -73,8 +69,7 @@ async def forwards():
         params={
             "default": False,
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/apps/user/piccolo_migrations/2020-06-11T21-38-55.py

@@ -15,8 +15,7 @@ async def forwards():
             "length": 255,
             "default": "",
             "null": True,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },
@@ -31,8 +30,7 @@ async def forwards():
             "length": 255,
             "default": "",
             "null": True,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/apps/user/piccolo_migrations/2021-04-30T16-14-15.py

@@ -18,8 +18,7 @@ async def forwards():
         params={
             "default": False,
             "null": False,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
             "index_method": IndexMethod.btree,
@@ -35,8 +34,7 @@ async def forwards():
         params={
             "default": None,
             "null": True,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
             "index_method": IndexMethod.btree,

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/columns/base.py

@@ -350,6 +350,20 @@ class ColumnMeta:
         return self.copy()
 
 
+class ColumnKwargs(t.TypedDict, total=False):
+    null: bool
+    primary_key: bool
+    unique: bool
+    index: bool
+    index_method: IndexMethod
+    required: bool
+    help_text: str
+    choices: t.Type[Enum]
+    db_column_name: str
+    secret: bool
+    auto_update: t.Any
+
+
 class Column(Selectable):
     """
     All other columns inherit from ``Column``. Don't use it directly.
@@ -467,10 +481,9 @@ class Column(Selectable):
         auto_update: t.Any = ...,
         **kwargs,
     ) -> None:
-        # This is for backwards compatibility - originally there were two
-        # separate arguments `primary` and `key`, but they have now been merged
-        # into `primary_key`.
-        if (kwargs.get("primary") is True) and (kwargs.get("key") is True):
+        # This is for backwards compatibility - originally the `primary_key`
+        # argument was called `primary`.
+        if kwargs.get("primary") is True:
             primary_key = True
 
         # Used for migrations.

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo/columns/column_types.py

@@ -35,8 +35,11 @@ from dataclasses import dataclass
 from datetime import date, datetime, time, timedelta
 from enum import Enum
 
+from typing_extensions import Unpack
+
 from piccolo.columns.base import (
     Column,
+    ColumnKwargs,
     ForeignKeyMeta,
     OnDelete,
     OnUpdate,
@@ -317,14 +320,13 @@ class Varchar(Column):
         self,
         length: t.Optional[int] = 255,
         default: t.Union[str, Enum, t.Callable[[], str], None] = "",
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (str, None))
 
         self.length = length
         self.default = default
-        kwargs.update({"length": length, "default": default})
-        super().__init__(**kwargs)
+        super().__init__(length=length, default=default, **kwargs)
 
     @property
     def column_type(self):
@@ -426,12 +428,11 @@ class Text(Column):
     def __init__(
         self,
         default: t.Union[str, Enum, None, t.Callable[[], str]] = "",
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (str, None))
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -490,7 +491,11 @@ class UUID(Column):
 
     value_type = uuid.UUID
 
-    def __init__(self, default: UUIDArg = UUID4(), **kwargs) -> None:
+    def __init__(
+        self,
+        default: UUIDArg = UUID4(),
+        **kwargs: Unpack[ColumnKwargs],
+    ) -> None:
         if default is UUID4:
             # In case the class is passed in, instead of an instance.
             default = UUID4()
@@ -509,8 +514,7 @@ class UUID(Column):
                 ) from e
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # Descriptors
@@ -553,12 +557,11 @@ class Integer(Column):
     def __init__(
         self,
         default: t.Union[int, Enum, t.Callable[[], int], None] = 0,
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (int, None))
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -833,7 +836,10 @@ class BigSerial(Serial):
 
 
 class PrimaryKey(Serial):
-    def __init__(self, **kwargs) -> None:
+    def __init__(
+        self,
+        **kwargs: Unpack[ColumnKwargs],
+    ) -> None:
         # Set the index to False, as a database should automatically create
         # an index for a PrimaryKey column.
         kwargs.update({"primary_key": True, "index": False})
@@ -896,7 +902,9 @@ class Timestamp(Column):
     timedelta_delegate = TimedeltaDelegate()
 
     def __init__(
-        self, default: TimestampArg = TimestampNow(), **kwargs
+        self,
+        default: TimestampArg = TimestampNow(),
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, TimestampArg.__args__)  # type: ignore
 
@@ -912,8 +920,7 @@ class Timestamp(Column):
             default = TimestampNow()
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -994,7 +1001,9 @@ class Timestamptz(Column):
     timedelta_delegate = TimedeltaDelegate()
 
     def __init__(
-        self, default: TimestamptzArg = TimestamptzNow(), **kwargs
+        self,
+        default: TimestamptzArg = TimestamptzNow(),
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(
             default, TimestamptzArg.__args__  # type: ignore
@@ -1007,8 +1016,7 @@ class Timestamptz(Column):
             default = TimestamptzNow()
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -1075,7 +1083,11 @@ class Date(Column):
     value_type = date
     timedelta_delegate = TimedeltaDelegate()
 
-    def __init__(self, default: DateArg = DateNow(), **kwargs) -> None:
+    def __init__(
+        self,
+        default: DateArg = DateNow(),
+        **kwargs: Unpack[ColumnKwargs],
+    ) -> None:
         self._validate_default(default, DateArg.__args__)  # type: ignore
 
         if isinstance(default, date):
@@ -1085,8 +1097,7 @@ class Date(Column):
             default = DateNow()
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -1153,15 +1164,18 @@ class Time(Column):
     value_type = time
     timedelta_delegate = TimedeltaDelegate()
 
-    def __init__(self, default: TimeArg = TimeNow(), **kwargs) -> None:
+    def __init__(
+        self,
+        default: TimeArg = TimeNow(),
+        **kwargs: Unpack[ColumnKwargs],
+    ) -> None:
         self._validate_default(default, TimeArg.__args__)  # type: ignore
 
         if isinstance(default, time):
             default = TimeCustom.from_time(default)
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # For update queries
@@ -1229,7 +1243,9 @@ class Interval(Column):
     timedelta_delegate = TimedeltaDelegate()
 
     def __init__(
-        self, default: IntervalArg = IntervalCustom(), **kwargs
+        self,
+        default: IntervalArg = IntervalCustom(),
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, IntervalArg.__args__)  # type: ignore
 
@@ -1237,8 +1253,7 @@ class Interval(Column):
             default = IntervalCustom.from_timedelta(default)
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     @property
     def column_type(self):
@@ -1319,12 +1334,11 @@ class Boolean(Column):
     def __init__(
         self,
         default: t.Union[bool, Enum, t.Callable[[], bool], None] = False,
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (bool, None))
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     def eq(self, value) -> Where:
         """
@@ -1448,7 +1462,7 @@ class Numeric(Column):
         default: t.Union[
             decimal.Decimal, Enum, t.Callable[[], decimal.Decimal], None
         ] = decimal.Decimal(0.0),
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         if isinstance(digits, tuple):
             if len(digits) != 2:
@@ -1464,8 +1478,7 @@ class Numeric(Column):
 
         self.default = default
         self.digits = digits
-        kwargs.update({"default": default, "digits": digits})
-        super().__init__(**kwargs)
+        super().__init__(default=default, digits=digits, **kwargs)
 
     ###########################################################################
     # Descriptors
@@ -1530,12 +1543,11 @@ class Real(Column):
     def __init__(
         self,
         default: t.Union[float, Enum, t.Callable[[], float], None] = 0.0,
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (float, None))
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # Descriptors
@@ -2302,7 +2314,7 @@ class JSON(Column):
             t.Callable[[], t.Union[str, t.List, t.Dict]],
             None,
         ] = "{}",
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (str, list, dict, None))
 
@@ -2310,8 +2322,7 @@ class JSON(Column):
             default = dump_json(default)
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
         self.json_operator: t.Optional[str] = None
 
@@ -2486,7 +2497,7 @@ class Bytea(Column):
             t.Callable[[], bytearray],
             None,
         ] = b"",
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         self._validate_default(default, (bytes, bytearray, None))
 
@@ -2494,8 +2505,7 @@ class Bytea(Column):
             default = bytes(default)
 
         self.default = default
-        kwargs.update({"default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, **kwargs)
 
     ###########################################################################
     # Descriptors
@@ -2587,7 +2597,7 @@ class Array(Column):
         default: t.Union[
             t.List, Enum, t.Callable[[], t.List], None
         ] = ListProxy(),
-        **kwargs,
+        **kwargs: Unpack[ColumnKwargs],
     ) -> None:
         if isinstance(base_column, ForeignKey):
             raise ValueError("Arrays of ForeignKeys aren't allowed.")
@@ -2613,8 +2623,7 @@ class Array(Column):
         self.base_column = base_column
         self.default = default
         self.index: t.Optional[int] = None
-        kwargs.update({"base_column": base_column, "default": default})
-        super().__init__(**kwargs)
+        super().__init__(default=default, base_column=base_column, **kwargs)
 
     @property
     def column_type(self):

{piccolo-1.26.1 → piccolo-1.27.0}/piccolo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: piccolo
-Version: 1.26.1
+Version: 1.27.0
 Summary: A fast, user friendly ORM and query builder which supports asyncio.
 Home-page: https://github.com/piccolo-orm/piccolo
 Author: Daniel Townsend

{piccolo-1.26.1 → piccolo-1.27.0}/tests/apps/migrations/auto/test_migration_manager.py

@@ -286,8 +286,7 @@ class TestMigrationManager(DBTestCase):
                 "length": 100,
                 "default": "",
                 "null": True,
-                "primary": False,
-                "key": False,
+                "primary_key": False,
                 "unique": True,
                 "index": False,
             },
@@ -355,8 +354,7 @@ class TestMigrationManager(DBTestCase):
                 "length": 100,
                 "default": "",
                 "null": True,
-                "primary": False,
-                "key": False,
+                "primary_key": False,
                 "unique": True,
                 "index": True,
             },
@@ -402,8 +400,7 @@ class TestMigrationManager(DBTestCase):
                 "on_update": OnUpdate.cascade,
                 "default": None,
                 "null": True,
-                "primary": False,
-                "key": False,
+                "primary_key": False,
                 "unique": False,
                 "index": False,
             },
@@ -449,8 +446,7 @@ class TestMigrationManager(DBTestCase):
                 "on_update": OnUpdate.cascade,
                 "default": None,
                 "null": True,
-                "primary": False,
-                "key": False,
+                "primary_key": False,
                 "unique": False,
                 "index": False,
             },
@@ -505,8 +501,7 @@ class TestMigrationManager(DBTestCase):
                 "length": 100,
                 "default": "",
                 "null": False,
-                "primary": False,
-                "key": False,
+                "primary_key": False,
                 "unique": True,
                 "index": False,
             },

{piccolo-1.26.1 → piccolo-1.27.0}/tests/apps/migrations/commands/test_migrations/2020-03-31T20-38-22.py

@@ -15,8 +15,7 @@ async def forwards():
             "length": 150,
             "default": "",
             "null": True,
-            "primary": False,
-            "key": False,
+            "primary_key": False,
             "unique": False,
             "index": False,
         },

{piccolo-1.26.1 → piccolo-1.27.0}/tests/columns/test_boolean.py

@@ -6,7 +6,7 @@ from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):
-    boolean = Boolean(boolean=False, null=True)
+    boolean = Boolean(default=False, null=True)
 
 
 class TestBoolean(TableTest):

{piccolo-1.26.1 → piccolo-1.27.0}/tests/columns/test_primary_key.py

@@ -75,12 +75,12 @@ class TestPrimaryKeyUUID(TableTest):
 
 
 class Manager(Table):
-    pk = UUID(primary=True, key=True)
+    pk = UUID(primary_key=True)
     name = Varchar()
 
 
 class Band(Table):
-    pk = UUID(primary=True, key=True)
+    pk = UUID(primary_key=True)
     name = Varchar()
     manager = ForeignKey(Manager)
 

piccolo-1.26.1/piccolo/__init__.py

@@ -1 +0,0 @@
-__VERSION__ = "1.26.1"