Title: Improve error message from `os.fspath` if `__fspath__` is set to `None` · Issue #106046 · python/cpython · GitHub
Open Graph Title: Improve error message from `os.fspath` if `__fspath__` is set to `None` · Issue #106046 · python/cpython
X Title: Improve error message from `os.fspath` if `__fspath__` is set to `None` · Issue #106046 · python/cpython
Description: Feature or enhancement A common Python idiom is to set a magic method to None in a subclass if you want to disable the behaviour that the magic method enables. If you do so, a nice error message will be given if a user tries to "call" th...
Open Graph Description: Feature or enhancement A common Python idiom is to set a magic method to None in a subclass if you want to disable the behaviour that the magic method enables. If you do so, a nice error message wi...
X Description: Feature or enhancement A common Python idiom is to set a magic method to None in a subclass if you want to disable the behaviour that the magic method enables. If you do so, a nice error message wi...
Opengraph URL: https://github.com/python/cpython/issues/106046
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Improve error message from `os.fspath` if `__fspath__` is set to `None`","articleBody":"# Feature or enhancement\r\n\r\nA common Python idiom is to set a magic method to `None` in a subclass if you want to disable the behaviour that the magic method enables. If you do so, a nice error message will be given if a user tries to \"call\" the magic method that's been set to `None`. For example:\r\n\r\n```pycon\r\n\u003e\u003e\u003e class Foo(list):\r\n... __iter__ = None\r\n...\r\n\u003e\u003e\u003e iter(Foo())\r\nTraceback (most recent call last):\r\n File \"\u003cstdin\u003e\", line 1, in \u003cmodule\u003e\r\nTypeError: 'Foo' object is not iterable\r\n\u003e\u003e\u003e class Bar(int):\r\n... __hash__ = None\r\n...\r\n\u003e\u003e\u003e hash(Bar(42))\r\nTraceback (most recent call last):\r\n File \"\u003cstdin\u003e\", line 1, in \u003cmodule\u003e\r\nTypeError: unhashable type: 'Bar'\r\n```\r\n\r\nHowever, Python doesn't currently do the same thing for `__fspath__`. If a subclass of an `os.PathLike` sets `__fspath__` to `None`, Python gives a bad error message when `os.fspath` is called on instances of that subclass:\r\n\r\n```pycon\r\n\u003e\u003e\u003e from pathlib import Path\r\n\u003e\u003e\u003e import os\r\n\u003e\u003e\u003e class Baz(Path):\r\n... __fspath__ = None\r\n...\r\n\u003e\u003e\u003e os.fspath(Baz())\r\nTraceback (most recent call last):\r\n File \"\u003cstdin\u003e\", line 1, in \u003cmodule\u003e\r\nTypeError: 'NoneType' object is not callable\r\n```\r\n\r\n# Pitch\r\n\r\nIt would be nice if Python handled `__fspath__` being set to `None` the same way it handles magic methods such as `__iter__` or `__hash__` being set to `None`. The error message in such cases should be the `expected str, bytes or os.PathLike object, not Baz` error message that the interpreter gives when `os.fspath` is called on an object that has no `__fspath__` method at all.\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-106082\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/AlexWaygood","@type":"Person","name":"AlexWaygood"},"datePublished":"2023-06-23T19:03:13.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/106046/cpython/issues/106046"}
| 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:2fa16c83-ae3a-1b2e-b3f0-4c0b669c65fd |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 988A:1272F1:1833E28:21958E2:696AA212 |
| html-safe-nonce | 7cc0a81f3fd2a4f73f6bc0ca0b164ce3d7b576bd7e09032a9a21e10aeb9ddf8b |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5ODhBOjEyNzJGMToxODMzRTI4OjIxOTU4RTI6Njk2QUEyMTIiLCJ2aXNpdG9yX2lkIjoiNTE0NDkxODMyMTgwMjE1ODYxMCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 5e1a942739cc6d4d0cbe5af3a2069e1ad5a4c03d1b21b5dda3a690f66ebfa3b0 |
| hovercard-subject-tag | issue:1771952612 |
| 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/cpython/106046/issue_layout |
| twitter:image | https://opengraph.githubassets.com/b0b61eabcee76bc96deeb1777813458b088514a4a653a064804e587d927c26a1/python/cpython/issues/106046 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/b0b61eabcee76bc96deeb1777813458b088514a4a653a064804e587d927c26a1/python/cpython/issues/106046 |
| og:image:alt | Feature or enhancement A common Python idiom is to set a magic method to None in a subclass if you want to disable the behaviour that the magic method enables. If you do so, a nice error message wi... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | AlexWaygood |
| hostname | github.com |
| expected-hostname | github.com |
| None | a51f97dbb9326f71c08ecb61577457d543c602124d1a2672871258ef37ac5261 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| 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 | 4bd0eac606c70914085176ef312ebdcd97a8cdf1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width