[Python-checkins] Fix: Docstrings hidden by slots. (GH-23352)

miss-islington webhook-mailer at python.org
Tue Nov 17 16:50:31 EST 2020


https://github.com/python/cpython/commit/282282a1c9347adbd07a2d59c2b861df7580cebb
commit: 282282a1c9347adbd07a2d59c2b861df7580cebb
branch: master
author: Julien Palard <julien at palard.fr>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2020-11-17T13:50:23-08:00
summary:

Fix: Docstrings hidden by slots. (GH-23352)



Some `__slots__` where before the docstring, hiding them.

files:
M Lib/_collections_abc.py

diff --git a/Lib/_collections_abc.py b/Lib/_collections_abc.py
index 36cd993000347..28690f8c0bdc5 100644
--- a/Lib/_collections_abc.py
+++ b/Lib/_collections_abc.py
@@ -430,7 +430,6 @@ def __subclasshook__(cls, C):
 
 
 class Set(Collection):
-
     """A set is a finite, iterable container.
 
     This class provides concrete generic implementations of all
@@ -657,17 +656,15 @@ def __isub__(self, it):
 
 
 class Mapping(Collection):
-
-    __slots__ = ()
-
     """A Mapping is a generic container for associating key/value
     pairs.
 
     This class provides concrete generic implementations of all
     methods except for __getitem__, __iter__, and __len__.
-
     """
 
+    __slots__ = ()
+
     @abstractmethod
     def __getitem__(self, key):
         raise KeyError
@@ -789,18 +786,16 @@ def __iter__(self):
 
 
 class MutableMapping(Mapping):
-
-    __slots__ = ()
-
     """A MutableMapping is a generic container for associating
     key/value pairs.
 
     This class provides concrete generic implementations of all
     methods except for __getitem__, __setitem__, __delitem__,
     __iter__, and __len__.
-
     """
 
+    __slots__ = ()
+
     @abstractmethod
     def __setitem__(self, key, value):
         raise KeyError
@@ -879,7 +874,6 @@ def setdefault(self, key, default=None):
 
 
 class Sequence(Reversible, Collection):
-
     """All the operations on a read-only sequence.
 
     Concrete subclasses must override __new__ or __init__,
@@ -947,7 +941,6 @@ def count(self, value):
 
 
 class ByteString(Sequence):
-
     """This unifies bytes and bytearray.
 
     XXX Should add all their methods.
@@ -960,16 +953,14 @@ class ByteString(Sequence):
 
 
 class MutableSequence(Sequence):
-
-    __slots__ = ()
-
     """All the operations on a read-write sequence.
 
     Concrete subclasses must provide __new__ or __init__,
     __getitem__, __setitem__, __delitem__, __len__, and insert().
-
     """
 
+    __slots__ = ()
+
     @abstractmethod
     def __setitem__(self, index, value):
         raise IndexError



More information about the Python-checkins mailing list