Add support for environment context

Author: ebyhr

pyiceberg/environment_context.py

@@ -0,0 +1,43 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from importlib.metadata import version
+
+
+class EnvironmentContext:
+    _PROPERTIES: dict[str, str] = {
+        "engine-name": "pyiceberg",
+        "engine-version": version("pyiceberg"),
+    }
+
+    def __init__(self) -> None:
+        raise NotImplementedError("EnvironmentContext is a utility class and cannot be instantiated.")
+
+    @classmethod
+    def get(cls) -> dict[str, str]:
+        """Return a read-only copy of all properties."""
+        return cls._PROPERTIES.copy()
+
+    @classmethod
+    def put(cls, key: str, value: str) -> None:
+        """Will add the given key/value pair in a global properties map."""
+        cls._PROPERTIES[key] = value
+
+    @classmethod
+    def remove(cls, key: str) -> str | None:
+        """Remove the key from the global properties map."""
+        return cls._PROPERTIES.pop(key, None)

pyiceberg/table/snapshots.py

@@ -25,6 +25,7 @@
 
 from pydantic import Field, PrivateAttr, model_serializer
 
+from pyiceberg.environment_context import EnvironmentContext
 from pyiceberg.io import FileIO
 from pyiceberg.manifest import DataFile, DataFileContent, ManifestFile, _manifests
 from pyiceberg.partitioning import UNPARTITIONED_PARTITION_SPEC, PartitionSpec
@@ -402,6 +403,9 @@ def _update_totals(total_property: str, added_property: str, removed_property: s
         removed_property=REMOVED_EQUALITY_DELETES,
     )
 
+    for key, value in EnvironmentContext.get().items():
+        summary.__setitem__(key, value)
+
     return summary
 
 

tests/table/test_snapshots.py

@@ -19,6 +19,7 @@
 
 import pytest
 
+from pyiceberg.environment_context import EnvironmentContext
 from pyiceberg.manifest import DataFile, DataFileContent, ManifestContent, ManifestFile
 from pyiceberg.partitioning import PartitionField, PartitionSpec
 from pyiceberg.schema import Schema
@@ -315,6 +316,8 @@ def test_merge_snapshot_summaries_empty() -> None:
             "total-files-size": "0",
             "total-position-deletes": "0",
             "total-equality-deletes": "0",
+            "engine-name": "pyiceberg",
+            "engine-version": EnvironmentContext.get().get("engine-version"),
         },
     )
 
@@ -349,6 +352,8 @@ def test_merge_snapshot_summaries_new_summary() -> None:
             "total-files-size": "4",
             "total-position-deletes": "5",
             "total-equality-deletes": "3",
+            "engine-name": "pyiceberg",
+            "engine-version": EnvironmentContext.get().get("engine-version"),
         },
     )
 
@@ -391,6 +396,8 @@ def test_merge_snapshot_summaries_overwrite_summary() -> None:
         "total-files-size": "5",
         "total-position-deletes": "6",
         "total-equality-deletes": "4",
+        "engine-name": "pyiceberg",
+        "engine-version": EnvironmentContext.get().get("engine-version"),
     }
 
     assert actual.additional_properties == expected

tests/test_environment_context.py

@@ -0,0 +1,39 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import tomllib
+
+from pyiceberg.environment_context import EnvironmentContext
+
+
+def test_default_value() -> None:
+    actual = EnvironmentContext.get()
+    expected = {"engine-name": "pyiceberg", "engine-version": _project_version()}
+    assert actual == expected
+
+
+def test_put_and_remove() -> None:
+    EnvironmentContext.put("test-key", "test-value")
+    assert EnvironmentContext.get()["test-key"] == "test-value"
+
+    EnvironmentContext.remove("test-key")
+    assert "test-key" not in EnvironmentContext.get()
+
+
+def _project_version() -> str:
+    with open("pyproject.toml", "rb") as f:
+        data = tomllib.load(f)
+        return data["project"]["version"]