Title: [BUG] Variables with annotation of 'typing.Literal' causes a panic · Issue #57 · fastapi/sqlmodel · GitHub
Open Graph Title: [BUG] Variables with annotation of 'typing.Literal' causes a panic · Issue #57 · fastapi/sqlmodel
X Title: [BUG] Variables with annotation of 'typing.Literal' causes a panic · Issue #57 · fastapi/sqlmodel
Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I already searched in Google "How to X in...
Open Graph Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I...
X Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated searc...
Opengraph URL: https://github.com/fastapi/sqlmodel/issues/57
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[BUG] Variables with annotation of 'typing.Literal' causes a panic","articleBody":"### First Check\r\n\r\n- [X] I added a very descriptive title to this issue.\r\n- [X] I used the GitHub search to find a similar issue and didn't find it.\r\n- [X] I searched the SQLModel documentation, with the integrated search.\r\n- [X] I already searched in Google \"How to X in SQLModel\" and didn't find any information.\r\n- [X] I already read and followed all the tutorial in the docs and didn't find an answer.\r\n- [X] I already checked if it is not related to SQLModel but to [Pydantic](https://github.com/samuelcolvin/pydantic).\r\n- [X] I already checked if it is not related to SQLModel but to [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).\r\n\r\n### Commit to Help\r\n\r\n- [X] I commit to help with one of those options 👆\r\n\r\n### Example Code\r\n\r\n```python\r\nfrom sqlmodel import SQLModel\r\nfrom typing import Literal\r\n\r\n\r\nclass Cool(SQLModel, table=True):\r\n name: Literal[\"fastapi\", \"sqlmodel\"]\r\n\r\n\r\n# This code outputs the following to stderr\r\n\r\n# File \"main.py\", line 5, in \u003cmodule>\r\n# class Cool(SQLModel, table=True):\r\n# File \"sqlmodel/main.py\", line 292, in __new__\r\n# col = get_column_from_field(v)\r\n# File \"sqlmodel/main.py\", line 415, in get_column_from_field\r\n# sa_type = get_sqlachemy_type(field)\r\n# File \"sqlmodel/main.py\", line 373, in get_sqlachemy_type\r\n# if issubclass(field.type_, str):\r\n# TypeError: issubclass() arg 1 must be a class\r\n```\r\n\r\n\r\n### Description\r\n\r\n* Create a sub-class of `sqlmodel.main.SQLModel` with `table=True`\r\n* Add a variable and annotate it with `typing.Literal[...]`\r\n* Python raises a `TypeError` exception at `sqlmodel/main:get_sqlachemy_type`\r\n\r\nThis happens because `typing.Literal[...]` is a function and since SQLModel uses `issubclass` to get the variable's SQLAlchemy type; `issubclass` just throws a `TypeError` since it expects a class.\r\n\r\n\r\n### Operating System\r\n\r\nLinux\r\n\r\n### Operating System Details\r\n\r\n_No response_\r\n\r\n### SQLModel Version\r\n\r\n0.0.4\r\n\r\n### Python Version\r\n\r\nPython 3.9.6\r\n\r\n### Additional Context\r\n\r\nFunny enough [Pydantic](https://github.com/samuelcolvin/pydantic) had quite the same issue samuelcolvin/pydantic#1026 so it can be as easy as importing `pydantic.typing.is_literal_type` and running an if statement at the top of `get_sqlachemy_type`\r\n\r\nI think the real issue is that `typing.Literal` is an 'Union' type it receive one or more values but since it's often used for one type (e.g. Literal[\"r\", \"w\", ...]) we can return the type of all the passed values if they are all the same else None. The values can be retrieved with `typing.get_args` as a tuple.","author":{"url":"https://github.com/faresbakhit","@type":"Person","name":"faresbakhit"},"datePublished":"2021-08-29T07:58:37Z","url":"https://github.com/fastapi/sqlmodel/issues/57"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:9f4a426b-d0ce-4314-0c52-6cfbcbb05473 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8D8C:17672A:188768:228D2C:6AFDF2FB |
| html-safe-nonce | 15b5f7a2de3ef7cf634f61fdb5ab12cd62e337eab4099e163be5769c62ddb84a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RDhDOjE3NjcyQToxODg3Njg6MjI4RDJDOjZBRkRGMkZCIiwidmlzaXRvcl9pZCI6IjYzMTA0MTUyMDcyMTAyODM3NzEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | ed6840418f6360099f1e2830f8c14bb51702a1d084e6b4a80631147f160e3c24 |
| hovercard-subject-tag | issue:982025933 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/fastapi/sqlmodel/57/issue_layout |
| twitter:image | https://opengraph.githubassets.com/e1d35f51f0b864c4231e763b4ac11b9b5de41083665b9f61cee60c6b4020daad/fastapi/sqlmodel/issues/57 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/e1d35f51f0b864c4231e763b4ac11b9b5de41083665b9f61cee60c6b4020daad/fastapi/sqlmodel/issues/57 |
| og:image:alt | First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | faresbakhit |
| hostname | github.com |
| expected-hostname | github.com |
| None | dd812ec581ecac95855f5ec917ef9827506c39a9da1443f43ddb4179a46471eb |
| turbo-cache-control | no-preview |
| go-import | github.com/fastapi/sqlmodel git https://github.com/fastapi/sqlmodel.git |
| octolytics-dimension-user_id | 156354296 |
| octolytics-dimension-user_login | fastapi |
| octolytics-dimension-repository_id | 399495186 |
| octolytics-dimension-repository_nwo | fastapi/sqlmodel |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 399495186 |
| octolytics-dimension-repository_network_root_nwo | fastapi/sqlmodel |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 32ac708bac264dafdc28e10ff49b4d137f0c34a7 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width