sapiopycommons 2024.12.12a382__py3-none-any.whl → 2024.12.13a385__py3-none-any.whl

sapiopycommons/callbacks/callback_util.py

@@ -1163,7 +1163,7 @@ class FieldModifier:
         """
         field = copy_field(field)
         if self.prepend_data_type is True:
-            field._data_field_name = field.data_field_name + "." + field.data_field_name
+            field._data_field_name = field.data_type_name + "." + field.data_field_name
         if self.display_name is not None:
             field.display_name = self.display_name
         if self.required is not None:

sapiopycommons/webhook/webservice_handlers.py

@@ -15,6 +15,7 @@ from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelMana
 from sapiopylib.rest.utils.recordmodel.ancestry import RecordModelAncestorManager
 from werkzeug.datastructures import Headers
 from werkzeug.datastructures.structures import MultiDict
+from werkzeug.exceptions import UnsupportedMediaType, BadRequest
 
 from sapiopycommons.general.exceptions import SapioException
 from sapiopycommons.recordmodel.record_handler import RecordHandler
@@ -73,11 +74,54 @@ class SapioWebserviceResult:
 WebserviceResponse = SapioWebserviceResult | Response | tuple[dict[str, Any] | int]
 
 
-class BaseAuthenticatorClass(AbstractWebhookHandler, ABC):
+class AbstractWebserviceHandler(AbstractWebhookHandler):
     """
-    The base class for classes that may need to authenticate a SapioUser object for interacting with a Sapio server
-    through the webservice API.
+    A base class for constructing POST webservice endpoints on your webhook server. These are endpoints that can be
+    communicated with by external sources without needing to format the request in the webhook context format that
+    normal webhook handlers expect.
+
+    Since this extends AbstractWebhookHandler, you can still register endpoints from this class in the same way you
+    would normal webhook endpoints.
     """
+    request: Request
+
+    def post(self) -> Response | tuple[dict[str, Any], int]:
+        """
+        Internal method to be executed to translate incoming POST requests.
+        """
+        # noinspection PyBroadException
+        try:
+            self.request = request
+            try:
+                raw_json = request.json
+                headers = request.headers
+                params = request.args
+            except UnsupportedMediaType as e:
+                return SapioWebserviceResult(str(e), 415, True).to_json(), 415
+            except BadRequest as e:
+                return SapioWebserviceResult(str(e), 400, True).to_json(), 400
+            ret_val: WebserviceResponse = self.run(raw_json, headers, params)
+            if isinstance(ret_val, SapioWebserviceResult):
+                return ret_val.to_result()
+            return ret_val
+        except Exception:
+            print('Error occurred while running webservice custom logic. See traceback.', file=sys.stderr)
+            traceback.print_exc()
+            return SapioWebserviceResult("Unexpected error occurred.", 500, True).to_json(), 500
+
+    # noinspection PyMethodOverriding
+    @abstractmethod
+    def run(self, payload: Any, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
+        """
+        The execution details for this endpoint.
+
+        :param payload: The JSON payload from the request. Usually a dictionary of strings to Any.
+        :param headers: The headers from the request. Can be used like a dictionary.
+        :param params: The URL parameters from the request.
+        :return: A response object to send back to the requester.
+        """
+        pass
+
     def authenticate_user(self, headers: dict[str, str]) -> SapioUser:
         """
         Authenticate a user for making requests to a Sapio server using the provided headers. If no user can be
@@ -144,90 +188,10 @@ class BaseAuthenticatorClass(AbstractWebhookHandler, ABC):
         return SapioUser(url, self.verify_sapio_cert, self.client_timeout_seconds, bearer_token=bearer_token)
 
 
-class AbstractWebservicePostHandler(BaseAuthenticatorClass):
-    """
-    A base class for constructing POST webservice endpoints on your webhook server. These are endpoints that can be
-    communicated with by external sources without needing to format the request in the webhook context format that
-    normal webhook handlers expect.
-
-    Since this extends AbstractWebhookHandler, you can still register endpoints from this class in the same way you
-    would normal webhook endpoints.
-    """
-    request: Request
-
-    def post(self) -> Response | tuple[dict[str, Any], int]:
-        """
-        Internal method to be executed to translate incoming POST requests.
-        """
-        # noinspection PyBroadException
-        try:
-            self.request = request
-            ret_val: WebserviceResponse = self.run(request.json, request.headers, request.args)
-            if isinstance(ret_val, SapioWebserviceResult):
-                return ret_val.to_result()
-            return ret_val
-        except Exception:
-            print('Error occurred while running webservice custom logic. See traceback.', file=sys.stderr)
-            traceback.print_exc()
-            return SapioWebserviceResult("Unexpected error occurred.", 500, True).to_json(), 500
-
-    # noinspection PyMethodOverriding
-    @abstractmethod
-    def run(self, payload: Any, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
-        """
-        The execution details for this endpoint.
-
-        :param payload: The JSON payload from the request. Usually a dictionary of strings to Any.
-        :param headers: The headers from the request. Can be used like a dictionary.
-        :param params: The URL parameters from the request.
-        :return: A response object to send back to the requester.
-        """
-        pass
-
-
-class AbstractWebserviceGetHandler(BaseAuthenticatorClass):
-    """
-    A base class for constructing GET webservice endpoints on your webhook server. These are endpoints that can be
-    communicated with by external sources without needing to format the request in the webhook context format that
-    normal webhook handlers expect.
-
-    Since this extends AbstractWebhookHandler, you can still register endpoints from this class in the same way you
-    would normal webhook endpoints.
-    """
-    request: Request
-
-    def get(self) -> Response | tuple[dict[str, Any], int]:
-        """
-        Internal method to be executed to translate incoming GET requests.
-        """
-        # noinspection PyBroadException
-        try:
-            self.request = request
-            ret_val: WebserviceResponse = self.run(request.headers, request.args)
-            if isinstance(ret_val, SapioWebserviceResult):
-                return ret_val.to_result()
-            return ret_val
-        except Exception:
-            print('Error occurred while running webservice custom logic. See traceback.', file=sys.stderr)
-            traceback.print_exc()
-            return SapioWebserviceResult("Unexpected error occurred.", 500, True).to_json(), 500
-
-    # noinspection PyMethodOverriding
-    @abstractmethod
-    def run(self, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
-        """
-        The execution details for this endpoint.
-
-        :param headers: The headers from the request. Can be used like a dictionary.
-        :param params: The URL parameters from the request.
-        :return: A response object to send back to the requester.
-        """
-        pass
-
-
-class CommonsWebserviceBaseHandler(BaseAuthenticatorClass, ABC):
+class CommonsWebserviceHandler(AbstractWebserviceHandler, ABC):
     """
-    A base class for all commons webservice handlers.
+    A subclass of AbstractWebservicePostHandler that provides additional quality of life features, including
+    authentication of a SapioUser from the request headers, initialization of various commonly used managers, and more.
     """
     logger: Logger
 
@@ -242,6 +206,18 @@ class CommonsWebserviceBaseHandler(BaseAuthenticatorClass, ABC):
     dt_cache: DataTypeCacheManager
     rec_handler: RecordHandler
 
+    def run(self, payload: Any, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
+        try:
+            self.initialize(headers)
+            result = self.execute(self.user, payload, headers, params)
+            if result is None:
+                raise SapioException("Your execute function returned a None result! Don't forget your return statement!")
+            return result
+        except SapioWebserviceException as e:
+            return self.handle_webservice_exception(e)
+        except Exception as e:
+            return self.handle_unexpected_exception(e)
+
     def initialize(self, headers: Headers) -> None:
         """
         A function that can be optionally overridden by your classes to initialize additional instance variables,
@@ -262,6 +238,20 @@ class CommonsWebserviceBaseHandler(BaseAuthenticatorClass, ABC):
         self.dt_cache = DataTypeCacheManager(self.user)
         self.rec_handler = RecordHandler(self.user)
 
+    @abstractmethod
+    def execute(self, user: SapioUser, payload: Any, headers: Headers, params: MultiDict[str, str]) \
+            -> SapioWebserviceResult:
+        """
+        The execution details for this endpoint.
+
+        :param user: The SapioUser object authenticated from the request headers.
+        :param payload: The JSON payload from the request. Usually a dictionary of strings to Any.
+        :param headers: The headers from the request. Can be used like a dictionary.
+        :param params: The URL parameters from the request.
+        :return: A response object to send back to the requester.
+        """
+        pass
+
     def handle_webservice_exception(self, e: SapioWebserviceException) -> WebserviceResponse:
         """
         Handle a generic exception which isn't one of the handled Sapio exceptions.
@@ -314,73 +304,14 @@ class CommonsWebserviceBaseHandler(BaseAuthenticatorClass, ABC):
         """
         Write an info message to the webhook server log. Log destination is stdout.
         """
-        self.logger.info(msg)
+        # If there's no user, then there's no logger.
+        if self.user:
+            self.logger.info(msg)
 
     def log_error(self, msg: str) -> None:
         """
         Write an error message to the webhook server log. Log destination is stderr.
         """
-        self.logger.error(msg)
-
-
-class CommonsWebservicePostHandler(AbstractWebservicePostHandler, CommonsWebserviceBaseHandler):
-    """
-    A subclass of AbstractWebservicePostHandler that provides additional quality of life features, including
-    authentication of a SapioUser from the request headers, initialization of various commonly used managers, and more.
-    """
-    def run(self, payload: Any, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
-        try:
-            self.initialize(headers)
-            result = self.execute(self.user, payload, headers, params)
-            if result is None:
-                raise SapioException("Your execute function returned a None result! Don't forget your return statement!")
-            return result
-        except SapioWebserviceException as e:
-            return self.handle_webservice_exception(e)
-        except Exception as e:
-            return self.handle_unexpected_exception(e)
-
-    @abstractmethod
-    def execute(self, user: SapioUser, payload: Any, headers: Headers, params: MultiDict[str, str]) \
-            -> SapioWebserviceResult:
-        """
-        The execution details for this endpoint.
-
-        :param user: The SapioUser object authenticated from the request headers.
-        :param payload: The JSON payload from the request. Usually a dictionary of strings to Any.
-        :param headers: The headers from the request. Can be used like a dictionary.
-        :param params: The URL parameters from the request.
-        :return: A response object to send back to the requester.
-        """
-        pass
-
-
-class CommonsWebserviceGetHandler(AbstractWebserviceGetHandler, CommonsWebserviceBaseHandler):
-    """
-    A subclass of AbstractWebserviceGetHandler that provides additional quality of life features, including
-    authentication of a SapioUser from the request headers, initialization of various commonly used managers, and more.
-    """
-    def run(self, headers: Headers, params: MultiDict[str, str]) -> WebserviceResponse:
-        try:
-            self.initialize(headers)
-            result = self.execute(self.user, headers, params)
-            if result is None:
-                raise SapioException("Your execute function returned a None result! Don't forget your return statement!")
-            return result
-        except SapioWebserviceException as e:
-            return self.handle_webservice_exception(e)
-        except Exception as e:
-            return self.handle_unexpected_exception(e)
-
-    @abstractmethod
-    def execute(self, user: SapioUser, headers: Headers, params: MultiDict[str, str]) \
-            -> SapioWebserviceResult:
-        """
-        The execution details for this endpoint.
-
-        :param user: The SapioUser object authenticated from the request headers.
-        :param headers: The headers from the request. Can be used like a dictionary.
-        :param params: The URL parameters from the request.
-        :return: A response object to send back to the requester.
-        """
-        pass
+        # If there's no user, then there's no logger.
+        if self.user:
+            self.logger.error(msg)

{sapiopycommons-2024.12.12a382.dist-info → sapiopycommons-2024.12.13a385.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2024.12.12a382
+Version: 2024.12.13a385
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2024.12.12a382.dist-info → sapiopycommons-2024.12.13a385.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/callbacks/callback_util.py,sha256=nb6cXK8yFq96gtG0Z2NiK-qdNaRh88bavUH-ZoBjh18,67953
+sapiopycommons/callbacks/callback_util.py,sha256=2pGr14f_FVCqeF6dsbYP1e4cOsaUTQyQ7XVwZuUkM_k,67952
 sapiopycommons/callbacks/field_builder.py,sha256=p2XacN99MuKk3ite8GAqstUMpixqugul2CsC4gB83-o,38620
 sapiopycommons/chem/IndigoMolecules.py,sha256=slM2y39zZFHc468c366EqR8T-GYJ24UnM9HWAqWFEwQ,3900
 sapiopycommons/chem/Molecules.py,sha256=9B4sbwbvYs50XHRn0TZiu-D1Oa3pKrI9qE5vNW8zv-U,12464
@@ -52,8 +52,8 @@ sapiopycommons/sftpconnect/sftp_builder.py,sha256=lFK3FeXk-sFLefW0hqY8WGUQDeYiGa
 sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/webhook/webhook_context.py,sha256=D793uLsb1691SalaPnBUk3rOSxn_hYLhdvkaIxjNXss,1909
 sapiopycommons/webhook/webhook_handlers.py,sha256=MdsVK4bHffkMNmNWl0_qvu-5Lz8-qGu4Ryi7lZO1BZs,18586
-sapiopycommons/webhook/webservice_handlers.py,sha256=AFM2Va9Fpb2BvlFycIUUOdghtGiEv1Ab5jf44yjHSgU,17218
-sapiopycommons-2024.12.12a382.dist-info/METADATA,sha256=mlgkT6CXxsqlKU179ENC20t7D2vtc-PBMXHylDjFlLU,3144
-sapiopycommons-2024.12.12a382.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2024.12.12a382.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2024.12.12a382.dist-info/RECORD,,
+sapiopycommons/webhook/webservice_handlers.py,sha256=Y5dHx_UFWFuSqaoPL6Re-fsKYRuxvCWZ8bj6KSZ3jfM,14285
+sapiopycommons-2024.12.13a385.dist-info/METADATA,sha256=s27na5Zc8V-FkzNFV7UeyJYmlWL3k-6VVtSiebeEb4Q,3144
+sapiopycommons-2024.12.13a385.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2024.12.13a385.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2024.12.13a385.dist-info/RECORD,,