resolved RESOLVED PASS · 12 tool calls · 40 s · Textualize/rich
Handle unusual __qualname__ in inspect
<!--
Please note that Rich isn't accepting any new features at this point.
If a feature can be implemented without modifying the core library, then
they should be released as a third-party module. I can accept updates to the
core library that make it easier to extend (think hooks).
Bugfixes are always welcome of course.
Sometimes it is not clear what is a feature and what is a bug fix.
If there is any doubt, please open a discussion first.
-->
<!--
*Are you contributing typo fixes?*
If your PR solely consists of typos, at least one must be in the docs to warrant an addition to CONTRIBUTORS.md
-->
## Type of changes
- [x] Bug fix
- [ ] New feature
- [ ] Documentation / docstrings
- [x] Tests
- [ ] Other
## Checklist
- [x] I've run the latest [black](https://github.com/psf/black) with default args on new code.
- [x] I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate (see note about typos above).
- [x] I've added tests for new code.
- [x] I accept that @willmcgugan may be pedantic in the code review.
## Description
I discovered, that an object with an unusual `__qualname__` attribute (not a `str`, e.g. a descriptor) causes `inspect` to fail.
This can happen if an object is created this way intentionally, but I discovered it, when decorating a class with `@functools.lru_cache` which forwards the underlying attributes using a descriptor when it can't add the to it's `__dict__` because the class uses `__slots__`:
```python
from functools import lru_cache
from rich import inspect
@lru_cache
class Klaas:
__slots__ = ("__qualname__",)
if __name__ == "__main__":
from rich.traceback import install
install()
inspect(Klaas.__qualname__)
inspect(Klaas, all=True)
```
I fixed it by checking the type of `__qualname__` falling back to `__name__` and if that isn't a `str` using the already provided fallback.
| # | Tool | Arguments | Result |
|---|---|---|---|
| 1 | run_command | {
"command": "python3 -c \"\nfrom functools import lru_cache\nfrom rich import inspect\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ntry:\n inspect(Klaas, all=True)\n print('Success')\nexcept Exception as e:\n print(f'Failed: {e}')\n\""
} | {"status": "ok", "stdout": "Failed: Only str or Text can be appended to Text\n", "exit_code": 0}full{"status": "ok", "stdout": "Failed: Only str or Text can be appended to Text\n", "exit_code": 0} |
| 2 | run_command | {
"command": "grep -rn \"inspect\" rich | grep \"def\""
} | {"status": "ok", "stdout": "rich/__init__.py:120:def inspect(\nrich/default_styles.py:39: \"inspect.attr\": Style(color=\"yellow\", italic=True),\nrich/default_full{"status": "ok", "stdout": "rich/__init__.py:120:def inspect(\nrich/default_styles.py:39: \"inspect.attr\": Style(color=\"yellow\", italic=True),\nrich/default_styles.py:40: \"inspect.attr.dunder\": Style(color=\"yellow\", italic=True, dim=True),\nrich/default_styles.py:41: \"inspect.callable\": Style(bold=True, color=\"red\"),\nrich/default_styles.py:42: \"inspect.async_def\": Style(italic=True, color=\"bright_cyan\"),\nrich/default_styles.py:43: \"inspect.def\": Style(italic=True, color=\"bright_cyan\"),\nrich/default_styles.py:44: \"inspect.class\": Style(italic=True, color=\"bright_cyan\"),\nrich/default_styles.py:45: \"inspect.error\": Style(bold=True, color=\"red\"),\nrich/default_styles.py:46: \"inspect.equals\": Style(),\nrich/default_styles.py:47: \"inspect.help\": Style(color=\"cyan\"),\nrich/default_styles.py:48: \"inspect.doc\": Style(dim=True),\nrich/default_styles.py:49: \"inspect.value.border\": Style(color=\"green\"),\nrich/pretty.py:109: default_repr_file = inspect.getfile(_dummy_namedtuple.__repr__)\n", "exit_code": 0} |
| 3 | read_file | {
"filepath": "rich/__init__.py",
"start_line": 120
} | {"status": "ok", "filepath": "rich/__init__.py", "content": "def inspect(\n obj: Any,\n *,\n console: Optional[\"Console\"] = None,\n title: Optional[str] = Nonfull{"status": "ok", "filepath": "rich/__init__.py", "content": "def inspect(\n obj: Any,\n *,\n console: Optional[\"Console\"] = None,\n title: Optional[str] = None,\n help: bool = False,\n methods: bool = False,\n docs: bool = True,\n private: bool = False,\n dunder: bool = False,\n sort: bool = True,\n all: bool = False,\n value: bool = True,\n) -> None:\n \"\"\"Inspect any Python object.\n\n * inspect(<OBJECT>) to see summarized info.\n * inspect(<OBJECT>, methods=True) to see methods.\n * inspect(<OBJECT>, help=True) to see full (non-abbreviated) help.\n * inspect(<OBJECT>, private=True) to see private attributes (single underscore).\n * inspect(<OBJECT>, dunder=True) to see attributes beginning with double underscore.\n * inspect(<OBJECT>, all=True) to see all attributes.\n\n Args:\n obj (Any): An object to inspect.\n title (str, optional): Title to display over inspect result, or None use type. Defaults to None.\n help (bool, optional): Show full help text rather than just first paragraph. Defaults to False.\n methods (bool, optional): Enable inspection of callables. Defaults to False.\n docs (bool, optional): Also render doc strings. Defaults to True.\n private (bool, optional): Show private attributes (beginning with underscore). Defaults to False.\n dunder (bool, optional): Show attributes starting with double underscore. Defaults to False.\n sort (bool, optional): Sort attributes alphabetically. Defaults to True.\n all (bool, optional): Show all attributes. Defaults to False.\n value (bool, optional): Pretty print value. Defaults to True.\n \"\"\"\n _console = console or get_console()\n from rich._inspect import Inspect\n\n # Special case for inspect(inspect)\n is_inspect = obj is inspect\n\n _inspect = Inspect(\n obj,\n title=title,\n help=is_inspect or help,\n methods=is_inspect or me |
| 4 | run_command | {
"command": "grep -rn \"class Inspect\" rich"
} | {"status": "ok", "stdout": "rich/_inspect.py:21:class Inspect(JupyterMixin):\n", "exit_code": 0}full{"status": "ok", "stdout": "rich/_inspect.py:21:class Inspect(JupyterMixin):\n", "exit_code": 0} |
| 5 | read_file | {
"filepath": "rich/_inspect.py"
} | {"status": "ok", "filepath": "rich/_inspect.py", "content": "import inspect\nfrom inspect import cleandoc, getdoc, getfile, isclass, ismodule, signature\nfrom tfull{"status": "ok", "filepath": "rich/_inspect.py", "content": "import inspect\nfrom inspect import cleandoc, getdoc, getfile, isclass, ismodule, signature\nfrom typing import Any, Collection, Iterable, Optional, Tuple, Type, Union\n\nfrom .console import Group, RenderableType\nfrom .control import escape_control_codes\nfrom .highlighter import ReprHighlighter\nfrom .jupyter import JupyterMixin\nfrom .panel import Panel\nfrom .pretty import Pretty\nfrom .table import Table\nfrom .text import Text, TextType\n\n\ndef _first_paragraph(doc: str) -> str:\n \"\"\"Get the first paragraph from a docstring.\"\"\"\n paragraph, _, _ = doc.partition(\"\\n\\n\")\n return paragraph\n\n\nclass Inspect(JupyterMixin):\n \"\"\"A renderable to inspect any Python Object.\n\n Args:\n obj (Any): An object to inspect.\n title (str, optional): Title to display over inspect result, or None use type. Defaults to None.\n help (bool, optional): Show full help text rather than just first paragraph. Defaults to False.\n methods (bool, optional): Enable inspection of callables. Defaults to False.\n docs (bool, optional): Also render doc strings. Defaults to True.\n private (bool, optional): Show private attributes (beginning with underscore). Defaults to False.\n dunder (bool, optional): Show attributes starting with double underscore. Defaults to False.\n sort (bool, optional): Sort attributes alphabetically. Defaults to True.\n all (bool, optional): Show all attributes. Defaults to False.\n value (bool, optional): Pretty print value of object. Defaults to True.\n \"\"\"\n\n def __init__(\n self,\n obj: Any,\n *,\n title: Optional[TextType] = None,\n help: bool = False,\n methods: bool = False,\n docs: bool = True,\n private: bool = False,\n dunder: bool = False,\n sort: bool = True,\n all: bool = True,\n value: bool = True,\n |
| 6 | read_file | {
"filepath": "rich/_inspect.py",
"start_line": 151,
"end_line": 268
} | {"status": "ok", "filepath": "rich/_inspect.py", "content": "\n if callable(obj):\n signature = self._get_signature(\"\", obj)\n if signature is not None:\n yiefull{"status": "ok", "filepath": "rich/_inspect.py", "content": "\n if callable(obj):\n signature = self._get_signature(\"\", obj)\n if signature is not None:\n yield signature\n yield \"\"\n\n if self.docs:\n _doc = self._get_formatted_doc(obj)\n if _doc is not None:\n doc_text = Text(_doc, style=\"inspect.help\")\n doc_text = highlighter(doc_text)\n yield doc_text\n yield \"\"\n\n if self.value and not (isclass(obj) or callable(obj) or ismodule(obj)):\n yield Panel(\n Pretty(obj, indent_guides=True, max_length=10, max_string=60),\n border_style=\"inspect.value.border\",\n )\n yield \"\"\n\n for key, (error, value) in items:\n key_text = Text.assemble(\n (\n key,\n \"inspect.attr.dunder\" if key.startswith(\"__\") else \"inspect.attr\",\n ),\n (\" =\", \"inspect.equals\"),\n )\n if error is not None:\n warning = key_text.copy()\n warning.stylize(\"inspect.error\")\n add_row(warning, highlighter(repr(error)))\n continue\n\n if callable(value):\n if not self.methods:\n continue\n\n _signature_text = self._get_signature(key, value)\n if _signature_text is None:\n add_row(key_text, Pretty(value, highlighter=highlighter))\n else:\n if self.docs:\n docs = self._get_formatted_doc(value)\n if docs is not None:\n _signature_text.append(\"\\n\" if \"\\n\" in docs else \" \")\n doc = highlighter(docs)\n doc.stylize(\"inspect.doc\")\n |
| 7 | run_command | {
"command": "python3 -c \"\nfrom functools import lru_cache\nfrom rich import inspect\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ntry:\n inspect(Klaas, all=True)\n print('Success')\nexcept Exception as e:\n print(f'Failed: {e}')\n import traceback\n traceback.print_exc()\n\""
} | {"status": "ok", "stdout": "Failed: Only str or Text can be appended to Text\n", "exit_code": 0}full{"status": "ok", "stdout": "Failed: Only str or Text can be appended to Text\n", "exit_code": 0} |
| 8 | run_command | {
"command": "python3 -c \"\nfrom functools import lru_cache\nfrom rich import inspect\nimport traceback\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ntry:\n inspect(Klaas, all=True)\nexcept Exception:\n traceback.print_exc()\n\""
} | {"status": "ok", "stdout": "", "exit_code": 0}full{"status": "ok", "stdout": "", "exit_code": 0} |
| 9 | run_command | {
"command": "python3 -c \"\nfrom functools import lru_cache\nfrom rich import inspect\nimport traceback\nimport sys\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ntry:\n inspect(Klaas, all=True)\nexcept Exception:\n traceback.print_exc(file=sys.stdout)\n\""
} | {"status": "ok", "stdout": "Traceback (most recent call last):\n File \"<string>\", line 12, in <module>\n inspect(Klaas, all=True)\n ~~~~~~~^^^^^^^^^^^^^^^^^\nfull{"status": "ok", "stdout": "Traceback (most recent call last):\n File \"<string>\", line 12, in <module>\n inspect(Klaas, all=True)\n ~~~~~~~^^^^^^^^^^^^^^^^^\n File \"/workspace/rich/__init__.py\", line 173, in inspect\n _console.print(_inspect)\n ~~~~~~~~~~~~~~^^^^^^^^^^\n File \"/workspace/rich/console.py\", line 1698, in print\n renderables = self._collect_renderables(\n objects,\n ...<5 lines>...\n highlight=highlight,\n )\n File \"/workspace/rich/console.py\", line 1555, in _collect_renderables\n renderable = rich_cast(renderable)\n File \"/workspace/rich/protocol.py\", line 36, in rich_cast\n renderable = cast_method()\n File \"/workspace/rich/_inspect.py\", line 76, in __rich__\n Group(*self._render()),\n ~~~~~^^^^^^^^^^^^^^^^^\n File \"/workspace/rich/_inspect.py\", line 153, in _render\n signature = self._get_signature(\"\", obj)\n File \"/workspace/rich/_inspect.py\", line 113, in _get_signature\n qual_signature = Text.assemble(\n (f\"{prefix} \", f\"inspect.{prefix.replace(' ', '_')}\"),\n (qualname, \"inspect.callable\"),\n signature_text,\n )\n File \"/workspace/rich/text.py\", line 397, in assemble\n append(*part)\n ~~~~~~^^^^^^^\n File \"/workspace/rich/text.py\", line 979, in append\n raise TypeError(\"Only str or Text can be appended to Text\")\nTypeError: Only str or Text can be appended to Text\n", "exit_code": 0} |
| 10 | read_file | {
"filepath": "rich/_inspect.py",
"start_line": 100,
"end_line": 120
} | {"status": "ok", "filepath": "rich/_inspect.py", "content": " callable_name.stylize(f\"link file://{source_filename}\")\n signature_text = self.highlighter(_sigfull{"status": "ok", "filepath": "rich/_inspect.py", "content": " callable_name.stylize(f\"link file://{source_filename}\")\n signature_text = self.highlighter(_signature)\n\n qualname = name or getattr(obj, \"__qualname__\", name)\n\n # If obj is a module, there may be classes (which are callable) to display\n if inspect.isclass(obj):\n prefix = \"class\"\n elif inspect.iscoroutinefunction(obj):\n prefix = \"async def\"\n else:\n prefix = \"def\"\n\n qual_signature = Text.assemble(\n (f\"{prefix} \", f\"inspect.{prefix.replace(' ', '_')}\"),\n (qualname, \"inspect.callable\"),\n signature_text,\n )\n\n return qual_signature\n\n", "start_line": 100, "end_line": 120, "total_lines": 268, "is_truncated": false} |
| 11 | edit_file | {
"filepath": "rich/_inspect.py",
"new_string": " qualname = name or getattr(obj, \"__qualname__\", name)\n if not isinstance(qualname, str):\n qualname = getattr(obj, \"__name__\", name)\n if not isinstance(qualname, str):\n qualname = str(qualname)",
"old_string": " qualname = name or getattr(obj, \"__qualname__\", name)"
} | {"status": "ok", "filepath": "rich/_inspect.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/_inspect.py\n+++ b/rich/_inspect.py\n@@ -101,6 +101,full{"status": "ok", "filepath": "rich/_inspect.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/_inspect.py\n+++ b/rich/_inspect.py\n@@ -101,6 +101,10 @@\n signature_text = self.highlighter(_signature)\n \n qualname = name or getattr(obj, \"__qualname__\", name)\n+ if not isinstance(qualname, str):\n+ qualname = getattr(obj, \"__name__\", name)\n+ if not isinstance(qualname, str):\n+ qualname = str(qualname)\n \n # If obj is a module, there may be classes (which are callable) to display\n if inspect.isclass(obj):\n", "is_truncated": false} |
| 12 | run_command | {
"command": "python3 -c \"\nfrom functools import lru_cache\nfrom rich import inspect\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ntry:\n inspect(Klaas, all=True)\n print('Success')\nexcept Exception as e:\n print(f'Failed: {e}')\n\""
} | {"status": "ok", "stdout": "\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 <functools._lru_cache_wrapper object at 0x78fb447997a0> \u2500\u2full{"status": "ok", "stdout": "\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 <functools._lru_cache_wrapper object at 0x78fb447997a0> \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 def Klaas(): \u2502\n\u2502 \u2502\n\u2502 __annotations__ = {} \u2502\n\u2502 __dict__ = { \u2502\n\u2502 'cache_parameters': <function \u2502\n\u2502 lru_cache.<locals>.<lambda> at 0x78fb445af4c0>, \u2502\n\u2502 '__module__': '__main__', \u2502\n\u2502 '__name__': 'Klaas', \u2502\n\u2502 '__qualname__': <member '__qualname__' of \u2502\n\u2502 'Klaas' objects>, \u2502\n\u2502 '__doc__': None, \u2502\n\u2502 '__annotations__': {}, \u2502\n\u2502 '__type_params__': (), \u2502\n\u2502 '__firstlineno__': 5, \u2502\n\u2502 '__slots__': ('__qualname__',), \u2502\n\u2502 '__static_attributes__': (), \u2502\n\u2502 '__wrapped__': <class '__main__.Klaas'> \u2502\n\u2502 } \u2502\n\u2502 __doc__ = None \u2502\n\u2502 __firstlineno_ |
| 13 | submit_patch | [] | {"status": "ok", "patch_size": 596, "files_changed": 1}full{"status": "ok", "patch_size": 596, "files_changed": 1} |
diff --git a/rich/_inspect.py b/rich/_inspect.py
index 27d65cec..527e1a25 100644
--- a/rich/_inspect.py
+++ b/rich/_inspect.py
@@ -101,6 +101,10 @@ class Inspect(JupyterMixin):
signature_text = self.highlighter(_signature)
qualname = name or getattr(obj, "__qualname__", name)
+ if not isinstance(qualname, str):
+ qualname = getattr(obj, "__name__", name)
+ if not isinstance(qualname, str):
+ qualname = str(qualname)
# If obj is a module, there may be classes (which are callable) to display
if inspect.isclass(obj):
...s....sss................................... [100%] 42 passed, 4 skipped in 0.21s