]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-103449: Fix a bug in dataclass docstring generation (GH-103454) (#103599)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 23 Apr 2023 15:40:52 +0000 (08:40 -0700)
committerGitHub <noreply@github.com>
Sun, 23 Apr 2023 15:40:52 +0000 (09:40 -0600)
Lib/dataclasses.py
Lib/test/test_dataclasses.py
Misc/NEWS.d/next/Library/2023-04-11-21-38-39.gh-issue-103449.-nxmhb.rst [new file with mode: 0644]

index 221ea2ba3e77c3a36a62d6fd7f0c5fa5f5fd29e3..a7e0547705ca2823526457b50ca3327ce677546f 100644 (file)
@@ -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
index abe02e3b1ab6dfa775d534a5c5ebff2948284992..1aaa78db4b0af880c4259b5de81d0a95cdc4a85b 100644 (file)
@@ -2224,6 +2224,19 @@ class TestDocString(unittest.TestCase):
 
         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 (file)
index 0000000..0b2b47a
--- /dev/null
@@ -0,0 +1 @@
+Fix a bug in doc string generation in :func:`dataclasses.dataclass`.