[Python-checkins] [3.11] gh-103449: Fix a bug in dataclass docstring generation (GH-103454) (#103599)
carljm
webhook-mailer at python.org
Sun Apr 23 11:41:19 EDT 2023
https://github.com/python/cpython/commit/ec29d0c0916af129eaafb0ad392449ca173309ed
commit: ec29d0c0916af129eaafb0ad392449ca173309ed
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: carljm <carl at oddbird.net>
date: 2023-04-23T09:40:52-06:00
summary:
[3.11] gh-103449: Fix a bug in dataclass docstring generation (GH-103454) (#103599)
files:
A Misc/NEWS.d/next/Library/2023-04-11-21-38-39.gh-issue-103449.-nxmhb.rst
M Lib/dataclasses.py
M Lib/test/test_dataclasses.py
diff --git a/Lib/dataclasses.py b/Lib/dataclasses.py
index 221ea2ba3e77..a7e0547705ca 100644
--- a/Lib/dataclasses.py
+++ b/Lib/dataclasses.py
@@ -1092,8 +1092,13 @@ def _process_class(cls, init, repr, eq, order, unsafe_hash, frozen,
if not getattr(cls, '__doc__'):
# Create a class doc-string.
- cls.__doc__ = (cls.__name__ +
- str(inspect.signature(cls)).replace(' -> None', ''))
+ try:
+ # In some cases fetching a signature is not possible.
+ # But, we surely should not fail in this case.
+ text_sig = str(inspect.signature(cls)).replace(' -> None', '')
+ except (TypeError, ValueError):
+ text_sig = ''
+ cls.__doc__ = (cls.__name__ + text_sig)
if match_args:
# I could probably compute this once
diff --git a/Lib/test/test_dataclasses.py b/Lib/test/test_dataclasses.py
index abe02e3b1ab6..1aaa78db4b0a 100644
--- a/Lib/test/test_dataclasses.py
+++ b/Lib/test/test_dataclasses.py
@@ -2224,6 +2224,19 @@ class C:
self.assertDocStrEqual(C.__doc__, "C(x:collections.deque=<factory>)")
+ def test_docstring_with_no_signature(self):
+ # See https://github.com/python/cpython/issues/103449
+ class Meta(type):
+ __call__ = dict
+ class Base(metaclass=Meta):
+ pass
+
+ @dataclass
+ class C(Base):
+ pass
+
+ self.assertDocStrEqual(C.__doc__, "C")
+
class TestInit(unittest.TestCase):
def test_base_has_init(self):
diff --git a/Misc/NEWS.d/next/Library/2023-04-11-21-38-39.gh-issue-103449.-nxmhb.rst b/Misc/NEWS.d/next/Library/2023-04-11-21-38-39.gh-issue-103449.-nxmhb.rst
new file mode 100644
index 000000000000..0b2b47af1cba
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2023-04-11-21-38-39.gh-issue-103449.-nxmhb.rst
@@ -0,0 +1 @@
+Fix a bug in doc string generation in :func:`dataclasses.dataclass`.
More information about the Python-checkins
mailing list