crossplane-function-sdk-python 0.5.0__tar.gz → 0.7.0__tar.gz

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/.github/workflows/ci.yml

@@ -120,7 +120,7 @@ jobs:
           path: "dist"
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.10.3
+        uses: pypa/gh-action-pypi-publish@v1.12.4
         with:
           # Note that this is currently being pushed to the 'crossplane' PyPI
           # user (not org). See @negz if you need access - PyPI requires 2FA to

crossplane_function_sdk_python-0.7.0/CODEOWNERS

@@ -0,0 +1,22 @@
+
+# SPDX-FileCopyrightText: 2025 The Crossplane Authors <https://crossplane.io>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+# This file controls automatic PR reviewer assignment. See the following docs:
+#
+# * https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+# * https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team
+#
+# The goal of this file is for most PRs to automatically and fairly have one
+# maintainer set as PR reviewers. All maintainers have permission to approve 
+# and merge PRs. All PRs must be approved by at least one maintainer before being merged.
+# 
+# Where possible, prefer explicitly specifying a maintainer who is a subject
+# matter expert for a particular part of the codebase rather than using fallback
+# owners. Fallback owners are listed at the bottom of this file.
+#
+# See also OWNERS.md for governance details
+
+# Fallback owners
+*			@negz @bobh66

crossplane_function_sdk_python-0.7.0/OWNERS.md

@@ -0,0 +1,18 @@
+<!--
+SPDX-FileCopyrightText: 2025 The Crossplane Authors <https://crossplane.io>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# OWNERS
+
+This page lists all maintainers for **this** repository. Each repository in the
+[Crossplane Contrib organization](https://github.com/crossplane-contrib/) will list their
+repository maintainers in their own `OWNERS.md` file.
+
+## Maintainers
+* Nic Cope <negz@upbound.com> ([negz](https://github.com/negz))
+* Bob Haddleton <bob.haddleton@nokia.com> ([bobh66](https://github.com/bobh66))
+
+
+See [CODEOWNERS](./CODEOWNERS) for automatic PR assignment.

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: crossplane-function-sdk-python
-Version: 0.5.0
+Version: 0.7.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
@@ -11,12 +11,13 @@ License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: grpcio-reflection==1.*
-Requires-Dist: grpcio==1.*
-Requires-Dist: protobuf==5.27.2
+Requires-Dist: grpcio==1.71.0
+Requires-Dist: protobuf==5.29.3
 Requires-Dist: pydantic==2.*
-Requires-Dist: structlog==24.*
+Requires-Dist: structlog==25.*
 Description-Content-Type: text/markdown
 
 # function-sdk-python

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/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.5.0"
+__version__ = "0.7.0"

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/proto/v1/run_function_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: crossplane/function/proto/v1/run_function.proto
-# Protobuf Python Version: 5.27.2
+# Protobuf Python Version: 5.29.0
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,8 +12,8 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    27,
-    2,
+    29,
+    0,
     '',
     'crossplane/function/proto/v1/run_function.proto'
 )

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/proto/v1/run_function_pb2_grpc.py

@@ -5,7 +5,7 @@ import warnings
 
 from crossplane.function.proto.v1 import run_function_pb2 as crossplane_dot_function_dot_proto_dot_v1_dot_run__function__pb2
 
-GRPC_GENERATED_VERSION = '1.66.0'
+GRPC_GENERATED_VERSION = '1.71.0'
 GRPC_VERSION = grpc.__version__
 _version_not_supported = False
 

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/proto/v1beta1/run_function_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: crossplane/function/proto/v1beta1/run_function.proto
-# Protobuf Python Version: 5.27.2
+# Protobuf Python Version: 5.29.0
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,8 +12,8 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    27,
-    2,
+    29,
+    0,
     '',
     'crossplane/function/proto/v1beta1/run_function.proto'
 )

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/proto/v1beta1/run_function_pb2_grpc.py

@@ -5,7 +5,7 @@ import warnings
 
 from crossplane.function.proto.v1beta1 import run_function_pb2 as crossplane_dot_function_dot_proto_dot_v1beta1_dot_run__function__pb2
 
-GRPC_GENERATED_VERSION = '1.66.0'
+GRPC_GENERATED_VERSION = '1.71.0'
 GRPC_VERSION = grpc.__version__
 _version_not_supported = False
 

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/resource.py

@@ -18,6 +18,7 @@ import dataclasses
 import datetime
 
 import pydantic
+from google.protobuf import json_format
 from google.protobuf import struct_pb2 as structpb
 
 import crossplane.function.proto.v1.run_function_pb2 as fnv1
@@ -38,7 +39,15 @@ def update(r: fnv1.Resource, source: dict | structpb.Struct | pydantic.BaseModel
     """
     match source:
         case pydantic.BaseModel():
-            r.resource.update(source.model_dump(exclude_defaults=True, warnings=False))
+            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)
@@ -57,9 +66,7 @@ def dict_to_struct(d: dict) -> structpb.Struct:
     function makes it possible to work with a Python dict, then convert it to a
     struct in a RunFunctionResponse.
     """
-    s = structpb.Struct()
-    s.update(d)
-    return s
+    return json_format.ParseDict(d, structpb.Struct())
 
 
 def struct_to_dict(s: structpb.Struct) -> dict:
@@ -69,10 +76,7 @@ def struct_to_dict(s: structpb.Struct) -> dict:
     protobuf struct. This function makes it possible to convert resources to a
     dictionary.
     """
-    return {
-        k: (struct_to_dict(v) if isinstance(v, structpb.Struct) else v)
-        for k, v in s.items()
-    }
+    return json_format.MessageToDict(s, preserving_proto_field_name=True)
 
 
 @dataclasses.dataclass
@@ -110,10 +114,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"]:
@@ -149,9 +153,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.5.0 → crossplane_function_sdk_python-0.7.0}/crossplane/function/runtime.py

@@ -16,6 +16,7 @@
 
 import asyncio
 import os
+import signal
 
 import grpc
 from grpc_reflection.v1alpha import reflection
@@ -31,6 +32,8 @@ SERVICE_NAMES = (
     fnv1beta1.DESCRIPTOR.services_by_name["FunctionRunnerService"].full_name,
 )
 
+SHUTDOWN_GRACE_PERIOD_SECONDS = 5
+
 
 def load_credentials(tls_certs_dir: str) -> grpc.ServerCredentials:
     """Load TLS credentials for a composition function gRPC server.
@@ -90,6 +93,11 @@ def serve(
 
     server = grpc.aio.server()
 
+    loop.add_signal_handler(
+        signal.SIGTERM,
+        lambda: asyncio.ensure_future(server.stop(grace=SHUTDOWN_GRACE_PERIOD_SECONDS)),
+    )
+
     grpcv1.add_FunctionRunnerServiceServicer_to_server(function, server)
     grpcv1beta1.add_FunctionRunnerServiceServicer_to_server(
         BetaFunctionRunner(wrapped=function), server
@@ -116,7 +124,7 @@ def serve(
     try:
         loop.run_until_complete(start())
     finally:
-        loop.run_until_complete(server.stop(grace=5))
+        loop.run_until_complete(server.stop(grace=SHUTDOWN_GRACE_PERIOD_SECONDS))
         loop.close()
 
 

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/pyproject.toml

@@ -14,14 +14,15 @@ classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.11",
+  "Typing :: Typed",
 ]
 
 dependencies = [
-  "grpcio==1.*",
+  "grpcio==1.71.0",
   "grpcio-reflection==1.*",
-  "protobuf==5.27.2",
+  "protobuf==5.29.3", # Must be compatible with grpcio-tools.
   "pydantic==2.*",
-  "structlog==24.*",
+  "structlog==25.*",
 ]
 
 dynamic = ["version"]
@@ -38,13 +39,16 @@ validate-bump = false                       # Allow going from 0.0.0.dev0+x to 0
 [tool.hatch.envs.default]
 type = "virtual"
 path = ".venv-default"
-dependencies = ["ipython==8.28.0"]
+dependencies = ["ipython==9.1.0"]
 
 [tool.hatch.envs.generate]
 type = "virtual"
 detached = true
 path = ".venv-generate"
-dependencies = ["grpcio-tools==1.66.2"]
+dependencies = [
+  "grpcio-tools==1.71.0",
+  "protobuf==5.29.3",
+]
 
 [tool.hatch.envs.generate.scripts]
 protoc = "python -m grpc_tools.protoc --proto_path=. --python_out=. --pyi_out=. --grpc_python_out=. crossplane/function/proto/v1beta1/run_function.proto crossplane/function/proto/v1/run_function.proto"
@@ -62,8 +66,8 @@ packages = ["crossplane"]
 
 # This special environment is used by hatch fmt.
 [tool.hatch.envs.hatch-static-analysis]
-dependencies = ["ruff==0.6.9"]
-config-path = "none"           # Disable Hatch's default Ruff config.
+dependencies = ["ruff==0.11.6"]
+config-path = "none"            # Disable Hatch's default Ruff config.
 
 [tool.ruff]
 target-version = "py311"

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/tests/test_resource.py

@@ -90,7 +90,11 @@ class TestResource(unittest.TestCase):
                 ),
                 want=fnv1.Resource(
                     resource=resource.dict_to_struct(
-                        {"spec": {"forProvider": {"region": "us-west-2"}}}
+                        {
+                            "apiVersion": "s3.aws.upbound.io/v1beta2",
+                            "kind": "Bucket",
+                            "spec": {"forProvider": {"region": "us-west-2"}},
+                        }
                     ),
                 ),
             ),
@@ -244,6 +248,66 @@ class TestResource(unittest.TestCase):
                 dataclasses.asdict(case.want), dataclasses.asdict(got), "-want, +got"
             )
 
+    def test_dict_to_struct(self) -> None:
+        @dataclasses.dataclass
+        class TestCase:
+            reason: str
+            d: dict
+            want: structpb.Struct
+
+        cases = [
+            TestCase(
+                reason="Convert an empty dictionary to a struct.",
+                d={},
+                want=structpb.Struct(),
+            ),
+            TestCase(
+                reason="Convert a dictionary with a single field to a struct.",
+                d={"foo": "bar"},
+                want=structpb.Struct(
+                    fields={"foo": structpb.Value(string_value="bar")}
+                ),
+            ),
+            TestCase(
+                reason="Convert a nested dictionary to a struct.",
+                d={"foo": {"bar": "baz"}},
+                want=structpb.Struct(
+                    fields={
+                        "foo": structpb.Value(
+                            struct_value=structpb.Struct(
+                                fields={"bar": structpb.Value(string_value="baz")}
+                            )
+                        )
+                    }
+                ),
+            ),
+            TestCase(
+                reason="Convert a nested dictionary containing lists to a struct.",
+                d={"foo": {"bar": ["baz", "qux"]}},
+                want=structpb.Struct(
+                    fields={
+                        "foo": structpb.Value(
+                            struct_value=structpb.Struct(
+                                fields={
+                                    "bar": structpb.Value(
+                                        list_value=structpb.ListValue(
+                                            values=[
+                                                structpb.Value(string_value="baz"),
+                                                structpb.Value(string_value="qux"),
+                                            ]
+                                        )
+                                    )
+                                }
+                            )
+                        )
+                    }
+                ),
+            ),
+        ]
+        for case in cases:
+            got = resource.dict_to_struct(case.d)
+            self.assertEqual(case.want, got, "-want, +got")
+
     def test_struct_to_dict(self) -> None:
         @dataclasses.dataclass
         class TestCase:
@@ -275,6 +339,28 @@ class TestResource(unittest.TestCase):
                 ),
                 want={"foo": {"bar": "baz"}},
             ),
+            TestCase(
+                reason="Convert a nested struct containing ListValues to a dictionary.",
+                s=structpb.Struct(
+                    fields={
+                        "foo": structpb.Value(
+                            struct_value=structpb.Struct(
+                                fields={
+                                    "bar": structpb.Value(
+                                        list_value=structpb.ListValue(
+                                            values=[
+                                                structpb.Value(string_value="baz"),
+                                                structpb.Value(string_value="qux"),
+                                            ]
+                                        )
+                                    )
+                                }
+                            )
+                        )
+                    }
+                ),
+                want={"foo": {"bar": ["baz", "qux"]}},
+            ),
         ]
 
         for case in cases:

{crossplane_function_sdk_python-0.5.0 → crossplane_function_sdk_python-0.7.0}/tests/testdata/models/io/upbound/aws/s3/v1beta2.py

@@ -759,11 +759,11 @@ class Status(BaseModel):
 
 
 class Bucket(BaseModel):
-    apiVersion: Optional[str] = None
+    apiVersion: Optional[str] = 's3.aws.upbound.io/v1beta2'
     """
     APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
     """
-    kind: Optional[str] = None
+    kind: Optional[str] = 'Bucket'
     """
     Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
     """