← eval7_submission

rich_3894

resolved RESOLVED LOOP HIGH_ERROR_RATE PASS · 11 tool calls · 81 s · Textualize/rich

Task input

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 calls (12)

#	Tool	Arguments	Result
1	`run_command`	{ "command": "python3 -c \"from functools import lru_cache\nfrom rich import inspect\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ninspect(Klaas, all=True)\"" }	{"status": "error", "error_type": "CommandError", "error_message": "Traceback (most recent call last):\n File \"<string>\", line 8, in <module>\n inspect(Klaas, full {"status": "error", "error_type": "CommandError", "error_message": "Traceback (most recent call last):\n File \"<string>\", line 8, 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", "details": {"stdout": "", "stderr": "Traceback (most recent call last):\n File \"<string>\", line 8, 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 15
2-4 ×3	`read_file`	{ "filepath": "rich/_inspect.py", "start_line": "100", "end_line": "130" }	{"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"} full {"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"}
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 t full {"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-7 ×2	`read_file`	{ "filepath": "rich/_inspect.py", "start_line": "100" }	{"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"} full {"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"}
8	`read_file`	{ "filepath": "rich/_inspect.py", "start_line": "80", "end_line": "120" }	{"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"} full {"status": "error", "error_type": "FileReadError", "error_message": "'>' not supported between instances of 'int' and 'str'"}
9	`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 t full {"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
10	`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 = name", "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 = name\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}
11	`run_command`	{ "command": "python3 -c \"from functools import lru_cache\nfrom rich import inspect\n\n@lru_cache\nclass Klaas:\n __slots__ = ('__qualname__',)\n\ninspect(Klaas, all=True)\"" }	{"status": "ok", "stdout": "\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 <functools._lru_cache_wrapper object at 0x7890d53b9850> \u2500\u2 full {"status": "ok", "stdout": "\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 <functools._lru_cache_wrapper object at 0x7890d53b9850> \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 0x7890d51d34c0>, \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__': 4, \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_
12	`submit_patch`	{}	{"status": "ok", "patch_size": 595, "files_changed": 1} full {"status": "ok", "patch_size": 595, "files_changed": 1}

Patch

diff --git a/rich/_inspect.py b/rich/_inspect.py
index 27d65cec..05d5eecc 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 = name
 
         # If obj is a module, there may be classes (which are callable) to display
         if inspect.isclass(obj):

Test output

show

...s....sss...................................                           [100%]
42 passed, 4 skipped in 0.21s