added ability to delete otpional fields when editing

Author: Mole1424

events/api.py

@@ -417,8 +417,8 @@ def create_repeat_event_api() -> tuple[Response, int]:  # noqa: PLR0911
 
 @events_api_bp.route("/<int:event_id>", methods=["PATCH"])
 @valid_api_auth
-def edit_event_api(event_id: int) -> tuple[Response, int]:
-    """Edit an existing event
+def edit_event_api(event_id: int) -> tuple[Response, int]:  # noqa: PLR0911, PLR0912
+    """Edit an existing event. Leave a field out to leave it unchanged, or as an empty string to clear it.
     ---
     parameters:
       - name: event_id
@@ -504,36 +504,64 @@ def edit_event_api(event_id: int) -> tuple[Response, int]:
     if not data:
         return jsonify({"error": "No data provided"}), 400
 
+    event = {}
+
+    if "name" in data:
+        if data["name"] == "":
+            return jsonify({"error": "Name cannot be empty"}), 400
+        event["name"] = data["name"]
+
+    if "description" in data:
+        if data["description"] == "":
+            return jsonify({"error": "Description cannot be empty"}), 400
+        event["description"] = data["description"]
+
+    if "draft" in data:
+        if not isinstance(data["draft"], bool):
+            return jsonify({"error": "Draft must be a boolean"}), 400
+        event["draft"] = data["draft"]
+
+    if "location" in data:
+        if data["location"] == "":
+            return jsonify({"error": "Location cannot be empty"}), 400
+        event["location"] = data["location"]
+
+    event["location_url"] = data.get("location_url", None)
+    event["icon"] = data.get("icon", None)
+    event["colour"] = data.get("colour", None)
+
     # convert strings to time objects
     if "start_time" in data:
-        start_time = get_datetime_from_string(data["start_time"])
-        if isinstance(start_time, str):
-            return jsonify({"error": start_time}), 400
+        if data["start_time"] == "":
+            return jsonify({"error": "Start time cannot be empty"}), 400
+        event["start_time"] = get_datetime_from_string(data["start_time"])
+        if isinstance(event["start_time"], str):
+            return jsonify({"error": event["start_time"]}), 400
 
     if "end_time" in data:
-        end_time = get_datetime_from_string(data["end_time"])
-        if isinstance(end_time, str):
-            return jsonify({"error": end_time}), 400
+        if data["end_time"] == "":
+            event["end_time"] = None
+        else:
+            event["end_time"] = get_datetime_from_string(data["end_time"])
+            if isinstance(event["end_time"], str):
+                return jsonify({"error": event["end_time"]}), 400
 
     if "duration" in data:
-        duration = get_timedelta_from_string(data["duration"])
-        if isinstance(duration, str):
-            return jsonify({"error": duration}), 400
-
-    event = edit_event(
-        event_id,
-        data.get("name"),
-        data.get("description"),
-        data.get("draft", False),
-        data.get("location"),
-        data.get("location_url"),
-        data.get("icon"),
-        data.get("colour"),
-        start_time if "start_time" in data else None,  # type: ignore
-        duration if "duration" in data else None,  # type: ignore
-        end_time if "end_time" in data else None,  # type: ignore
-        data.get("tags", []),
-    )
+        if data["duration"] == "":
+            event["duration"] = None
+        else:
+            event["duration"] = get_timedelta_from_string(data["duration"])
+            if isinstance(event["duration"], str):
+                return jsonify({"error": event["duration"]}), 400
+
+    if "tags" in data:
+        if not isinstance(data["tags"], list):
+            return jsonify({"error": "Tags must be a list"}), 400
+        if any(not isinstance(tag, str) for tag in data["tags"]):
+            return jsonify({"error": "All tags must be strings"}), 400
+        event["tags"] = data["tags"]
+
+    event = edit_event(event_id, **event)
 
     if isinstance(event, str):
         return jsonify({"error": event}), 400

events/ui.py

@@ -22,11 +22,16 @@
 def parse_form_data(form_data: ImmutableMultiDict) -> dict | str:
     """Parse event from form data"""
     # parse colour
-    text_colour = form_data.get("text_colour", None)
-    color_colour = form_data.get("color_colour", None)
-
-    text_colour = text_colour.strip().lower() if text_colour else None
-    color_colour = color_colour.strip().lower() if color_colour else None
+    text_colour = (
+        form_data["text_colour"].strip().lower()
+        if form_data["text_colour"] != ""
+        else None
+    )
+    color_colour = (
+        form_data["color_colour"].strip().lower()
+        if form_data["color_colour"] != ""
+        else None
+    )
 
     if (error := validate_colour(text_colour, color_colour)) is not None:
         return error
@@ -44,7 +49,7 @@ def parse_form_data(form_data: ImmutableMultiDict) -> dict | str:
 
     duration = (
         get_timedelta_from_string(form_data["duration"])
-        if form_data["duration"]
+        if form_data["duration"] != ""
         else None
     )
     if isinstance(duration, str):
@@ -68,8 +73,10 @@ def parse_form_data(form_data: ImmutableMultiDict) -> dict | str:
         "description": form_data["description"],
         "draft": "draft" in form_data,
         "location": form_data["location"],
-        "location_url": form_data.get("location_url", None),
-        "icon": form_data.get("icon", None),
+        "location_url": (
+            form_data["location_url"] if form_data["location_url"] != "" else None
+        ),
+        "icon": form_data["icon"] if form_data["icon"] != "" else None,
         "colour": colour,
         "duration": duration,
         "tags": tags,
@@ -105,8 +112,6 @@ def create() -> str | Response:
 
     # if posting, create the event
 
-    print("Creating event with data:", request.form)
-
     # parse form data
     data = parse_form_data(request.form)
     if isinstance(data, str):

events/utils.py

@@ -307,19 +307,22 @@ def get_events_by_time(
     return query.order_by(Event.start_time, Event.end_time, Event.name).all()  # type: ignore
 
 
+_KEEP = object()  # placeholder to leave the field unchanged
+
+
 def edit_event(  # noqa: PLR0913
     id: int,
-    name: str | None = None,
-    description: str | None = None,
-    draft: bool | None = None,
-    location: str | None = None,
-    location_url: str | None = None,
-    icon: str | None = None,
-    colour: str | None = None,
-    start_time: datetime | None = None,
-    duration: timedelta | None = None,
-    end_time: datetime | None = None,
-    tags: list[str] | None = None,
+    name: str | object = _KEEP,
+    description: str | object = _KEEP,
+    draft: bool | object = _KEEP,
+    location: str | object = _KEEP,
+    location_url: str | object | None = _KEEP,
+    icon: str | object | None = _KEEP,
+    colour: str | object | None = _KEEP,
+    start_time: datetime | object = _KEEP,
+    duration: timedelta | object | None = _KEEP,
+    end_time: datetime | object | None = _KEEP,
+    tags: list[str] | object | None = _KEEP,
 ) -> Event | str:
     """Edit an existing event"""
 
@@ -328,30 +331,32 @@ def edit_event(  # noqa: PLR0913
         return "Event not found"
 
     # update the event attributes if provided
-    event.name = name if name is not None else event.name
-    event.slug = name.lower().replace(" ", "-") if name else event.slug
-    event.description = description if description is not None else event.description
-    event.draft = draft if draft is not None else event.draft
-    event.location = location if location is not None else event.location
+    event.name = name if name is not _KEEP else event.name
+    event.slug = name.lower().replace(" ", "-") if name is not _KEEP else event.slug  # type: ignore
+    event.description = description if description is not _KEEP else event.description
+    event.draft = draft if draft is not _KEEP else event.draft
+    event.location = location if location is not _KEEP else event.location
     event.location_url = (
-        location_url if location_url is not None else event.location_url
+        location_url if location_url is not _KEEP else event.location_url
     )
-    event.icon = icon.lower() if icon else event.icon
+    if icon is not _KEEP:
+        event.icon = icon.lower() if icon is not None else event.icon  # type: ignore
     event.colour = colour if colour else event.colour
     event.start_time = (
-        start_time.astimezone(pytz.timezone("Europe/London"))
-        if start_time
+        start_time.astimezone(pytz.timezone("Europe/London"))  # type: ignore
+        if start_time is not _KEEP
         else event.start_time
     )
-    event.end_time = (
-        end_time.astimezone(pytz.timezone("Europe/London"))
-        if end_time
-        else event.end_time
-    )
+    if end_time is not _KEEP:
+        event.end_time = (
+            end_time.astimezone(pytz.timezone("Europe/London"))  # type: ignore
+            if end_time is not None
+            else event.end_time
+        )
 
     # if duration is provided, calculate end_time and verify it
-    if duration:
-        calculated_end_time = event.start_time + duration
+    if duration is not _KEEP and duration is not None:
+        calculated_end_time = event.start_time + duration  # type: ignore
         if event.end_time and event.end_time != calculated_end_time:
             return "End time does not match the duration"
         event.end_time = calculated_end_time
@@ -364,7 +369,7 @@ def edit_event(  # noqa: PLR0913
         return error
 
     # update tags if provided
-    if tags is not None:
+    if tags is not _KEEP:
         # clear existing tags
         event.tags.clear()
         # check all tags exist, create if not