stubtest whitelists: use regexes, add comments (#3883)

Co-authored-by: hauntsaninja <>

tests/stubtest_whitelists/py36.txt

@@ -1,7 +1,3 @@
-ast.NodeVisitor.visit_AnnAssign
-ast.NodeVisitor.visit_Constant
-ast.NodeVisitor.visit_FormattedValue
-ast.NodeVisitor.visit_JoinedStr
 asyncio.Future.__init__
 asyncio.Task._wakeup
 asyncio.constants.SENDFILE_FALLBACK_READBUFFER_SIZE

tests/stubtest_whitelists/py37.txt

@@ -2,10 +2,6 @@ _bisect.bisect
 _bisect.insort
 _tracemalloc._get_object_traceback
 _tracemalloc.start
-ast.NodeVisitor.visit_AnnAssign
-ast.NodeVisitor.visit_Constant
-ast.NodeVisitor.visit_FormattedValue
-ast.NodeVisitor.visit_JoinedStr
 asyncio.AbstractEventLoop.create_unix_server
 asyncio.AbstractEventLoop.sock_sendfile
 asyncio.Future.__init__

tests/stubtest_whitelists/py38.txt

@@ -5,10 +5,6 @@ _thread._ExceptHookArgs
 _tracemalloc._get_object_traceback
 _tracemalloc.start
 _weakref.getweakrefcount
-ast.NodeVisitor.visit_AnnAssign
-ast.NodeVisitor.visit_FormattedValue
-ast.NodeVisitor.visit_JoinedStr
-ast.NodeVisitor.visit_NamedExpr
 asyncio.AbstractEventLoop.create_unix_server
 asyncio.AbstractEventLoop.sock_sendfile
 asyncio.Future.__init__
@@ -122,12 +118,7 @@ lzma.LZMACompressor.compress
 lzma.is_check_supported
 macpath
 macurl2path
-mmap.MADV_AUTOSYNC
-mmap.MADV_CORE
-mmap.MADV_NOCORE
-mmap.MADV_NOSYNC
-mmap.MADV_PROTECT
-mmap.MADV_SOFT_OFFLINE
+mmap.MADV_[A-Z_]+
 multiprocessing.pool.CLOSE
 multiprocessing.pool.RUN
 multiprocessing.pool.TERMINATE

tests/stubtest_whitelists/py3_common.txt

@@ -15,106 +15,6 @@ abc.abstractstaticmethod
 aifc.open
 aifc.openfp
 argparse.Namespace.__getattr__
-ast.NodeVisitor.visit_Add
-ast.NodeVisitor.visit_And
-ast.NodeVisitor.visit_Assert
-ast.NodeVisitor.visit_Assign
-ast.NodeVisitor.visit_AsyncFor
-ast.NodeVisitor.visit_AsyncFunctionDef
-ast.NodeVisitor.visit_AsyncWith
-ast.NodeVisitor.visit_Attribute
-ast.NodeVisitor.visit_AugAssign
-ast.NodeVisitor.visit_AugLoad
-ast.NodeVisitor.visit_AugStore
-ast.NodeVisitor.visit_Await
-ast.NodeVisitor.visit_BinOp
-ast.NodeVisitor.visit_BitAnd
-ast.NodeVisitor.visit_BitOr
-ast.NodeVisitor.visit_BitXor
-ast.NodeVisitor.visit_BoolOp
-ast.NodeVisitor.visit_Break
-ast.NodeVisitor.visit_Bytes
-ast.NodeVisitor.visit_Call
-ast.NodeVisitor.visit_ClassDef
-ast.NodeVisitor.visit_Compare
-ast.NodeVisitor.visit_Continue
-ast.NodeVisitor.visit_Del
-ast.NodeVisitor.visit_Delete
-ast.NodeVisitor.visit_Dict
-ast.NodeVisitor.visit_DictComp
-ast.NodeVisitor.visit_Div
-ast.NodeVisitor.visit_Ellipsis
-ast.NodeVisitor.visit_Eq
-ast.NodeVisitor.visit_ExceptHandler
-ast.NodeVisitor.visit_Expr
-ast.NodeVisitor.visit_Expression
-ast.NodeVisitor.visit_ExtSlice
-ast.NodeVisitor.visit_FloorDiv
-ast.NodeVisitor.visit_For
-ast.NodeVisitor.visit_FunctionDef
-ast.NodeVisitor.visit_GeneratorExp
-ast.NodeVisitor.visit_Global
-ast.NodeVisitor.visit_Gt
-ast.NodeVisitor.visit_GtE
-ast.NodeVisitor.visit_If
-ast.NodeVisitor.visit_IfExp
-ast.NodeVisitor.visit_Import
-ast.NodeVisitor.visit_ImportFrom
-ast.NodeVisitor.visit_In
-ast.NodeVisitor.visit_Index
-ast.NodeVisitor.visit_Interactive
-ast.NodeVisitor.visit_Invert
-ast.NodeVisitor.visit_Is
-ast.NodeVisitor.visit_IsNot
-ast.NodeVisitor.visit_LShift
-ast.NodeVisitor.visit_Lambda
-ast.NodeVisitor.visit_List
-ast.NodeVisitor.visit_ListComp
-ast.NodeVisitor.visit_Load
-ast.NodeVisitor.visit_Lt
-ast.NodeVisitor.visit_LtE
-ast.NodeVisitor.visit_MatMult
-ast.NodeVisitor.visit_Mod
-ast.NodeVisitor.visit_Module
-ast.NodeVisitor.visit_Mult
-ast.NodeVisitor.visit_Name
-ast.NodeVisitor.visit_NameConstant
-ast.NodeVisitor.visit_Nonlocal
-ast.NodeVisitor.visit_Not
-ast.NodeVisitor.visit_NotEq
-ast.NodeVisitor.visit_NotIn
-ast.NodeVisitor.visit_Num
-ast.NodeVisitor.visit_Or
-ast.NodeVisitor.visit_Param
-ast.NodeVisitor.visit_Pass
-ast.NodeVisitor.visit_Pow
-ast.NodeVisitor.visit_RShift
-ast.NodeVisitor.visit_Raise
-ast.NodeVisitor.visit_Return
-ast.NodeVisitor.visit_Set
-ast.NodeVisitor.visit_SetComp
-ast.NodeVisitor.visit_Slice
-ast.NodeVisitor.visit_Starred
-ast.NodeVisitor.visit_Store
-ast.NodeVisitor.visit_Str
-ast.NodeVisitor.visit_Sub
-ast.NodeVisitor.visit_Subscript
-ast.NodeVisitor.visit_Suite
-ast.NodeVisitor.visit_Try
-ast.NodeVisitor.visit_Tuple
-ast.NodeVisitor.visit_UAdd
-ast.NodeVisitor.visit_USub
-ast.NodeVisitor.visit_UnaryOp
-ast.NodeVisitor.visit_While
-ast.NodeVisitor.visit_With
-ast.NodeVisitor.visit_Yield
-ast.NodeVisitor.visit_YieldFrom
-ast.NodeVisitor.visit_alias
-ast.NodeVisitor.visit_arg
-ast.NodeVisitor.visit_arguments
-ast.NodeVisitor.visit_comprehension
-ast.NodeVisitor.visit_keyword
-ast.NodeVisitor.visit_withitem
 asyncio.AbstractEventLoop.connect_accepted_socket
 asyncio.AbstractEventLoop.create_unix_connection
 asyncio.BaseChildWatcher
@@ -183,13 +83,8 @@ builtins.bytes.__int__
 builtins.bytes.maketrans
 builtins.classmethod.__get__
 builtins.complex.__complex__
-builtins.copyright
-builtins.credits
 builtins.ellipsis
-builtins.exit
 builtins.function
-builtins.help
-builtins.license
 builtins.memoryview.__contains__
 builtins.memoryview.__iter__
 builtins.memoryview.cast
@@ -198,9 +93,6 @@ builtins.property.__get__
 builtins.property.fdel
 builtins.property.fget
 builtins.property.fset
-builtins.quit
-builtins.reveal_locals
-builtins.reveal_type
 builtins.staticmethod.__get__
 bz2.BZ2File.readinto
 bz2.BZ2File.readlines
@@ -219,26 +111,6 @@ codecs.IncrementalEncoder.encode
 codecs.StreamReader.__getattr__
 codecs.StreamReader.readline
 codecs.StreamReader.readlines
-codecs.StreamReaderWriter.__getattr__
-codecs.StreamReaderWriter.close
-codecs.StreamReaderWriter.fileno
-codecs.StreamReaderWriter.flush
-codecs.StreamReaderWriter.isatty
-codecs.StreamReaderWriter.readable
-codecs.StreamReaderWriter.seekable
-codecs.StreamReaderWriter.tell
-codecs.StreamReaderWriter.truncate
-codecs.StreamReaderWriter.writable
-codecs.StreamRecoder.__getattr__
-codecs.StreamRecoder.close
-codecs.StreamRecoder.fileno
-codecs.StreamRecoder.flush
-codecs.StreamRecoder.isatty
-codecs.StreamRecoder.readable
-codecs.StreamRecoder.seekable
-codecs.StreamRecoder.tell
-codecs.StreamRecoder.truncate
-codecs.StreamRecoder.writable
 codecs.StreamWriter.__getattr__
 codecs.StreamWriter.write
 codecs.open
@@ -378,9 +250,6 @@ encodings.utf_8.IncrementalDecoder._buffer_decode
 encodings.utf_8.StreamReader.decode
 encodings.utf_8.StreamWriter.encode
 encodings.utf_8.encode
-errno.EDEADLCK
-fcntl.F_FULLFSYNC
-fcntl.F_NOCACHE
 gettext.GNUTranslations.lngettext
 gettext.GNUTranslations.ngettext
 gettext.NullTranslations.__init__
@@ -426,9 +295,7 @@ importlib.machinery.WindowsRegistryFinder.find_module
 importlib.machinery.WindowsRegistryFinder.find_spec
 importlib.util.spec_from_file_location
 importlib.util.spec_from_loader
-inspect.Parameter.__init__
 inspect.Parameter.replace
-inspect.Signature.__init__
 inspect.Signature.replace
 inspect.getabsfile
 inspect.getmodule
@@ -539,16 +406,6 @@ optparse.Values.__getattr__
 optparse.Values.read_file
 optparse.Values.read_module
 os.EX_NOTFOUND
-os.O_BINARY
-os.O_EXLOCK
-os.O_NOINHERIT
-os.O_RANDOM
-os.O_SEQUENTIAL
-os.O_SHLOCK
-os.O_SHORT_LIVED
-os.O_TEMPORARY
-os.O_TEXT
-os.SCHED_SPORADIC
 os.SF_MNOWAIT
 os.SF_NODISKIO
 os.SF_SYNC
@@ -558,21 +415,6 @@ os.lchflags
 os.lchmod
 os.listxattr
 os.plock
-os.sched_param._asdict
-os.sched_param._make
-os.sched_param._replace
-os.statvfs_result._asdict
-os.statvfs_result._make
-os.statvfs_result._replace
-os.times_result._asdict
-os.times_result._make
-os.times_result._replace
-os.uname_result._asdict
-os.uname_result._make
-os.uname_result._replace
-os.waitid_result._asdict
-os.waitid_result._make
-os.waitid_result._replace
 pickle.Pickler.persistent_id
 pickle.Unpickler.find_class
 pickle.Unpickler.persistent_load
@@ -580,18 +422,6 @@ pipes.Template.copy
 pkgutil.ImpImporter.__init__
 poplib.POP3_SSL.stls
 posix.EX_NOTFOUND
-posix.sched_param._asdict
-posix.sched_param._make
-posix.sched_param._replace
-posix.times_result._asdict
-posix.times_result._make
-posix.times_result._replace
-posix.uname_result._asdict
-posix.uname_result._make
-posix.uname_result._replace
-posix.waitid_result._asdict
-posix.waitid_result._make
-posix.waitid_result._replace
 pwd.getpwnam
 pydoc.HTMLDoc.docdata
 pydoc.HTMLDoc.docproperty
@@ -627,83 +457,6 @@ site.getusersitepackages
 smtpd.MailmanProxy.process_message
 smtpd.PureProxy.process_message
 smtplib.SMTP.send_message
-socket.AF_AAL5
-socket.AF_BLUETOOTH
-socket.AF_DECnet
-socket.AF_LINK
-socket.AF_SYSTEM
-socket.AI_DEFAULT
-socket.AI_MASK
-socket.AI_V4MAPPED_CFG
-socket.BDADDR_ANY
-socket.BDADDR_LOCAL
-socket.BTPROTO_HCI
-socket.BTPROTO_L2CAP
-socket.BTPROTO_RFCOMM
-socket.BTPROTO_SCO
-socket.EAIEAI_ADDRFAMILY
-socket.EAI_BADHINTS
-socket.EAI_MAX
-socket.EAI_PROTOCOL
-socket.EINTR
-socket.HCI_DATA_DIR
-socket.HCI_FILTER
-socket.HCI_TIME_STAMP
-socket.IPPROTO_BIP
-socket.IPPROTO_EON
-socket.IPPROTO_GGP
-socket.IPPROTO_HELLO
-socket.IPPROTO_IPCOMP
-socket.IPPROTO_IPV4
-socket.IPPROTO_MAX
-socket.IPPROTO_MOBILE
-socket.IPPROTO_ND
-socket.IPPROTO_VRRP
-socket.IPPROTO_XTP
-socket.IPV6_USE_MIN_MTU
-socket.IPX_TYPE
-socket.IP_RECVDSTADDR
-socket.LOCAL_PEERCRED
-socket.MSG_BCAST
-socket.MSG_BTAG
-socket.MSG_EOF
-socket.MSG_ETAG
-socket.MSG_MCAST
-socket.MSG_NOTIFICATION
-socket.NETLINK_ARPD
-socket.NETLINK_ROUTE6
-socket.NETLINK_SKIP
-socket.NETLINK_TAPBASE
-socket.NETLINK_TCPDIAG
-socket.NETLINK_W1
-socket.RDS_CANCEL_SENT_TO
-socket.RDS_CMSG_RDMA_ARGS
-socket.RDS_CMSG_RDMA_DEST
-socket.RDS_CMSG_RDMA_MAP
-socket.RDS_CMSG_RDMA_STATUS
-socket.RDS_CMSG_RDMA_UPDATE
-socket.RDS_CONG_MONITOR
-socket.RDS_FREE_MR
-socket.RDS_GET_MR
-socket.RDS_GET_MR_FOR_DEST
-socket.RDS_RDMA_DONTWAIT
-socket.RDS_RDMA_FENCE
-socket.RDS_RDMA_INVALIDATE
-socket.RDS_RDMA_NOTIFY_ME
-socket.RDS_RDMA_READWRITE
-socket.RDS_RDMA_SILENT
-socket.RDS_RDMA_USE_ONCE
-socket.RDS_RECVERR
-socket.SCM_CREDS
-socket.SOL_ATALK
-socket.SOL_AX25
-socket.SOL_HCI
-socket.SOL_IPX
-socket.SOL_NETROM
-socket.SOL_ROSE
-socket.SO_EXCLUSIVEADDRUSE
-socket.SO_SETFIB
-socket.SO_USELOOPBACK
 socket.create_connection
 socket.socketpair
 socketserver.BaseServer.fileno
@@ -740,12 +493,6 @@ sunau.Au_write.setmark
 sys.gettotalrefcount
 sys.getwindowsversion
 sys.implementation
-sys.last_traceback
-sys.last_type
-sys.last_value
-sys.ps1
-sys.ps2
-sys.tracebacklimit
 sysconfig.is_python_build
 sysconfig.parse_config_h
 tarfile.TarFile.__init__
@@ -813,21 +560,6 @@ unittest.signals.removeHandler
 unittest.suite.TestSuite.run
 urllib.request.BaseHandler.http_error_nnn
 urllib.request.proxy_bypass
-urllib.response.addbase.__next__
-urllib.response.addbase.fileno
-urllib.response.addbase.flush
-urllib.response.addbase.isatty
-urllib.response.addbase.read
-urllib.response.addbase.readable
-urllib.response.addbase.readline
-urllib.response.addbase.readlines
-urllib.response.addbase.seek
-urllib.response.addbase.seekable
-urllib.response.addbase.tell
-urllib.response.addbase.truncate
-urllib.response.addbase.writable
-urllib.response.addbase.write
-urllib.response.addbase.writelines
 urllib.robotparser.RobotFileParser.can_fetch
 weakref.CallableProxyType.__getattr__
 weakref.ProxyType.__getattr__
@@ -860,3 +592,46 @@ xml.sax.xmlreader.AttributesImpl.has_key
 zipfile.ZipExtFile.read
 zipfile.ZipExtFile.readline
 zlib.compressobj
+
+# ==========
+# Whitelist entries that cannot or should not be fixed
+# ==========
+ast.NodeVisitor.visit_\w+  # Methods are discovered dynamically, see #3796
+# Weird special builtins that are typed as functions, but aren't functions
+builtins.copyright
+builtins.credits
+builtins.exit
+builtins.help
+builtins.license
+builtins.quit
+# Builtins that mypy pretends exist
+builtins.reveal_locals
+builtins.reveal_type
+# We can't distinguish not having a default value from having a default value of inspect.Parameter.empty
+inspect.Parameter.__init__
+inspect.Signature.__init__
+os.[a-z]+_(param|result)._(asdict|make|replace)  # NamedTuple like, but not actually NamedTuples
+posix.[a-z]+_(param|result)._(asdict|make|replace)  # NamedTuple like, but not actually NamedTuples
+# sys attributes that are not always defined
+sys.last_traceback
+sys.last_type
+sys.last_value
+sys.ps1
+sys.ps2
+sys.tracebacklimit
+# See comments in file. List out methods that are delegated by __getattr__ at runtime.
+# Used to make the relevant class satisfy BinaryIO interface.
+codecs.StreamReaderWriter.\w+
+codecs.StreamRecoder.\w+
+urllib.response.addbase.\w+
+
+# Platform differences that cannot be captured by the type system
+errno.[A-Z0-9]+
+fcntl.[A-Z0-9_]+
+os.O_[A-Z_]+
+os.SCHED_[A-Z_]+
+(posix.O_[A-Z_]+)?
+(posix.ST_[A-Z]+)?
+socket.AF_DECnet
+socket.[A-Z0-9_]+
+(termios.[A-Z0-9_]+)?