Fix the `Surreal.patch` method #100

Wouterkoorn · 2024-04-02T00:00:50Z

Change request method type from "modify" to "patch". And fix type annotations.

What is the motivation?

Surreal.patch is currently not usable.
Fixing type annotations improved developer experience.

📚 Examples / docs / tutorials / dependencies update
🔧 Bug fix (non-breaking change which fixes an issue)
🥂 Improvement (non-breaking change which improves an existing feature)
🚀 New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to change)
🔐 Security fix

Changes the Surreal.patch request method type from "modify" to "patch"
Changes the Surreal.patch's data parameter type to Optional[List[Dict[str, Any]]]
Changes the Surreal.patch return type to Union[dict[str, Any], List[Dict[str, Any]]]

mypy OK
pre-commit OK
./scripts/run_tests.sh OK
manual testing OK

Yes: #99

Change request method type from "modify" to "patch". And fix type annotations.

Wouterkoorn · 2024-04-02T00:06:27Z

python_package/surrealdb/ws.py

@@ -598,6 +600,7 @@ async def patch(
 { 'op': "remove", "path": "/temp" },
 ])
 """
+ data = data or []


This is for backwards compatibility, making the change non-breaking.
The typing was Optional, but the server requires an array, None is invalid.

Fix the Surreal.patch method

e896a00

Change request method type from "modify" to "patch". And fix type annotations.

Wouterkoorn commented Apr 2, 2024

View reviewed changes