Title: Guidance needed: how to narrow unions of TypedDicts? · Issue #18543 · python/mypy · GitHub
Open Graph Title: Guidance needed: how to narrow unions of TypedDicts? · Issue #18543 · python/mypy
X Title: Guidance needed: how to narrow unions of TypedDicts? · Issue #18543 · python/mypy
Description: The docs give very clear guidance on how to write code using unions of TypedDicts: https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts This makes sense! However, a common use case (for me) of a TypedDict is to allo...
Open Graph Description: The docs give very clear guidance on how to write code using unions of TypedDicts: https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts This makes sense! However, a common use...
X Description: The docs give very clear guidance on how to write code using unions of TypedDicts: https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts This makes sense! However, a common use...
Opengraph URL: https://github.com/python/mypy/issues/18543
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Guidance needed: how to narrow unions of TypedDicts?","articleBody":"The docs give very clear guidance on how to write code using unions of `TypedDict`s:\n\nhttps://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts\n\nThis makes sense!\n\nHowever, a common use case (for me) of a `TypedDict` is to allow external code (e.g. REST API input) to be deserialized into a dict and refined at runtime into a `TypedDict` -- which implies the the design requirement to have a branded field (e.g. `tag`) must now exist in our public facing API.\n\nThis could work in some cases, but consider something like this:\n\n```python\nfrom __future__ import annotations\nfrom typing import List, TypedDict\n\nclass Policy(TypedDict):\n name: str\n\nclass CombinedORPolicy(TypedDict):\n OR: List[Policy]\n\nclass CombinedANDPolicy(TypedDict):\n AND: List[Policy]\n\n\ndef print_policy(policy: CombinedANDPolicy | CombinedORPolicy | Policy) -> None:\n if 'OR' in policy:\n allowed_policy_names = ' '.join([p['name'] for p in policy['OR']])\n print(f\"Can match _any_ of the following: {allowed_policy_names}\")\n elif 'AND' in policy:\n allowed_policy_names = ' '.join([p['name'] for p in policy['AND']])\n print(f\"Must match _all_ the following: {allowed_policy_names}\")\n else:\n print(f\"Must be exactly {policy['name']}\")\n\n\n# pretend this is an API endpoint or something\nprint_policy({'name': 'role:is_admin'})\n```\n\nhttps://github.com/python/mypy/pull/13838 being closed seems to imply this is possible but i'm still having trouble.\n\nHere's the current mypy (1.14.1) output:\n\n```\ntest.py: note: In function \"print_policy\":\ntest.py:16:68: error: TypedDict \"CombinedANDPolicy\" has no key \"OR\" [typeddict-item]\ntest.py:16:68: error: TypedDict \"Policy\" has no key \"OR\" [typeddict-item]\ntest.py:19:68: error: TypedDict \"Policy\" has no key \"AND\" [typeddict-item]\nFound 3 errors in 1 file (checked 1 source file)\n```\n\nThe solution as I understand is either:\n- force an API change (e.g. `print_policy({'name': 'role:is_admin', 'tag': 'root-policy'})`)\n- use `cast` (e.g. `policy = cast(CombinedANDPolicy, policy)`\n\nIs there anything more idiomatic i'm missing?\n\n(I searched the tracker but wasn't able to find discission of this specifically, but I think this is related: https://github.com/python/mypy/issues/7981 https://github.com/python/mypy/issues/12098 https://github.com/python/mypy/issues/11080)\n\nIs there a stance on this yet? Is this is a goal or non-goal of mypy? Thanks!\n\nFWIW -- here's a version of this working in\n- [TypeScript](https://www.typescriptlang.org/play/?#code/JYOwLgpgTgZghgYwgAgAoHsA2wEE9kDeAUMqciHALYQBcyAzmFKAOZEC+RRoksiKAYXSUARqAgATAPJQM2PIRJkpAJToBBKFDi4APHJy4AfBy49o8JMiGjxE9SAkGFxMsnUA5ACIatO-ViGJpxEMACuIAhgwOggyAAOzODOuAAU8YF4dCnIAD7WwmIgkjI5+TZFkg5OmbgAlIpuwDDIqQDkqm3IoAm1Da5uZAixjMhwmJjoAO6SKR5UEPTIALy98rgAdKoblHDx6StGCRsU1HUA3EqDyMMg9FgQG5Ms7QJwcbtgCAAWyAD671wf2Q6BaYG+KBgWEmU1YdDaABoxhNprNavNqPQLldkOxkBBMPQUM1Wm1PF4uj0Mut+ji3LdRuMYWj1hjFis1oYNuSdnsDssjvETgtsddSAyHk90C82gBZMKjT4-f5M4HgyHQ6Zw5CI5HMmqshZYy5uPEEomNMUSzCPZ7teWjEQoCAAD0QYEw+F11K5pwgorInHYQA)\n- [Pyright](https://pyright-play.net/?code=GYJw9gtgBA%2BjwFcAuCQFM5QJYQA5hCSgEMA7UsJYpLMUgZwChRIokBPXLUgc2zwJEAMlnpIANFAAqnNABMAIlgDGSRo2UAbYvXpQACmE0r2AChm55S1QEoAXIyhOopYhDR2oYkOq069AMKQAEbc8gDyAEqGxspmFlYqSPaOzlGeImIA2jEmALq%2B2rpQQRChpPIAggByCrlx5rKKSSnOUDUKGaJIOUb56oxyaMBQuCDcSDD4sWbTJp6l5VW19exQAD4lIWFyUasbBn1xNlAAtAB8UNV0HqlOWCMA5FGP2KSjR%2BwObW3EmppgADu8imnxgrncegAvFBXo8AHQAKzA3FMWVwWUeELQjzyUGABFGbw%2BM0xLzyeRsdx%2BYwmpmAACIAmQoBBqMoABawMjsGBQMAjJActD4owAwHcHieADef3FILmcXBbjQ9AAvgyqW00MYnh1XtwSfNqb9-kCFWDsdDYbCkSjSGiMViVbjRSAiYbFexMfqKVqfk5aaQkPSGQBZBBiVnsrkwOV8oUiglmiW8GVy81yUEzZWQjX%2Bpw6%2Bi3AOB8bB0MRqPBEVoAAexFUmjW0q9mOxuPzAwAxKN0Eg0KQ5GwOaJsHoWZV9ABJKCDuT4Cb8930SBoIWSxhByZe0zS53uR6eR7gTQeURxuQQbiPNU2IA)\n\n\n\nthanks!\n","author":{"url":"https://github.com/magicmark","@type":"Person","name":"magicmark"},"datePublished":"2025-01-27T04:07:03Z","url":"https://github.com/python/mypy/issues/18543"}
| 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:8363d0b4-357c-2729-966a-7299d369e66d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B2D0:24D752:30CE72:41FA64:6B0026C8 |
| html-safe-nonce | e9edbd577e3d613b3c4a083333c94522bc1505af4cf3065c257a229767e546d2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMkQwOjI0RDc1MjozMENFNzI6NDFGQTY0OjZCMDAyNkM4IiwidmlzaXRvcl9pZCI6IjE2ODQ3MzgyNTk4MDE4NzYxNjgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | aee0bf152c14293b112c01783ba660cfdce32470167e954fcce1be45acfe7a43 |
| hovercard-subject-tag | issue:2812038604 |
| 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/python/mypy/18543/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2a7623ee69cb21581656c884d4b32ab5fdcadbb2ebc76640bb0c6bddee550940/python/mypy/issues/18543 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2a7623ee69cb21581656c884d4b32ab5fdcadbb2ebc76640bb0c6bddee550940/python/mypy/issues/18543 |
| og:image:alt | The docs give very clear guidance on how to write code using unions of TypedDicts: https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts This makes sense! However, a common use... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | magicmark |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/mypy git https://github.com/python/mypy.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 7053637 |
| octolytics-dimension-repository_nwo | python/mypy |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 7053637 |
| octolytics-dimension-repository_network_root_nwo | python/mypy |
| 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 | 44c658b24abf00491fb7ae5f56d42c9f38cbeab2 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width