add ne operator (#260)

Author: dantownsend

docs/source/crud/piccolo_crud.rst

@@ -135,6 +135,7 @@ time fields the following operators are allowed:
 * ``gt``: Greater Than
 * ``gte``: Greater Than or Equal
 * ``e``: Equal (default)
+* ``ne``: Not Equal
 
 To specify which operator to use, pass a query parameter like ``field__operator=operator_name``.
 For example ``duration__operator=gte``.

piccolo_api/crud/endpoints.py

@@ -18,6 +18,7 @@
     IsNull,
     LessEqualThan,
     LessThan,
+    NotEqual,
 )
 from piccolo.columns.operators.comparison import ComparisonOperator
 from piccolo.query.methods.delete import Delete
@@ -53,6 +54,7 @@
     "gt": GreaterThan,
     "gte": GreaterEqualThan,
     "e": Equal,
+    "ne": NotEqual,
     "is_null": IsNull,
     "not_null": IsNotNull,
 }

piccolo_api/fastapi/endpoints.py

@@ -492,7 +492,7 @@ def modify_signature(
                             description=(
                                 f"Which operator to use for `{field_name}`. "
                                 "The options are `e` (equals - default) `lt`, "
-                                "`lte`, `gt`, `gte`, `is_null`, and "
+                                "`lte`, `gt`, `gte`, `ne`, `is_null`, and "
                                 "`not_null`."
                             ),
                         ),

tests/crud/test_crud_endpoints.py

@@ -964,6 +964,21 @@ def test_operator_gt(self):
             {"rows": [{"id": 1, "name": "Star Wars", "rating": 93}]},
         )
 
+    def test_operator_ne(self):
+        """
+        Test operator - not equals.
+        """
+        client = TestClient(PiccoloCRUD(table=Movie, read_only=False))
+        response = client.get(
+            "/",
+            params={"__order": "id", "rating": "90", "rating__operator": "ne"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            response.json(),
+            {"rows": [{"id": 1, "name": "Star Wars", "rating": 93}]},
+        )
+
     def test_operator_null(self):
         """
         Test operators - `is_null` / `not_null`.