canvas 0.33.0__py3-none-any.whl → 0.34.0__py3-none-any.whl

canvas_sdk/utils/http.py

@@ -1,5 +1,6 @@
 import concurrent
 import functools
+import os
 import time
 import urllib.parse
 from collections.abc import Callable, Iterable, Mapping
@@ -8,7 +9,8 @@ from functools import wraps
 from typing import Any, Literal, Protocol, TypeVar, cast
 
 import requests
-import statsd
+
+from canvas_sdk.utils.stats import StatsDClientProxy
 
 F = TypeVar("F", bound=Callable)
 
@@ -97,34 +99,25 @@ class Http:
 
     _MAX_REQUEST_TIMEOUT_SECONDS = 30
 
-    base_url: str
-    session: requests.Session
-
-    def __setattr__(self, name: str, value: Any) -> None:
-        """
-        Prevent base_url or session from being updated after initialization.
-        """
-        if name in ("base_url", "session"):
-            raise AttributeError(f"{name} is read-only")
-
-        super().__setattr__(name, value)
+    _base_url: str
+    _session: requests.Session
 
     def join_url(self, url: str) -> str:
         """
         Join a URL to the base_url.
         """
-        joined = urllib.parse.urljoin(self.base_url, url)
+        joined = urllib.parse.urljoin(self._base_url, url)
 
-        if not joined.startswith(self.base_url):
+        if not joined.startswith(self._base_url):
             raise ValueError("You may not access other URLs using this client.")
 
         return joined
 
     def __init__(self, base_url: str = "") -> None:
-        super().__setattr__("base_url", base_url)
-        super().__setattr__("session", requests.Session())
+        self._base_url = base_url
+        self._session = requests.Session()
 
-        self.statsd_client = statsd.StatsClient()
+        self.statsd_client = StatsDClientProxy()
 
     @staticmethod
     def measure_time(fn: F) -> F:
@@ -136,7 +129,7 @@ class Http:
             result = fn(self, *args, **kwargs)
             end_time = time.time()
             timing = int((end_time - start_time) * 1000)
-            self.statsd_client.timing(f"plugins.http_{fn.__name__}", timing)
+            self.statsd_client.timing(f"plugins.http_{fn.__name__}", timing, tags={})
             return result
 
         return cast(F, wrapper)
@@ -148,7 +141,7 @@ class Http:
         """Sends a GET request."""
         if headers is None:
             headers = {}
-        return self.session.get(
+        return self._session.get(
             self.join_url(url),
             headers=headers,
             timeout=self._MAX_REQUEST_TIMEOUT_SECONDS,
@@ -163,7 +156,7 @@ class Http:
         headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a POST request."""
-        return self.session.post(
+        return self._session.post(
             self.join_url(url),
             json=json,
             data=data,
@@ -180,7 +173,7 @@ class Http:
         headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a PUT request."""
-        return self.session.put(
+        return self._session.put(
             self.join_url(url),
             json=json,
             data=data,
@@ -197,7 +190,7 @@ class Http:
         headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a PATCH request."""
-        return self.session.patch(
+        return self._session.patch(
             self.join_url(url),
             json=json,
             data=data,
@@ -233,7 +226,75 @@ class Http:
             return [future.result() for future in futures]
 
 
-class OntologiesHttp(Http):
+class JsonOnlyResponse:
+    """
+    A very simple Response analog that only allows access to the json() method
+    and the status_code.
+
+    If we returned the response directly the user could look at the request
+    headers on the response object and see any authentication headers we sent
+    on their behalf.
+    """
+
+    _json: dict[str, Any] | None
+    status_code: int
+
+    def __init__(self, response: requests.Response):
+        self.status_code = response.status_code
+
+        try:
+            self._json = response.json()
+        except Exception:
+            self._json = None
+
+    def json(self) -> dict[str, Any] | None:
+        return self._json
+
+
+class JsonOnlyHttp(Http):
+    def get(
+        self,
+        url: str,
+        headers: Mapping[str, str | bytes | None] | None = None,
+    ) -> requests.Response:
+        raise NotImplementedError
+
+    def get_json(
+        self,
+        url: str,
+        headers: Mapping[str, str | bytes | None] | None = None,
+    ) -> JsonOnlyResponse:
+        return JsonOnlyResponse(super().get(url, headers))
+
+    def post(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: Mapping[str, str | bytes | None] | None = None,
+    ) -> requests.Response:
+        raise NotImplementedError
+
+    def put(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: Mapping[str, str | bytes | None] | None = None,
+    ) -> requests.Response:
+        raise NotImplementedError
+
+    def patch(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: Mapping[str, str | bytes | None] | None = None,
+    ) -> requests.Response:
+        raise NotImplementedError
+
+
+class OntologiesHttp(JsonOnlyHttp):
     """
     An HTTP client for the ontologies service.
     """
@@ -241,13 +302,10 @@ class OntologiesHttp(Http):
     def __init__(self) -> None:
         super().__init__(base_url="https://ontologies.canvasmedical.com")
 
-        # import here to avoid making it exportable to module importers
-        import os
-
-        self.session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
+        self._session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
 
 
-class ScienceHttp(Http):
+class ScienceHttp(JsonOnlyHttp):
     """
     An HTTP client for the ontologies service.
     """
@@ -255,18 +313,19 @@ class ScienceHttp(Http):
     def __init__(self) -> None:
         super().__init__(base_url="https://science.canvasmedical.com")
 
-        # import here to avoid making it exportable to module importers
-        import os
+        self._session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
 
-        self.session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
 
+ontologies_http = OntologiesHttp()
+science_http = ScienceHttp()
 
-__all__ = [
+__all__ = __exports__ = (
+    "ThreadPoolExecutor",
     "Http",
-    "OntologiesHttp",
-    "ScienceHttp",
+    "ontologies_http",
+    "science_http",
     "batch_get",
     "batch_post",
     "batch_put",
     "batch_patch",
-]
+)

canvas_sdk/utils/plugins.py

@@ -18,8 +18,12 @@ def plugin_only(func: Callable[..., Any]) -> Callable[..., Any]:
 
         plugin_name = caller.f_globals["__name__"].split(".")[0]
         plugin_dir = Path(PLUGIN_DIRECTORY) / plugin_name
+        kwargs["plugin_name"] = plugin_name
         kwargs["plugin_dir"] = plugin_dir.resolve()
 
         return func(*args, **kwargs)
 
     return wrapper
+
+
+__exports__ = ()

canvas_sdk/utils/stats.py

@@ -31,6 +31,9 @@ def tags_to_line_protocol(tags: dict[str, Any]) -> str:
     )
 
 
+STATS_ENABLED = True
+
+
 class StatsDClientProxy:
     """Proxy for a StatsD client."""
 
@@ -45,6 +48,9 @@ class StatsDClientProxy:
             value (float): The value to report.
             tags (dict[str, str]): Dictionary of tags to attach to the metric.
         """
+        if not STATS_ENABLED:
+            return
+
         statsd_tags = tags_to_line_protocol(tags)
         self.client.gauge(f"{metric_name},{statsd_tags}", value)
 
@@ -56,8 +62,13 @@ class StatsDClientProxy:
             delta (float | timedelta): The value to report.
             tags (dict[str, str]): Dictionary of tags to attach to the metric.
         """
+        if not STATS_ENABLED:
+            return
+
         statsd_tags = tags_to_line_protocol(tags)
         self.client.timing(f"{metric_name},{statsd_tags}", delta)
 
 
 statsd_client = StatsDClientProxy()
+
+__exports__ = ()

canvas_sdk/v1/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

canvas_sdk/v1/apps.py

@@ -5,3 +5,6 @@ class CanvasSdkV1Config(AppConfig):
     """AppConfig for v1 of the SDK data module."""
 
     name = "canvas_sdk.v1"
+
+
+__exports__ = ()

canvas_sdk/v1/data/__init__.py

@@ -54,7 +54,7 @@ from .staff import Staff, StaffContactPoint
 from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
 from .user import CanvasUser
 
-__all__ = [
+__all__ = __exports__ = (
     "Appointment",
     "AppointmentExternalIdentifier",
     "AllergyIntolerance",
@@ -120,4 +120,4 @@ __all__ = [
     "Transactor",
     "TransactorAddress",
     "TransactorPhone",
-]
+)

canvas_sdk/v1/data/allergy_intolerance.py

@@ -77,3 +77,6 @@ class AllergyIntoleranceCoding(models.Model):
         related_name="codings",
         null=True,
     )
+
+
+__exports__ = ("AllergyIntolerance", "AllergyIntoleranceCoding")

canvas_sdk/v1/data/appointment.py

@@ -76,3 +76,10 @@ class AppointmentExternalIdentifier(models.Model):
     appointment = models.ForeignKey(
         Appointment, on_delete=models.DO_NOTHING, related_name="external_identifiers"
     )
+
+
+__exports__ = (
+    "AppointmentProgressStatus",
+    "Appointment",
+    "AppointmentExternalIdentifier",
+)

canvas_sdk/v1/data/assessment.py

@@ -38,3 +38,6 @@ class Assessment(models.Model):
     narrative = models.CharField()
     background = models.CharField()
     care_team = models.CharField()
+
+
+__exports__ = ("AssessmentStatus", "Assessment")

canvas_sdk/v1/data/banner_alert.py

@@ -25,3 +25,6 @@ class BannerAlert(models.Model):
     intent = models.CharField()
     href = models.CharField()
     status = models.CharField()
+
+
+__exports__ = ("BannerAlert",)

canvas_sdk/v1/data/base.py

@@ -187,3 +187,6 @@ class ValueSetTimeframeLookupQuerySet(ValueSetLookupQuerySet, TimeframeLookupQue
     """A class that includes methods for looking up value sets and using timeframes."""
 
     pass
+
+
+__exports__ = ()

canvas_sdk/v1/data/billing.py

@@ -83,3 +83,10 @@ class BillingLineItemModifier(models.Model):
         related_name="modifiers",
         null=True,
     )
+
+
+__exports__ = (
+    "BillingLineItemStatus",
+    "BillingLineItem",
+    "BillingLineItemModifier",
+)

canvas_sdk/v1/data/care_team.py

@@ -58,3 +58,10 @@ class CareTeamMembership(models.Model):
 
     def __str__(self) -> str:
         return f"id={self.id}"
+
+
+__exports__ = (
+    "CareTeamMembershipStatus",
+    "CareTeamRole",
+    "CareTeamMembership",
+)

canvas_sdk/v1/data/command.py

@@ -36,3 +36,6 @@ class Command(models.Model):
             app_label=self._meta.app_label, model_name=self.anchor_object_type
         )
         return anchor_model.objects.get(dbid=self.anchor_object_dbid)
+
+
+__exports__ = ("Command",)

canvas_sdk/v1/data/common.py

@@ -154,3 +154,21 @@ class AddressState(models.TextChoices):
 
     ACTIVE = "active", "Active"
     DELETED = "deleted", "Deleted"
+
+
+__exports__ = (
+    "DocumentReviewMode",
+    "OrderStatus",
+    "ReviewPatientCommunicationMethod",
+    "ReviewStatus",
+    "PersonSex",
+    "TaxIDType",
+    "ColorEnum",
+    "Origin",
+    "ContactPointSystem",
+    "ContactPointUse",
+    "ContactPointState",
+    "AddressUse",
+    "AddressType",
+    "AddressState",
+)

canvas_sdk/v1/data/condition.py

@@ -76,3 +76,10 @@ class ConditionCoding(models.Model):
     condition = models.ForeignKey(
         Condition, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )
+
+
+__exports__ = (
+    "ClinicalStatus",
+    "Condition",
+    "ConditionCoding",
+)

canvas_sdk/v1/data/coverage.py

@@ -292,3 +292,17 @@ class TransactorPhone(models.Model):
 
     def __str__(self) -> str:
         return f"id={self.id}"
+
+
+__exports__ = (
+    "CoverageStack",
+    "CoverageState",
+    "CoverageType",
+    "CoverageRelationshipCode",
+    "TransactorCoverageType",
+    "TransactorType",
+    "Coverage",
+    "Transactor",
+    "TransactorAddress",
+    "TransactorPhone",
+)

canvas_sdk/v1/data/detected_issue.py

@@ -49,3 +49,6 @@ class DetectedIssueEvidence(models.Model):
         related_name="evidence",
         null=True,
     )
+
+
+__exports__ = ("DetectedIssue", "DetectedIssueEvidence")

canvas_sdk/v1/data/device.py

@@ -40,3 +40,6 @@ class Device(models.Model):
     manufacturing_date = models.DateField()
     manufacturer = models.CharField()
     procedure_id = models.BigIntegerField()
+
+
+__exports__ = ("Device",)

canvas_sdk/v1/data/imaging.py

@@ -97,3 +97,10 @@ class ImagingReport(models.Model):
     result_date = models.DateField()
     original_date = models.DateField()
     review = models.ForeignKey(ImagingReview, on_delete=models.DO_NOTHING, null=True)
+
+
+__exports__ = (
+    "ImagingOrder",
+    "ImagingReview",
+    "ImagingReport",
+)

canvas_sdk/v1/data/lab.py

@@ -349,3 +349,19 @@ class LabPartnerTest(models.Model):
     order_name = models.TextField()
     keywords = models.TextField(blank=True)
     cpt_code = models.CharField(max_length=256, blank=True, null=True)
+
+
+__exports__ = (
+    "TransmissionType",
+    "LabReport",
+    "LabReviewQuerySet",
+    "LabReview",
+    "LabValue",
+    "LabValueCoding",
+    "LabOrder",
+    "LabOrderReason",
+    "LabOrderReasonCondition",
+    "LabTest",
+    "LabPartner",
+    "LabPartnerTest",
+)

canvas_sdk/v1/data/medication.py

@@ -72,3 +72,6 @@ class MedicationCoding(models.Model):
     medication = models.ForeignKey(
         Medication, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )
+
+
+__exports__ = ("Status", "Medication", "MedicationCoding")

canvas_sdk/v1/data/note.py

@@ -160,3 +160,12 @@ class Note(models.Model):
     location = models.ForeignKey("v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True)
     datetime_of_service = models.DateTimeField()
     place_of_service = models.CharField()
+
+
+__exports__ = (
+    "NoteTypeCategories",
+    "PracticeLocationPOS",
+    "NoteTypes",
+    "NoteType",
+    "Note",
+)

canvas_sdk/v1/data/observation.py

@@ -122,3 +122,12 @@ class ObservationValueCoding(models.Model):
     observation = models.ForeignKey(
         Observation, on_delete=models.DO_NOTHING, related_name="value_codings", null=True
     )
+
+
+__exports__ = (
+    "Observation",
+    "ObservationCoding",
+    "ObservationComponent",
+    "ObservationComponentCoding",
+    "ObservationValueCoding",
+)

canvas_sdk/v1/data/organization.py

@@ -26,3 +26,6 @@ class Organization(models.Model):
     group_taxonomy_number = models.CharField()
     include_zz_qualifier = models.BooleanField()
     main_location = models.OneToOneField("v1.PracticeLocation", on_delete=models.DO_NOTHING)
+
+
+__exports__ = ("Organization",)

canvas_sdk/v1/data/patient.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import TYPE_CHECKING, Any
 
 import arrow
@@ -82,10 +84,10 @@ class Patient(models.Model):
     default_provider_id = models.BigIntegerField()
     user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
 
-    settings: "RelatedManager[PatientSetting]"
+    settings: RelatedManager[PatientSetting]
 
     @classmethod
-    def find(cls, id: str) -> "Patient":
+    def find(cls, id: str) -> Patient:
         """Find a patient by id."""
         return cls._default_manager.get(id=id)
 
@@ -223,3 +225,17 @@ class PatientSetting(models.Model):
     )
     name = models.CharField()
     value = models.JSONField()
+
+
+__exports__ = (
+    "SexAtBirth",
+    "PatientSettingConstants",
+    "Patient",
+    "PatientContactPoint",
+    "PatientAddress",
+    "PatientExternalIdentifier",
+    "PatientSetting",
+    # not defined here but used by current plugins
+    "ContactPointState",
+    "ContactPointSystem",
+)

canvas_sdk/v1/data/practicelocation.py

@@ -101,3 +101,10 @@ class PracticeLocationSetting(models.Model):
 
     def __str__(self) -> str:
         return self.name
+
+
+__exports__ = (
+    "PracticeLocationPOS",
+    "PracticeLocation",
+    "PracticeLocationSetting",
+)

canvas_sdk/v1/data/protocol_override.py

@@ -67,3 +67,10 @@ class ProtocolOverride(models.Model):
     cycle_quantity = models.IntegerField()
     cycle_unit = models.CharField(choices=IntervalUnit.choices)
     status = models.CharField(choices=Status.choices)
+
+
+__exports__ = (
+    "IntervalUnit",
+    "Status",
+    "ProtocolOverride",
+)

canvas_sdk/v1/data/questionnaire.py

@@ -107,7 +107,7 @@ class Questionnaire(models.Model):
     code_system = models.CharField()
     code = models.CharField()
     search_tags = models.CharField()
-    questions = models.ManyToManyField(Question, through="v1.QuestionnaireQuestionMap")  # type: ignore[misc, var-annotated]
+    questions = models.ManyToManyField(Question, through="v1.QuestionnaireQuestionMap")
     use_in_shx = models.BooleanField()
     carry_forward = models.TextField()
 
@@ -159,9 +159,9 @@ class Interview(models.Model):
     )
     note_id = models.BigIntegerField()
     appointment_id = models.BigIntegerField()
-    questionnaires = models.ManyToManyField(  # type: ignore[var-annotated]
+    questionnaires = models.ManyToManyField(
         Questionnaire,
-        through="v1.InterviewQuestionnaireMap",  # type: ignore[misc]
+        through="v1.InterviewQuestionnaireMap",
     )
     progress_status = models.CharField()
     created = models.DateTimeField()
@@ -210,3 +210,16 @@ class InterviewQuestionResponse(models.Model):
     questionnaire_state = models.TextField()
     interview_state = models.TextField()
     comment = models.CharField()
+
+
+__exports__ = (
+    "ResponseOptionSet",
+    "ResponseOption",
+    "Question",
+    "Questionnaire",
+    "QuestionnaireQuestionMap",
+    "InterviewQuerySet",
+    "Interview",
+    "InterviewQuestionnaireMap",
+    "InterviewQuestionResponse",
+)

canvas_sdk/v1/data/reason_for_visit.py

@@ -20,3 +20,6 @@ class ReasonForVisitSettingCoding(models.Model):
     version = models.CharField()
 
     duration = ArrayField(models.DurationField())
+
+
+__exports__ = ("ReasonForVisitSettingCoding",)

canvas_sdk/v1/data/staff.py

@@ -84,3 +84,6 @@ class StaffContactPoint(models.Model):
     rank = models.IntegerField()
     state = models.CharField(choices=ContactPointState.choices)
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="telecom")
+
+
+__exports__ = ("Staff", "StaffContactPoint")

canvas_sdk/v1/data/task.py

@@ -108,3 +108,15 @@ class TaskTaskLabel(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     task_label = models.ForeignKey(TaskLabel, on_delete=models.DO_NOTHING, null=True)
     task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, null=True)
+
+
+__exports__ = (
+    "TaskType",
+    "EventType",
+    "TaskStatus",
+    "TaskLabelModule",
+    "Task",
+    "TaskComment",
+    "TaskLabel",
+    "TaskTaskLabel",
+)

canvas_sdk/v1/data/team.py

@@ -52,7 +52,7 @@ class Team(models.Model):
     name = models.CharField()
     responsibilities = ArrayField(models.CharField(choices=TeamResponsibility.choices))
     members = models.ManyToManyField(  # type: ignore[var-annotated]
-        "v1.Staff",  # type: ignore[misc]
+        "v1.Staff",
         related_name="teams",
         db_table="canvas_sdk_data_api_team_members_001",
     )
@@ -74,3 +74,10 @@ class TeamContactPoint(models.Model):
     rank = models.IntegerField()
     state = models.CharField(choices=ContactPointState.choices)
     team = models.ForeignKey(Team, on_delete=models.DO_NOTHING, related_name="telecom")
+
+
+__exports__ = (
+    "TeamResponsibility",
+    "Team",
+    "TeamContactPoint",
+)