omnata-plugin-runtime 0.1.87__py3-none-any.whl → 0.1.89__py3-none-any.whl

omnata_plugin_runtime/configuration.py

@@ -565,14 +565,15 @@ class SyncConfigurationParameters(ConnectionConfigurationParameters):
         self, parameter_name: str, default_value: Optional[str] = None
     ) -> StoredConfigurationValue:
         """
-        Retrieves a connection parameter, which was collected during connection configuration.
-        What you can expect to retrieve is based on the form definition returned by your connection_form function (form fields returned with secret=False).
+        Retrieves a parameter from the current form. The "current form" refers to a temporary form which is not part of the final sync configuration,
+        such as a new option creator for a data source.
+        What you can expect to retrieve is based on the form definition returned by your NewOptionCreator's creation form function.
 
         :param str parameter_name: The name of the parameter
         :param str default_value: A default value to return if the parameter does not exist
         :return: the configuration value, which contains a string property named "value", and a metadata dict
         :rtype: StoredConfigurationValue
-        :raises ValueError: if a connection parameter by that name does not exist
+        :raises ValueError: if a form parameter by that name does not exist, and no default was provided
         """
         if parameter_name not in self.current_form_parameters.keys():
             if default_value is not None:
@@ -584,7 +585,8 @@ class SyncConfigurationParameters(ConnectionConfigurationParameters):
 
     def condense_current_form_parameters(self, exclude_fields: List[str]) -> dict:
         """
-        Takes a dictionary representing a completed form, and condenses it into a simple dictionary containing just the values of each field
+        Takes a dictionary representing a completed form, and condenses it into a simple dictionary containing just the values of each field.
+        This is useful for building a metadata object that typically accompanies a value in a StoredConfigurationValue.
         """
         return_dict = {}
         for dict_key in self.current_form_parameters.keys():

omnata_plugin_runtime/forms.py

@@ -19,6 +19,7 @@ from .configuration import (
     StreamConfiguration,
     SyncConfigurationParameters,
     InboundSyncConfigurationParameters,
+    StoredConfigurationValue,
 )
 
 
@@ -325,14 +326,20 @@ class ConfigurationFormBase(BaseModel, ABC):
 class NewOptionCreator(SubscriptableBaseModel):
     """
     Allows for options to be added to a datasource by the user.
-    It does this by presenting the user with a form, then building a FormOption from the provided values.
+    It does this by presenting the user with a form, then building a StoredConfigurationValue from the provided values.
+    Since this StoredConfigurationValue won't be present in the data source (at least not initially), there is
+    also a function (construct_form_option) to convert the StoredConfigurationValue into a FormOption which can be added to the data source.
+    This means that all the presentation options (e.g. required, unique) must be derivable from the metadata in StoredConfigurationValue.
     """
 
     creation_form_function: Union[
         Callable[[SyncConfigurationParameters], ConfigurationFormBase], str
     ]
     creation_complete_function: Union[
-        Callable[[SyncConfigurationParameters], FormOption], str
+        Callable[[SyncConfigurationParameters], StoredConfigurationValue], str
+    ]
+    construct_form_option: Union[
+        Callable[[StoredConfigurationValue], FormOption], str
     ]
     allow_create: bool = True
 

{omnata_plugin_runtime-0.1.87.dist-info → omnata_plugin_runtime-0.1.89.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.1.87
+Version: 0.1.89
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.1.87.dist-info → omnata_plugin_runtime-0.1.89.dist-info}/RECORD

@@ -1,12 +1,12 @@
 omnata_plugin_runtime/__init__.py,sha256=w63LVME5nY-hQ4BBzfacy9kvTunwqHGs8iiSPGAX2ns,1214
 omnata_plugin_runtime/api.py,sha256=vCDTCxPZ5rIhi8aSM6Z0TXWHtGpbCoNvCnM3mKa-47Q,5591
-omnata_plugin_runtime/configuration.py,sha256=7P1g8ryOqiXULhKnosAp_uS-h4bZP7i0VZOQ3Izmsac,29513
-omnata_plugin_runtime/forms.py,sha256=AEj74Wko89zBSgucVfPRctU-MI-AuYsIOEBDPhDi6Hc,15050
+omnata_plugin_runtime/configuration.py,sha256=xtPp0ET1Gdgk4zjklWwXLNuczVZ_rMhaKDS5c9ZCwVU,29744
+omnata_plugin_runtime/forms.py,sha256=85T2LVFHg3w2PPNi9ug9mOd3blkYB3ajhZhXaBHEXp8,15600
 omnata_plugin_runtime/logging.py,sha256=ne1sLh5cBkjdRS54B30PGc5frABgjy0sF1_2RMcJ_Tk,3012
 omnata_plugin_runtime/omnata_plugin.py,sha256=x4Vvd1a8FNNiQNiURFuhp8s7FIuJgX03xR5d_iNTxK0,74287
 omnata_plugin_runtime/plugin_entrypoints.py,sha256=m1wrGf_uYxJNuv2N5r5QoyPWtor98bYGIBunocHWoIc,21652
 omnata_plugin_runtime/rate_limiting.py,sha256=OnFnCdMenpMpAZYumpe6mypRnMmDl1Q02vzlgmQgiw0,10733
-omnata_plugin_runtime-0.1.87.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-omnata_plugin_runtime-0.1.87.dist-info/METADATA,sha256=XF7SxK_67K6zWREm91HMdOW9lAg5pYnph-YoMCVfvnY,1086
-omnata_plugin_runtime-0.1.87.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-omnata_plugin_runtime-0.1.87.dist-info/RECORD,,
+omnata_plugin_runtime-0.1.89.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+omnata_plugin_runtime-0.1.89.dist-info/METADATA,sha256=IP9fv2rD02MuH4d-kG7zZ0MmfIpUJ7UwM8nekqul4-I,1086
+omnata_plugin_runtime-0.1.89.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+omnata_plugin_runtime-0.1.89.dist-info/RECORD,,