canvas 0.1.14__py3-none-any.whl → 0.1.15__py3-none-any.whl

{canvas-0.1.14.dist-info → canvas-0.1.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: canvas
-Version: 0.1.14
+Version: 0.1.15
 Summary: SDK to customize event-driven actions in your Canvas instance
 License: MIT
 Author: Canvas Team

{canvas-0.1.14.dist-info → canvas-0.1.15.dist-info}/RECORD

@@ -6,7 +6,7 @@ canvas_cli/apps/auth/utils.py,sha256=IH5oZB3pdlb4_FRfCZKkNTncx_kdKagpiBqlhtM8h2U
 canvas_cli/apps/logs/__init__.py,sha256=ehY9SRb6nBw81xZF50yyBlUZJtNR2VeVSNI5sFuWJ7o,64
 canvas_cli/apps/logs/logs.py,sha256=Ixue8Z1wgxABunVIx6TzmsH6oZ0FPf2H51Sd3nFUnAI,1969
 canvas_cli/apps/plugin/__init__.py,sha256=G_nLsu6cdko5OjatnbqUyEboGcNlGGLwpZmCBxMKdfo,236
-canvas_cli/apps/plugin/plugin.py,sha256=irJdh1WGHSnzuBPp2TuKc18dpPtxtvrv9IA5IqgdB4g,11391
+canvas_cli/apps/plugin/plugin.py,sha256=MBA1JAFN6wknm5l1A1Tmb3jXNQj3L_67mLkakp1gRxE,11380
 canvas_cli/apps/plugin/tests.py,sha256=_8fHTGlQermt4AVs20nsTYcs2bDRNEqr9CGE29pD6YQ,1035
 canvas_cli/conftest.py,sha256=pGvVS6VT0Zll_Lp3ezLh2jykOk-2HTBVH8RP5FwLUVw,930
 canvas_cli/main.py,sha256=lUCh5M7u0KJ9CWOL_oPa0J4284ggxHxteURYv6dGU4g,3790
@@ -30,6 +30,9 @@ canvas_cli/utils/validators/__init__.py,sha256=rBvSR2O1hWkNAnUBdcr-zUkmqT796_A61
 canvas_cli/utils/validators/manifest_schema.py,sha256=SIMpr_vTV8dtkO9cjsRnZZtRm5tgGkPR6QewTG8CztI,3117
 canvas_cli/utils/validators/tests.py,sha256=cZHLSx7oteOfLOoU1tXGvw88n6itcvUT2B3ZBg-bmEY,1206
 canvas_cli/utils/validators/validators.py,sha256=RKDKxIvZ1IuCPVuhQ1KHdpwu7aewAqT9ZX-nA-LZDdg,1614
+canvas_generated/data_access_layer/data_access_layer_pb2.py,sha256=zifzwTsVs1pwNoBGEAlX_qJllIruk1gIeUSONQdvbP4,1673
+canvas_generated/data_access_layer/data_access_layer_pb2.pyi,sha256=mJNO3x6UYhPMurn2aGBuYJYS6tFigd3znPknndy4dpk,868
+canvas_generated/data_access_layer/data_access_layer_pb2_grpc.py,sha256=nmmH2hPYLcaAVOK_SMgX1ruZmiQGSJ3aRRnxiUVMftc,2828
 canvas_generated/messages/effects_pb2.py,sha256=NX__XT0xZk3G2zchK-BW5huCVtoZ4jBW-F2hcYNK98Q,4376
 canvas_generated/messages/effects_pb2.pyi,sha256=6YkzAOo6xnbWqxvv4gHdz1K6cz52JVQCRejpLVaX2y0,6640
 canvas_generated/messages/effects_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
@@ -62,7 +65,9 @@ canvas_sdk/commands/tests/test_utils.py,sha256=008nUdp5UCTyyFXI58KSgIofMt9njEbpX
 canvas_sdk/commands/tests/tests.py,sha256=lawX4BKlibIhc04mZJWNsWKSzyVr_fDSrAHIN89pmYo,15613
 canvas_sdk/data/__init__.py,sha256=dmqlcw11-0DCbH2lOebwBCq6njSQ6BDhxygmncUgZRs,28
 canvas_sdk/data/base.py,sha256=XbUctLoEdY8egrPzw_x2Ox41nurubh8sl4Kjbhu8rTE,795
-canvas_sdk/data/patient.py,sha256=IhJxZoQHJPK2O7d7v0UVUTZ_8FYAXZ_sl2BUVvgsztY,130
+canvas_sdk/data/data_access_layer_client.py,sha256=ujd6LnC7IzOvD6_IVpDQOQgaz_ZDtClwUN5j360e0P8,3400
+canvas_sdk/data/exceptions.py,sha256=PRSD0N7AzqajebSK-vfJDaN8BGBEG5WTxejZaEMDZ6Y,305
+canvas_sdk/data/patient.py,sha256=k0pmxkPUYYoHzWWtQf6h1__0cn1dy42NRcFsetMxs3M,742
 canvas_sdk/data/staff.py,sha256=zmwKZlndqFdwsE3j14DD79MSzM9doIkeqqzToGDBjTs,168
 canvas_sdk/data/task.py,sha256=VeOh45M6tQ0IPwPr03yK6EYa8xox3iJhoRBzqUdcq2k,1756
 canvas_sdk/effects/__init__.py,sha256=oChQi5y_8mK2zDiNMwWYp6CaQX1_zbmwXILPF7iSt-4,69
@@ -84,7 +89,7 @@ canvas_sdk/utils/tests.py,sha256=t3MScbIfzXkQttMIvj0dRzJlFVS8LFU8WgWRrChM-H0,193
 canvas_sdk/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 logger/__init__.py,sha256=sf54RfJ48tCbXm5jTHAea3WWuSH5-AXRHxTNNKVuxgA,60
 logger/logger.py,sha256=u103k5-yP62ifK1Hcp-PDTRrw_vOfLGeC-5raxNmBC0,1428
-canvas-0.1.14.dist-info/METADATA,sha256=Wx2__EHrsmOGVYPZj-WQVdJPKgOi8GTc8kN4iiRtiDk,4253
-canvas-0.1.14.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-canvas-0.1.14.dist-info/entry_points.txt,sha256=VSmSo1IZ3aEfL7enmLmlWSraS_IIkoXNVeyXzgRxFiY,46
-canvas-0.1.14.dist-info/RECORD,,
+canvas-0.1.15.dist-info/METADATA,sha256=1sbQDXfVO4ofQAcawRy1drfTEbYzVzUdBzDMz1ZupsU,4253
+canvas-0.1.15.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+canvas-0.1.15.dist-info/entry_points.txt,sha256=VSmSo1IZ3aEfL7enmLmlWSraS_IIkoXNVeyXzgRxFiY,46
+canvas-0.1.15.dist-info/RECORD,,

canvas_cli/apps/plugin/plugin.py

@@ -204,8 +204,8 @@ def enable(
         print(f"Failed to connect to {host}")
         raise typer.Exit(1)
 
-    if r.status_code == requests.codes.no_content:
-        print(r.text)
+    if r.ok:
+        print(f"Plugin {name} successfully enabled!")
     else:
         print(f"Status code {r.status_code}: {r.text}")
         raise typer.Exit(1)
@@ -241,8 +241,8 @@ def disable(
         print(f"Failed to connect to {host}")
         raise typer.Exit(1)
 
-    if r.status_code == requests.codes.no_content:
-        print(r.text)
+    if r.ok:
+        print(f"Plugin {name} successfully disabled!")
     else:
         print(f"Status code {r.status_code}: {r.text}")
         raise typer.Exit(1)

canvas_generated/data_access_layer/data_access_layer_pb2.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: canvas_generated/data_access_layer/data_access_layer.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()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n:canvas_generated/data_access_layer/data_access_layer.proto\"\x10\n\x02ID\x12\n\n\x02id\x18\x01 \x01(\t\"\x8b\x01\n\x07Patient\x12\n\n\x02id\x18\x01 \x01(\t\x12\x17\n\nfirst_name\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x16\n\tlast_name\x18\x03 \x01(\tH\x01\x88\x01\x01\x12\x17\n\nbirth_date\x18\x04 \x01(\tH\x02\x88\x01\x01\x42\r\n\x0b_first_nameB\x0c\n\n_last_nameB\r\n\x0b_birth_date20\n\x0f\x44\x61taAccessLayer\x12\x1d\n\nGetPatient\x12\x03.ID\x1a\x08.Patient\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'canvas_generated.data_access_layer.data_access_layer_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_ID']._serialized_start=62
+  _globals['_ID']._serialized_end=78
+  _globals['_PATIENT']._serialized_start=81
+  _globals['_PATIENT']._serialized_end=220
+  _globals['_DATAACCESSLAYER']._serialized_start=222
+  _globals['_DATAACCESSLAYER']._serialized_end=270
+# @@protoc_insertion_point(module_scope)

canvas_generated/data_access_layer/data_access_layer_pb2.pyi

@@ -0,0 +1,23 @@
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Optional as _Optional
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ID(_message.Message):
+    __slots__ = ("id",)
+    ID_FIELD_NUMBER: _ClassVar[int]
+    id: str
+    def __init__(self, id: _Optional[str] = ...) -> None: ...
+
+class Patient(_message.Message):
+    __slots__ = ("id", "first_name", "last_name", "birth_date")
+    ID_FIELD_NUMBER: _ClassVar[int]
+    FIRST_NAME_FIELD_NUMBER: _ClassVar[int]
+    LAST_NAME_FIELD_NUMBER: _ClassVar[int]
+    BIRTH_DATE_FIELD_NUMBER: _ClassVar[int]
+    id: str
+    first_name: str
+    last_name: str
+    birth_date: str
+    def __init__(self, id: _Optional[str] = ..., first_name: _Optional[str] = ..., last_name: _Optional[str] = ..., birth_date: _Optional[str] = ...) -> None: ...

canvas_generated/data_access_layer/data_access_layer_pb2_grpc.py

@@ -0,0 +1,66 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from canvas_generated.data_access_layer import data_access_layer_pb2 as canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2
+
+
+class DataAccessLayerStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.GetPatient = channel.unary_unary(
+                '/DataAccessLayer/GetPatient',
+                request_serializer=canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.ID.SerializeToString,
+                response_deserializer=canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.Patient.FromString,
+                )
+
+
+class DataAccessLayerServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def GetPatient(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_DataAccessLayerServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'GetPatient': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetPatient,
+                    request_deserializer=canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.ID.FromString,
+                    response_serializer=canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.Patient.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'DataAccessLayer', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class DataAccessLayer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def GetPatient(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/DataAccessLayer/GetPatient',
+            canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.ID.SerializeToString,
+            canvas__generated_dot_data__access__layer_dot_data__access__layer__pb2.Patient.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

canvas_sdk/data/data_access_layer_client.py

@@ -0,0 +1,95 @@
+"""
+Data Access Layer client.
+
+This module is primarily responsible for executing calls to the gRPC service so that such details
+are abstracted away from callers. The return values of the methods on the client class are protobufs
+which must be mapped to user-facing objects.
+"""
+
+import functools
+from collections.abc import Callable
+from types import FunctionType
+from typing import Any
+
+import grpc
+from grpc import StatusCode
+
+from canvas_generated.data_access_layer.data_access_layer_pb2 import ID, Patient
+from canvas_generated.data_access_layer.data_access_layer_pb2_grpc import (
+    DataAccessLayerStub,
+)
+from settings import DAL_TARGET
+
+from . import exceptions
+from .exceptions import DataModuleError
+
+
+class _DataAccessLayerClientMeta(type):
+    """
+    Metaclass for the Data Access Layer client class.
+
+    Wraps all methods of a class with a gRPC error handler.
+    """
+
+    def __new__(cls, name: str, bases: tuple, attrs: dict) -> type:
+        for attr_name, attr_value in attrs.items():
+            if isinstance(attr_value, FunctionType):
+                attrs[attr_name] = cls.handle_grpc_errors(attr_value)
+        return super().__new__(cls, name, bases, attrs)
+
+    @classmethod
+    def handle_grpc_errors(cls, func: Callable[..., Any]) -> Callable[..., Any]:
+        """
+        Decorator that wraps a try-except block around all class methods. gRPC errors are mapped to
+        a defined set of exceptions from a Data Access Layer exception hierarchy.
+        """
+
+        @functools.wraps(func)
+        def wrapper(*args: Any, **kwargs: Any) -> Any:
+            try:
+                return func(*args, **kwargs)
+            except grpc.RpcError as error:
+                # gRPC exceptions aren't tightly defined, so we'll try to get a status code and
+                # error details, and handle it if we can't
+                try:
+                    status_code = error.code()
+                except Exception:
+                    status_code = None
+
+                try:
+                    error_details = error.details()
+                except Exception:
+                    error_details = ""
+
+                # Map more gRPC status codes to exception types as needed
+                match status_code:
+                    case StatusCode.NOT_FOUND:
+                        raise exceptions.DataModuleNotFoundError(error_details) from error
+                    case _:
+                        raise exceptions.DataModuleError from error
+            except Exception as exception:
+                raise DataModuleError from exception
+
+        return wrapper
+
+
+class _DataAccessLayerClient(metaclass=_DataAccessLayerClientMeta):
+    """
+    Data Access Layer client.
+
+    Do not instantiate -- just import the global variable DAL_CLIENT.
+    """
+
+    def __init__(self) -> None:
+        self._channel = grpc.insecure_channel(DAL_TARGET)
+        self._stub = DataAccessLayerStub(self._channel)
+
+    def get_patient(self, id: str) -> Patient:
+        """Given an ID, get the Patient from the Data Access Layer."""
+        return self._stub.GetPatient(ID(id=id))
+
+
+# There should only be one instantiation of the client, so this global will act as a singleton in a
+# way. This is the value that should be imported; no one should be instantiating the DAL client
+# (hence the underscore notation indicating that the class is "private").
+DAL_CLIENT = _DataAccessLayerClient()

canvas_sdk/data/exceptions.py

@@ -0,0 +1,16 @@
+"""Data Access Layer exceptions."""
+
+
+class DataModuleError(RuntimeError):
+    """
+    General Data Access Layer error; base class and also used to represent errors of indeterminate
+    cause.
+    """
+
+    pass
+
+
+class DataModuleNotFoundError(DataModuleError):
+    """Object not found error."""
+
+    pass

canvas_sdk/data/patient.py

@@ -1,6 +1,26 @@
+from datetime import date
+from typing import Self
+
 from canvas_sdk.data import DataModel
 
+from .data_access_layer_client import DAL_CLIENT
+
 
 class Patient(DataModel):
+    """Patient model."""
+
     id: str | None = None
-    # TODO - populate more attributes
+    first_name: str | None = None
+    last_name: str | None = None
+    birth_date: date | None = None
+
+    @classmethod
+    def get(cls, id: str) -> Self:
+        """Given an ID, get the Patient from the Data Access Layer."""
+        patient = DAL_CLIENT.get_patient(id)
+        return cls(
+            id=patient.id,
+            first_name=patient.first_name or None,
+            last_name=patient.last_name or None,
+            birth_date=date.fromisoformat(patient.birth_date) if patient.birth_date else None,
+        )