👽 Rename $pk to $primary_key

core/harambe_core/parser/parser.py

@@ -31,12 +31,12 @@ class SchemaParser:
     def __init__(
         self, schema: Schema, evaluator: ExpressionEvaluator | None = None
     ) -> None:
-        self._pk_expression = schema.get("$pk", None)
+        self._pk_expression = schema.get("$primary_key", None)
 
         if "$schema" in schema:
             del schema["$schema"]
-        if "$pk" in schema:
-            del schema["$pk"]
+        if "$primary_key" in schema:
+            del schema["$primary_key"]
 
         if evaluator is None:
             evaluator = ExpressionEvaluator()
@@ -58,7 +58,7 @@ def validate(self, data: dict[str, Any], base_url: str) -> dict[str, Any]:
         try:
             res = model(**data).model_dump()
             if self._pk_expression:
-                res["$pk"] = self.evaluator.evaluate(self._pk_expression, res)
+                res["$primary_key"] = self.evaluator.evaluate(self._pk_expression, res)
             return res
 
         except ValidationError as validation_error:

core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "harambe-core"
-version = "0.45.3"
+version = "0.46.0"
 description = "Core types for harambe SDK 🐒🍌"
 authors = [
     { name = "Adam Watkins", email = "[email protected]" }

core/test/parser/mock_schemas/computed_pk.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/reworkd/harambe/refs/heads/main/schema.json",
-  "$pk": "CONCAT_WS('_', resource.name, resource.link)",
+  "$primary_key": "CONCAT_WS('_', resource.name, resource.link)",
   "resource": {
     "type": "object",
     "properties": {

core/test/parser/test_parser_computed.py

@@ -1,7 +1,6 @@
 import pytest
 
 from harambe_core import SchemaParser
-from harambe_core.errors import SchemaValidationError
 from test.parser.mock_schemas.load_schema import load_schema
 
 
@@ -114,7 +113,7 @@ def test_nested_reference(schema, data):
 
 def test_parser_computed_pk():
     schema_ = load_schema("computed_pk")
-    schema_["$pk"] = "CONCAT(resource.name, '_', resource.link)"
+    schema_["$primary_key"] = "CONCAT(resource.name, '_', resource.link)"
     data = {
         "resource": {
             "name": "API Documentation",
@@ -124,7 +123,7 @@ def test_parser_computed_pk():
 
     validator = SchemaParser(schema_)
     output_data = validator.validate(data, base_url="http://example.com")
-    assert output_data["$pk"] == "API Documentation_https://reworkd.ai/docs"
+    assert output_data["$primary_key"] == "API Documentation_https://reworkd.ai/docs"
 
 
 def test_computed_on_nullable_field(schema, data):

schema.json

@@ -180,7 +180,7 @@
     "$schema": {
       "type": "string"
     },
-    "$pk": {
+    "$primary_key": {
       "type": "string",
       "description": "Primary key expression override"
     }

sdk/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
 name = "harambe-sdk"
-version = "0.45.3"
+version = "0.46.0"
 description = "Data extraction SDK for Playwright 🐒🍌"
 authors = [
     { name = "Adam Watkins", email = "[email protected]" }
 ]
 requires-python = ">=3.11,<4.0"
 readme = "README.md"
 dependencies = [
-    "harambe_core==0.45.3",
+    "harambe_core==0.46.0",
     "pydantic==2.9.2",
     "playwright==1.47.0",
     "setuptools==73.0.0",