Custom Data relation access

[j-hulbert]

I'm trying to extend NoteType using the new custom data model extension but having an issue fetch the related data in the same way as described in the docs.

https://docs.canvasmedical.com/sdk/custom-data-extending-sdk-models/
https://docs.canvasmedical.com/sdk/custom-data-custom-models/

class CustomNoteType(NoteType, ModelExtension):
    pass

class NoteTypeSchedulingSettings(CustomModel):
    note_type = OneToOneField(
        CustomNoteType,
        to_field="dbid",
        on_delete=DO_NOTHING,
        related_name="scheduling_settings",
    )
    new_patient_schedulable = BooleanField(null=True)

The table is created successfully but I can't access the relation "scheduling_settings" directly from CustomNoteType like the docs suggest.

def note_type_to_dict(note_type: CustomNoteType) -> dict:
    data = {
        "id": str(note_type.dbid),
        "new_patient_schedulable": note_type.scheduling_settings.new_patient_schedulable,
    }

note_types = CustomNoteType.objects.all()
note_types_asdict = [note_type_to_dict(nt) for nt in note_types]

Error:

CustomNoteType' object has no attribute 'scheduling_settings'

Or with prefetch enabled

note_types = CustomNoteType.objects.prefetch_related("scheduling_settings").all()
note_types_asdict = [note_type_to_dict(nt) for nt in note_types]

Error:

Cannot find 'scheduling_settings' on CustomNoteType object, 'scheduling_settings' is an invalid parameter to prefetch_related()

I was able to get the settings via something this - but this seems very inefficient and doesn't match the docs example

    settings = NoteTypeSchedulingSettings.objects.filter(note_type=note_type).first()

One side note - I did load some values for NoteTypeSchedulingSettings for some NoteTypes but not all - not sure if that is playing a factor.

[djantzen]

Hi @j-hulbert, I took your example code and loaded it into a plugin. I am able to retrieve the associated one-to-one from CustomNoteType object, and prefetch without error. My guess is that your CustomModel is not defined within a directory called models at the plugin root. The plugin runner scans that directory specifically looking for models, and any model declared outside of that directory will not be configured properly. It also should not have created the table though, so that is concerning. What does canvas namespace inspect $THE_NAMESPACE --host localhost show?

[j-hulbert]

Ah thanks @djantzen think that was the hint I needed to figure it out. The models were in the models directory but guess I was getting a bit too cute since I had a __init__.py that looked like this

from canvas_lookup.models.extensions import CustomNoteType
from canvas_lookup.models.scheduling import NoteTypeSchedulingSettings

__all__ = [
    "CustomNoteType",
    "NoteTypeSchedulingSettings",
]

Once I removed this then I started getting this exception instead of my previous error. That's probably expected since I didn't add my custom data to every note type.

    "type": "canvas_lookup.models.extensions.CustomNoteType.scheduling_settings.RelatedObjectDoesNotExist",
    "message": "CustomNoteType has no scheduling_settings."

added a try/except to catch NoteTypeSchedulingSettings.DoesNotExist and things seem to be working as expected now. I was also able to add in the prefetch_related without it throwing an error.