refactor: convert ConstraintTypes to ConstraintType StrEnum

Author: purificant

README.md

@@ -27,7 +27,7 @@ user = await User.get(uid)
 
 # query
 users = await User.find(constraints=[
-    constraint("status", ConstraintTypes.EQUALS, "active")
+    constraint("status", ConstraintType.EQUALS, "active")
 ])
 
 # update
@@ -43,7 +43,7 @@ if await User.exists(uid):
 
 # count
 active_count = await User.count(constraints=[
-    constraint("status", ConstraintTypes.EQUALS, "active")
+    constraint("status", ConstraintType.EQUALS, "active")
 ])
 ```
 
@@ -178,11 +178,11 @@ user = await User.create(name="Ada Lovelace", email="ada@example.com")
 user = await User.get("1234567890x1234567890")
 
 # query with constraints
-from bubble_data_api_client import constraint, ConstraintTypes
+from bubble_data_api_client import constraint, ConstraintType
 
 active_users = await User.find(constraints=[
-    constraint("status", ConstraintTypes.EQUALS, "active"),
-    constraint("age", ConstraintTypes.GREATER_THAN, 18),
+    constraint("status", ConstraintType.EQUALS, "active"),
+    constraint("age", ConstraintType.GREATER_THAN, 18),
 ])
 
 # update
@@ -235,14 +235,14 @@ user, created = await User.create_or_update(
 Build type-safe queries using Bubble's constraint system:
 
 ```python
-from bubble_data_api_client import constraint, ConstraintTypes
+from bubble_data_api_client import constraint, ConstraintType
 
 constraints = [
-    constraint("status", ConstraintTypes.EQUALS, "active"),
-    constraint("age", ConstraintTypes.GREATER_THAN, 21),
-    constraint("tags", ConstraintTypes.CONTAINS, "premium"),
-    constraint("email", ConstraintTypes.IS_NOT_EMPTY),
-    constraint("category", ConstraintTypes.IN, ["A", "B", "C"]),
+    constraint("status", ConstraintType.EQUALS, "active"),
+    constraint("age", ConstraintType.GREATER_THAN, 21),
+    constraint("tags", ConstraintType.CONTAINS, "premium"),
+    constraint("email", ConstraintType.IS_NOT_EMPTY),
+    constraint("category", ConstraintType.IN, ["A", "B", "C"]),
 ]
 
 results = await User.find(constraints=constraints)
@@ -314,7 +314,7 @@ This library is async-only, but you can use it in sync code:
 
 ```python
 import asyncio
-from bubble_data_api_client import BubbleBaseModel, constraint, ConstraintTypes
+from bubble_data_api_client import BubbleBaseModel, constraint, ConstraintType
 
 class User(BubbleBaseModel, typename="user"):
     name: str
@@ -327,8 +327,8 @@ user = asyncio.run(User.get("1234567890x1234567890"))
 # or wrap multiple operations
 async def main():
     constraints = [
-        constraint("is_verified", ConstraintTypes.EQUALS, True),
-        constraint("account_type", ConstraintTypes.EQUALS, "premium"),
+        constraint("is_verified", ConstraintType.EQUALS, True),
+        constraint("account_type", ConstraintType.EQUALS, "premium"),
     ]
     users = await User.find(constraints=constraints)
     for user in users:

src/bubble_data_api_client/__init__.py

@@ -6,7 +6,7 @@
     configure,
     set_config_provider,
 )
-from bubble_data_api_client.constraints import Constraint, ConstraintTypes, constraint
+from bubble_data_api_client.constraints import Constraint, ConstraintType, constraint
 from bubble_data_api_client.pool import client_scope, close_clients
 from bubble_data_api_client.types import (
     BubbleField,
@@ -28,7 +28,7 @@
     "RawClient",
     # query building
     "Constraint",
-    "ConstraintTypes",
+    "ConstraintType",
     "constraint",
     # client lifecycle
     "client_scope",

src/bubble_data_api_client/client/orm.py

@@ -6,7 +6,7 @@
 from pydantic import Field
 
 from bubble_data_api_client.client.raw_client import RawClient
-from bubble_data_api_client.constraints import Constraint, ConstraintTypes, constraint
+from bubble_data_api_client.constraints import Constraint, ConstraintType, constraint
 from bubble_data_api_client.types import BubbleField, OnMultiple
 
 
@@ -50,7 +50,7 @@ async def get_many(cls, uids: list[str]) -> dict[str, typing.Self]:
         if not uids:
             return {}
         items: list[typing.Self] = await cls.find(
-            constraints=[constraint(BubbleField.ID, ConstraintTypes.IN, uids)],
+            constraints=[constraint(BubbleField.ID, ConstraintType.IN, uids)],
         )
         return {item.uid: item for item in items}
 

src/bubble_data_api_client/client/raw_client.py

@@ -6,7 +6,7 @@
 
 import httpx
 
-from bubble_data_api_client.constraints import Constraint, ConstraintTypes, constraint
+from bubble_data_api_client.constraints import Constraint, ConstraintType, constraint
 from bubble_data_api_client.exceptions import InvalidOnMultipleError, MultipleMatchesError, PartialFailureError
 from bubble_data_api_client.transport import Transport
 from bubble_data_api_client.types import BubbleField, CreateOrUpdateResult, OnMultiple
@@ -179,7 +179,7 @@ async def create_or_update(
 
         # build equals constraints from match fields to find existing thing
         constraints: list[Constraint] = [
-            constraint(key=key, constraint_type=ConstraintTypes.EQUALS, value=value) for key, value in match.items()
+            constraint(key=key, constraint_type=ConstraintType.EQUALS, value=value) for key, value in match.items()
         ]
 
         # for dedupe strategies, sort by created date to determine oldest/newest

src/bubble_data_api_client/constraints.py

@@ -1,4 +1,5 @@
 import typing
+from enum import StrEnum
 
 
 # all constraints are of the form:
@@ -25,7 +26,9 @@ def constraint(
 
 
 # https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/data-api-requests#constraint-types
-class ConstraintTypes:
+class ConstraintType(StrEnum):
+    """Constraint types for Bubble Data API queries."""
+
     # Use to test strict equality
     EQUALS = "equals"
     NOT_EQUAL = "not equal"
@@ -55,6 +58,6 @@ class ConstraintTypes:
     EMPTY = "empty"
     NOT_EMPTY = "not empty"
 
-    # Use to test if the current thing is within a radius from a central address.#
+    # Use to test if the current thing is within a radius from a central address.
     # To use this, the value sent with the constraint must have an address and a range.
     GEOGRAPHIC_SEARCH = "geographic_search"

src/tests/integration/test_orm.py

@@ -1,7 +1,7 @@
 import pytest
 
 from bubble_data_api_client.client.orm import BubbleBaseModel
-from bubble_data_api_client.constraints import ConstraintTypes, constraint
+from bubble_data_api_client.constraints import ConstraintType, constraint
 from bubble_data_api_client.types import BubbleField
 
 
@@ -36,7 +36,7 @@ async def test_orm_integration():
 
     # find
     things = await IntegrationTestModel.find(
-        constraints=[constraint(BubbleField.ID, ConstraintTypes.EQUALS, thing3.uid)]
+        constraints=[constraint(BubbleField.ID, ConstraintType.EQUALS, thing3.uid)]
     )
     assert len(things) == 1
     assert isinstance(things[0], IntegrationTestModel)

src/tests/unit/test_constraints.py

@@ -1,10 +1,10 @@
-from bubble_data_api_client.constraints import ConstraintTypes, constraint
+from bubble_data_api_client.constraints import ConstraintType, constraint
 from bubble_data_api_client.types import BubbleField
 
 
 def test_constraint_with_value():
     """Test constraint factory with a value."""
-    result = constraint(BubbleField.ID, ConstraintTypes.IN, ["uid1", "uid2"])
+    result = constraint(BubbleField.ID, ConstraintType.IN, ["uid1", "uid2"])
     assert result == {
         "key": "_id",
         "constraint_type": "in",
@@ -14,7 +14,7 @@ def test_constraint_with_value():
 
 def test_constraint_without_value():
     """Test constraint factory without a value."""
-    result = constraint("field", ConstraintTypes.IS_EMPTY)
+    result = constraint("field", ConstraintType.IS_EMPTY)
     assert result == {
         "key": "field",
         "constraint_type": "is_empty",