Raise a helpful error if Table=True is passed instead of table

[JamesHutchison]

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

class MyTable(SQLModel, Table=True):
    __tablename__ = "my_table"

Description

I was writing a model definition and using GitHub Copilot.

Copilot suggested Table=True as the keyword argument instead of the correct table=True. I failed to notice this when I accepted the suggestion.

After various other changes, I got around to finally testing the model with a relationship. I get a cryptic error about the name of my model not being mapped. The error comes from the relationship line itself, so it gives the impression that maybe I did that wrong somehow.

I check my imports and realize I forgot to add it an import to the __init__.py for the models.

The error persists.

I ask GPT-4 to find something wrong with my code and it says it looks good.

I spend a bunch of time checking imports, commenting things out, I set breakpoints and confirm my file is getting imported correctly. I check the database and notice that it for some reason really hates my model and refuses to acknowledge it.

I finally get around to setting a breakpoint in the metaclass and determine that it really is executing. Eventually, after A/B stepping through the logic between a working and the non-working model, I see that it's missing the table config.

I finally notice that its a capital T instead of lowercase t.

This could have been easily avoided. Its not clear to me why I would create a class that inherits from SQLModel and not have it be a table. The only reason I can tell is that its to differentiate from the base class or a possible user base class.

At the very least, passing Table (capitalized) should raise a helpful error. Defining __tablename__ but not setting table=True also feels like an error case.

Operating System

Linux

Operating System Details

N/A

SQLModel Version

0.0.11

Python Version

3.11.4

Additional Context

No response