piccolo 1.22.0__tar.gz → 1.24.0__tar.gz

{piccolo-1.22.0 → piccolo-1.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: piccolo
-Version: 1.22.0
+Version: 1.24.0
 Summary: A fast, user friendly ORM and query builder which supports asyncio.
 Home-page: https://github.com/piccolo-orm/piccolo
 Author: Daniel Townsend
@@ -9,7 +9,6 @@ License: MIT
 Project-URL: Documentation, https://piccolo-orm.readthedocs.io/en/latest/index.html
 Project-URL: Source, https://github.com/piccolo-orm/piccolo
 Project-URL: Tracker, https://github.com/piccolo-orm/piccolo/issues
-Platform: UNKNOWN
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -24,13 +23,42 @@ Classifier: Typing :: Typed
 Classifier: Topic :: Database
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: black
+Requires-Dist: colorama>=0.4.0
+Requires-Dist: Jinja2>=2.11.0
+Requires-Dist: targ>=0.3.7
+Requires-Dist: inflection>=0.5.1
+Requires-Dist: typing-extensions>=4.3.0
+Requires-Dist: pydantic[email]==2.*
 Provides-Extra: orjson
+Requires-Dist: orjson>=3.5.1; extra == "orjson"
 Provides-Extra: playground
+Requires-Dist: ipython; extra == "playground"
 Provides-Extra: postgres
+Requires-Dist: asyncpg>=0.30.0; extra == "postgres"
 Provides-Extra: sqlite
+Requires-Dist: aiosqlite>=0.16.0; extra == "sqlite"
 Provides-Extra: uvloop
+Requires-Dist: uvloop>=0.12.0; sys_platform != "win32" and extra == "uvloop"
 Provides-Extra: all
-License-File: LICENSE
+Requires-Dist: orjson>=3.5.1; extra == "all"
+Requires-Dist: ipython; extra == "all"
+Requires-Dist: asyncpg>=0.30.0; extra == "all"
+Requires-Dist: aiosqlite>=0.16.0; extra == "all"
+Requires-Dist: uvloop>=0.12.0; sys_platform != "win32" and extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ![Logo](https://raw.githubusercontent.com/piccolo-orm/piccolo/master/docs/logo_hero.png "Piccolo Logo")
 
@@ -128,7 +156,7 @@ Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM:
 piccolo asgi new
 ```
 
-[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/) and [Lilya](https://lilya.dev) are currently supported.
+[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/), [Lilya](https://lilya.dev), [Quart](https://quart.palletsprojects.com/en/latest/), [Falcon](https://falconframework.org/) and [Sanic](https://sanic.dev/en/) are currently supported.
 
 ## Are you a Django user?
 
@@ -139,5 +167,3 @@ We have a handy page which shows the equivalent of [common Django queries in Pic
 Our documentation is on [Read the docs](https://piccolo-orm.readthedocs.io/en/latest/piccolo/getting_started/index.html).
 
 We also have some great [tutorial videos on YouTube](https://www.youtube.com/channel/UCE7x5nm1Iy9KDfXPNrNQ5lA).
-
-

{piccolo-1.22.0 → piccolo-1.24.0}/README.md

@@ -94,7 +94,7 @@ Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM:
 piccolo asgi new
 ```
 
-[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/) and [Lilya](https://lilya.dev) are currently supported.
+[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/), [Lilya](https://lilya.dev), [Quart](https://quart.palletsprojects.com/en/latest/), [Falcon](https://falconframework.org/) and [Sanic](https://sanic.dev/en/) are currently supported.
 
 ## Are you a Django user?
 

piccolo-1.24.0/piccolo/__init__.py

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

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/asgi/commands/new.py

@@ -17,6 +17,9 @@ ROUTER_DEPENDENCIES = {
     "litestar": ["litestar"],
     "esmerald": ["esmerald"],
     "lilya": ["lilya"],
+    "quart": ["quart", "quart_schema"],
+    "falcon": ["falcon"],
+    "sanic": ["sanic", "sanic_ext"],
 }
 ROUTERS = list(ROUTER_DEPENDENCIES.keys())
 

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/_falcon_app.py.jinja

@@ -0,0 +1,60 @@
+import os
+import typing as t
+
+import falcon.asgi
+from hypercorn.middleware import DispatcherMiddleware
+from piccolo.engine import engine_finder
+from piccolo_admin.endpoints import create_admin
+from piccolo_api.crud.endpoints import PiccoloCRUD
+
+from home.endpoints import HomeEndpoint
+from home.piccolo_app import APP_CONFIG
+from home.tables import Task
+
+
+async def open_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.start_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+async def close_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.close_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+class LifespanMiddleware:
+    async def process_startup(
+        self, scope: t.Dict[str, t.Any], event: t.Dict[str, t.Any]
+    ) -> None:
+        await open_database_connection_pool()
+
+    async def process_shutdown(
+        self, scope: t.Dict[str, t.Any], event: t.Dict[str, t.Any]
+    ) -> None:
+        await close_database_connection_pool()
+
+
+app: t.Any = falcon.asgi.App(middleware=LifespanMiddleware())
+app.add_static_route("/static", directory=os.path.abspath("static"))
+app.add_route("/", HomeEndpoint())
+
+PICCOLO_CRUD: t.Any = PiccoloCRUD(table=Task)
+
+# enable the Admin and PiccoloCrud app using DispatcherMiddleware
+app = DispatcherMiddleware(  # type: ignore
+    {
+        "/admin": create_admin(
+            tables=APP_CONFIG.table_classes,
+            # Required when running under HTTPS:
+            # allowed_hosts=['my_site.com']
+        ),
+        "/tasks": PICCOLO_CRUD,
+        "": app,
+    }
+)

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/_quart_app.py.jinja

@@ -0,0 +1,119 @@
+import typing as t
+from http import HTTPStatus
+
+from hypercorn.middleware import DispatcherMiddleware
+from piccolo.engine import engine_finder
+from piccolo_admin.endpoints import create_admin
+from piccolo_api.crud.serializers import create_pydantic_model
+from quart import Quart
+from quart_schema import (
+    Info,
+    QuartSchema,
+    hide,
+    tag,
+    validate_request,
+    validate_response,
+)
+
+from home.endpoints import index
+from home.piccolo_app import APP_CONFIG
+from home.tables import Task
+
+
+app = Quart(__name__, static_folder="static")
+QuartSchema(app, info=Info(title="Quart API", version="0.1.0"))
+
+
+TaskModelIn: t.Any = create_pydantic_model(
+    table=Task,
+    model_name="TaskModelIn",
+)
+TaskModelOut: t.Any = create_pydantic_model(
+    table=Task,
+    include_default_columns=True,
+    model_name="TaskModelOut",
+)
+
+
+@app.get("/")
+@hide
+def home():
+    return index()
+
+
+@app.get("/tasks/")
+@validate_response(t.List[TaskModelOut])
+@tag(["Task"])
+async def tasks():
+    return await Task.select().order_by(Task._meta.primary_key, ascending=False)
+
+
+@app.post("/tasks/")
+@validate_request(TaskModelIn)
+@validate_response(TaskModelOut)
+@tag(["Task"])
+async def create_task(data: TaskModelIn):
+    task = Task(**data.model_dump())
+    await task.save()
+    return task.to_dict(), HTTPStatus.CREATED
+
+
+@app.put("/tasks/<int:task_id>/")
+@validate_request(TaskModelIn)
+@validate_response(TaskModelOut)
+@tag(["Task"])
+async def update_task(task_id: int, data: TaskModelIn):
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
+    if not task:
+        return {}, HTTPStatus.NOT_FOUND
+
+    for key, value in data.model_dump().items():
+        setattr(task, key, value)
+
+    await task.save()
+
+    return task.to_dict(), HTTPStatus.OK
+
+
+@app.delete("/tasks/<int:task_id>/")
+@validate_response(TaskModelOut)
+@tag(["Task"])
+async def delete_task(task_id: int):
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
+    if not task:
+        return {}, HTTPStatus.NOT_FOUND
+
+    await task.remove()
+
+    return {}, HTTPStatus.OK
+
+
+@app.before_serving
+async def open_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.start_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+@app.after_serving
+async def close_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.close_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+# enable the admin application using DispatcherMiddleware
+app = DispatcherMiddleware(  # type: ignore
+    {
+        "/admin": create_admin(
+            tables=APP_CONFIG.table_classes,
+            # Required when running under HTTPS:
+            # allowed_hosts=['my_site.com']
+        ),
+        "": app,
+    }
+)

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/_sanic_app.py.jinja

@@ -0,0 +1,121 @@
+import asyncio
+import typing as t
+
+from hypercorn.middleware import DispatcherMiddleware
+from piccolo.engine import engine_finder
+from piccolo_admin.endpoints import create_admin
+from piccolo_api.crud.serializers import create_pydantic_model
+from sanic import Request, Sanic, json
+from sanic_ext import openapi
+
+from home.endpoints import index
+from home.piccolo_app import APP_CONFIG
+from home.tables import Task
+
+app = Sanic(__name__)
+app.static("/static/", "static")
+
+
+TaskModelIn: t.Any = create_pydantic_model(
+    table=Task,
+    model_name="TaskModelIn",
+)
+TaskModelOut: t.Any = create_pydantic_model(
+    table=Task,
+    include_default_columns=True,
+    model_name="TaskModelOut",
+)
+
+
+@app.get("/")
+@openapi.exclude()
+def home(request: Request):
+    return index()
+
+
+@app.get("/tasks/")
+@openapi.tag("Task")
+@openapi.response(200, {"application/json": TaskModelOut.model_json_schema()})
+async def tasks(request: Request):
+    return json(
+        await Task.select().order_by(Task._meta.primary_key, ascending=False),
+        status=200,
+    )
+
+
+@app.post("/tasks/")
+@openapi.definition(
+    body={"application/json": TaskModelIn.model_json_schema()},
+    tag="Task",
+)
+@openapi.response(201, {"application/json": TaskModelOut.model_json_schema()})
+async def create_task(request: Request):
+    task = Task(**request.json)
+    await task.save()
+    return json(task.to_dict(), status=201)
+
+
+@app.put("/tasks/<task_id:int>/")
+@openapi.definition(
+    body={"application/json": TaskModelIn.model_json_schema()},
+    tag="Task",
+)
+@openapi.response(200, {"application/json": TaskModelOut.model_json_schema()})
+async def update_task(request: Request, task_id: int):
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
+    if not task:
+        return json({}, status=404)
+    for key, value in request.json.items():
+        setattr(task, key, value)
+
+    await task.save()
+    return json(task.to_dict(), status=200)
+
+
+@app.delete("/tasks/<task_id:int>/")
+@openapi.tag("Task")
+async def delete_task(request: Request, task_id: int):
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
+    if not task:
+        return json({}, status=404)
+    await task.remove()
+    return json({}, status=200)
+
+
+async def open_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.start_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+async def close_database_connection_pool():
+    try:
+        engine = engine_finder()
+        await engine.close_connection_pool()
+    except Exception:
+        print("Unable to connect to the database")
+
+
+@app.after_server_start
+async def startup(app, loop):
+    await open_database_connection_pool()
+
+
+@app.before_server_stop
+async def shutdown(app, loop):
+    await close_database_connection_pool()
+
+
+# enable the admin application using DispatcherMiddleware
+app = DispatcherMiddleware(  # type: ignore
+    {
+        "/admin": create_admin(
+            tables=APP_CONFIG.table_classes,
+            # Required when running under HTTPS:
+            # allowed_hosts=['my_site.com']
+        ),
+        "": app,
+    }
+)

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/asgi/commands/templates/app/app.py.jinja

@@ -10,4 +10,10 @@
     {% include '_esmerald_app.py.jinja' %}
 {% elif router == 'lilya' %}
     {% include '_lilya_app.py.jinja' %}
+{% elif router == 'quart' %}
+    {% include '_quart_app.py.jinja' %}
+{% elif router == 'falcon' %}
+    {% include '_falcon_app.py.jinja' %}
+{% elif router == 'sanic' %}
+    {% include '_sanic_app.py.jinja' %}
 {% endif %}

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/home/_falcon_endpoints.py.jinja

@@ -0,0 +1,19 @@
+import os
+
+import falcon
+import jinja2
+
+ENVIRONMENT = jinja2.Environment(
+    loader=jinja2.FileSystemLoader(
+        searchpath=os.path.join(os.path.dirname(__file__), "templates")
+    )
+)
+
+
+class HomeEndpoint:
+    async def on_get(self, req, resp):
+        template = ENVIRONMENT.get_template("home.html.jinja")
+        content = template.render(title="Piccolo + ASGI",)
+        resp.status = falcon.HTTP_200
+        resp.content_type = "text/html"
+        resp.text = content

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/home/_quart_endpoints.py.jinja

@@ -0,0 +1,18 @@
+import os
+
+import jinja2
+
+from quart import Response
+
+ENVIRONMENT = jinja2.Environment(
+    loader=jinja2.FileSystemLoader(
+        searchpath=os.path.join(os.path.dirname(__file__), "templates")
+    )
+)
+
+
+def index():
+    template = ENVIRONMENT.get_template("home.html.jinja")
+    content = template.render(title="Piccolo + ASGI")
+    return Response(content)
+    

piccolo-1.24.0/piccolo/apps/asgi/commands/templates/app/home/_sanic_endpoints.py.jinja

@@ -0,0 +1,17 @@
+import os
+
+import jinja2
+
+from sanic import HTTPResponse
+
+ENVIRONMENT = jinja2.Environment(
+    loader=jinja2.FileSystemLoader(
+        searchpath=os.path.join(os.path.dirname(__file__), "templates")
+    )
+)
+
+
+def index():
+    template = ENVIRONMENT.get_template("home.html.jinja")
+    content = template.render(title="Piccolo + ASGI")
+    return HTTPResponse(content)

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/asgi/commands/templates/app/home/endpoints.py.jinja

@@ -8,4 +8,10 @@
     {% include '_esmerald_endpoints.py.jinja' %}
 {% elif router == 'lilya' %}
     {% include '_lilya_endpoints.py.jinja' %}
+{% elif router == 'quart' %}
+    {% include '_quart_endpoints.py.jinja' %}
+{% elif router == 'falcon' %}
+    {% include '_falcon_endpoints.py.jinja' %}
+{% elif router == 'sanic' %}
+    {% include '_sanic_endpoints.py.jinja' %}
 {% endif %}

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/asgi/commands/templates/app/home/templates/home.html.jinja_raw

@@ -66,6 +66,21 @@
                 <li><a href="/admin/">Admin</a></li>
                 <li><a href="/tasks/">JSON endpoint</a></li>
             </ul>
+            <h3>Quart</h3>
+            <ul>
+                <li><a href="/admin/">Admin</a></li>
+                <li><a href="/docs">Swagger API</a></li>
+            </ul>
+            <h3>Falcon</h3>
+            <ul>
+                <li><a href="/admin/">Admin</a></li>
+                <li><a href="/tasks/">JSON endpoint</a></li>
+            </ul>
+            <h3>Sanic</h3>
+            <ul>
+                <li><a href="/admin/">Admin</a></li>
+                <li><a href="/docs/swagger">Swagger API</a></li>
+            </ul>
         </section>
     </div>
 {% endblock content %}

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/sql_shell/commands/run.py

@@ -28,24 +28,23 @@ def run() -> None:
 
         args = ["psql"]
 
-        host = engine.config.get("host")
-        port = engine.config.get("port")
-        user = engine.config.get("user")
-        password = engine.config.get("password")
-        database = engine.config.get("database")
+        config = engine.config
 
-        if user:
-            args += ["-U", user]
-        if host:
-            args += ["-h", host]
-        if port:
-            args += ["-p", str(port)]
-        if database:
-            args += [database]
+        if dsn := config.get("dsn"):
+            args += [dsn]
+        else:
+            if user := config.get("user"):
+                args += ["-U", user]
+            if host := config.get("host"):
+                args += ["-h", host]
+            if port := config.get("port"):
+                args += ["-p", str(port)]
+            if database := config.get("database"):
+                args += [database]
 
         sigint_handler = signal.getsignal(signal.SIGINT)
         subprocess_env = os.environ.copy()
-        if password:
+        if password := config.get("password"):
             subprocess_env["PGPASSWORD"] = str(password)
         try:
             # Allow SIGINT to pass to psql to abort queries.

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/apps/user/tables.py

@@ -202,7 +202,9 @@ class BaseUser(Table, tablename="piccolo_user"):
             The id of the user if a match is found, otherwise ``None``.
 
         """
-        if len(username) > cls.username.length:
+        if (max_username_length := cls.username.length) and len(
+            username
+        ) > max_username_length:
             logger.warning("Excessively long username provided.")
             return None
 

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/columns/column_types.py

@@ -315,7 +315,7 @@ class Varchar(Column):
 
     def __init__(
         self,
-        length: int = 255,
+        length: t.Optional[int] = 255,
         default: t.Union[str, Enum, t.Callable[[], str], None] = "",
         **kwargs,
     ) -> None:

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/columns/defaults/timestamptz.py

@@ -73,6 +73,7 @@ TimestamptzArg = t.Union[
     Enum,
     None,
     datetime.datetime,
+    t.Callable[[], datetime.datetime],
 ]
 
 

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/engine/sqlite.py

@@ -173,9 +173,21 @@ def convert_numeric_out(value: str) -> Decimal:
 @decode_to_string
 def convert_int_out(value: str) -> int:
     """
-    Make sure Integer values are actually of type int.
+    Make sure INTEGER values are actually of type ``int``.
+
+    SQLite doesn't enforce that the values in INTEGER columns are actually
+    integers - they could be strings ('hello'), or floats (1.0).
+
+    There's not much we can do if the value is something like 'hello' - a
+    ``ValueError`` is appropriate in this situation.
+
+    For a value like ``1.0``, it seems reasonable to handle this, and return a
+    value of ``1``.
+
     """
-    return int(float(value))
+    # We used to use int(float(value)), but it was incorrect, because float has
+    # limited precision for large numbers.
+    return int(Decimal(value))
 
 
 @decode_to_string

{piccolo-1.22.0 → piccolo-1.24.0}/piccolo/query/methods/objects.py

@@ -65,22 +65,20 @@ class GetOrCreate(
             instance._was_created = False
             return instance
 
-        instance = self.table_class(_data=self.defaults)
+        data = {**self.defaults}
 
         # If it's a complex `where`, there can be several column values to
         # extract e.g. (Band.name == 'Pythonistas') & (Band.popularity == 1000)
         if isinstance(self.where, Where):
-            setattr(
-                instance,
-                self.where.column._meta.name,  # type: ignore
-                self.where.value,  # type: ignore
-            )
+            data[self.where.column] = self.where.value
         elif isinstance(self.where, And):
             for column, value in self.where.get_column_values().items():
                 if len(column._meta.call_chain) == 0:
                     # Make sure we only set the value if the column belongs
                     # to this table.
-                    setattr(instance, column._meta.name, value)
+                    data[column] = value
+
+        instance = self.table_class(_data=data)
 
         await instance.save().run(node=node, in_pool=in_pool)