omnata-plugin-runtime 0.5.0a113__tar.gz → 0.5.2__tar.gz

{omnata_plugin_runtime-0.5.0a113 → omnata_plugin_runtime-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.5.0a113
+Version: 0.5.2
 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.5.0a113 → omnata_plugin_runtime-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.5.0-a113"
+version = "0.5.2"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.5.0a113 → omnata_plugin_runtime-0.5.2}/src/omnata_plugin_runtime/configuration.py

@@ -8,7 +8,7 @@ from typing import Any, List, Dict, Literal, Union, Optional
 from enum import Enum
 
 from abc import ABC
-from pydantic import BaseModel, Field, PrivateAttr, validator  # pylint: disable=no-name-in-module
+from pydantic import BaseModel, Field, PrivateAttr, SerializationInfo, model_serializer, validator  # pylint: disable=no-name-in-module
 
 if tuple(sys.version_info[:2]) >= (3, 9):
     # Python 3.9 and above
@@ -110,16 +110,18 @@ class OutboundSyncAction(SubscriptableBaseModel, ABC):
                     **STANDARD_OUTBOUND_SYNC_ACTIONS[data["action_name"]]().__dict__,
                 }
         super().__init__(**data)
-
-    def dict(self, *args, trim: bool = True, **kwargs) -> Dict[str, any]:
-        """
-        OutboundSyncStrategy objects can be serialized much smaller if the instance is of a Standard strategy that resides in the
-        Omnata plugin runtime. This method trims out the unneeded attributes in these scenarios.
-        This method also trims the actions for this strategy if it's a custom one.
-
-        """
-        excluded_fields = {} if not trim or self.custom_action else {"description"}
-        return super().dict(exclude=excluded_fields)
+    
+    @model_serializer(mode='wrap')
+    def ser_model(self,handler,info:SerializationInfo) -> Dict[str, Any]:
+        serialized:Dict[str,Any] = handler(self)
+        if not self.custom_action and (info.exclude_none is None or info.exclude_none == False):
+            return {k:v for k,v in serialized.items() if k not in [
+                "description"]}
+        return serialized
+    
+    def model_dump_no_trim(self) -> Dict[str, Any]:
+        # we use our own special include value to signal not to trim
+        return self.model_dump(exclude_none=True)
 
 
 class CreateSyncAction(OutboundSyncAction):
@@ -221,13 +223,13 @@ class OutboundSyncStrategy(SubscriptableBaseModel, ABC):
     name: str
     description: str
     icon_source: str = ICON_URL_CODE
-    action_on_record_create: Optional[OutboundSyncAction] = None
-    action_on_record_update: Optional[OutboundSyncAction] = None
-    action_on_record_delete: Optional[OutboundSyncAction] = None
-    action_on_record_unchanged: Optional[OutboundSyncAction] = None
+    action_on_record_create: Optional[OutboundSyncAction] = Field(default=None)
+    action_on_record_update: Optional[OutboundSyncAction] = Field(default=None)
+    action_on_record_delete: Optional[OutboundSyncAction] = Field(default=None)
+    action_on_record_unchanged: Optional[OutboundSyncAction] = Field(default=None)
     custom_strategy: bool = True
 
-    def __eq__(self, other):
+    def __eq__(self, other:OutboundSyncStrategy):
         if hasattr(other, 'custom_strategy') and hasattr(other, 'name'):
             return (
                 self.custom_strategy == other.custom_strategy
@@ -251,27 +253,23 @@ class OutboundSyncStrategy(SubscriptableBaseModel, ABC):
                 }
         super().__init__(**data)
 
-    def dict(self, *args, trim: bool = True, **kwargs) -> Dict[str, any]:
-        """
-        OutboundSyncStrategy objects can be serialized much smaller if the instance is of a Standard strategy that resides in the
-        Omnata plugin runtime. This method trims out the unneeded attributes in these scenarios.
-        This method also trims the actions for this strategy if it's a custom one.
-
-        """
-        excluded_fields = (
-            {}
-            if not trim or self.custom_strategy
-            else {
+    @model_serializer(mode='wrap')
+    def ser_model(self,handler,info:SerializationInfo) -> Dict[str, Any]:
+        serialized:Dict[str,Any] = handler(self)
+        if not self.custom_strategy and (info.exclude_none is None or info.exclude_none == False):
+            return {k:v for k,v in serialized.items() if k not in [
                 "description",
                 "icon_source",
                 "action_on_record_create",
                 "action_on_record_update",
                 "action_on_record_delete",
-                "action_on_record_unchanged",
-            }
-        )
-        return super().dict(exclude=excluded_fields)
-
+                "action_on_record_unchanged"]}
+        return serialized
+    
+    def model_dump_no_trim(self) -> Dict[str, Any]:
+        # we use our own special include value to signal not to trim
+        return self.model_dump(exclude_none=True)
+    
 
 class CreateSyncStrategy(OutboundSyncStrategy):
     """
@@ -424,8 +422,8 @@ class InboundSyncStreamsConfiguration(SubscriptableBaseModel):
     """
 
     include_new_streams: bool
-    new_stream_sync_strategy: Optional[InboundSyncStrategy] = None
-    new_stream_storage_behaviour: Optional[InboundStorageBehaviour] = None
+    new_stream_sync_strategy: Optional[InboundSyncStrategy] = Field(default=None)
+    new_stream_storage_behaviour: Optional[InboundStorageBehaviour] = Field(default=None)
     included_streams: Dict[str, StoredStreamConfiguration]
     excluded_streams: List[str]
     bulk_configuration: InboundSyncBulkConfiguration = InboundSyncBulkConfiguration.CUSTOMIZE
@@ -532,10 +530,10 @@ class ConnectionConfigurationParameters(SubscriptableBaseModel):
     """
 
     connection_method: str
-    connection_parameters: Dict[str, StoredConfigurationValue] = None
-    connection_secrets: Dict[str, StoredConfigurationValue] = None
-    ngrok_tunnel_settings: Optional[NgrokTunnelSettings] = None
-    access_token_secret_name: Optional[str] = None
+    connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    ngrok_tunnel_settings: Optional[NgrokTunnelSettings] = Field(default=None)
+    access_token_secret_name: Optional[str] = Field(default=None)
 
     _snowflake: Optional[Any] = PrivateAttr(  # or use Any to annotate the type and use Field to initialize
         default=None
@@ -608,10 +606,10 @@ class SyncConfigurationParameters(ConnectionConfigurationParameters):
     """
 
     connection_method: str
-    connection_parameters: Dict[str, StoredConfigurationValue] = None
-    connection_secrets: Dict[str, StoredConfigurationValue] = None
-    sync_parameters: Dict[str, StoredConfigurationValue] = None
-    current_form_parameters: Dict[str, StoredConfigurationValue] = None
+    connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    sync_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    current_form_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
 
     def sync_parameter_exists(self, parameter_name: str) -> bool:
         """
@@ -688,12 +686,12 @@ class OutboundSyncConfigurationParameters(SyncConfigurationParameters):
     """
 
     connection_method: str
-    connection_parameters: Dict[str, StoredConfigurationValue] = None
-    connection_secrets: Dict[str, StoredConfigurationValue] = None
-    sync_parameters: Dict[str, StoredConfigurationValue] = None
-    current_form_parameters: Dict[str, StoredConfigurationValue] = None
-    sync_strategy: OutboundSyncStrategy = None
-    field_mappings: StoredMappingValue = None
+    connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    sync_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    current_form_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    sync_strategy: Optional[OutboundSyncStrategy] = Field(default=None)
+    field_mappings: Optional[StoredMappingValue] = Field(default=None)
 
 
 class InboundSyncConfigurationParameters(SyncConfigurationParameters):
@@ -708,11 +706,11 @@ class InboundSyncConfigurationParameters(SyncConfigurationParameters):
     """
 
     connection_method: str
-    connection_parameters: Dict[str, StoredConfigurationValue] = None
-    connection_secrets: Dict[str, StoredConfigurationValue] = None
-    sync_parameters: Dict[str, StoredConfigurationValue] = None
-    current_form_parameters: Dict[str, StoredConfigurationValue] = None
-    currently_selected_streams: List[str] = None
+    connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    sync_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    current_form_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
+    currently_selected_streams: Optional[List[str]] = Field(default=None)
 
 
 class StoredJinjaTemplate(SubscriptableBaseModel):
@@ -722,7 +720,7 @@ class StoredJinjaTemplate(SubscriptableBaseModel):
     """
 
     mapper_type: Literal["jinja_template"] = "jinja_template"
-    additional_column_expressions: Dict[str, str] = {}
+    additional_column_expressions: Dict[str, str] = Field(default={})
     jinja_template: str
 
 
@@ -759,11 +757,11 @@ class SyncScheduleSnowflakeTask(SubscriptableBaseModel):
     mode: Literal["snowflake_task"] = "snowflake_task"
     sync_frequency: str
     sync_frequency_name: Literal["1 min", "5 mins", "15 mins", "Hourly", "Daily","Custom"]
-    warehouse: str = None
+    warehouse: Optional[str] = Field(default=None)
     time_limit_mins: int = 60 * 4
-    daily_hour: Optional[int] = None
-    daily_minute: Optional[int] = None
-    minute_of_hour: Optional[int] = None
+    daily_hour: Optional[int] = Field(default=None)
+    daily_minute: Optional[int] = Field(default=None)
+    minute_of_hour: Optional[int] = Field(default=None)
 
 
 class SyncScheduleDbt(SubscriptableBaseModel):

{omnata_plugin_runtime-0.5.0a113 → omnata_plugin_runtime-0.5.2}/src/omnata_plugin_runtime/forms.py

@@ -41,10 +41,10 @@ class FormOption(SubscriptableBaseModel):
     value: str
     label: str
     metadata: dict = Field(default_factory=dict)
-    required: bool = False
-    unique: bool = False
-    default: bool = False
-    disabled: bool = False
+    required: bool = Field(default=False)
+    unique: bool = Field(default=False)
+    default: bool = Field(default=False)
+    disabled: bool = Field(default=False)
     data_type_icon: str = "unknown"
 
 
@@ -55,12 +55,12 @@ class FormInputField(SubscriptableBaseModel):
 
     name: str
     label: str
-    default_value: Union[str, bool] = ""
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
-    secret: bool = False
+    default_value: Union[str, bool] = Field(default="")
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
+    secret: bool = Field(default=False)
     type: Literal["input"] = "input"
 
 
@@ -81,15 +81,15 @@ class FormTextAreaField(SubscriptableBaseModel):
 
     name: str
     label: str
-    default_value: str = ""
-    secret: bool = False
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
+    default_value: str = Field(default="")
+    secret: bool = Field(default=False)
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
     type: Literal["textarea"] = "textarea"
 
-    variables: bool = False
+    variables: bool = Field(default=False)
 
 class InformationField(SubscriptableBaseModel):
     """
@@ -101,10 +101,10 @@ class InformationField(SubscriptableBaseModel):
     """
     name: str
     markdown_content: str
-    depends_on: Optional[str] = None
+    depends_on: Optional[str] = Field(default=None)
     type: Literal["information"] = "information"
-    reload_on_change: bool = False
-    secret: bool = False
+    reload_on_change: bool = Field(default=False)
+    secret: bool = Field(default=False)
 
 class InformationBoxField(SubscriptableBaseModel):
     """
@@ -119,12 +119,12 @@ class InformationBoxField(SubscriptableBaseModel):
     """
     name: str
     markdown_content: str
-    depends_on: Optional[str] = None
+    depends_on: Optional[str] = Field(default=None)
     type: Literal["information_box"] = "information_box"
-    reload_on_change: bool = False
+    reload_on_change: bool = Field(default=False)
     box_type: Literal["info", "warning", "error"] = "info"
-    box_icon: Optional[str] = None
-    secret: bool = False
+    box_icon: Optional[str] = Field(default=None)
+    secret: bool = Field(default=False)
 
 class FormSshKeypair(SubscriptableBaseModel):
     """
@@ -132,21 +132,21 @@ class FormSshKeypair(SubscriptableBaseModel):
     """
     name: str
     label: str
-    default_value: Optional[str] = None
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
+    default_value: Optional[str] = Field(default=None)
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
     local_side: Literal["public", "private"] = "public"
     """
     The side of the keypair which belongs to Snowflake. This value will be stored as the secret value, and the other side
     can be copied/downloaded only during the connection process.
     """
-    allow_user_provided: bool = True
+    allow_user_provided: bool = Field(default=True)
     """
     Allows the user to provide Snowflake's side of the keypair, for cases where one is generated on the outside
     """
     type: Literal["ssh_keypair"] = "ssh_keypair"
-    secret: bool = True
+    secret: bool = Field(default=True)
 
 class FormX509Certificate(SubscriptableBaseModel):
     """
@@ -155,12 +155,12 @@ class FormX509Certificate(SubscriptableBaseModel):
     """
     name: str
     label: str
-    default_value: Optional[str] = None
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
+    default_value: Optional[str] = Field(default=None)
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
     type: Literal["x509_certificate"] = "x509_certificate"
-    secret: bool = True
+    secret: bool = Field(default=True)
 
 class FormGpgKeypair(SubscriptableBaseModel):
     """
@@ -169,21 +169,21 @@ class FormGpgKeypair(SubscriptableBaseModel):
 
     name: str
     label: str
-    default_value: Optional[str] = None
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
+    default_value: Optional[str] = Field(default=None)
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
     local_side: Literal["public", "private"] = "public"
     """
     The side of the keypair which belongs to Snowflake. This value will be stored as the secret value, and the other side
     can be copied/downloaded only during the connection process.
     """
-    allow_user_provided: bool = True
+    allow_user_provided: bool = Field(default=True)
     """
     Allows the user to provide Snowflake's side of the keypair, for cases where one is generated on the outside
     """
     type: Literal["gpg_keypair"] = "gpg_keypair"
-    secret: bool = True
+    secret: bool = Field(default=True)
 
 
 class FormCheckboxField(SubscriptableBaseModel):
@@ -193,12 +193,12 @@ class FormCheckboxField(SubscriptableBaseModel):
 
     name: str
     label: str
-    default_value: bool = False
-    required: bool = False
-    secret: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
+    default_value: bool = Field(default=False)
+    required: bool = Field(default=False)
+    secret: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
     type: Literal["checkbox"] = "checkbox"
 
 
@@ -209,17 +209,17 @@ class FormSliderField(SubscriptableBaseModel):
 
     name: str
     label: str
-    default_value: Optional[str] = None
-    secret: bool = False
-    required: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
+    default_value: Optional[str] = Field(default=None)
+    secret: bool = Field(default=False)
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
     type: Literal["slider"] = "slider"
 
-    min_value: int = 0
-    max_value: int = 100
-    step_size: int = 1
+    min_value: int = Field(default=0)
+    max_value: int = Field(default=100)
+    step_size: int = Field(default=1)
 
 
 class FormJinjaTemplate(SubscriptableBaseModel):
@@ -229,7 +229,7 @@ class FormJinjaTemplate(SubscriptableBaseModel):
 
     mapper_type: Literal["jinja_template"] = "jinja_template"
     label: str = "Jinja Template"
-    depends_on: Optional[str] = None
+    depends_on: Optional[str] = Field(default=None)
 
 
 # ----------------------------------------------------------------------------
@@ -249,7 +249,7 @@ class StaticFormOptionsDataSource(SubscriptableBaseModel):
     """
 
     values: List[FormOption] = Field(default_factory=list)
-    new_option_creator: Optional[NewOptionCreator] = None
+    new_option_creator: Optional[NewOptionCreator] = Field(default=None)
     type: Literal["static"] = "static"
 
 
@@ -261,7 +261,7 @@ class DynamicFormOptionsDataSource(SubscriptableBaseModel):
     source_function: Union[
         Callable[[SyncConfigurationParameters], List[FormOption]], str
     ]
-    new_option_creator: Optional[NewOptionCreator] = None
+    new_option_creator: Optional[NewOptionCreator] = Field(default=None)
     type: Literal["dynamic"] = "dynamic"
 
     @validator("source_function", always=True)
@@ -299,12 +299,12 @@ class FormRadioField(FormFieldWithDataSource, BaseModel):
 
     name: str
     label: str
-    default_value: Optional[str] = None
-    required: bool = False
-    secret: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
+    default_value: Optional[str] = Field(default=None)
+    required: bool = Field(default=False)
+    secret: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
     type: Literal["radio"] = "radio"
 
 
@@ -316,15 +316,15 @@ class FormDropdownField(FormFieldWithDataSource, BaseModel):
 
     name: str
     label: str
-    default_value: Optional[str] = None
-    required: bool = False
-    secret: bool = False
-    depends_on: Optional[str] = None
-    help_text: str = ""
-    reload_on_change: bool = False
+    default_value: Optional[str] = Field(default=None)
+    required: bool = Field(default=False)
+    secret: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
     type: Literal["dropdown"] = "dropdown"
 
-    multi_select: bool = False
+    multi_select: bool = Field(default=False)
 
 
 FormFieldBase = Annotated[
@@ -374,7 +374,7 @@ class NewOptionCreator(SubscriptableBaseModel):
     construct_form_option: Union[
         Callable[[StoredConfigurationValue], FormOption], str
     ]
-    allow_create: bool = True
+    allow_create: bool = Field(default=True)
 
     @validator("creation_form_function", always=True)
     def function_name_convertor(cls, v) -> str:
@@ -404,7 +404,7 @@ class FormFieldMappingSelector(FormFieldWithDataSource, BaseModel):
 
     mapper_type: Literal["field_mapping_selector"] = "field_mapping_selector"
     label: str = "Field Mappings"
-    depends_on: Optional[str] = None
+    depends_on: Optional[str] = Field(default=None)
 
 
 Mapper = Annotated[
@@ -420,7 +420,7 @@ class OutboundSyncConfigurationForm(ConfigurationFormBase):
     to map Snowflake columns to app fields/payloads.
     """
 
-    mapper: Optional[Mapper] = None
+    mapper: Optional[Mapper] = Field(default=None)
 
 
 class InboundSyncConfigurationForm(ConfigurationFormBase):
@@ -436,24 +436,24 @@ class SecurityIntegrationTemplateAuthorizationCode(BaseModel):
     Provides values used to populate a security integration instructions template, which
     in turn allows the customer to create an OAuth based secret object
     """
-    oauth_docs_url: Optional[str] = None
+    oauth_docs_url: Optional[str] = Field(default=None)
     oauth_grant: Literal["authorization_code"] = "authorization_code"
-    oauth_client_id: str = '<client id>'
-    oauth_client_secret: str = '<client secret>'
-    oauth_token_endpoint: str = '<token endpoint>'
-    oauth_authorization_endpoint: str = '<authorization endpoint>'
-    oauth_allowed_scopes: List[str] = []
+    oauth_client_id: str = Field(default='<client id>')
+    oauth_client_secret: str = Field(default='<client secret>')
+    oauth_token_endpoint: str = Field(default='<token endpoint>')
+    oauth_authorization_endpoint: str = Field(default='<authorization endpoint>')
+    oauth_allowed_scopes: List[str] = Field(default=[])
 
 class SecurityIntegrationTemplateClientCredentials(BaseModel):
     """
     Provides values used to populate a security integration instructions template, which
     in turn allows the customer to create an OAuth based secret object
     """
-    oauth_docs_url: Optional[str] = None
+    oauth_docs_url: Optional[str] = Field(default=None)
     oauth_grant: Literal["client_credentials"] = "client_credentials"
-    oauth_client_id: str = '<client id>'
-    oauth_client_secret: str = '<client secret>'
-    oauth_token_endpoint: str = '<token endpoint>'
+    oauth_client_id: str = Field(default='<client id>')
+    oauth_client_secret: str = Field(default='<client secret>')
+    oauth_token_endpoint: str = Field(default='<token endpoint>')
     oauth_allowed_scopes: List[str] = []
 
 SecurityIntegrationTemplate = Annotated[
@@ -465,7 +465,7 @@ class NGrokMTLSTunnel(SubscriptableBaseModel):
     """
     Designates a ConnectionMethod as connecting via an ngrok tunnel.
     """
-    SupportEdgeTermination: bool = True
+    SupportEdgeTermination: bool = Field(default=True)
     post_tunnel_fields_function: Union[
         Callable[[ConnectionConfigurationParameters], List[FormFieldBase]], str
     ]
@@ -488,6 +488,6 @@ class ConnectionMethod(SubscriptableBaseModel):
 
     name: str
     fields: List[FormFieldBase]
-    oauth_template: Optional[SecurityIntegrationTemplate] = None
-    ngrok_tunnel_configuration: Optional[NGrokMTLSTunnel] = None
-    description: str = ""
+    oauth_template: Optional[SecurityIntegrationTemplate] = Field(default=None)
+    ngrok_tunnel_configuration: Optional[NGrokMTLSTunnel] = Field(default=None)
+    description: str = Field(default="")

{omnata_plugin_runtime-0.5.0a113 → omnata_plugin_runtime-0.5.2}/src/omnata_plugin_runtime/plugin_entrypoints.py

@@ -32,6 +32,7 @@ from .omnata_plugin import (
     OutboundSyncRequest,
     DeadlineReachedException,
 )
+from pydantic import TypeAdapter
 from .rate_limiting import ApiLimits, RateLimitState
 
 # set the logger class to our custom logger so that pydantic errors are handled correctly
@@ -233,7 +234,7 @@ class PluginEntrypoint:
                     stream_errors=omnata_log_handler.stream_global_errors,
                     total_records_estimate=inbound_sync_request._total_records_estimate
                 )
-                return_dict["final_progress_update"] = final_progress_update.dict()
+                return_dict["final_progress_update"] = final_progress_update.model_dump()
                 if inbound_sync_request.deadline_reached:
                     # if we actually hit the deadline, this is flagged by the cancellation checking worker and the cancellation
                     # token is set. We throw it here as an error since that's currently how it flows back to the engine with a DELAYED state
@@ -305,10 +306,10 @@ class PluginEntrypoint:
         )
         script_result = the_function(parameters)
         if isinstance(script_result, BaseModel):
-            script_result = script_result.dict()
+            script_result = script_result.model_dump()
         elif isinstance(script_result, List):
             if len(script_result) > 0 and isinstance(script_result[0], BaseModel):
-                script_result = [r.dict() for r in script_result]
+                script_result = [r.model_dump() for r in script_result]
         return script_result
         
     def inbound_list_streams(
@@ -341,10 +342,10 @@ class PluginEntrypoint:
 
         script_result = self._plugin_instance.inbound_stream_list(parameters)
         if isinstance(script_result, BaseModel):
-            script_result = script_result.dict()
+            script_result = script_result.model_dump()
         elif isinstance(script_result, List):
             if len(script_result) > 0 and isinstance(script_result[0], BaseModel):
-                script_result = [r.dict() for r in script_result]
+                script_result = [r.model_dump() for r in script_result]
         return script_result
 
 
@@ -365,17 +366,17 @@ class PluginEntrypoint:
             script_result = the_function(stored_value)
             if not isinstance(script_result, FormOption):
                 raise ValueError(f"Expected a FormOption from function {function_name}, got {type(script_result)}")
-            results.append(script_result.dict())
+            results.append(script_result.model_dump())
         return results
 
     def connection_form(self):
         logger.info("Entered connection_form method")
         form: List[ConnectionMethod] = self._plugin_instance.connection_form()
-        return [f.dict() for f in form]
+        return [f.model_dump() for f in form]
 
     def create_billing_events(self, session, event_request: Dict):
         logger.info("Entered create_billing_events method")
-        request = BillingEventRequest.model_validate(event_request)
+        request = TypeAdapter(BillingEventRequest).validate_python(event_request)
         events: List[SnowflakeBillingEvent] = self._plugin_instance.create_billing_events(
             request
         )
@@ -408,7 +409,7 @@ class PluginEntrypoint:
                     logger.warn('Billing event creation failed due to running internally to Omnata')
                 else:
                     raise e
-        return [e.dict() for e in events]
+        return [e.model_dump() for e in events]
 
     def get_secrets(
         self, oauth_secret_name: Optional[str], other_secrets_name: Optional[str]
@@ -461,7 +462,7 @@ class PluginEntrypoint:
         script_result = the_function(parameters)
         if isinstance(script_result, List):
             if len(script_result) > 0 and isinstance(script_result[0], BaseModel):
-                script_result = [r.dict() for r in script_result]
+                script_result = [r.model_dump() for r in script_result]
         else:
             raise ValueError(f"Expected a List from function {function_name}, got {type(script_result)}")
         return script_result
@@ -531,7 +532,7 @@ class PluginEntrypoint:
                 f"alter network rule {network_rule_name} set value_list = ({rule_values_string})"
             ).collect()
 
-        return connect_response.dict()
+        return connect_response.model_dump()
 
     def api_limits(self,
                    method:str,
@@ -564,7 +565,7 @@ class PluginEntrypoint:
         # There's a bit of parsing here that could possibly be done outside of the handler function, but this shouldn't be too expensive
         sync_parameters: Dict[str, StoredConfigurationValue] = TypeAdapter(
             Dict[str, StoredConfigurationValue]).validate_python(sync_parameters)
-        field_mappings: StoredMappingValue = StoredMappingValue.model_validate(field_mappings)
+        field_mappings: StoredMappingValue = TypeAdapter(StoredMappingValue).validate_python(field_mappings)
         return self._plugin_instance.outbound_record_validator(
             sync_parameters, field_mappings, transformed_record, source_types
         )

{omnata_plugin_runtime-0.5.0a113 → omnata_plugin_runtime-0.5.2}/src/omnata_plugin_runtime/rate_limiting.py

@@ -178,10 +178,9 @@ class RateLimitState(SubscriptableBaseModel):
         [],
         description="A list of timestamps where previous requests have been made, used to calculate the next request time",
     )
-    
-    _request_timestamps_lock: threading.Lock = PrivateAttr(  # or use Any to annotate the type and use Field to initialize
-        default_factory=lambda: threading.Lock()
-    )
+    # can't set this as a class variable because it's not serializable
+    # TODO: probably shouldn't mix models with functionality like this
+    _request_timestamps_lock: Optional[threading.Lock] = None
 
     @field_serializer('wait_until',when_used='always')
     def serialize_wait_until(self, value:Optional[datetime.datetime]) -> Optional[int]:
@@ -253,6 +252,8 @@ class RateLimitState(SubscriptableBaseModel):
         You only need to use this if your HTTP requests are not automatically being
         registered, which happens if http.client.HTTPConnection is not being used.
         """
+        if self._request_timestamps_lock is None:
+            self._request_timestamps_lock = threading.Lock()
         with self._request_timestamps_lock:
             append_time = datetime.datetime.now(datetime.timezone.utc)
             if self.previous_request_timestamps is None: