Merge branch 'master' of github.com:piccolo-orm/piccolo_admin

Author: dantownsend

docs/source/custom_forms/examples/app.py

@@ -1,53 +1,30 @@
-import datetime
-import smtplib
-
 from fastapi import FastAPI
 from fastapi.routing import Mount
-from pydantic import BaseModel, EmailStr
+from pydantic import BaseModel
 from starlette.requests import Request
 
 from piccolo_admin.endpoints import FormConfig, create_admin
 
 
 # Pydantic model for the form
-class BookingModel(BaseModel):
-    movie: str = "Star Wars: Episode IV - A New Hope"
-    email: EmailStr
-    name: str
-    tickets: int
-    starts_at: datetime.datetime
-    notes: str = "N/A"
+class CalculatorModel(BaseModel):
+    number_1: int
+    number_2: int
 
 
 # Endpoint for handling the form
-def booking_endpoint(request: Request, data: BookingModel) -> str:
-    """
-    An example form function which sends an email.
+def calculator(request: Request, data: CalculatorModel):
     """
-    sender = "info@example.com"
-    receivers = [data.email]
-
-    message = f"""From: Bookings <info@example.com>
-    To: Customer <{data.email}>
-    Subject: {data.name} booked {data.tickets} ticket(s) for {data.starts_at}.
-    {data.notes}
+    A very simple example of a form which adds numbers together.
     """
-
-    try:
-        smtpObj = smtplib.SMTP("localhost:1025")
-        smtpObj.sendmail(sender, receivers, message)
-        print("Successfully sent email")
-    except (smtplib.SMTPException, ConnectionRefusedError):
-        print("Error: unable to send email")
-
-    return "Booking complete"
+    return f"The answer is {data.number_1 + data.number_2}."
 
 
 FORM = FormConfig(
-    name="Booking form",
-    pydantic_model=BookingModel,
-    endpoint=booking_endpoint,
-    description="Make a booking for a customer.",
+    name="Calculator",
+    pydantic_model=CalculatorModel,
+    endpoint=calculator,
+    description=("Adds two numbers together."),
 )
 
 

docs/source/custom_forms/index.rst

@@ -31,7 +31,11 @@ string
 If a string is returned, it is shown to the user once the form has been
 submitted.
 
-Here's an example where we send an email, then return a string:
+Here's a really simple example:
+
+.. literalinclude:: ../../../piccolo_admin/example/forms/calculator.py
+
+Here's a more advanced example where we send an email, then return a string:
 
 .. literalinclude:: ../../../piccolo_admin/example/forms/email.py
 

piccolo_admin/example/forms/__init__.py

@@ -1,5 +1,11 @@
+from .calculator import FORM as CALCULATOR_FORM
 from .csv import FORM as CSV_FORM
 from .email import FORM as EMAIL_FORM
 from .image import FORM as IMAGE_FORM
 
-FORMS = [CSV_FORM, EMAIL_FORM, IMAGE_FORM]
+FORMS = [
+    CALCULATOR_FORM,
+    CSV_FORM,
+    EMAIL_FORM,
+    IMAGE_FORM,
+]

piccolo_admin/example/forms/calculator.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel
+from starlette.requests import Request
+
+from piccolo_admin.endpoints import FormConfig
+
+
+class CalculatorModel(BaseModel):
+    number_1: int
+    number_2: int
+
+
+def calculator(request: Request, data: CalculatorModel):
+    """
+    A very simple example of a form which adds numbers together.
+    """
+    return f"The answer is {data.number_1 + data.number_2}."
+
+
+FORM = FormConfig(
+    name="Calculator",
+    pydantic_model=CalculatorModel,
+    endpoint=calculator,
+    description=("Adds two numbers together."),
+)

piccolo_admin/sandbox.py

@@ -7,6 +7,10 @@
 import uvicorn
 
 from piccolo_admin.endpoints import create_admin
+from piccolo_admin.example.forms.calculator import FORM as CALCULATOR_FORM
+from piccolo_admin.example.forms.csv import FORM as CSV_FORM
+from piccolo_admin.example.forms.email import FORM as BOOKING_FORM
+from piccolo_admin.example.forms.image import FORM as IMAGE_FORM
 from piccolo_admin.example.tables import (
     Director,
     Movie,
@@ -22,6 +26,12 @@
     auth_table=User,
     session_table=Sessions,
     read_only=True,
+    forms=[
+        BOOKING_FORM,
+        CALCULATOR_FORM,
+        CSV_FORM,
+        IMAGE_FORM,
+    ],
 )
 
 

tests/test_endpoints.py

@@ -283,22 +283,27 @@ def test_forms(self):
             response.json(),
             [
                 {
-                    "description": (
-                        "Download a list of movies for the director as a "
-                        "CSV file."
-                    ),
+                    "name": "Calculator",
+                    "slug": "calculator",
+                    "description": "Adds two numbers together.",
+                },
+                {
                     "name": "Download director movies",
                     "slug": "download-director-movies",
+                    "description": (
+                        "Download a list of movies for the director as a CSV "
+                        "file."
+                    ),
                 },
                 {
-                    "description": "Make a booking for a customer.",
                     "name": "Booking form",
                     "slug": "booking-form",
+                    "description": "Make a booking for a customer.",
                 },
                 {
-                    "description": "Download the schedule for the day.",
                     "name": "Download schedule",
                     "slug": "download-schedule",
+                    "description": "Download the schedule for the day.",
                 },
             ],
         )