crossplane-function-sdk-python 0.1.0__tar.gz → 0.2.0__tar.gz

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/.github/workflows/ci.yml

@@ -12,6 +12,19 @@ on:
         description: PyPI project version (e.g. v0.1.0)
         required: false
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run
+# in-progress and latest queued. However, do NOT cancel in-progress runs as we
+# want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
 env:
   # Common versions
   PYTHON_VERSION: '3.11.5'
@@ -113,3 +126,36 @@ jobs:
           # be enabled, which makes sharing the account hard. We're waiting for
           # a crossplane org to be approved.
           password: ${{ secrets.PYPI_API_TOKEN }}
+
+
+  docs:
+    # The simple docs tool we're using doesn't support versions, so our docs
+    # will only reflect what's in main.
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Setup Hatch
+        run: pipx install hatch==1.7.0
+
+      - name: Build Documentation
+        run: hatch run docs:pdoc -d google crossplane/function -o docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# We don't commit our docs - instead we generate them and upload to GitHub pages.
+docs

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crossplane-function-sdk-python
-Version: 0.1.0
+Version: 0.2.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,11 +14,12 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
 Requires-Dist: grpcio-reflection==1.*
 Requires-Dist: grpcio==1.*
-Requires-Dist: structlog==23.*
+Requires-Dist: structlog==24.*
 Description-Content-Type: text/markdown
 
 # function-sdk-python
-[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python)
+[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml) [![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python)](https://github.com/crossplane/function-sdk-python/releases) [![PyPI - Version](https://img.shields.io/pypi/v/crossplane-function-sdk-python)](https://pypi.org/project/crossplane-function-sdk-python/)
+
 
 The [Python][python] SDK for writing [composition functions][functions].
 
@@ -28,14 +29,18 @@ guidelines] as Crossplane.
 
 To learn how to use this SDK:
 
+* [Follow the guide to writing a composition function in Python][function guide]
 * [Learn about how composition functions work][functions]
-* [Learn about Python code generated from protocol buffers][python-protobuf]
+* [Read the package documentation][package docs]
 
 The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
 are generated from a proto3 protocol buffer schema. Their fields behave
 similarly to built-in Python types like lists and dictionaries, but there are
-some differences. Read the generated code documentation to familiarize yourself
-with the the differences.
+some differences. Read the [generated code documentation][python-protobuf] to
+familiarize yourself with the the differences.
+
+If you just want to jump in and get started, consider using the
+[function-template-python] template repository.
 
 ## Contributing
 
@@ -61,5 +66,8 @@ hatch build
 [python]: https://python.org
 [functions]: https://docs.crossplane.io/latest/concepts/composition-functions
 [python-protobuf]: https://protobuf.dev/reference/python/python-generated/
+[function-template-python]: https://github.com/crossplane/function-template-python
+[function guide]: https://docs.crossplane.io/knowledge-base/guides/write-a-composition-function-in-python
+[package docs]: https://crossplane.github.io/function-sdk-python
 [contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
 [hatch]: https://github.com/pypa/hatch

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/README.md

@@ -1,5 +1,6 @@
 # function-sdk-python
-[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python)
+[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml) [![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python)](https://github.com/crossplane/function-sdk-python/releases) [![PyPI - Version](https://img.shields.io/pypi/v/crossplane-function-sdk-python)](https://pypi.org/project/crossplane-function-sdk-python/)
+
 
 The [Python][python] SDK for writing [composition functions][functions].
 
@@ -9,14 +10,18 @@ guidelines] as Crossplane.
 
 To learn how to use this SDK:
 
+* [Follow the guide to writing a composition function in Python][function guide]
 * [Learn about how composition functions work][functions]
-* [Learn about Python code generated from protocol buffers][python-protobuf]
+* [Read the package documentation][package docs]
 
 The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
 are generated from a proto3 protocol buffer schema. Their fields behave
 similarly to built-in Python types like lists and dictionaries, but there are
-some differences. Read the generated code documentation to familiarize yourself
-with the the differences.
+some differences. Read the [generated code documentation][python-protobuf] to
+familiarize yourself with the the differences.
+
+If you just want to jump in and get started, consider using the
+[function-template-python] template repository.
 
 ## Contributing
 
@@ -42,5 +47,8 @@ hatch build
 [python]: https://python.org
 [functions]: https://docs.crossplane.io/latest/concepts/composition-functions
 [python-protobuf]: https://protobuf.dev/reference/python/python-generated/
+[function-template-python]: https://github.com/crossplane/function-template-python
+[function guide]: https://docs.crossplane.io/knowledge-base/guides/write-a-composition-function-in-python
+[package docs]: https://crossplane.github.io/function-sdk-python
 [contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
 [hatch]: https://github.com/pypa/hatch

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.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.1.0"
+__version__ = "0.2.0"

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/crossplane/function/proto/v1beta1/run_function.proto

@@ -61,6 +61,19 @@ message RunFunctionRequest {
   // and that context will be passed to subsequent Functions. Crossplane
   // discards all context returned by the last Function in the pipeline.
   optional google.protobuf.Struct context = 5;
+
+  // Optional extra resources that the Function required.
+  // Note that extra resources is a map to Resources, plural.
+  // The map key corresponds to the key in a RunFunctionResponse's
+  // extra_resources field. If a Function requested extra resources that
+  // did not exist, Crossplane sets the map key to an empty Resources message to
+  // indicate that it attempted to satisfy the request.
+  map<string, Resources> extra_resources = 6;
+}
+
+// Resources represents the state of several Crossplane resources.
+message Resources {
+  repeated Resource items = 1;
 }
 
 // A RunFunctionResponse contains the result of a Composition Function run.
@@ -88,6 +101,9 @@ message RunFunctionResponse {
   // Optional context to be passed to the next Function in the pipeline as part
   // of the RunFunctionRequest. Dropped on the last function in the pipeline.
   optional google.protobuf.Struct context = 4;
+
+  // Requirements that must be satisfied for this Function to run successfully.
+  Requirements requirements = 5;
 }
 
 // RequestMeta contains metadata pertaining to a RunFunctionRequest.
@@ -97,6 +113,29 @@ message RequestMeta {
   string tag = 1;
 }
 
+// Requirements that must be satisfied for a Function to run successfully.
+message Requirements {
+  // Extra resources that this Function requires.
+  // The map key uniquely identifies the group of resources.
+  map<string, ResourceSelector> extra_resources = 1;
+}
+
+// ResourceSelector selects a group of resources, either by name or by label.
+message ResourceSelector {
+  string api_version = 1;
+  string kind = 2;
+
+  oneof match {
+    string match_name = 3;
+    MatchLabels match_labels = 4;
+  }
+}
+
+// MatchLabels defines a set of labels to match resources against.
+message MatchLabels {
+  map<string, string> labels = 1;
+}
+
 // ResponseMeta contains metadata pertaining to a RunFunctionResponse.
 message ResponseMeta {
   // An opaque string identifying the content of the request. Must match the

crossplane_function_sdk_python-0.2.0/crossplane/function/proto/v1beta1/run_function_pb2.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: crossplane/function/proto/v1beta1/run_function.proto
+# Protobuf Python Version: 4.25.0
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n4crossplane/function/proto/v1beta1/run_function.proto\x12\x1e\x61piextensions.fn.proto.v1beta1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1egoogle/protobuf/duration.proto\"\xf5\x03\n\x12RunFunctionRequest\x12\x39\n\x04meta\x18\x01 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.RequestMeta\x12\x37\n\x08observed\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x36\n\x07\x64\x65sired\x18\x03 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12+\n\x05input\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12-\n\x07\x63ontext\x18\x05 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x12_\n\x0f\x65xtra_resources\x18\x06 \x03(\x0b\x32\x46.apiextensions.fn.proto.v1beta1.RunFunctionRequest.ExtraResourcesEntry\x1a`\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x38\n\x05value\x18\x02 \x01(\x0b\x32).apiextensions.fn.proto.v1beta1.Resources:\x02\x38\x01\x42\x08\n\x06_inputB\n\n\x08_context\"D\n\tResources\x12\x37\n\x05items\x18\x01 \x03(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\"\xc1\x02\n\x13RunFunctionResponse\x12:\n\x04meta\x18\x01 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.ResponseMeta\x12\x36\n\x07\x64\x65sired\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x37\n\x07results\x18\x03 \x03(\x0b\x32&.apiextensions.fn.proto.v1beta1.Result\x12-\n\x07\x63ontext\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12\x42\n\x0crequirements\x18\x05 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.RequirementsB\n\n\x08_context\"\x1a\n\x0bRequestMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\"\xd2\x01\n\x0cRequirements\x12Y\n\x0f\x65xtra_resources\x18\x01 \x03(\x0b\x32@.apiextensions.fn.proto.v1beta1.Requirements.ExtraResourcesEntry\x1ag\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12?\n\x05value\x18\x02 \x01(\x0b\x32\x30.apiextensions.fn.proto.v1beta1.ResourceSelector:\x02\x38\x01\"\x99\x01\n\x10ResourceSelector\x12\x13\n\x0b\x61pi_version\x18\x01 \x01(\t\x12\x0c\n\x04kind\x18\x02 \x01(\t\x12\x14\n\nmatch_name\x18\x03 \x01(\tH\x00\x12\x43\n\x0cmatch_labels\x18\x04 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.MatchLabelsH\x00\x42\x07\n\x05match\"\x85\x01\n\x0bMatchLabels\x12G\n\x06labels\x18\x01 \x03(\x0b\x32\x37.apiextensions.fn.proto.v1beta1.MatchLabels.LabelsEntry\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"P\n\x0cResponseMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\x12+\n\x03ttl\x18\x02 \x01(\x0b\x32\x19.google.protobuf.DurationH\x00\x88\x01\x01\x42\x06\n\x04_ttl\"\xe9\x01\n\x05State\x12;\n\tcomposite\x18\x01 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\x12G\n\tresources\x18\x02 \x03(\x0b\x32\x34.apiextensions.fn.proto.v1beta1.State.ResourcesEntry\x1aZ\n\x0eResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x37\n\x05value\x18\x02 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource:\x02\x38\x01\"\x82\x02\n\x08Resource\x12)\n\x08resource\x18\x01 \x01(\x0b\x32\x17.google.protobuf.Struct\x12[\n\x12\x63onnection_details\x18\x02 \x03(\x0b\x32?.apiextensions.fn.proto.v1beta1.Resource.ConnectionDetailsEntry\x12\x34\n\x05ready\x18\x03 \x01(\x0e\x32%.apiextensions.fn.proto.v1beta1.Ready\x1a\x38\n\x16\x43onnectionDetailsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"U\n\x06Result\x12:\n\x08severity\x18\x01 \x01(\x0e\x32(.apiextensions.fn.proto.v1beta1.Severity\x12\x0f\n\x07message\x18\x02 \x01(\t*?\n\x05Ready\x12\x15\n\x11READY_UNSPECIFIED\x10\x00\x12\x0e\n\nREADY_TRUE\x10\x01\x12\x0f\n\x0bREADY_FALSE\x10\x02*c\n\x08Severity\x12\x18\n\x14SEVERITY_UNSPECIFIED\x10\x00\x12\x12\n\x0eSEVERITY_FATAL\x10\x01\x12\x14\n\x10SEVERITY_WARNING\x10\x02\x12\x13\n\x0fSEVERITY_NORMAL\x10\x03\x32\x91\x01\n\x15\x46unctionRunnerService\x12x\n\x0bRunFunction\x12\x32.apiextensions.fn.proto.v1beta1.RunFunctionRequest\x1a\x33.apiextensions.fn.proto.v1beta1.RunFunctionResponse\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'crossplane.function.proto.v1beta1.run_function_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._options = None
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._options = None
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_MATCHLABELS_LABELSENTRY']._options = None
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_options = b'8\001'
+  _globals['_STATE_RESOURCESENTRY']._options = None
+  _globals['_STATE_RESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._options = None
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_options = b'8\001'
+  _globals['_READY']._serialized_start=2247
+  _globals['_READY']._serialized_end=2310
+  _globals['_SEVERITY']._serialized_start=2312
+  _globals['_SEVERITY']._serialized_end=2411
+  _globals['_RUNFUNCTIONREQUEST']._serialized_start=151
+  _globals['_RUNFUNCTIONREQUEST']._serialized_end=652
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_start=534
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_end=630
+  _globals['_RESOURCES']._serialized_start=654
+  _globals['_RESOURCES']._serialized_end=722
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_start=725
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_end=1046
+  _globals['_REQUESTMETA']._serialized_start=1048
+  _globals['_REQUESTMETA']._serialized_end=1074
+  _globals['_REQUIREMENTS']._serialized_start=1077
+  _globals['_REQUIREMENTS']._serialized_end=1287
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_start=1184
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_end=1287
+  _globals['_RESOURCESELECTOR']._serialized_start=1290
+  _globals['_RESOURCESELECTOR']._serialized_end=1443
+  _globals['_MATCHLABELS']._serialized_start=1446
+  _globals['_MATCHLABELS']._serialized_end=1579
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_start=1534
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_end=1579
+  _globals['_RESPONSEMETA']._serialized_start=1581
+  _globals['_RESPONSEMETA']._serialized_end=1661
+  _globals['_STATE']._serialized_start=1664
+  _globals['_STATE']._serialized_end=1897
+  _globals['_STATE_RESOURCESENTRY']._serialized_start=1807
+  _globals['_STATE_RESOURCESENTRY']._serialized_end=1897
+  _globals['_RESOURCE']._serialized_start=1900
+  _globals['_RESOURCE']._serialized_end=2158
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_start=2102
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_end=2158
+  _globals['_RESULT']._serialized_start=2160
+  _globals['_RESULT']._serialized_end=2245
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_start=2414
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_end=2559
+# @@protoc_insertion_point(module_scope)

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/crossplane/function/proto/v1beta1/run_function_pb2.pyi

@@ -9,13 +9,13 @@ from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Map
 DESCRIPTOR: _descriptor.FileDescriptor
 
 class Ready(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
-    __slots__ = []
+    __slots__ = ()
     READY_UNSPECIFIED: _ClassVar[Ready]
     READY_TRUE: _ClassVar[Ready]
     READY_FALSE: _ClassVar[Ready]
 
 class Severity(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
-    __slots__ = []
+    __slots__ = ()
     SEVERITY_UNSPECIFIED: _ClassVar[Severity]
     SEVERITY_FATAL: _ClassVar[Severity]
     SEVERITY_WARNING: _ClassVar[Severity]
@@ -29,39 +29,94 @@ SEVERITY_WARNING: Severity
 SEVERITY_NORMAL: Severity
 
 class RunFunctionRequest(_message.Message):
-    __slots__ = ["meta", "observed", "desired", "input", "context"]
+    __slots__ = ("meta", "observed", "desired", "input", "context", "extra_resources")
+    class ExtraResourcesEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: Resources
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[Resources, _Mapping]] = ...) -> None: ...
     META_FIELD_NUMBER: _ClassVar[int]
     OBSERVED_FIELD_NUMBER: _ClassVar[int]
     DESIRED_FIELD_NUMBER: _ClassVar[int]
     INPUT_FIELD_NUMBER: _ClassVar[int]
     CONTEXT_FIELD_NUMBER: _ClassVar[int]
+    EXTRA_RESOURCES_FIELD_NUMBER: _ClassVar[int]
     meta: RequestMeta
     observed: State
     desired: State
     input: _struct_pb2.Struct
     context: _struct_pb2.Struct
-    def __init__(self, meta: _Optional[_Union[RequestMeta, _Mapping]] = ..., observed: _Optional[_Union[State, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., input: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+    extra_resources: _containers.MessageMap[str, Resources]
+    def __init__(self, meta: _Optional[_Union[RequestMeta, _Mapping]] = ..., observed: _Optional[_Union[State, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., input: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., extra_resources: _Optional[_Mapping[str, Resources]] = ...) -> None: ...
+
+class Resources(_message.Message):
+    __slots__ = ("items",)
+    ITEMS_FIELD_NUMBER: _ClassVar[int]
+    items: _containers.RepeatedCompositeFieldContainer[Resource]
+    def __init__(self, items: _Optional[_Iterable[_Union[Resource, _Mapping]]] = ...) -> None: ...
 
 class RunFunctionResponse(_message.Message):
-    __slots__ = ["meta", "desired", "results", "context"]
+    __slots__ = ("meta", "desired", "results", "context", "requirements")
     META_FIELD_NUMBER: _ClassVar[int]
     DESIRED_FIELD_NUMBER: _ClassVar[int]
     RESULTS_FIELD_NUMBER: _ClassVar[int]
     CONTEXT_FIELD_NUMBER: _ClassVar[int]
+    REQUIREMENTS_FIELD_NUMBER: _ClassVar[int]
     meta: ResponseMeta
     desired: State
     results: _containers.RepeatedCompositeFieldContainer[Result]
     context: _struct_pb2.Struct
-    def __init__(self, meta: _Optional[_Union[ResponseMeta, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., results: _Optional[_Iterable[_Union[Result, _Mapping]]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+    requirements: Requirements
+    def __init__(self, meta: _Optional[_Union[ResponseMeta, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., results: _Optional[_Iterable[_Union[Result, _Mapping]]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., requirements: _Optional[_Union[Requirements, _Mapping]] = ...) -> None: ...
 
 class RequestMeta(_message.Message):
-    __slots__ = ["tag"]
+    __slots__ = ("tag",)
     TAG_FIELD_NUMBER: _ClassVar[int]
     tag: str
     def __init__(self, tag: _Optional[str] = ...) -> None: ...
 
+class Requirements(_message.Message):
+    __slots__ = ("extra_resources",)
+    class ExtraResourcesEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: ResourceSelector
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[ResourceSelector, _Mapping]] = ...) -> None: ...
+    EXTRA_RESOURCES_FIELD_NUMBER: _ClassVar[int]
+    extra_resources: _containers.MessageMap[str, ResourceSelector]
+    def __init__(self, extra_resources: _Optional[_Mapping[str, ResourceSelector]] = ...) -> None: ...
+
+class ResourceSelector(_message.Message):
+    __slots__ = ("api_version", "kind", "match_name", "match_labels")
+    API_VERSION_FIELD_NUMBER: _ClassVar[int]
+    KIND_FIELD_NUMBER: _ClassVar[int]
+    MATCH_NAME_FIELD_NUMBER: _ClassVar[int]
+    MATCH_LABELS_FIELD_NUMBER: _ClassVar[int]
+    api_version: str
+    kind: str
+    match_name: str
+    match_labels: MatchLabels
+    def __init__(self, api_version: _Optional[str] = ..., kind: _Optional[str] = ..., match_name: _Optional[str] = ..., match_labels: _Optional[_Union[MatchLabels, _Mapping]] = ...) -> None: ...
+
+class MatchLabels(_message.Message):
+    __slots__ = ("labels",)
+    class LabelsEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: str
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[str] = ...) -> None: ...
+    LABELS_FIELD_NUMBER: _ClassVar[int]
+    labels: _containers.ScalarMap[str, str]
+    def __init__(self, labels: _Optional[_Mapping[str, str]] = ...) -> None: ...
+
 class ResponseMeta(_message.Message):
-    __slots__ = ["tag", "ttl"]
+    __slots__ = ("tag", "ttl")
     TAG_FIELD_NUMBER: _ClassVar[int]
     TTL_FIELD_NUMBER: _ClassVar[int]
     tag: str
@@ -69,9 +124,9 @@ class ResponseMeta(_message.Message):
     def __init__(self, tag: _Optional[str] = ..., ttl: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...) -> None: ...
 
 class State(_message.Message):
-    __slots__ = ["composite", "resources"]
+    __slots__ = ("composite", "resources")
     class ResourcesEntry(_message.Message):
-        __slots__ = ["key", "value"]
+        __slots__ = ("key", "value")
         KEY_FIELD_NUMBER: _ClassVar[int]
         VALUE_FIELD_NUMBER: _ClassVar[int]
         key: str
@@ -84,9 +139,9 @@ class State(_message.Message):
     def __init__(self, composite: _Optional[_Union[Resource, _Mapping]] = ..., resources: _Optional[_Mapping[str, Resource]] = ...) -> None: ...
 
 class Resource(_message.Message):
-    __slots__ = ["resource", "connection_details", "ready"]
+    __slots__ = ("resource", "connection_details", "ready")
     class ConnectionDetailsEntry(_message.Message):
-        __slots__ = ["key", "value"]
+        __slots__ = ("key", "value")
         KEY_FIELD_NUMBER: _ClassVar[int]
         VALUE_FIELD_NUMBER: _ClassVar[int]
         key: str
@@ -101,7 +156,7 @@ class Resource(_message.Message):
     def __init__(self, resource: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., connection_details: _Optional[_Mapping[str, bytes]] = ..., ready: _Optional[_Union[Ready, str]] = ...) -> None: ...
 
 class Result(_message.Message):
-    __slots__ = ["severity", "message"]
+    __slots__ = ("severity", "message")
     SEVERITY_FIELD_NUMBER: _ClassVar[int]
     MESSAGE_FIELD_NUMBER: _ClassVar[int]
     severity: Severity

{crossplane_function_sdk_python-0.1.0 → crossplane_function_sdk_python-0.2.0}/pyproject.toml

@@ -16,11 +16,7 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
 ]
 
-dependencies = [
-  "grpcio==1.*",
-  "grpcio-reflection==1.*",
-  "structlog==23.*",
-]
+dependencies = ["grpcio==1.*", "grpcio-reflection==1.*", "structlog==24.*"]
 
 dynamic = ["version"]
 
@@ -31,18 +27,18 @@ Source = "https://github.com/crossplane/function-sdk-python"
 
 [tool.hatch.version]
 path = "crossplane/function/__version__.py"
-validate-bump = false # Allow going from 0.0.0.dev0+x to 0.0.0.dev0+y.
+validate-bump = false                       # Allow going from 0.0.0.dev0+x to 0.0.0.dev0+y.
 
 [tool.hatch.envs.default]
 type = "virtual"
 path = ".venv-default"
-dependencies = ["ipython==8.19.0"]
+dependencies = ["ipython==8.21.0"]
 
 [tool.hatch.envs.generate]
 type = "virtual"
 detached = true
 path = ".venv-generate"
-dependencies = ["grpcio-tools==1.60.0"]
+dependencies = ["grpcio-tools==1.60.1"]
 
 [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"
@@ -51,7 +47,7 @@ protoc = "python -m grpc_tools.protoc --proto_path=. --python_out=. --pyi_out=.
 type = "virtual"
 detached = true
 path = ".venv-lint"
-dependencies = ["ruff==0.1.11"]
+dependencies = ["ruff==0.2.2"]
 
 [tool.hatch.envs.lint.scripts]
 check = "ruff check crossplane tests && ruff format --diff crossplane tests"
@@ -63,6 +59,14 @@ path = ".venv-test"
 [tool.hatch.envs.test.scripts]
 unit = "python -m unittest tests/*.py"
 
+[tool.hatch.envs.docs]
+type = "virtual"
+path = ".venv-docs"
+dependencies = ["pdoc"]
+
+[tool.hatch.envs.docs.scripts]
+generate = "pdoc -m google crossplane/function -o docs"
+
 [tool.hatch.build.targets.wheel]
 packages = ["crossplane"]
 

crossplane_function_sdk_python-0.1.0/crossplane/function/proto/v1beta1/run_function_pb2.py

@@ -1,53 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: crossplane/function/proto/v1beta1/run_function.proto
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
-from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n4crossplane/function/proto/v1beta1/run_function.proto\x12\x1e\x61piextensions.fn.proto.v1beta1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1egoogle/protobuf/duration.proto\"\xb2\x02\n\x12RunFunctionRequest\x12\x39\n\x04meta\x18\x01 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.RequestMeta\x12\x37\n\x08observed\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x36\n\x07\x64\x65sired\x18\x03 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12+\n\x05input\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12-\n\x07\x63ontext\x18\x05 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x42\x08\n\x06_inputB\n\n\x08_context\"\xfd\x01\n\x13RunFunctionResponse\x12:\n\x04meta\x18\x01 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.ResponseMeta\x12\x36\n\x07\x64\x65sired\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x37\n\x07results\x18\x03 \x03(\x0b\x32&.apiextensions.fn.proto.v1beta1.Result\x12-\n\x07\x63ontext\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x42\n\n\x08_context\"\x1a\n\x0bRequestMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\"P\n\x0cResponseMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\x12+\n\x03ttl\x18\x02 \x01(\x0b\x32\x19.google.protobuf.DurationH\x00\x88\x01\x01\x42\x06\n\x04_ttl\"\xe9\x01\n\x05State\x12;\n\tcomposite\x18\x01 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\x12G\n\tresources\x18\x02 \x03(\x0b\x32\x34.apiextensions.fn.proto.v1beta1.State.ResourcesEntry\x1aZ\n\x0eResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x37\n\x05value\x18\x02 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource:\x02\x38\x01\"\x82\x02\n\x08Resource\x12)\n\x08resource\x18\x01 \x01(\x0b\x32\x17.google.protobuf.Struct\x12[\n\x12\x63onnection_details\x18\x02 \x03(\x0b\x32?.apiextensions.fn.proto.v1beta1.Resource.ConnectionDetailsEntry\x12\x34\n\x05ready\x18\x03 \x01(\x0e\x32%.apiextensions.fn.proto.v1beta1.Ready\x1a\x38\n\x16\x43onnectionDetailsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"U\n\x06Result\x12:\n\x08severity\x18\x01 \x01(\x0e\x32(.apiextensions.fn.proto.v1beta1.Severity\x12\x0f\n\x07message\x18\x02 \x01(\t*?\n\x05Ready\x12\x15\n\x11READY_UNSPECIFIED\x10\x00\x12\x0e\n\nREADY_TRUE\x10\x01\x12\x0f\n\x0bREADY_FALSE\x10\x02*c\n\x08Severity\x12\x18\n\x14SEVERITY_UNSPECIFIED\x10\x00\x12\x12\n\x0eSEVERITY_FATAL\x10\x01\x12\x14\n\x10SEVERITY_WARNING\x10\x02\x12\x13\n\x0fSEVERITY_NORMAL\x10\x03\x32\x91\x01\n\x15\x46unctionRunnerService\x12x\n\x0bRunFunction\x12\x32.apiextensions.fn.proto.v1beta1.RunFunctionRequest\x1a\x33.apiextensions.fn.proto.v1beta1.RunFunctionResponse\"\x00\x62\x06proto3')
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'crossplane.function.proto.v1beta1.run_function_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-  DESCRIPTOR._options = None
-  _STATE_RESOURCESENTRY._options = None
-  _STATE_RESOURCESENTRY._serialized_options = b'8\001'
-  _RESOURCE_CONNECTIONDETAILSENTRY._options = None
-  _RESOURCE_CONNECTIONDETAILSENTRY._serialized_options = b'8\001'
-  _globals['_READY']._serialized_start=1409
-  _globals['_READY']._serialized_end=1472
-  _globals['_SEVERITY']._serialized_start=1474
-  _globals['_SEVERITY']._serialized_end=1573
-  _globals['_RUNFUNCTIONREQUEST']._serialized_start=151
-  _globals['_RUNFUNCTIONREQUEST']._serialized_end=457
-  _globals['_RUNFUNCTIONRESPONSE']._serialized_start=460
-  _globals['_RUNFUNCTIONRESPONSE']._serialized_end=713
-  _globals['_REQUESTMETA']._serialized_start=715
-  _globals['_REQUESTMETA']._serialized_end=741
-  _globals['_RESPONSEMETA']._serialized_start=743
-  _globals['_RESPONSEMETA']._serialized_end=823
-  _globals['_STATE']._serialized_start=826
-  _globals['_STATE']._serialized_end=1059
-  _globals['_STATE_RESOURCESENTRY']._serialized_start=969
-  _globals['_STATE_RESOURCESENTRY']._serialized_end=1059
-  _globals['_RESOURCE']._serialized_start=1062
-  _globals['_RESOURCE']._serialized_end=1320
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_start=1264
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_end=1320
-  _globals['_RESULT']._serialized_start=1322
-  _globals['_RESULT']._serialized_end=1407
-  _globals['_FUNCTIONRUNNERSERVICE']._serialized_start=1576
-  _globals['_FUNCTIONRUNNERSERVICE']._serialized_end=1721
-# @@protoc_insertion_point(module_scope)