PyPI - crossplane-function-sdk-python - Versions diffs - 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl - Mend

crossplane-function-sdk-python 0.1.0py3-none-any.whl → 0.3.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

crossplane/function/__version__.py CHANGED Viewed

@@ -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.3.0"

crossplane/function/proto/v1beta1/run_function.proto CHANGED Viewed

@@ -61,6 +61,37 @@ 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;
+  // Optional credentials that this Function may use to communicate with an
+  // external system.
+  map <string, Credentials> credentials = 7;
+}
+// Credentials that a Function may use to communicate with an external system.
+message Credentials {
+  // Source of the credentials.
+  oneof source {
+    // Credential data loaded by Crossplane, for example from a Secret.
+    CredentialData credential_data = 1;
+  }
+}
+// CredentialData loaded by Crossplane, for example from a Secret.
+message CredentialData {
+  map<string, bytes> data = 1;
+}
+// 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 +119,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 +131,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
@@ -199,4 +256,4 @@ enum Severity {
   // Normal results are emitted as normal events and debug logs associated
   // with the composite resource.
   SEVERITY_NORMAL = 3;
-}
+}

crossplane/function/proto/v1beta1/run_function_pb2.py CHANGED Viewed

@@ -1,6 +1,7 @@
 # -*- 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.1
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -15,39 +16,71 @@ 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')
+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\"\xb0\x05\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\x12X\n\x0b\x63redentials\x18\x07 \x03(\x0b\x32\x43.apiextensions.fn.proto.v1beta1.RunFunctionRequest.CredentialsEntry\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\x1a_\n\x10\x43redentialsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12:\n\x05value\x18\x02 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.Credentials:\x02\x38\x01\x42\x08\n\x06_inputB\n\n\x08_context\"b\n\x0b\x43redentials\x12I\n\x0f\x63redential_data\x18\x01 \x01(\x0b\x32..apiextensions.fn.proto.v1beta1.CredentialDataH\x00\x42\x08\n\x06source\"\x85\x01\n\x0e\x43redentialData\x12\x46\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32\x38.apiextensions.fn.proto.v1beta1.CredentialData.DataEntry\x1a+\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"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
-  _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_EXTRARESOURCESENTRY']._options = None
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._options = None
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_options = b'8\001'
+  _globals['_CREDENTIALDATA_DATAENTRY']._options = None
+  _globals['_CREDENTIALDATA_DATAENTRY']._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=2670
+  _globals['_READY']._serialized_end=2733
+  _globals['_SEVERITY']._serialized_start=2735
+  _globals['_SEVERITY']._serialized_end=2834
   _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
+  _globals['_RUNFUNCTIONREQUEST']._serialized_end=839
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_start=624
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_end=720
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_start=722
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_end=817
+  _globals['_CREDENTIALS']._serialized_start=841
+  _globals['_CREDENTIALS']._serialized_end=939
+  _globals['_CREDENTIALDATA']._serialized_start=942
+  _globals['_CREDENTIALDATA']._serialized_end=1075
+  _globals['_CREDENTIALDATA_DATAENTRY']._serialized_start=1032
+  _globals['_CREDENTIALDATA_DATAENTRY']._serialized_end=1075
+  _globals['_RESOURCES']._serialized_start=1077
+  _globals['_RESOURCES']._serialized_end=1145
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_start=1148
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_end=1469
+  _globals['_REQUESTMETA']._serialized_start=1471
+  _globals['_REQUESTMETA']._serialized_end=1497
+  _globals['_REQUIREMENTS']._serialized_start=1500
+  _globals['_REQUIREMENTS']._serialized_end=1710
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_start=1607
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_end=1710
+  _globals['_RESOURCESELECTOR']._serialized_start=1713
+  _globals['_RESOURCESELECTOR']._serialized_end=1866
+  _globals['_MATCHLABELS']._serialized_start=1869
+  _globals['_MATCHLABELS']._serialized_end=2002
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_start=1957
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_end=2002
+  _globals['_RESPONSEMETA']._serialized_start=2004
+  _globals['_RESPONSEMETA']._serialized_end=2084
+  _globals['_STATE']._serialized_start=2087
+  _globals['_STATE']._serialized_end=2320
+  _globals['_STATE_RESOURCESENTRY']._serialized_start=2230
+  _globals['_STATE_RESOURCESENTRY']._serialized_end=2320
+  _globals['_RESOURCE']._serialized_start=2323
+  _globals['_RESOURCE']._serialized_end=2581
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_start=2525
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_end=2581
+  _globals['_RESULT']._serialized_start=2583
+  _globals['_RESULT']._serialized_end=2668
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_start=2837
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_end=2982
 # @@protoc_insertion_point(module_scope)

crossplane/function/proto/v1beta1/run_function_pb2.pyi CHANGED Viewed

@@ -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,122 @@ SEVERITY_WARNING: Severity
 SEVERITY_NORMAL: Severity
 class RunFunctionRequest(_message.Message):
-    __slots__ = ["meta", "observed", "desired", "input", "context"]
+    __slots__ = ("meta", "observed", "desired", "input", "context", "extra_resources", "credentials")
+    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: ...
+    class CredentialsEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: Credentials
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[Credentials, _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]
+    CREDENTIALS_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]
+    credentials: _containers.MessageMap[str, Credentials]
+    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]] = ..., credentials: _Optional[_Mapping[str, Credentials]] = ...) -> None: ...
+class Credentials(_message.Message):
+    __slots__ = ("credential_data",)
+    CREDENTIAL_DATA_FIELD_NUMBER: _ClassVar[int]
+    credential_data: CredentialData
+    def __init__(self, credential_data: _Optional[_Union[CredentialData, _Mapping]] = ...) -> None: ...
+class CredentialData(_message.Message):
+    __slots__ = ("data",)
+    class DataEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: bytes
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[bytes] = ...) -> None: ...
+    DATA_FIELD_NUMBER: _ClassVar[int]
+    data: _containers.ScalarMap[str, bytes]
+    def __init__(self, data: _Optional[_Mapping[str, bytes]] = ...) -> 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 +152,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 +167,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 +184,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/resource.py CHANGED Viewed

@@ -106,3 +106,24 @@ def get_condition(resource: structpb.Struct, typ: str) -> Condition:
         return condition
     return unknown
+@dataclasses.dataclass
+class Credentials:
+    """Credentials."""
+    type: str
+    data: dict
+def get_credentials(req: structpb.Struct, name: str) -> Credentials:
+    """Get the supplied credentials."""
+    empty = Credentials(type="data", data={})
+    if "credentials" not in req:
+        return empty
+    if name not in req["credentials"]:
+        return empty
+    return Credentials(
+        type=req["credentials"][name]["type"],
+        data=struct_to_dict(req["credentials"][name]["data"]),
+    )

crossplane/function/runtime.py CHANGED Viewed

@@ -82,6 +82,9 @@ def serve(
     If insecure is true requests will be served insecurely, even if credentials
     are supplied.
     """
+    # Define the loop before the server so everything uses the same loop.
+    loop = asyncio.get_event_loop()
     server = grpc.aio.server()
     grpcv1beta1.add_FunctionRunnerServiceServicer_to_server(function, server)
@@ -104,7 +107,6 @@ def serve(
         await server.start()
         await server.wait_for_termination()
-    loop = asyncio.get_event_loop()
     try:
         loop.run_until_complete(start())
     finally:

{crossplane_function_sdk_python-0.1.0.dist-info → crossplane_function_sdk_python-0.3.0.dist-info}/METADATA RENAMED Viewed

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: crossplane-function-sdk-python
-Version: 0.1.0
+Version: 0.3.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.3.0.dist-info/RECORD ADDED Viewed

@@ -0,0 +1,13 @@
+crossplane/function/__version__.py,sha256=tqA7NsKI87Qs9KuV6_27-GU8EBOe0-jcyYictk-vtqM,704
+crossplane/function/logging.py,sha256=Zawqq36FBzjkVg4bJ3VGK12-so7N8yAMoSPrhdwpBSA,2503
+crossplane/function/resource.py,sha256=41u-aZ6TZB0cBMMU8JABPR0PSqevLJLh_rWvXOkbn1c,3759
+crossplane/function/response.py,sha256=fYJcPz5ZVN06hbNWXzy0tBTOMHNYQvj3m9JjWb2qRU8,2429
+crossplane/function/runtime.py,sha256=7-fWdxK__vbEjy6jQTnoYxtCa_bax50-qJXZP5Fz3nM,3505
+crossplane/function/proto/v1beta1/run_function.proto,sha256=hDZgaavZ_NAAZH0OBDMJjGKpUCptQeFORviIqVXO_tA,9841
+crossplane/function/proto/v1beta1/run_function_pb2.py,sha256=wVTF4w88n6TYgmZvVHE_AcB06HtHGqmCsOxH_fW9guI,9136
+crossplane/function/proto/v1beta1/run_function_pb2.pyi,sha256=xitztFrrlLvArYum_uaNV_WZNGjcb8FT0hdHOx6K3e0,8901
+crossplane/function/proto/v1beta1/run_function_pb2_grpc.py,sha256=iLQTF8CHQzjZlBGJUJTWPTfNSmm3ew02zGf6OPIsxVY,3026
+crossplane_function_sdk_python-0.3.0.dist-info/METADATA,sha256=JmN799wI7T6k3oxFWoPAS46ywnfEKDLsTnsJEvI7U48,3160
+crossplane_function_sdk_python-0.3.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+crossplane_function_sdk_python-0.3.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+crossplane_function_sdk_python-0.3.0.dist-info/RECORD,,

{crossplane_function_sdk_python-0.1.0.dist-info → crossplane_function_sdk_python-0.3.0.dist-info}/WHEEL RENAMED Viewed

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

crossplane_function_sdk_python-0.1.0.dist-info/RECORD DELETED Viewed

@@ -1,13 +0,0 @@
-crossplane/function/__version__.py,sha256=WSXqJJ_BxokLA53mrcW73RxV0JfgGyb-2r2658HHVjw,704
-crossplane/function/logging.py,sha256=Zawqq36FBzjkVg4bJ3VGK12-so7N8yAMoSPrhdwpBSA,2503
-crossplane/function/resource.py,sha256=DJhangADTadAcjemKFSirTZcmeCraCzp9XeD_fdyDKw,3251
-crossplane/function/response.py,sha256=fYJcPz5ZVN06hbNWXzy0tBTOMHNYQvj3m9JjWb2qRU8,2429
-crossplane/function/runtime.py,sha256=Nh-nn9bAkfOoXepTTzhNs5nMH8a7JaMfSE2dP5-0E7U,3430
-crossplane/function/proto/v1beta1/run_function.proto,sha256=3PRKNtZnVII9IfuH9vTVBw8i-_xMIQLQquEvU5TxaH4,7996
-crossplane/function/proto/v1beta1/run_function_pb2.py,sha256=Dg-N-BFSXEwUKViUjK7M5_1mElAp7l34Kjhu1hfGUX0,5125
-crossplane/function/proto/v1beta1/run_function_pb2.pyi,sha256=V9r_wwTfVZ_3F3ICJEq86RgKyYN1xaPCrkMQ6GC1OPk,4927
-crossplane/function/proto/v1beta1/run_function_pb2_grpc.py,sha256=iLQTF8CHQzjZlBGJUJTWPTfNSmm3ew02zGf6OPIsxVY,3026
-crossplane_function_sdk_python-0.1.0.dist-info/METADATA,sha256=HDOYsG0zyFELRP-kMB5B2qefsRJ_9A9PgF4us7TNRas,2518
-crossplane_function_sdk_python-0.1.0.dist-info/WHEEL,sha256=mRYSEL3Ih6g5a_CVMIcwiF__0Ae4_gLYh01YFNwiq1k,87
-crossplane_function_sdk_python-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-crossplane_function_sdk_python-0.1.0.dist-info/RECORD,,

{crossplane_function_sdk_python-0.1.0.dist-info → crossplane_function_sdk_python-0.3.0.dist-info}/licenses/LICENSE RENAMED Viewed

File without changes

crossplane-function-sdk-python 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

crossplane-function-sdk-python 0.1.0py3-none-any.whl → 0.3.0py3-none-any.whl