Add configurable option to disable automatic snake_case conversion (#123)

* feat: implement snake case field names for Record model

* docs: add note about auto_snake_case conversion behavior

---------

Co-authored-by: Antharuu <[email protected]>

Author: antharuu

README.md

@@ -54,6 +54,16 @@ result = client.collection("example").create(
 ```
 > More detailed API docs and copy-paste examples could be found in the [API documentation for each service](https://pocketbase.io/docs/api-authentication). Just remember to 'pythonize it' 🙃.
 
+---
+
+**Note:** By default, camelCase (or any other key style) from the API is converted to snake_case in Python. You can keep the original keys by setting `auto_snake_case=False` when creating the client.
+
+```python
+from pocketbase import Client
+client = Client(auto_snake_case=False)
+# Fields will keep their original names from the API
+```
+
 ## Development
 
 These are the requirements for local development:

pocketbase/client.py

@@ -27,12 +27,14 @@ def __init__(
         auth_store: AuthStore | None = None,
         timeout: float = 120,
         http_client: httpx.Client | None = None,
+        auto_snake_case: bool = True,
     ) -> None:
         self.base_url = base_url
         self.lang = lang
         self.auth_store = auth_store or BaseAuthStore()  # LocalAuthStore()
         self.timeout = timeout
         self.http_client = http_client or httpx.Client()
+        self.auto_snake_case = auto_snake_case
         # services
         self.admins = AdminService(self)
         self.backups = BackupsService(self)

pocketbase/models/record.py

@@ -15,7 +15,7 @@ def load(self, data: dict[str, Any]) -> None:
         super().load(data)
         self.expand = {}
         for key, value in data.items():
-            key = camel_to_snake(key).replace("@", "")
+            key = camel_to_snake(key, getattr(self, 'client', None) and getattr(self.client, 'auto_snake_case', True)).replace("@", "")
             setattr(self, key, value)
         self.load_expanded()
 

pocketbase/services/record_service.py

@@ -179,7 +179,7 @@ def list_auth_methods(
 
         def apply_pythonic_keys(ap: dict[str, Any]) -> dict[str, Any]:
             pythonic_keys_ap = {
-                camel_to_snake(key).replace("@", ""): value
+                camel_to_snake(key, getattr(self.client, 'auto_snake_case', True)).replace("@", ""): value
                 for key, value in ap.items()
             }
             return pythonic_keys_ap

pocketbase/utils.py

@@ -8,7 +8,9 @@
 from .errors import ClientResponseError  # noqa: F401
 
 
-def camel_to_snake(name: str) -> str:
+def camel_to_snake(name: str, enabled: bool = True) -> str:
+    if not enabled:
+        return name
     name = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", name)
     return re.sub("([a-z0-9])([A-Z])", r"\1_\2", name).lower()
 

tests/test_client_snake_case.py

@@ -0,0 +1,41 @@
+import pytest
+from pocketbase import Client
+from pocketbase.models.record import Record
+from pocketbase.utils import camel_to_snake
+
+class DummyClient:
+    def __init__(self, auto_snake_case=True):
+        self.auto_snake_case = auto_snake_case
+
+class DummyRecord(Record):
+    def __init__(self, data, client=None):
+        self.client = client
+        self.expand = {}
+        self.load(data)
+
+def test_camel_to_snake_enabled():
+    assert camel_to_snake("TestCase") == "test_case"
+    assert camel_to_snake("testCase") == "test_case"
+    assert camel_to_snake("test_case") == "test_case"
+    assert camel_to_snake("TestBS123") == "test_bs123"
+    assert camel_to_snake("TestCase", enabled=False) == "TestCase"
+
+def test_record_snake_case_enabled():
+    client = DummyClient(auto_snake_case=True)
+    data = {"myFieldName": "value", "anotherField": 42}
+    record = DummyRecord(data, client=client)
+    assert hasattr(record, "my_field_name")
+    assert hasattr(record, "another_field")
+    assert record.my_field_name == "value"
+    assert record.another_field == 42
+
+def test_record_snake_case_disabled():
+    client = DummyClient(auto_snake_case=False)
+    data = {"myFieldName": "value", "anotherField": 42}
+    record = DummyRecord(data, client=client)
+    assert hasattr(record, "myFieldName")
+    assert hasattr(record, "anotherField")
+    assert not hasattr(record, "my_field_name")
+    assert not hasattr(record, "another_field")
+    assert record.myFieldName == "value"
+    assert record.anotherField == 42