René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:8363d0b4-357c-2729-966a-7299d369e66d
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB2D0:24D752:30CE72:41FA64:6B0026C8
html-safe-noncee9edbd577e3d613b3c4a083333c94522bc1505af4cf3065c257a229767e546d2
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMkQwOjI0RDc1MjozMENFNzI6NDFGQTY0OjZCMDAyNkM4IiwidmlzaXRvcl9pZCI6IjE2ODQ3MzgyNTk4MDE4NzYxNjgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacaee0bf152c14293b112c01783ba660cfdce32470167e954fcce1be45acfe7a43
hovercard-subject-tagissue:2812038604
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/mypy/18543/issue_layout
twitter:imagehttps://opengraph.githubassets.com/2a7623ee69cb21581656c884d4b32ab5fdcadbb2ebc76640bb0c6bddee550940/python/mypy/issues/18543
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/2a7623ee69cb21581656c884d4b32ab5fdcadbb2ebc76640bb0c6bddee550940/python/mypy/issues/18543
og:image:altThe 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamemagicmark
hostnamegithub.com
expected-hostnamegithub.com
None4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0
turbo-cache-controlno-preview
go-importgithub.com/python/mypy git https://github.com/python/mypy.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id7053637
octolytics-dimension-repository_nwopython/mypy
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id7053637
octolytics-dimension-repository_network_root_nwopython/mypy
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release44c658b24abf00491fb7ae5f56d42c9f38cbeab2
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/mypy/issues/18543#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F18543
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fmypy%2Fissues%2F18543
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fmypy
Reloadhttps://github.com/python/mypy/issues/18543
Reloadhttps://github.com/python/mypy/issues/18543
Reloadhttps://github.com/python/mypy/issues/18543
pythonhttps://github.com/python
mypyhttps://github.com/python/mypy
Codehttps://github.com/python/mypy
Issues2.7k (2.7k)https://github.com/python/mypy/issues
Pull requests547 (547)https://github.com/python/mypy/pulls
Actionshttps://github.com/python/mypy/actions
Projectshttps://github.com/python/mypy/projects
Wikihttps://github.com/python/mypy/wiki
Security and qualityhttps://github.com/python/mypy/security
Insightshttps://github.com/python/mypy/insights
https://github.com/python/mypy
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/18543
New issuehttps://github.com/login?return_to=https://github.com/python/mypy/issues/18543
#18547https://github.com/python/mypy/pull/18547
Guidance needed: how to narrow unions of TypedDicts?https://github.com/python/mypy/issues/18543#top
#18547https://github.com/python/mypy/pull/18547
https://github.com/magicmark
magicmarkhttps://github.com/magicmark
on Jan 27, 2025https://github.com/python/mypy/issues/18543#issue-2812038604
https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddictshttps://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts
#13838https://github.com/python/mypy/pull/13838
#7981https://github.com/python/mypy/issues/7981
#12098https://github.com/python/mypy/issues/12098
#11080https://github.com/python/mypy/issues/11080
TypeScripthttps://www.typescriptlang.org/play/#code/JYOwLgpgTgZghgYwgAgAoHsA2wEE9kDeAUMqciHALYQBcyAzmFKAOZEC+RRoksiKAYXSUARqAgATAPJQM2PIRJkpAJToBBKFDi4APHJy4AfBy49o8JMiGjxE9SAkGFxMsnUA5ACIatO-ViGJpxEMACuIAhgwOggyAAOzODOuAAU8YF4dCnIAD7WwmIgkjI5+TZFkg5OmbgAlIpuwDDIqQDkqm3IoAm1Da5uZAixjMhwmJjoAO6SKR5UEPTIALy98rgAdKoblHDx6StGCRsU1HUA3EqDyMMg9FgQG5Ms7QJwcbtgCAAWyAD671wf2Q6BaYG+KBgWEmU1YdDaABoxhNprNavNqPQLldkOxkBBMPQUM1Wm1PF4uj0Mut+ji3LdRuMYWj1hjFis1oYNuSdnsDssjvETgtsddSAyHk90C82gBZMKjT4-f5M4HgyHQ6Zw5CI5HMmqshZYy5uPEEomNMUSzCPZ7teWjEQoCAAD0QYEw+F11K5pwgorInHYQA
Pyrighthttps://pyright-play.net/?code=GYJw9gtgBA%2BjwFcAuCQFM5QJYQA5hCSgEMA7UsJYpLMUgZwChRIokBPXLUgc2zwJEAMlnpIANFAAqnNABMAIlgDGSRo2UAbYvXpQACmE0r2AChm55S1QEoAXIyhOopYhDR2oYkOq069AMKQAEbc8gDyAEqGxspmFlYqSPaOzlGeImIA2jEmALq%2B2rpQQRChpPIAggByCrlx5rKKSSnOUDUKGaJIOUb56oxyaMBQuCDcSDD4sWbTJp6l5VW19exQAD4lIWFyUasbBn1xNlAAtAB8UNV0HqlOWCMA5FGP2KSjR%2BwObW3EmppgADu8imnxgrncegAvFBXo8AHQAKzA3FMWVwWUeELQjzyUGABFGbw%2BM0xLzyeRsdx%2BYwmpmAACIAmQoBBqMoABawMjsGBQMAjJActD4owAwHcHieADef3FILmcXBbjQ9AAvgyqW00MYnh1XtwSfNqb9-kCFWDsdDYbCkSjSGiMViVbjRSAiYbFexMfqKVqfk5aaQkPSGQBZBBiVnsrkwOV8oUiglmiW8GVy81yUEzZWQjX%2Bpw6%2Bi3AOB8bB0MRqPBEVoAAexFUmjW0q9mOxuPzAwAxKN0Eg0KQ5GwOaJsHoWZV9ABJKCDuT4Cb8930SBoIWSxhByZe0zS53uR6eR7gTQeURxuQQbiPNU2IA
https://github.com/A5rocks
A5rockshttps://github.com/A5rocks
on Jan 27, 2025https://github.com/python/mypy/issues/18543#issuecomment-2614973840
#15697https://github.com/python/mypy/issues/15697
A5rockshttps://github.com/A5rocks
completedhttps://github.com/python/mypy/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Jan 27, 2025https://github.com/python/mypy/issues/18543#event-16073287802
https://github.com/A5rocks
A5rockshttps://github.com/A5rocks
on Jan 27, 2025https://github.com/python/mypy/issues/18543#issuecomment-2614974931
A5rockshttps://github.com/A5rocks
not plannedhttps://github.com/python/mypy/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Anot-planned
on Jan 27, 2025https://github.com/python/mypy/issues/18543#event-16073350657
https://github.com/magicmark
magicmarkhttps://github.com/magicmark
on Jan 27, 2025https://github.com/python/mypy/issues/18543#issuecomment-2615875140
https://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddictshttps://mypy.readthedocs.io/en/stable/typed_dict.html#unions-of-typeddicts
magicmarkhttps://github.com/magicmark
on Jan 27, 2025https://github.com/python/mypy/issues/18543#event-16079024114
[docs] Add example of using `@final` with TypedDicthttps://github.com/magicmark/mypy/commit/fd7ffbd100f342001a424f4a044bde4556ed4e0d
fd7ffbdhttps://github.com/magicmark/mypy/commit/fd7ffbd100f342001a424f4a044bde4556ed4e0d
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/mypy/issues/18543
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/mypy/issues/18543
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.