piccolo 1.4.2__py3-none-any.whl → 1.5.1__py3-none-any.whl

piccolo/columns/column_types.py

@@ -350,12 +350,10 @@ class Varchar(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> str:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> str: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Varchar:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Varchar: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -389,12 +387,10 @@ class Secret(Varchar):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> str:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> str: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Secret:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Secret: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -456,12 +452,10 @@ class Text(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> str:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> str: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Text:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Text: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -521,12 +515,10 @@ class UUID(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> uuid.UUID:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> uuid.UUID: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> UUID:
-        ...
+    def __get__(self, obj: None, objtype=None) -> UUID: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -641,12 +633,10 @@ class Integer(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Integer:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Integer: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -699,12 +689,10 @@ class BigInt(Integer):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> BigInt:
-        ...
+    def __get__(self, obj: None, objtype=None) -> BigInt: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -749,12 +737,10 @@ class SmallInt(Integer):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> SmallInt:
-        ...
+    def __get__(self, obj: None, objtype=None) -> SmallInt: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -801,12 +787,10 @@ class Serial(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Serial:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Serial: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -835,12 +819,10 @@ class BigSerial(Serial):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> BigSerial:
-        ...
+    def __get__(self, obj: None, objtype=None) -> BigSerial: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -870,12 +852,10 @@ class PrimaryKey(Serial):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> int:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> int: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> PrimaryKey:
-        ...
+    def __get__(self, obj: None, objtype=None) -> PrimaryKey: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -960,12 +940,10 @@ class Timestamp(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> datetime:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> datetime: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Timestamp:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Timestamp: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1057,12 +1035,10 @@ class Timestamptz(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> datetime:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> datetime: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Timestamptz:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Timestamptz: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1137,12 +1113,10 @@ class Date(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> date:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> date: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Date:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Date: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1214,12 +1188,10 @@ class Time(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> time:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> time: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Time:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Time: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1305,12 +1277,10 @@ class Interval(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> timedelta:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> timedelta: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Interval:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Interval: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1399,12 +1369,10 @@ class Boolean(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> bool:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> bool: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Boolean:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Boolean: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1502,12 +1470,10 @@ class Numeric(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> decimal.Decimal:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> decimal.Decimal: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Numeric:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Numeric: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1525,12 +1491,10 @@ class Decimal(Numeric):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> decimal.Decimal:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> decimal.Decimal: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Decimal:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Decimal: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1576,12 +1540,10 @@ class Real(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> float:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> float: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Real:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Real: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1599,12 +1561,10 @@ class Float(Real):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> float:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> float: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Float:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Float: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1626,12 +1586,10 @@ class DoublePrecision(Real):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> float:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> float: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> DoublePrecision:
-        ...
+    def __get__(self, obj: None, objtype=None) -> DoublePrecision: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -1871,8 +1829,7 @@ class ForeignKey(Column, t.Generic[ReferencedTable]):
         on_update: OnUpdate = OnUpdate.cascade,
         target_column: t.Union[str, Column, None] = None,
         **kwargs,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @t.overload
     def __init__(
@@ -1884,8 +1841,7 @@ class ForeignKey(Column, t.Generic[ReferencedTable]):
         on_update: OnUpdate = OnUpdate.cascade,
         target_column: t.Union[str, Column, None] = None,
         **kwargs,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @t.overload
     def __init__(
@@ -1897,8 +1853,7 @@ class ForeignKey(Column, t.Generic[ReferencedTable]):
         on_update: OnUpdate = OnUpdate.cascade,
         target_column: t.Union[str, Column, None] = None,
         **kwargs,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     def __init__(
         self,
@@ -2248,16 +2203,15 @@ class ForeignKey(Column, t.Generic[ReferencedTable]):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> t.Any:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> t.Any: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> ForeignKey[ReferencedTable]:
-        ...
+    def __get__(
+        self, obj: None, objtype=None
+    ) -> ForeignKey[ReferencedTable]: ...
 
     @t.overload
-    def __get__(self, obj: t.Any, objtype=None) -> t.Any:
-        ...
+    def __get__(self, obj: t.Any, objtype=None) -> t.Any: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -2317,12 +2271,10 @@ class JSON(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> str:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> str: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> JSON:
-        ...
+    def __get__(self, obj: None, objtype=None) -> JSON: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -2387,12 +2339,10 @@ class JSONB(JSON):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> str:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> str: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> JSONB:
-        ...
+    def __get__(self, obj: None, objtype=None) -> JSONB: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -2460,12 +2410,10 @@ class Bytea(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> bytes:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> bytes: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Bytea:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Bytea: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -2483,12 +2431,10 @@ class Blob(Bytea):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> bytes:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> bytes: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Blob:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Blob: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self
@@ -2597,6 +2543,43 @@ class Array(Column):
         if isinstance(self.base_column, Array):
             self.base_column._setup_base_column(table_class=table_class)
 
+    def _get_dimensions(self, start: int = 0) -> int:
+        """
+        A helper function to get the number of dimensions for the array. For
+        example::
+
+            >>> Array(Varchar())._get_dimensions()
+            1
+
+            >>> Array(Array(Varchar()))._get_dimensions()
+            2
+
+        :param start:
+            Ignore this - it's just used for  calling this method recursively.
+
+        """
+        if isinstance(self.base_column, Array):
+            return self.base_column._get_dimensions(start=start + 1)
+        else:
+            return start + 1
+
+    def _get_inner_value_type(self) -> t.Type:
+        """
+        A helper function to get the innermost value type for the array. For
+        example::
+
+            >>> Array(Varchar())._get_inner_value_type()
+            str
+
+            >>> Array(Array(Varchar()))._get_inner_value_type()
+            str
+
+        """
+        if isinstance(self.base_column, Array):
+            return self.base_column._get_inner_value_type()
+        else:
+            return self.base_column.value_type
+
     def __getitem__(self, value: int) -> Array:
         """
         Allows queries which retrieve an item from the array. The index starts
@@ -2719,12 +2702,10 @@ class Array(Column):
     # Descriptors
 
     @t.overload
-    def __get__(self, obj: Table, objtype=None) -> t.List[t.Any]:
-        ...
+    def __get__(self, obj: Table, objtype=None) -> t.List[t.Any]: ...
 
     @t.overload
-    def __get__(self, obj: None, objtype=None) -> Array:
-        ...
+    def __get__(self, obj: None, objtype=None) -> Array: ...
 
     def __get__(self, obj, objtype=None):
         return obj.__dict__[self._meta.name] if obj else self

piccolo/columns/reference.py

@@ -1,6 +1,7 @@
 """
 Dataclasses for storing lazy references between ForeignKey columns and tables.
 """
+
 from __future__ import annotations
 
 import importlib

piccolo/conf/apps.py

@@ -25,8 +25,7 @@ class MigrationModule(ModuleType):
 
     @staticmethod
     @abstractmethod
-    async def forwards() -> MigrationManager:
-        ...
+    async def forwards() -> MigrationManager: ...
 
 
 class PiccoloAppModule(ModuleType):

piccolo/query/methods/objects.py

@@ -124,10 +124,10 @@ class First(
 
         results = objects[0] if objects else None
 
-        modified_response: t.Optional[
-            TableInstance
-        ] = await self.query.callback_delegate.invoke(
-            results=results, kind=CallbackType.success
+        modified_response: t.Optional[TableInstance] = (
+            await self.query.callback_delegate.invoke(
+                results=results, kind=CallbackType.success
+            )
         )
         return modified_response
 
@@ -355,10 +355,10 @@ class Objects(
             # With callbacks, the user can return any data that they want.
             # Assume that most of the time they will still return a list of
             # Table instances.
-            modified: t.List[
-                TableInstance
-            ] = await self.callback_delegate.invoke(
-                results, kind=CallbackType.success
+            modified: t.List[TableInstance] = (
+                await self.callback_delegate.invoke(
+                    results, kind=CallbackType.success
+                )
             )
             return modified
         else:

piccolo/query/methods/select.py

@@ -604,20 +604,16 @@ class Select(Query[TableInstance, t.List[t.Dict[str, t.Any]]]):
         return self
 
     @t.overload
-    def output(self: Self, *, as_list: bool) -> SelectList:
-        ...
+    def output(self: Self, *, as_list: bool) -> SelectList: ...
 
     @t.overload
-    def output(self: Self, *, as_json: bool) -> SelectJSON:
-        ...
+    def output(self: Self, *, as_json: bool) -> SelectJSON: ...
 
     @t.overload
-    def output(self: Self, *, load_json: bool) -> Self:
-        ...
+    def output(self: Self, *, load_json: bool) -> Self: ...
 
     @t.overload
-    def output(self: Self, *, nested: bool) -> Self:
-        ...
+    def output(self: Self, *, nested: bool) -> Self: ...
 
     def output(
         self: Self,

piccolo/query/mixins.py

@@ -639,9 +639,9 @@ class OnConflictAction(str, Enum):
 class OnConflictItem:
     target: t.Optional[t.Union[str, Column, t.Tuple[Column, ...]]] = None
     action: t.Optional[OnConflictAction] = None
-    values: t.Optional[
-        t.Sequence[t.Union[Column, t.Tuple[Column, t.Any]]]
-    ] = None
+    values: t.Optional[t.Sequence[t.Union[Column, t.Tuple[Column, t.Any]]]] = (
+        None
+    )
     where: t.Optional[Combinable] = None
 
     @property

piccolo/query/proxy.py

@@ -8,8 +8,9 @@ from piccolo.utils.sync import run_sync
 
 
 class Runnable(Protocol):
-    async def run(self, node: t.Optional[str] = None, in_pool: bool = True):
-        ...
+    async def run(
+        self, node: t.Optional[str] = None, in_pool: bool = True
+    ): ...
 
 
 QueryType = t.TypeVar("QueryType", bound=Runnable)

piccolo/table.py

@@ -78,6 +78,7 @@ class TableMeta:
     columns: t.List[Column] = field(default_factory=list)
     default_columns: t.List[Column] = field(default_factory=list)
     non_default_columns: t.List[Column] = field(default_factory=list)
+    array_columns: t.List[Array] = field(default_factory=list)
     email_columns: t.List[Email] = field(default_factory=list)
     foreign_key_columns: t.List[ForeignKey] = field(default_factory=list)
     primary_key: Column = field(default_factory=Column)
@@ -267,6 +268,7 @@ class Table(metaclass=TableMetaclass):
         columns: t.List[Column] = []
         default_columns: t.List[Column] = []
         non_default_columns: t.List[Column] = []
+        array_columns: t.List[Array] = []
         foreign_key_columns: t.List[ForeignKey] = []
         secret_columns: t.List[Secret] = []
         json_columns: t.List[t.Union[JSON, JSONB]] = []
@@ -304,6 +306,7 @@ class Table(metaclass=TableMetaclass):
 
                 if isinstance(column, Array):
                     column._setup_base_column(table_class=cls)
+                    array_columns.append(column)
 
                 if isinstance(column, Email):
                     email_columns.append(column)
@@ -337,6 +340,7 @@ class Table(metaclass=TableMetaclass):
             columns=columns,
             default_columns=default_columns,
             non_default_columns=non_default_columns,
+            array_columns=array_columns,
             email_columns=email_columns,
             primary_key=primary_key,
             foreign_key_columns=foreign_key_columns,
@@ -562,12 +566,10 @@ class Table(metaclass=TableMetaclass):
     @t.overload
     def get_related(
         self, foreign_key: ForeignKey[ReferencedTable]
-    ) -> First[ReferencedTable]:
-        ...
+    ) -> First[ReferencedTable]: ...
 
     @t.overload
-    def get_related(self, foreign_key: str) -> First[Table]:
-        ...
+    def get_related(self, foreign_key: str) -> First[Table]: ...
 
     def get_related(
         self, foreign_key: t.Union[str, ForeignKey[ReferencedTable]]
@@ -741,9 +743,9 @@ class Table(metaclass=TableMetaclass):
             if isinstance(value, Table):
                 value = value.to_dict(*columns)
 
-            output[
-                alias_names.get(column._meta.name) or column._meta.name
-            ] = value
+            output[alias_names.get(column._meta.name) or column._meta.name] = (
+                value
+            )
         return output
 
     def __setitem__(self, key: str, value: t.Any):
@@ -809,9 +811,11 @@ class Table(metaclass=TableMetaclass):
         # If unquoted, dump it straight into the query.
         query = ",".join(
             [
-                args_dict[column._meta.name].value
-                if is_unquoted(args_dict[column._meta.name])
-                else "{}"
+                (
+                    args_dict[column._meta.name].value
+                    if is_unquoted(args_dict[column._meta.name])
+                    else "{}"
+                )
                 for column in self._meta.columns
             ]
         )
@@ -995,9 +999,11 @@ class Table(metaclass=TableMetaclass):
         Convert any string arguments to column instances.
         """
         return [
-            cls._meta.get_column_by_name(column)
-            if (isinstance(column, str))
-            else column
+            (
+                cls._meta.get_column_by_name(column)
+                if (isinstance(column, str))
+                else column
+            )
             for column in columns
         ]
 

piccolo/utils/pydantic.py

@@ -280,6 +280,7 @@ def create_pydantic_model(
             "choices": column._meta.get_choices_dict(),
             "secret": column._meta.secret,
             "nullable": column._meta.null,
+            "unique": column._meta.unique,
         }
 
         if isinstance(column, ForeignKey):
@@ -333,6 +334,11 @@ def create_pydantic_model(
             elif isinstance(column, Timestamptz):
                 extra["widget"] = "timestamptz"
 
+            # It is useful for Piccolo API and Piccolo Admin to easily know
+            # how many dimensions the array has.
+            if isinstance(column, Array):
+                extra["dimensions"] = column._get_dimensions()
+
         field = pydantic.Field(
             json_schema_extra={"extra": extra},
             **params,