parseapi 1.9.1__tar.gz → 1.9.2__tar.gz

{parseapi-1.9.1 → parseapi-1.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: parseapi
-Version: 1.9.1
+Version: 1.9.2
 Summary: Official ParseAPI client for Python. One key, minimal JSON, fast.
 Project-URL: Homepage, https://parseapi.com
 Project-URL: Documentation, https://parseapi.com/docs
@@ -260,6 +260,8 @@ units = parse.measure.units(unit="m")
 
 `amount` is a decimal string, such as `"180.34"`. Without `to`, the API returns the canonical unit for the measurement type. Pass `locale` for number formatting and `system` (`us` or `imperial`) when a customary unit needs context. Ambiguous input returns `valid: false`, a `reason`, and available `choices`. Invalid or incompatible target units use the normal API error.
 
+Successful HTTP JSON contains `measure`, `valid`, `type`, `amount`, and `unit`. Invalid input adds `reason`. `choices` appears only when unit alternatives are available.
+
 Unit discovery accepts optional `query`, `type`, and `unit` filters. `unit` selects compatible targets. Omit the filters for the reviewed catalog. Both operations use pooled requests.
 
 ## Place statistics and optional detail

{parseapi-1.9.1 → parseapi-1.9.2}/README.md

@@ -241,6 +241,8 @@ units = parse.measure.units(unit="m")
 
 `amount` is a decimal string, such as `"180.34"`. Without `to`, the API returns the canonical unit for the measurement type. Pass `locale` for number formatting and `system` (`us` or `imperial`) when a customary unit needs context. Ambiguous input returns `valid: false`, a `reason`, and available `choices`. Invalid or incompatible target units use the normal API error.
 
+Successful HTTP JSON contains `measure`, `valid`, `type`, `amount`, and `unit`. Invalid input adds `reason`. `choices` appears only when unit alternatives are available.
+
 Unit discovery accepts optional `query`, `type`, and `unit` filters. `unit` selects compatible targets. Omit the filters for the reviewed catalog. Both operations use pooled requests.
 
 ## Place statistics and optional detail

{parseapi-1.9.1 → parseapi-1.9.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "parseapi"
-version = "1.9.1"
+version = "1.9.2"
 description = "Official ParseAPI client for Python. One key, minimal JSON, fast."
 readme = "README.md"
 license = "MIT"

{parseapi-1.9.1 → parseapi-1.9.2}/src/parseapi/__init__.py

@@ -2,5 +2,5 @@
 
 from ._client import AsyncParseAPI, ParseAPI, ParseAPIError
 
-__version__ = "1.9.0"
+__version__ = "1.9.2"
 __all__ = ["ParseAPI", "AsyncParseAPI", "ParseAPIError", "__version__"]

{parseapi-1.9.1 → parseapi-1.9.2}/src/parseapi/_client.py

@@ -1176,6 +1176,7 @@ class _MeasureSync:
     def __call__(self, measure: str, *, to: Optional[str] = None, locale: Optional[str] = None, system: Optional[str] = None) -> Json:
         """Parse or convert a measurement. Amount is a decimal string. Without to, use the
         type's canonical unit. Locale and system (us or imperial) resolve explicit ambiguity.
+        Successful JSON omits reason and choices. Invalid input adds reason and alternatives add choices.
         Invalid measurements return valid=False and a reason. Invalid targets raise an API error.
         """
         return self._client._get(f"/measure/{_seg(measure)}", {"to": to, "locale": locale, "system": system})
@@ -1192,6 +1193,7 @@ class _MeasureAsync:
     async def __call__(self, measure: str, *, to: Optional[str] = None, locale: Optional[str] = None, system: Optional[str] = None) -> Json:
         """Parse or convert a measurement. Amount is a decimal string. Without to, use the
         type's canonical unit. Locale and system (us or imperial) resolve explicit ambiguity.
+        Successful JSON omits reason and choices. Invalid input adds reason and alternatives add choices.
         Invalid measurements return valid=False and a reason. Invalid targets raise an API error.
         """
         return await self._client._get(f"/measure/{_seg(measure)}", {"to": to, "locale": locale, "system": system})

parseapi-1.9.2/tests/fixtures/measure-response.json

@@ -0,0 +1,51 @@
+[
+  {
+    "measure": "0 m",
+    "valid": true,
+    "type": "length",
+    "amount": "0",
+    "unit": "m"
+  },
+  {
+    "measure": "1.00000000000000000001 m",
+    "valid": true,
+    "type": "length",
+    "amount": "1",
+    "unit": "m"
+  },
+  {
+    "measure": "180",
+    "valid": false,
+    "type": null,
+    "amount": null,
+    "unit": null,
+    "reason": "missing_unit"
+  },
+  {
+    "measure": "1 gallon",
+    "valid": false,
+    "type": null,
+    "amount": null,
+    "unit": null,
+    "reason": "ambiguous_unit",
+    "choices": [
+      {
+        "unit": "gal_us",
+        "name": "US gallon"
+      },
+      {
+        "unit": "gal_imp",
+        "name": "imperial gallon"
+      }
+    ]
+  },
+  {
+    "measure": "0 m",
+    "valid": true,
+    "type": "length",
+    "amount": "0",
+    "unit": "m",
+    "reason": null,
+    "choices": []
+  }
+]

parseapi-1.9.2/tests/test_measure_response.py

@@ -0,0 +1,18 @@
+import asyncio
+import json
+from pathlib import Path
+
+import httpx
+from parseapi import AsyncParseAPI, ParseAPI
+
+CASES = json.loads((Path(__file__).parent / 'fixtures/measure-response.json').read_text())
+
+def test_clean_and_legacy_measure_responses_sync_and_async():
+    for body in CASES:
+        transport = httpx.MockTransport(lambda request: httpx.Response(200, json=body))
+        with ParseAPI('fixture', transport=transport) as client:
+            assert client.measure(body['measure']) == body
+        async def check():
+            async with AsyncParseAPI('fixture', transport=transport) as client:
+                assert await client.measure(body['measure']) == body
+        asyncio.run(check())