crossplane-function-sdk-python 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

crossplane/function/__version__.py

@@ -15,4 +15,4 @@
 """The version of function-sdk-python."""
 
 # This is set at build time, using "hatch version"
-__version__ = "0.4.0"
+__version__ = "0.6.0"

crossplane/function/resource.py

@@ -17,12 +17,47 @@
 import dataclasses
 import datetime
 
+import pydantic
 from google.protobuf import struct_pb2 as structpb
 
+import crossplane.function.proto.v1.run_function_pb2 as fnv1
+
 # TODO(negz): Do we really need dict_to_struct and struct_to_dict? They don't do
 # much, but are perhaps useful for discoverability/"documentation" purposes.
 
 
+def update(r: fnv1.Resource, source: dict | structpb.Struct | pydantic.BaseModel):
+    """Update a composite or composed resource.
+
+    Use update to add or update the supplied resource. If the resource doesn't
+    exist, it'll be added. If the resource does exist, it'll be updated. The
+    update method semantics are the same as a dictionary's update method. Fields
+    that don't exist will be added. Fields that exist will be overwritten.
+
+    The source can be a dictionary, a protobuf Struct, or a Pydantic model.
+    """
+    match source:
+        case pydantic.BaseModel():
+            data = source.model_dump(exclude_defaults=True, warnings=False)
+            # In Pydantic, exclude_defaults=True in model_dump excludes fields
+            # that have their value equal to the default. If a field like
+            # apiVersion is set to its default value 's3.aws.upbound.io/v1beta2'
+            # (and not explicitly provided during initialization), it will be
+            # excluded from the serialized output.
+            data['apiVersion'] = source.apiVersion
+            data['kind'] = source.kind
+            r.resource.update(data)
+        case structpb.Struct():
+            # TODO(negz): Use struct_to_dict and update to match other semantics?
+            r.resource.MergeFrom(source)
+        case dict():
+            r.resource.update(source)
+        case _:
+            t = type(source)
+            msg = f"Unsupported type: {t}"
+            raise TypeError(msg)
+
+
 def dict_to_struct(d: dict) -> structpb.Struct:
     """Create a Struct well-known type from the supplied dict.
 
@@ -83,10 +118,10 @@ def get_condition(resource: structpb.Struct, typ: str) -> Condition:
     """
     unknown = Condition(typ=typ, status="Unknown")
 
-    if "status" not in resource:
+    if not resource or "status" not in resource:
         return unknown
 
-    if "conditions" not in resource["status"]:
+    if not resource["status"] or "conditions" not in resource["status"]:
         return unknown
 
     for c in resource["status"]["conditions"]:
@@ -122,9 +157,9 @@ class Credentials:
 def get_credentials(req: structpb.Struct, name: str) -> Credentials:
     """Get the supplied credentials."""
     empty = Credentials(type="data", data={})
-    if "credentials" not in req:
+    if not req or "credentials" not in req:
         return empty
-    if name not in req["credentials"]:
+    if not req["credentials"] or name not in req["credentials"]:
         return empty
     return Credentials(
         type=req["credentials"][name]["type"],

{crossplane_function_sdk_python-0.4.0.dist-info → crossplane_function_sdk_python-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: crossplane-function-sdk-python
-Version: 0.4.0
+Version: 0.6.0
 Summary: The Python SDK for Crossplane composition functions
 Project-URL: Documentation, https://github.com/crossplane/function-sdk-python#readme
 Project-URL: Issues, https://github.com/crossplane/function-sdk-python/issues
@@ -14,7 +14,8 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
 Requires-Dist: grpcio-reflection==1.*
 Requires-Dist: grpcio==1.*
-Requires-Dist: protobuf==5.27.2
+Requires-Dist: protobuf==5.29.3
+Requires-Dist: pydantic==2.*
 Requires-Dist: structlog==24.*
 Description-Content-Type: text/markdown
 
@@ -54,11 +55,11 @@ Some useful commands:
 # Generate gRPC stubs.
 hatch run generate:protoc
 
-# Lint the code.
-hatch run lint:check
+# Format and lint the code.
+hatch fmt
 
 # Run unit tests.
-hatch run test:unit
+hatch test
 
 # Build an sdist and wheel.
 hatch build

{crossplane_function_sdk_python-0.4.0.dist-info → crossplane_function_sdk_python-0.6.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-crossplane/function/__version__.py,sha256=UmYGftOClDeeEqm_1NAJL-F44l3lUDF3p6gNQUY3O6E,704
+crossplane/function/__version__.py,sha256=DtYXkdzOSFDLCo0rG7l_tz5EZeXg-UK3VURBigcLQSg,704
 crossplane/function/logging.py,sha256=Zawqq36FBzjkVg4bJ3VGK12-so7N8yAMoSPrhdwpBSA,2503
-crossplane/function/resource.py,sha256=wsPYkPKjO63Gz2HNyHoE2fe-TGXmFg0MjAborujymIA,3861
+crossplane/function/resource.py,sha256=NT8Z1dt3Tz82P9q9bqXrR8HwohtYWJaG3AnvN7C3E1w,5502
 crossplane/function/response.py,sha256=5TDz2vXcvH2cMuDojN1YFrr0Vsyvz1XCzNEBwxruFf4,2354
 crossplane/function/runtime.py,sha256=DoCLFildkwBgB-y-qlHcoSXStDRcJ426_V81C3QvVOE,4864
 crossplane/function/proto/v1/run_function.proto,sha256=83RIkEQWuMfXC5HPaPpJqXXDxYMR3VlG4xhmtutle5k,12032
@@ -11,7 +11,7 @@ crossplane/function/proto/v1beta1/run_function.proto,sha256=xep0DvulCjo8LUf-2fOb
 crossplane/function/proto/v1beta1/run_function_pb2.py,sha256=LmKTg848G5Ud8GI2AIK2jjLj19nnjthRsQwECZgE4ls,10907
 crossplane/function/proto/v1beta1/run_function_pb2.pyi,sha256=IYcl0F9Chx_jN6AP9FI0yZCqidpbiFCK0ANU6AlKfXY,10624
 crossplane/function/proto/v1beta1/run_function_pb2_grpc.py,sha256=Abx0c4U82vIsWyeIKwS1vfEshP74N6gjB-hx0DM1lFk,4082
-crossplane_function_sdk_python-0.4.0.dist-info/METADATA,sha256=VS0q5hBjxru_-tiQyLIMbPI6fKCYPl_Mx34YsBWhsnI,3192
-crossplane_function_sdk_python-0.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-crossplane_function_sdk_python-0.4.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-crossplane_function_sdk_python-0.4.0.dist-info/RECORD,,
+crossplane_function_sdk_python-0.6.0.dist-info/METADATA,sha256=qPkiww0PHZ0LLfT-BqZ52t2ZUPVVwap83nDy0ABhQD8,3212
+crossplane_function_sdk_python-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+crossplane_function_sdk_python-0.6.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+crossplane_function_sdk_python-0.6.0.dist-info/RECORD,,

{crossplane_function_sdk_python-0.4.0.dist-info → crossplane_function_sdk_python-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any