Title: Add more return types to the `numbers` module by AlexWaygood · Pull Request #11353 · python/typeshed · GitHub
Open Graph Title: Add more return types to the `numbers` module by AlexWaygood · Pull Request #11353 · python/typeshed
X Title: Add more return types to the `numbers` module by AlexWaygood · Pull Request #11353 · python/typeshed
Description: This PR represents a compromise between what the numbers module was supposed to be, and the reality of where we are today with Python's typing system. This module is supposed to provide a framework of ABCs that would allow for third-party implementations of Complex, Rational, Real and Integral numbers. As such, the annotations we should be giving to the Real class should be something like this: class Real: @abstractmethod def __mod__(self, other: Real) -> Real: ... @abstractmethod def __round__(self, ndigits: int) -> Real: ... @abstractmethod def __divmod__(self, other: Real) -> tuple[Real, Real]: ... Unfortunately, that doesn't work! The reason is that fractions.Fraction inherits from numbers.Real, and it overrides these abstract methods to provide concrete implementations. The concrete implementations return concrete types such as int, which type checkers don't recognise as subtypes of Real (because the numbers module has never been supported by static type checkers, and never will be): typeshed/stdlib/fractions.pyi Lines 105 to 106 in 547cbc7 @overload def __divmod__(a, b: int | Fraction) -> tuple[int, Fraction]: ... As such, for every method I tried adding types to according to the above strategy, mypy emitted an error warning me that fractions.Fraction incompatibly overrode numbers.Real. (There were also similar errors for a numbers.Real subclass in our Pillow stubs.) Instead of returning Complex from methods that really should be returning Complex, therefore, this PR annotates those methods as returning SupportsComplex. SupportsComplex works pretty well here: It's a supertype of numbers.Complex, so it's not incorrect It's a good deal more precise than Any It's vague enough that it will permit third-party subclassers to return their own implementations of numbers.Complex from these methods, which is what the module was designed for anyway. In a similar way, I've annotated methods that should be returning numbers.Integral as returning SupportsIndex, and I've annotated methods that should be returning numbers.Real as returning SupportsFloat. I haven't attempted to add any new argument annotations as part of this PR. The return annotations were hard enough.
Open Graph Description: This PR represents a compromise between what the numbers module was supposed to be, and the reality of where we are today with Python's typing system. This module is supposed to provide a frame...
X Description: This PR represents a compromise between what the numbers module was supposed to be, and the reality of where we are today with Python's typing system. This module is supposed to provide a f...
Opengraph URL: https://github.com/python/typeshed/pull/11353
X: @github
Domain: github.com
| 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 | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:06141fac-0a29-320b-bc4d-813a30e4e3ee |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D7D0:3E4AC7:2523865:3265656:6B0032E1 |
| html-safe-nonce | fdcd88e29b01f5b915396b262c93693ab58eb0682fd546fdaf10799e02cdaca9 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0QwOjNFNEFDNzoyNTIzODY1OjMyNjU2NTY6NkIwMDMyRTEiLCJ2aXNpdG9yX2lkIjoiNzU3NjYxMTIzNDM4OTE3NzA1NyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 18e724657e8518d3c0fa643079e5d081a214885ecd8d3cc6989c8171044d8a91 |
| hovercard-subject-tag | pull_request:1706488283 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,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/python/typeshed/pull/11353/files |
| twitter:image | https://avatars.githubusercontent.com/u/66076021?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/66076021?s=400&v=4 |
| og:image:alt | This PR represents a compromise between what the numbers module was supposed to be, and the reality of where we are today with Python's typing system. This module is supposed to provide a frame... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/python/typeshed git https://github.com/python/typeshed.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 31696383 |
| octolytics-dimension-repository_nwo | python/typeshed |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 31696383 |
| octolytics-dimension-repository_network_root_nwo | python/typeshed |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | f3f3a43ca095cdea3abbb394112e971f9fdb94fa |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width