Problem with one-to-one relationship

[tavaresmatheus]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

import uuid
from datetime import datetime, timezone, date
from typing import Optional

from sqlmodel import Field, SQLModel, Relationship

class User(SQLModel, table=True):
    __tablename__ = "users"

    user_id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)
    name: str
    email: str
    birth_date: date
    cpf: str
    rg: str
    email_verified: datetime | None = None
    password: str
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime

    doctors: Optional['Doctor'] = Relationship(back_populates='users')

import uuid
from datetime import datetime, timezone
from typing import Optional

from sqlmodel import Field, SQLModel, Relationship

class Doctor(SQLModel, table=True):
    __tablename__ = "doctors"

    doctor_id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)
    user_id: uuid.UUID = Field(foreign_key="users.user_id", unique=True)
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime

    users: Optional['User'] = Relationship(back_populates="doctors")

Description

I'm trying to create a table users (parent), and doctors (child), they relationship are one-to-one, a user can be a doctor, but a doctor cant exist without beeing a user, but some how I'm having this erros:

Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 2522, in get_property
    return self._props[key]
           ~~~~~~~~~~~^^^^^
KeyError: 'doctors'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/healing_medical_record/app/database/seeders/user_admin_seed.py", line 36, in <module>
    user_admin_seed.seed()
  File "/healing_medical_record/app/database/seeders/user_admin_seed.py", line 17, in seed
    user = User(
           ^^^^^
  File "<string>", line 4, in __init__
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/state.py", line 566, in _initialize_instance
    manager.dispatch.init(self, args, kwargs)
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/event/attr.py", line 497, in __call__
    fn(*args, **kw)
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 4406, in _event_on_init
    instrumenting_mapper._check_configure()
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 2401, in _check_configure
    _configure_registries({self.registry}, cascade=True)
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 4214, in _configure_registries
    _do_configure_registries(registries, cascade)
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 4255, in _do_configure_registries
    mapper._post_configure_properties()
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 2418, in _post_configure_properties
    prop.init()
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/interfaces.py", line 589, in init
    self.do_init()
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/relationships.py", line 1661, in do_init
    self._generate_backref()
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/relationships.py", line 2145, in _generate_backref
    self._add_reverse_property(self.back_populates)
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/relationships.py", line 1592, in _add_reverse_property
    other = self.mapper.get_property(key, _configure_mappers=False)
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/sqlalchemy/orm/mapper.py", line 2524, in get_property
    raise sa_exc.InvalidRequestError(
sqlalchemy.exc.InvalidRequestError: Mapper 'Mapper[Doctor(doctors)]' has no property 'doctors'.  If this property was indicated from other mappers or configure events, ensure registry.configure() has been called.

Already searched but can't find any answer.

Operating System

Linux

Operating System Details

Linux Mint 22.01 'Xia'

SQLModel Version

0.0.24

Python Version

3.12.11

Additional Context

No response

[tavaresmatheus]

Found the error.
The problem was not (only) my user and doctor model, but all the other models depending on them, since they are the main domain of my application, almost everything depend on them.

I've had to refactor all my other models, but it worked, I'm sharing the code of my new user and doctor model's so you guys in the future having the same problem can see this:

import uuid
from datetime import datetime, timezone, date
from typing import List, Optional
from sqlmodel import Field, SQLModel, Relationship

class User(SQLModel, table=True):
    __tablename__ = 'users'

    user_id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)
    name: str
    email: str
    birth_date: date
    cpf: str
    rg: str
    email_verified: bool = Field(default=False)
    password: str
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime

    doctor: Optional['Doctor'] = Relationship(back_populates='user')
    medical_records: List['MedicalRecord'] = Relationship(back_populates='user')

import uuid
from datetime import datetime, timezone
from typing import List
from sqlmodel import Field, SQLModel, Relationship

class Doctor(SQLModel, table=True):
    __tablename__ = 'doctors'

    doctor_id: uuid.UUID = Field(default_factory=uuid.uuid4, primary_key=True)
    user_id: uuid.UUID = Field(foreign_key='users.user_id', unique=True)
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime

    user: 'User' = Relationship(back_populates='doctor')
    doctor_medical_specialities: List['DoctorMedicalSpeciality'] = Relationship(back_populates='doctor')
    doctor_crms: List['DoctorCrm'] = Relationship(back_populates='doctor')

As I'm new to Python and FastAPI, here is my advice: Always check all of your relationships, this do matter to SQLModel :)