canvas 0.18.0__py3-none-any.whl → 0.19.1__py3-none-any.whl

{canvas-0.18.0.dist-info → canvas-0.19.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvas
-Version: 0.18.0
+Version: 0.19.1
 Summary: SDK to customize event-driven actions in your Canvas instance
 Author-email: Canvas Team <engineering@canvasmedical.com>
 License-Expression: MIT

{canvas-0.18.0.dist-info → canvas-0.19.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-settings.py,sha256=wtQMRHsbynzEjZb5WmUMV3q27oWc6prLS9ztnEAsqMg,2829
+settings.py,sha256=Mk332hOSmNyLVRKLUhtc1Kll-P5Iun7vbkZ0chwnOAs,3176
 canvas_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_cli/conftest.py,sha256=0mEjjU7_w9nq-HCvscxFJClw-EeyQYujNLLRPssksZQ,931
 canvas_cli/main.py,sha256=L6JQkt1yxy30cA3-M9v7JD8WMW4i0M5GPr9kZetAito,2728
@@ -95,7 +95,7 @@ canvas_cli/utils/urls/__init__.py,sha256=08hlrQhQ1pKBjlIRaC0j53IkgK723jfK8-j3djv
 canvas_cli/utils/urls/tests.py,sha256=opXDF2i3lXTdsKJ7ywIRzWDDzZ5KAO0JbGIR3hbJdoE,407
 canvas_cli/utils/urls/urls.py,sha256=KwWTh5ERrEsZEvdBrZpZB71xtyWkDuglpXUbycWmBOo,798
 canvas_cli/utils/validators/__init__.py,sha256=rBvSR2O1hWkNAnUBdcr-zUkmqT796_A61b9pnvEhwrM,113
-canvas_cli/utils/validators/manifest_schema.py,sha256=BDOi4wj3AZcKyV6ItNrDwIPun_7ozK3Yacc6hDTtLFg,4171
+canvas_cli/utils/validators/manifest_schema.py,sha256=Bp3FFdIY7KFz1AXnQAbJa6_E1pm9PCc0CXGkwK4JdZo,4573
 canvas_cli/utils/validators/tests.py,sha256=KhaOdbxGUK2QwL2KnycAJJkqclYQSXF7CKg-scSf0DU,1259
 canvas_cli/utils/validators/validators.py,sha256=lrUBQ0sF7seTe_pNGsNgASdr2BGp6g-Qui58V4H9qfQ,1598
 canvas_generated/messages/effects_pb2.py,sha256=qGIcJpjSrhLvj6Km2wMRKRPJ2IxymA0M_R9SghvilII,9821
@@ -110,7 +110,7 @@ canvas_generated/messages/plugins_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCN
 canvas_generated/services/plugin_runner_pb2.py,sha256=RfAo_imYoSuoexq-1IHhMhXZgQpzq91pqugxsigL8NU,1557
 canvas_generated/services/plugin_runner_pb2.pyi,sha256=1w-Pa4k7HtlmQAr7B6sgV64zdZplBKQKHN-S8bjwO3w,265
 canvas_generated/services/plugin_runner_pb2_grpc.py,sha256=EzJJVkP_AZ3dwBA7OxUito0NSalRmjjg8q9TZ_P18ww,4549
-canvas_sdk/__init__.py,sha256=d7V1Qsp4hSqp8opmvqp-0J33uibArUjwENMfzSDAdZg,102
+canvas_sdk/__init__.py,sha256=7IuwjhqIaOO5BgCfXi-B1eV6XfK9Ku5PHPWuTGeDNgU,151
 canvas_sdk/base.py,sha256=aaWilIx70lsAE76x7QaJolyIvcFnXDGPw1UMv9t0FDw,2035
 canvas_sdk/commands/__init__.py,sha256=cNQy1Y_Ji3cPush2hbaoXC3pbIFmobv_Vm-UG0w0hlc,2696
 canvas_sdk/commands/base.py,sha256=ScfOo4QXTInhTf6OGLT5dEu81yhZAcgVT8qxwIKWbow,5155
@@ -132,7 +132,7 @@ canvas_sdk/commands/commands/perform.py,sha256=FpumHzPJp5pzb4F0CBW2QbSWdR_5mpib1
 canvas_sdk/commands/commands/plan.py,sha256=uxjXmdNcG32R4S0CJ7fqDaaXTMiJJH9RuvwlWuztlZ0,403
 canvas_sdk/commands/commands/prescribe.py,sha256=CWk25bQtpHb7KTNnCIPGaIGEnUQagAJ8fnbRnyPIssc,2176
 canvas_sdk/commands/commands/questionnaire.py,sha256=Giu4stTzpddO8fH3iVyxm2lUeDwe7AmhfuIfb_0WUj4,644
-canvas_sdk/commands/commands/reason_for_visit.py,sha256=NX_hKyWg2HXFO03uWLOFwrO1v2-kVeez1CSlFIQ38eA,1479
+canvas_sdk/commands/commands/reason_for_visit.py,sha256=XapED7uU9yIUPkJ5p0PUboBNX7MlpM9PYfmOmAkAdpY,2242
 canvas_sdk/commands/commands/refill.py,sha256=HC9Nl3_BkGn3HRZ-4YNT9lqIywFVom6PyJChK3_0Zyc,458
 canvas_sdk/commands/commands/remove_allergy.py,sha256=6CXo3s63z7oqMlROExPWudQBZeSvD3x0SC_efQSb0Lw,748
 canvas_sdk/commands/commands/review_of_systems.py,sha256=F2wXmeh5yEuWokC5I2_H-9k32PgYBUcfyLHgYVL4LPQ,276
@@ -142,13 +142,13 @@ canvas_sdk/commands/commands/task.py,sha256=p-WskHqj_q8TqllarEw73AIW6n2J7uzyIso9
 canvas_sdk/commands/commands/update_diagnosis.py,sha256=fqPcKBaiRemo8Qa4H4g6ZvKM2YczVlj9FxpBGjs8J9Q,824
 canvas_sdk/commands/commands/update_goal.py,sha256=ddvxlDnoTm5k-G5aJ-pW2fMIC-s5K8jYia9tISXsxAk,1580
 canvas_sdk/commands/commands/vitals.py,sha256=hOuDXbNwqJbsBAvvkpjrXWqssrdQPxEfCox1NlI0h4A,3127
-canvas_sdk/commands/tests/test_utils.py,sha256=qkzcTDjyvrpXyPkm3f6KBVy-4lqJ1cOq2QSc-bPVPsU,12004
+canvas_sdk/commands/tests/test_utils.py,sha256=Jrkbz2xltrjUVYRdIyNaKdq5tCtGQ4vygic7hpBp6Ek,12157
 canvas_sdk/commands/tests/protocol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/commands/tests/protocol/tests.py,sha256=e0fiJUKsfi0aYSlaTdrMHybZntC7oBdaHks9PSrMuhU,2168
 canvas_sdk/commands/tests/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/commands/tests/schema/tests.py,sha256=rSu146RouMrPLv0G-E6QtgQhG2vkUCCk1M3Baa6fXBg,3701
 canvas_sdk/commands/tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas_sdk/commands/tests/unit/tests.py,sha256=FsjNpUxkS4F89g341uuc5GkMCTp_JACTx32wxcwYcWg,9948
+canvas_sdk/commands/tests/unit/tests.py,sha256=uzQbGIgAM1PTCGJy0p8etHx0zhOB0GDVWO7WCaxZuUs,8767
 canvas_sdk/effects/__init__.py,sha256=rcMI7IaVe8kDaYRngvlH5JPOL7FBSGIoLZB4UCN18d8,151
 canvas_sdk/effects/base.py,sha256=znIaDNkCYbzJxf4Q80hLRYUG5H73c8IMq1UCzeBcXjw,714
 canvas_sdk/effects/launch_modal.py,sha256=2yVY7r6hY5YYiBKae0rpS4Q0UgJPJtGlLuZGj68hm8s,1058
@@ -180,30 +180,34 @@ canvas_sdk/protocols/__init__.py,sha256=3u9zet5D4DX4V953tLCoN1xhaOhAUCwGwscMv-7I
 canvas_sdk/protocols/base.py,sha256=sbm0uOk3PPfPemqBmHh2hawE5utC6no46EmvyMN8Y7Q,179
 canvas_sdk/protocols/clinical_quality_measure.py,sha256=8cU93ah9YsPecpZR1-csAbg69oFn9a8LtjHjYMMHedw,4844
 canvas_sdk/protocols/timeframe.py,sha256=SlTDhTy0TqPXKS9JZFeTVApQJDf8C-NIRLqFJltB17g,1148
+canvas_sdk/questionnaires/__init__.py,sha256=WqEj8iLUjvubIzHVAXUEYQwzUFxgauAX9rPdVvJjbRQ,96
+canvas_sdk/questionnaires/utils.py,sha256=tGTlEYWg6HJkf0zSWXgaSRsh4BW2z6dWNTTPGBU0i5Q,3569
+canvas_sdk/questionnaires/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canvas_sdk/questionnaires/tests/test_utils.py,sha256=4NCYPFSmn96wSfEB48eFfM4548sOULAX58Ln49FugEw,3032
 canvas_sdk/templates/__init__.py,sha256=crz8FE6yoCgwTrqosLDHM7cOiVdhWgWz0l0J--1sgmM,69
-canvas_sdk/templates/utils.py,sha256=pjU9ZOAb4MHb8ui4l3f1yWRczy62JCF51rn6fWAjMKY,1645
+canvas_sdk/templates/utils.py,sha256=h-BAX4rm-EpqKMnFGMZF1RbXaWsOr6-ECQYhmJ8skyI,1422
 canvas_sdk/templates/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/templates/tests/test_utils.py,sha256=VRahmmVwXKcp1NMLoA3BZL4cFFXzFnD-i5IUpcEeXTg,1832
 canvas_sdk/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/utils/__init__.py,sha256=nZEfYeU-qNZBOh39b8zAuEh0Wzh2PgXxs0NRKKe66Pg,184
-canvas_sdk/utils/db.py,sha256=0AO5bhu-k9OsAHpXe1RHzyDZnBGHUEzrv8-vYtTIoeA,592
 canvas_sdk/utils/http.py,sha256=McFtcrgdR2W8XguTaTF54O5Xf5r5buoYDldDM5H5ahY,5846
+canvas_sdk/utils/plugins.py,sha256=853MW2fiLpyG3o9ISEawAthQeRiZP73cai5Tngwu4MY,767
 canvas_sdk/utils/stats.py,sha256=sJhIW_IssUVefQN6rrUAt1P0KvVIUIYcnpZlMHLibNA,732
 canvas_sdk/utils/tests.py,sha256=0Buh_7PvDU1D081_rSJoYSJwIHMOBbL0gtGS3bSKe7s,2285
 canvas_sdk/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/v1/apps.py,sha256=z5HVdICPLYrbWM8ZXK89Xu7RWaXuKU4AFRrPAZGz0C4,151
 canvas_sdk/v1/models.py,sha256=q9Sofiu9JDH5g04H8NHYIqAtBYxH4KjnwOldoKsY9Lk,206
-canvas_sdk/v1/data/__init__.py,sha256=1xQqNKh9rSwyLqT8pE8PYNOx3DTxcS9qXuU79OqjEDU,2903
+canvas_sdk/v1/data/__init__.py,sha256=SAAiRSaYly47oB8uyfjf6e4chTULX7M6qisR-fk2eHQ,3052
 canvas_sdk/v1/data/allergy_intolerance.py,sha256=cm29fCOFiHHHVyff9kreWFUPZM--Nydw3a0FSbWh5-w,2303
 canvas_sdk/v1/data/appointment.py,sha256=rK4Vl2bE_aE73vGx8Elj-tJdDdIbQNTbl0uLtWme89Y,1900
 canvas_sdk/v1/data/assessment.py,sha256=MYUrE6xtOVYSRiMuQKMdHuWFvuGx62w4SZJpyFskQ2U,1485
 canvas_sdk/v1/data/base.py,sha256=_UnCf0SP_HC9FYEzB1BsJ3QcKqXNdCR90Dtx1Gggcf4,6328
-canvas_sdk/v1/data/billing.py,sha256=Fk2_hIh6-HeuStxL3t4aZvIuFYdF7Kyn9aKcin0ypOU,1960
+canvas_sdk/v1/data/billing.py,sha256=dPQb9vj2mIhlU5cSfmfTkXw0NRDMmueJojyRNrgx1no,2586
 canvas_sdk/v1/data/care_team.py,sha256=qy9x-FZ6LI_GrXnohS5izc6e-SANhV50eh_bilaVI4Y,1818
 canvas_sdk/v1/data/command.py,sha256=r1hFQDFkGTAcpfRqCsQICcKivtSt08Mdz2jcKS8m9TA,1613
 canvas_sdk/v1/data/common.py,sha256=JB8Lf8pHTo8VttZTnQFthnKLjalX8iI-ZoBsjpVMxHs,4559
 canvas_sdk/v1/data/condition.py,sha256=olHJFb7A9ORWlMzolpt15fQmg47F--5oEM_lrAQGeMk,2096
-canvas_sdk/v1/data/coverage.py,sha256=xFCIwpoiQ7SLzAUgye408XoutAQdYhixpd9MdPt_BhI,10835
+canvas_sdk/v1/data/coverage.py,sha256=buz0VwJvyKJcX-EallQweA-5P0UxSjt6QLg3f8sMHEQ,10836
 canvas_sdk/v1/data/detected_issue.py,sha256=hvzUIjLx2unA_GNdW1oJcsLRx8jIEOKHWP8j_p88s4k,1685
 canvas_sdk/v1/data/device.py,sha256=RZ200OCaBRGwdERvx9eFOPTHg56r62Hqp9uJeS2giOo,1613
 canvas_sdk/v1/data/imaging.py,sha256=2caHmSQmt1zUx5q_AoydkuUqtkQo-tdMk5B_0suSlWw,4297
@@ -216,6 +220,7 @@ canvas_sdk/v1/data/patient.py,sha256=tKsZRaexpanDtCHTy4HtEsodiw7BKk8hPcEwpF98o-g
 canvas_sdk/v1/data/practicelocation.py,sha256=6W2NzwiK0xXlzXfDom_Wm3ScERd8W6mw8obSTFZWYLc,4206
 canvas_sdk/v1/data/protocol_override.py,sha256=o-GK7-HkOsyYDLxUyn9BwlZM-13QNuGGNrey5EF44QI,2105
 canvas_sdk/v1/data/questionnaire.py,sha256=1Vo5QUsOLYbZiQ64QFpgY7Mj6wY8vsV8f9uPiFl0wac,7031
+canvas_sdk/v1/data/reason_for_visit.py,sha256=9rCmvbJZ4dKUUDzqFX1uxlMa_qO57KcRntV3re8q_8g,608
 canvas_sdk/v1/data/staff.py,sha256=QyFxvFAvNwgTm4gf-uPH6A8ibFE2TBhEckZpAM7gNpw,2762
 canvas_sdk/v1/data/task.py,sha256=5KNn88APPNOHEk4s1ZJRBBav8-AEQTUH039Vio_ZtAk,3471
 canvas_sdk/v1/data/team.py,sha256=FlkZsHSSHKtvmlB1XuGPUmC7wl8iMbOPi_fl9sYw-aU,2801
@@ -249,13 +254,13 @@ plugin_runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plugin_runner/authentication.py,sha256=SDPso2AogtLAV_H0LuMDp99IMZuF3oTq-Q_AXAvJ8uc,1116
 plugin_runner/aws_headers.py,sha256=DenX_nAMVhXMJZw88PLZbqJsi5_XriNtr3jE-eJqHY4,2773
 plugin_runner/exceptions.py,sha256=YnRZiQVzbU3HrVlmEXLje_np99009YnhTRVHHyBCtqc,433
-plugin_runner/plugin_installer.py,sha256=0gHMpI4CDkWljbU7HLhbPjl2E_oHxDZMlmPtTqCyS9o,7748
+plugin_runner/plugin_installer.py,sha256=8hWllx7YciatEozFRwcp5Y_L_KyEi2e8CGienRWrZs0,7375
 plugin_runner/plugin_runner.py,sha256=h_FHStJrvRiG9DSf8uXHKFb4aby2wBzLAe10Ov4xnas,16437
-plugin_runner/sandbox.py,sha256=SdTfPWzs5mcMmQ5J9ESpTk5c3e1nQG8F4N0pKPuK48M,14499
+plugin_runner/sandbox.py,sha256=P64SKpKZdoJwk2NsirGRKq7xjygBtvdipIAVSD5roY8,14509
 plugin_runner/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plugin_runner/tests/test_application.py,sha256=e1R2YagMRD96gZALx-Zra-e-sR3SiP7cIpI6pheZnUc,2427
 plugin_runner/tests/test_plugin_installer.py,sha256=i3ELG5cRfaG7ETLwk8aJhahgJuPfKjIrXL250t2wpzI,4434
-plugin_runner/tests/test_plugin_runner.py,sha256=D2NyTGogu1FpiFo0MKZXcJRWFh4Ix6uznYnthdXXzk4,11632
+plugin_runner/tests/test_plugin_runner.py,sha256=i1GAX8VsSU5KMwDOPYOQ5S9nxkRCWSjzG1nnh_IJLu4,11638
 plugin_runner/tests/test_sandbox.py,sha256=fDIkRBzoVWClvIMOI37FvJ1TRZ5mAztt88YZ0OPqsA8,4231
 plugin_runner/tests/data/plugins/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plugin_runner/tests/fixtures/plugins/example_plugin/CANVAS_MANIFEST.json,sha256=J9T_E5vqUX4HITHbFsd6JQpw3YvMS4wR_lhI5JL2KMk,749
@@ -271,6 +276,11 @@ plugin_runner/tests/fixtures/plugins/test_implicit_imports_plugin/templates/__in
 plugin_runner/tests/fixtures/plugins/test_implicit_imports_plugin/templates/base.py,sha256=apbdzjKtqeQJpPnAxgKituh0ZG71jK0SlwtQRSiV-4o,170
 plugin_runner/tests/fixtures/plugins/test_implicit_imports_plugin/utils/__init__.py,sha256=ZvCN37hADp2VG1-DfJE_dtHrXf-yirF0321f92WzC20,79
 plugin_runner/tests/fixtures/plugins/test_implicit_imports_plugin/utils/base.py,sha256=--erTS2NGGcw4aVhabrKTtHtuR5OHjc8rsK30fvuYZs,83
+plugin_runner/tests/fixtures/plugins/test_load_questionnaire/CANVAS_MANIFEST.json,sha256=orbmUtS3uGl6XNiubCo79H4Jr_DbydMtzvdXUuk6cAM,1579
+plugin_runner/tests/fixtures/plugins/test_load_questionnaire/README.md,sha256=D3SFO-pnyZjpEFLylWaIWi8AmUW8ZxMyHDddN4a7vAQ,246
+plugin_runner/tests/fixtures/plugins/test_load_questionnaire/protocols/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugin_runner/tests/fixtures/plugins/test_load_questionnaire/protocols/my_protocol.py,sha256=_dWsMARIefDi8FlMhZIN0j62-0EjXimdfu42ZEhtDzU,1444
+plugin_runner/tests/fixtures/plugins/test_load_questionnaire/questionnaires/example_questionnaire.yml,sha256=PjbCH4bbRFDmrciM-mJWjrKG7KTFhcSgZu1w6dAorio,1940
 plugin_runner/tests/fixtures/plugins/test_module_forbidden_imports_plugin/CANVAS_MANIFEST.json,sha256=o84LSegKZ7eH_MeGkmRZFJJPEcOYHUzT0P2QkQpCZac,793
 plugin_runner/tests/fixtures/plugins/test_module_forbidden_imports_plugin/README.md,sha256=ZuFqRirQNoqdPzBjfpYzTGpIogmiQ_noX59hY0W2KHU,292
 plugin_runner/tests/fixtures/plugins/test_module_forbidden_imports_plugin/other_module/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -318,7 +328,7 @@ protobufs/canvas_generated/messages/plugins.proto,sha256=oNainUPWFYQjgCX7bJEPI9_
 protobufs/canvas_generated/services/plugin_runner.proto,sha256=doadBKn5k4xAtOgR-q_pEvW4yzxpUaHNOowMG6CL5GY,304
 pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pubsub/pubsub.py,sha256=pyTW0JU8mtaqiAV6g6xjZwel1CVy2EonPMU-_vkmhUM,1044
-canvas-0.18.0.dist-info/METADATA,sha256=qAXIh8PHMwAY2D85FKRWX0i-6x5B0_AA9BRKzOLGr2g,4375
-canvas-0.18.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-canvas-0.18.0.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
-canvas-0.18.0.dist-info/RECORD,,
+canvas-0.19.1.dist-info/METADATA,sha256=7w1TpwcKJ-BjC9HRzHYW4OW6LzUFr1gHFxlqRrIkX-U,4375
+canvas-0.19.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+canvas-0.19.1.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
+canvas-0.19.1.dist-info/RECORD,,

canvas_cli/utils/validators/manifest_schema.py

@@ -16,6 +16,7 @@ manifest_schema = {
                 "effects": {"$ref": "#/$defs/component"},
                 "views": {"$ref": "#/$defs/component"},
                 "applications": {"$ref": "#/$defs/applications"},
+                "questionnaires": {"$ref": "#/$defs/questionnaires"},
             },
             "additionalProperties": False,
             "minProperties": 1,
@@ -101,5 +102,16 @@ manifest_schema = {
                 "additionalProperties": False,
             },
         },
+        "questionnaires": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "template": {"type": "string"},
+                },
+                "required": ["template"],
+                "additionalProperties": False,
+            },
+        },
     },
 }

canvas_sdk/__init__.py

@@ -1,7 +1,9 @@
 import os
+import sys
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
 
-import django
+if "mypy" not in sys.argv[0]:
+    import django
 
-django.setup()
+    django.setup()

canvas_sdk/commands/commands/reason_for_visit.py

@@ -1,9 +1,11 @@
 from typing import Literal
+from uuid import UUID
 
 from pydantic_core import InitErrorDetails
 
 from canvas_sdk.commands.base import _BaseCommand
 from canvas_sdk.commands.constants import Coding
+from canvas_sdk.v1.data import ReasonForVisitSettingCoding
 
 
 class ReasonForVisitCommand(_BaseCommand):
@@ -13,8 +15,7 @@ class ReasonForVisitCommand(_BaseCommand):
         key = "reasonForVisit"
 
     structured: bool = False
-    # how do we make sure that coding is a valid rfv coding from their home-app?
-    coding: Coding | None = None
+    coding: Coding | UUID | str | None = None
     comment: str | None = None
 
     def _get_error_details(
@@ -27,6 +28,16 @@ class ReasonForVisitCommand(_BaseCommand):
                     "value", "Structured RFV should have a coding.", self.coding
                 )
             )
+
+        if self.coding:
+            if isinstance(self.coding, str | UUID):
+                query = {"id": self.coding}
+                error_message = f"ReasonForVisitSettingCoding with id {self.coding} does not exist."
+            else:
+                query = {"code": self.coding["code"], "system": self.coding["system"]}
+                error_message = f"ReasonForVisitSettingCoding with code {self.coding['code']} and system {self.coding['system']} does not exist."
+            if not ReasonForVisitSettingCoding.objects.filter(**query).exists():
+                errors.append(self._create_error_detail("value", error_message, self.coding))
         return errors
 
     @classmethod
@@ -40,4 +51,8 @@ class ReasonForVisitCommand(_BaseCommand):
     @property
     def values(self) -> dict:
         """The ReasonForVisit command's field values."""
-        return {"structured": self.structured, "coding": self.coding, "comment": self.comment}
+        return {
+            "structured": self.structured,
+            "coding": str(self.coding) if isinstance(self.coding, UUID) else self.coding,
+            "comment": self.comment,
+        }

canvas_sdk/commands/tests/test_utils.py

@@ -37,6 +37,12 @@ from canvas_sdk.commands.constants import ClinicalQuantity, Coding
 runner = CliRunner()
 
 
+class WrongType:
+    """A type to yield ValidationErrors in tests."""
+
+    wrong_field: str
+
+
 class MaskedValue:
     """A class to mask sensitive values in tests."""
 
@@ -97,6 +103,8 @@ def fake(field_props: dict, Command: type[_BaseCommand]) -> Any:
             return Coding(system=random_string(), code=random_string(), display=random_string())
         case "ClinicalQuantity":
             return ClinicalQuantity(representative_ndc="ndc", ncpdp_quantity_qualifier_code="code")
+        case "WrongType":
+            return WrongType()
     if t[0].isupper():
         return random.choice(list(getattr(Command, t)))
 
@@ -108,7 +116,8 @@ def raises_wrong_type_error(
     """Test that the correct error is raised when the wrong type is passed to a field."""
     field_props = Command.model_json_schema()["properties"][field]
     field_type = get_field_type(field_props)
-    wrong_field_type = "integer" if field_type == "string" else "string"
+
+    wrong_field_type = "WrongType"
 
     with pytest.raises(ValidationError) as e1:
         err_kwargs = {field: fake({"type": wrong_field_type}, Command)}
@@ -122,8 +131,11 @@ def raises_wrong_type_error(
         setattr(cmd, field, err_value)
     err_msg2 = repr(e2.value)
 
-    assert f"1 validation error for {Command.__name__}\n{field}" in err_msg1
-    assert f"1 validation error for {Command.__name__}\n{field}" in err_msg2
+    assert "validation error" in err_msg1
+    assert f"{Command.__name__}\n{field}" in err_msg1
+
+    assert "validation error" in err_msg2
+    assert f"{Command.__name__}\n{field}" in err_msg1
 
     field_type = (
         "dictionary" if field_type == "Coding" or field_type == "ClinicalQuantity" else field_type

canvas_sdk/commands/tests/unit/tests.py

@@ -1,3 +1,5 @@
+import uuid
+
 import pytest
 from pydantic import ValidationError
 from typer.testing import CliRunner
@@ -91,24 +93,21 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
 
 
 @pytest.mark.parametrize(
-    "Command,err_kwargs,err_msg,valid_kwargs",
+    "Command,err_kwargs,valid_kwargs",
     [
         (
             PlanCommand,
             {"narrative": "yo", "note_uuid": 1},
-            "1 validation error for PlanCommand\nnote_uuid\n  Input should be a valid string [type=string_type",
             {"narrative": "yo", "note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
             PlanCommand,
             {"narrative": "yo", "note_uuid": "5", "command_uuid": 5},
-            "1 validation error for PlanCommand\ncommand_uuid\n  Input should be a valid string [type=string_type",
             {"narrative": "yo", "note_uuid": "5", "command_uuid": "5"},
         ),
         (
             ReasonForVisitCommand,
             {"note_uuid": "00000000-0000-0000-0000-000000000000", "structured": True},
-            "1 validation error for ReasonForVisitCommand\n  Structured RFV should have a coding",
             {
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "structured": False,
@@ -120,7 +119,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": "x"},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.system\n  Field required [type=missing",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -129,7 +127,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": 1, "system": "y"},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.code\n  Input should be a valid string [type=string_type",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -138,7 +135,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": None, "system": "y"},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.code\n  Input should be a valid string [type=string_type",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -147,7 +143,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"system": "y"},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.code\n  Field required [type=missing",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -156,7 +151,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": "x", "system": 1},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.system\n  Input should be a valid string [type=string_type",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -165,7 +159,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": "x", "system": None},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.system\n  Input should be a valid string [type=string_type",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
         (
@@ -174,7 +167,6 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
                 "note_uuid": "00000000-0000-0000-0000-000000000000",
                 "coding": {"code": "x", "system": "y", "display": 1},
             },
-            "1 validation error for ReasonForVisitCommand\ncoding.display\n  Input should be a valid string [type=string_type",
             {"note_uuid": "00000000-0000-0000-0000-000000000000"},
         ),
     ],
@@ -182,25 +174,24 @@ def test_command_raises_generic_error_when_kwarg_given_incorrect_type(
 def test_command_raises_specific_error_when_kwarg_given_incorrect_type(
     Command: type[PlanCommand] | type[ReasonForVisitCommand],
     err_kwargs: dict,
-    err_msg: str,
     valid_kwargs: dict,
 ) -> None:
     """Test that Command raises a specific error when a kwarg is given an incorrect type."""
-    with pytest.raises(ValidationError) as e1:
+    with pytest.raises(ValidationError):
         cmd = Command(**err_kwargs)
         cmd.originate()
+        cmd.command_uuid = str(uuid.uuid4())
         cmd.edit()
-    assert err_msg in repr(e1.value)
 
     cmd = Command(**valid_kwargs)
     if len(err_kwargs) < len(valid_kwargs):
         return
     key, value = list(err_kwargs.items())[-1]
-    with pytest.raises(ValidationError) as e2:
+    with pytest.raises(ValidationError):
         setattr(cmd, key, value)
         cmd.originate()
+        cmd.command_uuid = str(uuid.uuid4())
         cmd.edit()
-    assert err_msg in repr(e2.value)
 
 
 @pytest.mark.parametrize(

canvas_sdk/questionnaires/__init__.py

@@ -0,0 +1,3 @@
+from .utils import from_yaml as questionnaire_from_yaml
+
+__all__ = ("questionnaire_from_yaml",)

canvas_sdk/questionnaires/tests/test_utils.py

@@ -0,0 +1,74 @@
+import json
+from pathlib import Path
+
+import pytest
+import yaml
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.events import Event, EventRequest, EventType
+from canvas_sdk.questionnaires import questionnaire_from_yaml
+from plugin_runner.plugin_runner import LOADED_PLUGINS
+from settings import PLUGIN_DIRECTORY
+
+
+@pytest.mark.parametrize("install_test_plugin", ["test_load_questionnaire"], indirect=True)
+def test_from_yaml_valid_questionnaire(install_test_plugin: Path, load_test_plugins: None) -> None:
+    """Test that the from_yaml function loads a valid questionnaire."""
+    plugin = LOADED_PLUGINS[
+        "test_load_questionnaire:test_load_questionnaire.protocols.my_protocol:ValidQuestionnaire"
+    ]
+    result: list[Effect] = plugin["class"](Event(EventRequest(type=EventType.UNKNOWN))).compute()
+
+    assert (
+        yaml.load(
+            (
+                Path(PLUGIN_DIRECTORY)
+                / "test_load_questionnaire/questionnaires/example_questionnaire.yml"
+            )
+            .resolve()
+            .read_text(),
+            Loader=yaml.SafeLoader,
+        ).items()
+        <= json.loads(result[0].payload).items()
+    )
+
+
+@pytest.mark.parametrize("install_test_plugin", ["test_load_questionnaire"], indirect=True)
+def test_from_yaml_invalid_questionnaire(
+    install_test_plugin: Path, load_test_plugins: None
+) -> None:
+    """Test that the from_yaml function raises an error for invalid questionnaires."""
+    plugin = LOADED_PLUGINS[
+        "test_load_questionnaire:test_load_questionnaire.protocols.my_protocol:InvalidQuestionnaire"
+    ]
+    with pytest.raises(FileNotFoundError):
+        plugin["class"](Event(EventRequest(type=EventType.UNKNOWN))).compute()
+
+
+@pytest.mark.parametrize("install_test_plugin", ["test_load_questionnaire"], indirect=True)
+def test_from_yaml_forbidden_questionnaire(
+    install_test_plugin: Path, load_test_plugins: None
+) -> None:
+    """Test that the from_yaml function raises an error for a questionnaire outside plugin package."""
+    plugin = LOADED_PLUGINS[
+        "test_load_questionnaire:test_load_questionnaire.protocols.my_protocol:ForbiddenQuestionnaire"
+    ]
+    with pytest.raises(PermissionError):
+        plugin["class"](Event(EventRequest(type=EventType.UNKNOWN))).compute()
+
+
+def test_from_yaml_non_plugin_caller() -> None:
+    """Test that the from_yaml function returns None when called outside a plugin."""
+    assert questionnaire_from_yaml("questionnaires/example_questionnaire.yml") is None
+
+
+@pytest.mark.parametrize("install_test_plugin", ["test_load_questionnaire"], indirect=True)
+def test_from_yaml_sets_default_values(install_test_plugin: Path) -> None:
+    """Test that the from_yaml function sets default values for properties."""
+    globals()["__is_plugin__"] = True
+    globals()["__name__"] = "test_load_questionnaire"
+
+    definition = questionnaire_from_yaml("questionnaires/example_questionnaire.yml")
+
+    assert definition is not None
+    assert definition["display_results_in_social_history_section"] is False

canvas_sdk/questionnaires/utils.py

@@ -0,0 +1,117 @@
+import functools
+import json
+from collections.abc import Generator
+from pathlib import Path
+from typing import Any, TypedDict
+
+import yaml
+from jsonschema import Draft7Validator, validators
+
+from canvas_sdk.utils.plugins import plugin_only
+
+
+class Response(TypedDict):
+    """A Response of a Questionnaire."""
+
+    name: str
+    code: str
+    code_description: str
+    value: str
+
+
+class Question(TypedDict):
+    """A Question of a Questionnaire."""
+
+    code_system: str
+    code: str
+    code_description: str
+    content: str
+    responses_code_system: str
+    responses_type: str
+    display_result_in_social_history_section: bool
+    responses: list[Response]
+
+
+class QuestionnaireConfig(TypedDict):
+    """A Questionnaire configuration."""
+
+    name: str
+    form_type: str
+    code_system: str
+    code: str
+    can_originate_in_charting: bool
+    prologue: str
+    display_results_in_social_history_section: bool
+    questions: list[Question]
+
+
+def extend_with_defaults(validator_class: type[Draft7Validator]) -> type[Draft7Validator]:
+    """Extend a Draft7Validator with default values for properties."""
+    validate_properties = validator_class.VALIDATORS["properties"]
+
+    def set_defaults(
+        validator: Draft7Validator,
+        properties: dict[str, Any],
+        instance: dict[str, Any],
+        schema: dict[str, Any],
+    ) -> Generator[Any, None, None]:
+        for property, subschema in properties.items():
+            if "default" in subschema:
+                instance.setdefault(property, subschema["default"])
+
+        yield from validate_properties(
+            validator,
+            properties,
+            instance,
+            schema,
+        )
+
+    return validators.extend(
+        validator_class,
+        {"properties": set_defaults},
+    )
+
+
+ExtendedDraft7Validator = extend_with_defaults(Draft7Validator)
+
+
+@plugin_only
+def from_yaml(questionnaire_name: str, **kwargs: Any) -> QuestionnaireConfig | None:
+    """Load a Questionnaire configuration from a YAML file.
+
+    Args:
+        questionnaire_name (str): The path to the questionnaire file, relative to the plugin package.
+            If the path starts with a forward slash ("/"), it will be stripped during resolution.
+        kwargs (Any): Additional keyword arguments.
+
+    Returns:
+        QuestionnaireConfig: The loaded Questionnaire configuration.
+
+    Raises:
+        FileNotFoundError: If the questionnaire file does not exist within the plugin's directory
+            or if the resolved path is invalid.
+        PermissionError: If the resolved path is outside the plugin's directory.
+        ValidationError: If the questionnaire file does not conform to the JSON schema.
+    """
+    plugin_dir = kwargs["plugin_dir"]
+    questionnaire_config_path = Path(plugin_dir / questionnaire_name.lstrip("/")).resolve()
+
+    if not questionnaire_config_path.is_relative_to(plugin_dir):
+        raise PermissionError(f"Invalid Questionnaire '{questionnaire_name}'")
+    elif not questionnaire_config_path.exists():
+        raise FileNotFoundError(f"Questionnaire {questionnaire_name} not found.")
+
+    questionnaire_config = yaml.load(questionnaire_config_path.read_text(), Loader=yaml.SafeLoader)
+    ExtendedDraft7Validator(json_schema()).validate(questionnaire_config)
+
+    return questionnaire_config
+
+
+@functools.cache
+def json_schema() -> dict[str, Any]:
+    """Reads the JSON schema for a Questionnaire Config."""
+    schema = json.loads(
+        (Path(__file__).resolve().parent.parent.parent / "schemas/questionnaire.json").read_text()
+    )
+
+    return schema

canvas_sdk/templates/utils.py

@@ -1,13 +1,15 @@
-import inspect
 from pathlib import Path
 from typing import Any
 
 from django.template import Context, Template
 
-from settings import PLUGIN_DIRECTORY
+from canvas_sdk.utils.plugins import plugin_only
 
 
-def render_to_string(template_name: str, context: dict[str, Any] | None = None) -> str | None:
+@plugin_only
+def render_to_string(
+    template_name: str, context: dict[str, Any] | None = None, **kwargs: Any
+) -> str | None:
     """Load a template and render it with the given context.
 
     Args:
@@ -15,6 +17,7 @@ def render_to_string(template_name: str, context: dict[str, Any] | None = None)
             If the path starts with a forward slash ("/"), it will be stripped during resolution.
         context (dict[str, Any] | None): A dictionary of variables to pass to the template
             for rendering. Defaults to None, which uses an empty context.
+        kwargs (Any): Additional keyword arguments.
 
     Returns:
         str: The rendered template as a string.
@@ -23,15 +26,7 @@ def render_to_string(template_name: str, context: dict[str, Any] | None = None)
         FileNotFoundError: If the template file does not exist within the plugin's directory
             or if the resolved path is invalid.
     """
-    plugins_dir = Path(PLUGIN_DIRECTORY).resolve()
-    current_frame = inspect.currentframe()
-    caller = current_frame.f_back if current_frame else None
-
-    if not caller or "__is_plugin__" not in caller.f_globals:
-        return None
-
-    plugin_name = caller.f_globals["__name__"].split(".")[0]
-    plugin_dir = plugins_dir / plugin_name
+    plugin_dir = kwargs["plugin_dir"]
     template_path = Path(plugin_dir / template_name.lstrip("/")).resolve()
 
     if not template_path.is_relative_to(plugin_dir):

canvas_sdk/utils/plugins.py

@@ -0,0 +1,25 @@
+import inspect
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any
+
+from settings import PLUGIN_DIRECTORY
+
+
+def plugin_only(func: Callable[..., Any]) -> Callable[..., Any]:
+    """Decorator to restrict a function's execution to plugins only."""
+
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        current_frame = inspect.currentframe()
+        caller = current_frame.f_back if current_frame else None
+
+        if not caller or "__is_plugin__" not in caller.f_globals:
+            return None
+
+        plugin_name = caller.f_globals["__name__"].split(".")[0]
+        plugin_dir = Path(PLUGIN_DIRECTORY) / plugin_name
+        kwargs["plugin_dir"] = plugin_dir.resolve()
+
+        return func(*args, **kwargs)
+
+    return wrapper

canvas_sdk/v1/data/__init__.py

@@ -1,7 +1,7 @@
 from .allergy_intolerance import AllergyIntolerance, AllergyIntoleranceCoding
 from .appointment import Appointment
 from .assessment import Assessment
-from .billing import BillingLineItem
+from .billing import BillingLineItem, BillingLineItemModifier
 from .care_team import CareTeamMembership, CareTeamRole
 from .command import Command
 from .condition import Condition, ConditionCoding
@@ -48,6 +48,7 @@ from .questionnaire import (
     ResponseOption,
     ResponseOptionSet,
 )
+from .reason_for_visit import ReasonForVisitSettingCoding
 from .staff import Staff
 from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
 from .user import CanvasUser
@@ -58,6 +59,7 @@ __all__ = [
     "AllergyIntoleranceCoding",
     "Assessment",
     "BillingLineItem",
+    "BillingLineItemModifier",
     "CanvasUser",
     "CareTeamMembership",
     "CareTeamRole",
@@ -103,6 +105,7 @@ __all__ = [
     "Question",
     "Questionnaire",
     "QuestionnaireQuestionMap",
+    "ReasonForVisitSettingCoding",
     "ResponseOption",
     "ResponseOptionSet",
     "Staff",

canvas_sdk/v1/data/billing.py

@@ -44,10 +44,16 @@ class BillingLineItem(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     note = models.ForeignKey(
-        "v1.Note", on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
+        "v1.Note",
+        on_delete=models.DO_NOTHING,
+        related_name="billing_line_items",
+        null=True,
     )
     patient = models.ForeignKey(
-        "v1.Patient", on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
+        "v1.Patient",
+        on_delete=models.DO_NOTHING,
+        related_name="billing_line_items",
+        null=True,
     )
     cpt = models.CharField()
     charge = models.DecimalField()
@@ -56,3 +62,24 @@ class BillingLineItem(models.Model):
     command_type = models.CharField()
     command_id = models.IntegerField()
     status = models.CharField(choices=BillingLineItemStatus.choices)
+
+
+class BillingLineItemModifier(models.Model):
+    """BillingLineItemModifier."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_billinglineitemmodifier_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    system = models.CharField()
+    version = models.CharField()
+    code = models.CharField()
+    display = models.CharField()
+    user_selected = models.BooleanField()
+    line_item = models.ForeignKey(
+        "v1.BillingLineItem",
+        on_delete=models.DO_NOTHING,
+        related_name="modifiers",
+        null=True,
+    )

canvas_sdk/v1/data/coverage.py

@@ -46,7 +46,7 @@ class CoverageRelationshipCode(models.TextChoices):
     """CoverageRelationshipCode."""
 
     SELF = "18", "Self"
-    SPOUSE = "01" "Spouse"
+    SPOUSE = "01", "Spouse"
     CHILD_INSURED_HAS_FINANCIAL_RESP = "19", "Natural Child, insured has financial responsibility"
     CHILD_HAS_FINANCIAL_RESP = "43", "Natural Child, insured does not have financial responsibility"
     STEP_CHILD = "17", "Step Child"

canvas_sdk/v1/data/reason_for_visit.py

@@ -0,0 +1,22 @@
+from django.contrib.postgres.fields import ArrayField
+from django.db import models
+
+
+class ReasonForVisitSettingCoding(models.Model):
+    """ReasonForVisitSettingCoding."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_reasonforvisitsettingcoding_001"
+
+    objects: models.Manager["ReasonForVisitSettingCoding"]
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+
+    code = models.CharField()
+    display = models.CharField()
+    system = models.CharField()
+    version = models.CharField()
+
+    duration = ArrayField(models.DurationField())

plugin_runner/plugin_installer.py

@@ -6,7 +6,7 @@ import tempfile
 from collections.abc import Generator
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Any, TypedDict
+from typing import TypedDict, cast
 from urllib import parse
 
 import psycopg
@@ -30,41 +30,32 @@ from settings import (
 UPLOAD_TO_PREFIX = "plugins"
 
 
-def get_database_dict_from_url() -> dict[str, Any]:
-    """Creates a psycopg ready dictionary from the home-app database URL."""
-    parsed_url = parse.urlparse(os.getenv("DATABASE_URL"))
-    db_name = parsed_url.path[1:]
-    return {
-        "dbname": db_name,
-        "user": parsed_url.username,
-        "password": parsed_url.password,
-        "host": parsed_url.hostname,
-        "port": parsed_url.port,
-    }
+def open_database_connection() -> Connection:
+    """Opens a psycopg connection to the home-app database.
 
+    When running within Aptible, use the database URL, otherwise pull from
+    the environment variables.
+    """
+    if os.getenv("DATABASE_URL"):
+        parsed_url = parse.urlparse(os.getenv("DATABASE_URL"))
+
+        return psycopg.connect(
+            dbname=cast(str, parsed_url.path[1:]),
+            user=cast(str, parsed_url.username),
+            password=cast(str, parsed_url.password),
+            host=cast(str, parsed_url.hostname),
+            port=parsed_url.port,
+        )
 
-def get_database_dict_from_env() -> dict[str, Any]:
-    """Creates a psycopg ready dictionary from the environment variables."""
     APP_NAME = os.getenv("APP_NAME")
 
-    return {
-        "dbname": APP_NAME,
-        "user": os.getenv("DB_USERNAME", "app"),
-        "password": os.getenv("DB_PASSWORD", "app"),
-        "host": os.getenv("DB_HOST", f"{APP_NAME}-db"),
-        "port": os.getenv("DB_PORT", "5432"),
-    }
-
-
-def open_database_connection() -> Connection:
-    """Opens a psycopg connection to the home-app database."""
-    # When running within Aptible, use the database URL, otherwise pull from the environment variables.
-    if os.getenv("DATABASE_URL"):
-        database_dict = get_database_dict_from_url()
-    else:
-        database_dict = get_database_dict_from_env()
-    conn = psycopg.connect(**database_dict)
-    return conn
+    return psycopg.connect(
+        dbname=APP_NAME,
+        user=os.getenv("DB_USERNAME", "app"),
+        password=os.getenv("DB_PASSWORD", "app"),
+        host=os.getenv("DB_HOST", f"{APP_NAME}-db"),
+        port=os.getenv("DB_PORT", "5432"),
+    )
 
 
 class PluginAttributes(TypedDict):

plugin_runner/sandbox.py

@@ -45,6 +45,7 @@ ALLOWED_MODULES = frozenset(
         "canvas_sdk.events",
         "canvas_sdk.handlers",
         "canvas_sdk.protocols",
+        "canvas_sdk.questionnaires",
         "canvas_sdk.utils",
         "canvas_sdk.templates",
         "canvas_sdk.v1",
@@ -173,12 +174,12 @@ class Sandbox:
             ):
                 self.warn(
                     node,
-                    f'"{name}" is an invalid variable name because it ' 'starts with "_"',
+                    f'"{name}" is an invalid variable name because it starts with "_"',
                 )
             elif name.endswith("__roles__"):
                 self.error(
                     node,
-                    f'"{name}" is an invalid variable name because ' 'it ends with "__roles__".',
+                    f'"{name}" is an invalid variable name because it ends with "__roles__".',
                 )
             elif name in FORBIDDEN_FUNC_NAMES:
                 self.error(node, f'"{name}" is a reserved name.')
@@ -215,21 +216,20 @@ class Sandbox:
             if node.attr.startswith("_") and node.attr != "_":
                 self.warn(
                     node,
-                    f'"{node.attr}" is an invalid attribute name because it starts ' 'with "_".',
+                    f'"{node.attr}" is an invalid attribute name because it starts with "_".',
                 )
 
             if node.attr.endswith("__roles__"):
                 self.error(
                     node,
-                    f'"{node.attr}" is an invalid attribute name because it ends '
-                    'with "__roles__".',
+                    f'"{node.attr}" is an invalid attribute name because it ends with "__roles__".',
                 )
 
             if isinstance(node.ctx, ast.Load):
                 node = self.node_contents_visit(node)
                 new_node = ast.Call(
                     func=ast.Name("_getattr_", ast.Load()),
-                    args=[node.value, ast.Str(node.attr)],
+                    args=[node.value, ast.Constant(node.attr)],
                     keywords=[],
                 )
 

plugin_runner/tests/fixtures/plugins/test_load_questionnaire/CANVAS_MANIFEST.json

@@ -0,0 +1,52 @@
+{
+    "sdk_version": "0.1.4",
+    "plugin_version": "0.0.1",
+    "name": "test_load_questionnaire",
+    "description": "Edit the description in CANVAS_MANIFEST.json",
+    "components": {
+        "protocols": [
+            {
+                "class": "test_load_questionnaire.protocols.my_protocol:ValidQuestionnaire",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            },
+             {
+                "class": "test_load_questionnaire.protocols.my_protocol:InvalidQuestionnaire",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            },
+             {
+                "class": "test_load_questionnaire.protocols.my_protocol:ForbiddenQuestionnaire",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            }
+        ],
+        "commands": [],
+        "content": [],
+        "effects": [],
+        "views": [],
+        "questionnaires": [
+          {
+            "template": "questionnaires/example_questionnaire.yml"
+          }
+        ]
+    },
+    "secrets": [],
+    "tags": {},
+    "references": [],
+    "license": "",
+    "diagram": false,
+    "readme": "./README.md"
+}

plugin_runner/tests/fixtures/plugins/test_load_questionnaire/README.md

@@ -0,0 +1,11 @@
+test_load_questionnaire
+====================
+
+## Description
+
+A description of this plugin
+
+### Important Note!
+
+The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
+gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_load_questionnaire/protocols/my_protocol.py

@@ -0,0 +1,39 @@
+import json
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.events import EventType
+from canvas_sdk.handlers import BaseHandler
+from canvas_sdk.questionnaires import questionnaire_from_yaml
+
+
+class ValidQuestionnaire(BaseHandler):
+    """You should put a helpful description of this protocol's behavior here."""
+
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        config = questionnaire_from_yaml("questionnaires/example_questionnaire.yml")
+        return [Effect(payload=json.dumps(config))]
+
+
+class InvalidQuestionnaire(BaseHandler):
+    """You should put a helpful description of this protocol's behavior here."""
+
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        questionnaire_from_yaml("questionnaires/example_questionnaire1.yml")
+        return []
+
+
+class ForbiddenQuestionnaire(BaseHandler):
+    """You should put a helpful description of this protocol's behavior here."""
+
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        questionnaire_from_yaml("../../questionnaires/example_questionnaire.yml")
+        return []

plugin_runner/tests/fixtures/plugins/test_load_questionnaire/questionnaires/example_questionnaire.yml

@@ -0,0 +1,61 @@
+# yaml-language-server: $schema=../../../../../../schemas/questionnaire.json
+
+name: Example Name
+form_type: QUES
+code_system: LOINC
+code: QUES_EXAMPLE_NAME
+can_originate_in_charting: true
+prologue: This is an example of a structured assessment with single select, multiselect, and free text responses.
+questions:
+  - content: "This is question #1"
+    code_system: CPT
+    code: H0005
+    code_description: ""
+    responses_code_system: INTERNAL
+    responses_type: SING
+    display_result_in_social_history_section: true
+    responses:
+      - name: "Single select response #1"
+        code: QUES_EXAMPLE_NAME_Q1_A1
+        code_description: ''
+        value: "1"
+      - name: "Single select response #2"
+        code: QUES_EXAMPLE_NAME_Q1_A2
+        code_description: ''
+        value: "0"
+      - name: "Single select response #3"
+        code: QUES_EXAMPLE_NAME_Q1_A3
+        code_description: ''
+        value: "0"
+  - content: "This is question #2"
+    code_system: INTERNAL
+    code: QUES_EXAMPLE_NAME_Q2
+    code_description: ""
+    responses_code_system: ICD-10
+    responses_type: MULT
+    display_result_in_social_history_section: true
+    responses:
+      - name: "Multi select response #1"
+        code: F1910
+        code_description: ''
+        value: "0"
+      - name: "Multi select response #2"
+        code: QUES_EXAMPLE_NAME_Q1_A1
+        code_description: ''
+        value: "2"
+      - name: "Multi select response #3"
+        code: QUES_EXAMPLE_NAME_Q1_A2
+        code_description: ''
+        value: "0"
+  - content: "This is question #3"
+    code_system: INTERNAL
+    code: QUES_EXAMPLE_NAME_Q3
+    code_description: ""
+    responses_code_system: INTERNAL
+    responses_type: TXT
+    display_result_in_social_history_section: true
+    responses:
+      - name: "Free text response"
+        code: QUES_EXAMPLE_NAME_Q3_A1
+        code_description: ''
+        value: "This is a default pre-populated free text response."

plugin_runner/tests/test_plugin_runner.py

@@ -83,9 +83,9 @@ def test_load_plugins_with_plugin_that_imports_other_modules_outside_plugin_pack
     with caplog.at_level(logging.ERROR):
         load_or_reload_plugin(install_test_plugin)
 
-    assert any(
-        "Error importing module" in record.message for record in caplog.records
-    ), "log.error() was not called with the expected message."
+    assert any("Error importing module" in record.message for record in caplog.records), (
+        "log.error() was not called with the expected message."
+    )
 
 
 @pytest.mark.parametrize(
@@ -102,9 +102,9 @@ def test_load_plugins_with_plugin_that_imports_forbidden_modules(
     with caplog.at_level(logging.ERROR):
         load_or_reload_plugin(install_test_plugin)
 
-    assert any(
-        "Error importing module" in record.message for record in caplog.records
-    ), "log.error() was not called with the expected message."
+    assert any("Error importing module" in record.message for record in caplog.records), (
+        "log.error() was not called with the expected message."
+    )
 
 
 @pytest.mark.parametrize(
@@ -144,9 +144,9 @@ def test_plugin_that_implicitly_imports_allowed_modules(
         ]["class"]
         class_handler(Event(EventRequest(type=EventType.UNKNOWN))).compute()
 
-    assert any(
-        "Hello, World!" in record.message for record in caplog.records
-    ), "log.info() with Template.render() was not called."
+    assert any("Hello, World!" in record.message for record in caplog.records), (
+        "log.info() with Template.render() was not called."
+    )
 
 
 @pytest.mark.parametrize(
@@ -170,9 +170,9 @@ def test_plugin_that_implicitly_imports_forbidden_modules(
         ]["class"]
         class_handler(Event(EventRequest(type=EventType.UNKNOWN))).compute()
 
-    assert (
-        any("os list dir" in record.message for record in caplog.records) is False
-    ), "log.info() with os.listdir() was called."
+    assert any("os list dir" in record.message for record in caplog.records) is False, (
+        "log.info() with os.listdir() was called."
+    )
 
 
 @pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)

settings.py

@@ -1,11 +1,10 @@
 import os
 import sys
+from urllib import parse
 
 from dotenv import load_dotenv
 from env_tools import env_to_bool
 
-from canvas_sdk.utils.db import get_database_dict_from_url
-
 load_dotenv()
 
 ENV = os.getenv("ENV", "development")
@@ -40,19 +39,30 @@ CANVAS_SDK_DB_HOST = os.getenv("CANVAS_SDK_DB_HOST", "home-app-db")
 CANVAS_SDK_DB_PORT = os.getenv("CANVAS_SDK_DB_PORT", "5432")
 
 if os.getenv("DATABASE_URL"):
-    database_dict = get_database_dict_from_url()
+    parsed_url = parse.urlparse(os.getenv("DATABASE_URL"))
+
+    DATABASES = {
+        "default": {
+            "ENGINE": "django.db.backends.postgresql",
+            "NAME": parsed_url.path[1:],
+            "USER": os.getenv("CANVAS_SDK_DATABASE_ROLE"),
+            "PASSWORD": os.getenv("CANVAS_SDK_DATABASE_ROLE_PASSWORD"),
+            "HOST": parsed_url.hostname,
+            "PORT": parsed_url.port,
+        }
+    }
 else:
-    database_dict = {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": CANVAS_SDK_DB_NAME,
-        "USER": CANVAS_SDK_DB_USERNAME,
-        "PASSWORD": CANVAS_SDK_DB_PASSWORD,
-        "HOST": CANVAS_SDK_DB_HOST,
-        "PORT": CANVAS_SDK_DB_PORT,
+    DATABASES = {
+        "default": {
+            "ENGINE": "django.db.backends.postgresql",
+            "NAME": CANVAS_SDK_DB_NAME,
+            "USER": CANVAS_SDK_DB_USERNAME,
+            "PASSWORD": CANVAS_SDK_DB_PASSWORD,
+            "HOST": CANVAS_SDK_DB_HOST,
+            "PORT": CANVAS_SDK_DB_PORT,
+        }
     }
 
-DATABASES = {"default": database_dict}
-
 AWS_ACCESS_KEY_ID = os.getenv("AWS_ACCESS_KEY_ID", "")
 AWS_SECRET_ACCESS_KEY = os.getenv("AWS_SECRET_ACCESS_KEY", "")
 AWS_REGION = os.getenv("AWS_REGION", "us-west-2")

canvas_sdk/utils/db.py

@@ -1,17 +0,0 @@
-import os
-from typing import Any
-from urllib import parse
-
-
-def get_database_dict_from_url() -> dict[str, Any]:
-    """Retrieves the database URL for the data module connection formatted for Django settings."""
-    parsed_url = parse.urlparse(os.getenv("DATABASE_URL"))
-    db_name = parsed_url.path[1:]
-    return {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": db_name,
-        "USER": os.getenv("CANVAS_SDK_DATABASE_ROLE"),
-        "PASSWORD": os.getenv("CANVAS_SDK_DATABASE_ROLE_PASSWORD"),
-        "HOST": parsed_url.hostname,
-        "PORT": parsed_url.port,
-    }