typeshed: remove crufty comments (#4699)

Co-authored-by: hauntsaninja <>

stdlib/3/_imp.pyi

@@ -1,5 +1,3 @@
-# Stubs for _imp (Python 3.6)
-
 import types
 from importlib.machinery import ModuleSpec
 from typing import Any, List

stdlib/3/_json.pyi

@@ -1,5 +1,3 @@
-"""Stub file for the '_json' module."""
-
 from typing import Any, Callable, Dict, Optional, Tuple
 
 class make_encoder:

stdlib/3/_operator.pyi

@@ -1,5 +1,3 @@
-# Stubs for _operator (Python 3.5)
-
 # In reality the import is the other way around, but this way we can keep the operator stub in 2and3
 from operator import (
     abs as abs,

stdlib/3/_posixsubprocess.pyi

@@ -1,5 +1,3 @@
-# Stubs for _posixsubprocess
-
 # NOTE: These are incomplete!
 
 from typing import Callable, Sequence, Tuple

stdlib/3/_stat.pyi

@@ -1,5 +1,3 @@
-"""Stub file for the '_stat' module."""
-
 SF_APPEND: int
 SF_ARCHIVED: int
 SF_IMMUTABLE: int

stdlib/3/_threading_local.pyi

@@ -1,4 +1,3 @@
-# Source: https://github.com/python/cpython/blob/master/Lib/_threading_local.py
 from typing import Any, Dict, Tuple
 from weakref import ReferenceType
 

stdlib/3/abc.pyi

@@ -1,11 +1,9 @@
 from typing import Any, Callable, Type, TypeVar
 
-# Stubs for abc.
-
 _T = TypeVar("_T")
 _FuncT = TypeVar("_FuncT", bound=Callable[..., Any])
 
-# Thesee definitions have special processing in mypy
+# These definitions have special processing in mypy
 class ABCMeta(type):
     def register(cls: ABCMeta, subclass: Type[_T]) -> Type[_T]: ...
 

stdlib/3/atexit.pyi

@@ -1,5 +1,3 @@
-"""Stub file for the 'atexit' module."""
-
 from typing import Any, Callable
 
 def _clear() -> None: ...

stdlib/3/builtins.pyi

@@ -1,6 +1,3 @@
-# True and False are deliberately omitted because they are keywords in
-# Python 3, and stub files conform to Python 3 syntax.
-
 import sys
 from _typeshed import (
     AnyPath,

stdlib/3/collections/abc.pyi

@@ -1,6 +1,3 @@
-# Stubs for collections.abc (introduced from Python 3.3)
-#
-# https://docs.python.org/3.3/whatsnew/3.3.html#collections
 import sys
 
 from . import (

stdlib/3/distutils/archive_util.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.archive_util
-
 from typing import Optional
 
 def make_archive(

stdlib/3/distutils/bcppcompiler.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.bcppcompiler
-
 from distutils.ccompiler import CCompiler
 
 class BCPPCompiler(CCompiler): ...

stdlib/3/distutils/ccompiler.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.ccompiler
-
 from typing import Any, Callable, List, Optional, Tuple, Union
 
 _Macro = Union[Tuple[str], Tuple[str, Optional[str]]]

stdlib/3/distutils/core.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.core
-
 from distutils.cmd import Command as Command
 from distutils.dist import Distribution as Distribution
 from distutils.extension import Extension as Extension

stdlib/3/distutils/cygwinccompiler.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.cygwinccompiler
-
 from distutils.unixccompiler import UnixCCompiler
 
 class CygwinCCompiler(UnixCCompiler): ...

stdlib/3/distutils/debug.pyi

@@ -1,3 +1 @@
-# Stubs for distutils.debug
-
 DEBUG: bool

stdlib/3/distutils/dep_util.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.dep_util
-
 from typing import List, Tuple
 
 def newer(source: str, target: str) -> bool: ...

stdlib/3/distutils/dir_util.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.dir_util
-
 from typing import List
 
 def mkpath(name: str, mode: int = ..., verbose: int = ..., dry_run: int = ...) -> List[str]: ...

stdlib/3/distutils/dist.pyi

@@ -1,4 +1,3 @@
-# Stubs for distutils.dist
 from distutils.cmd import Command
 from typing import Any, Dict, Iterable, Mapping, Optional, Tuple, Type
 

stdlib/3/distutils/fancy_getopt.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.fancy_getopt
-
 from typing import Any, List, Mapping, Optional, Tuple, Union, overload
 
 _Option = Tuple[str, Optional[str], str]

stdlib/3/distutils/file_util.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.file_util
-
 from typing import Optional, Sequence, Tuple
 
 def copy_file(

stdlib/3/distutils/filelist.pyi

@@ -1,3 +1 @@
-# Stubs for distutils.filelist
-
 class FileList: ...

stdlib/3/distutils/msvccompiler.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.msvccompiler
-
 from distutils.ccompiler import CCompiler
 
 class MSVCCompiler(CCompiler): ...

stdlib/3/distutils/spawn.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.spawn
-
 from typing import List, Optional
 
 def spawn(cmd: List[str], search_path: bool = ..., verbose: bool = ..., dry_run: bool = ...) -> None: ...

stdlib/3/distutils/sysconfig.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.sysconfig
-
 from distutils.ccompiler import CCompiler
 from typing import Mapping, Optional, Union
 

stdlib/3/distutils/text_file.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.text_file
-
 from typing import IO, List, Optional, Tuple, Union
 
 class TextFile:

stdlib/3/distutils/unixccompiler.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.unixccompiler
-
 from distutils.ccompiler import CCompiler
 
 class UnixCCompiler(CCompiler): ...

stdlib/3/distutils/util.pyi

@@ -1,5 +1,3 @@
-# Stubs for distutils.util
-
 from typing import Any, Callable, List, Mapping, Optional, Tuple
 
 def get_platform() -> str: ...

stdlib/3/email/__init__.pyi

@@ -1,5 +1,3 @@
-# Stubs for email (Python 3.4)
-
 from email.message import Message
 from email.policy import Policy
 from typing import IO, Callable

stdlib/3/email/charset.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.charset (Python 3.4)
-
 from typing import Any, Iterator, List, Optional
 
 QP: int  # undocumented

stdlib/3/email/contentmanager.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.contentmanager (Python 3.4)
-
 from email.message import Message
 from typing import Any, Callable
 

stdlib/3/email/encoders.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.encoders (Python 3.4)
-
 from email.message import Message
 
 def encode_base64(msg: Message) -> None: ...

stdlib/3/email/errors.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.errors (Python 3.4)
-
 class MessageError(Exception): ...
 class MessageParseError(MessageError): ...
 class HeaderParseError(MessageParseError): ...

stdlib/3/email/generator.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.generator (Python 3.4)
-
 from email.message import Message
 from email.policy import Policy
 from typing import BinaryIO, Optional, TextIO

stdlib/3/email/header.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.header (Python 3.4)
-
 from email.charset import Charset
 from typing import Any, List, Optional, Tuple, Union
 

stdlib/3/email/headerregistry.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.headerregistry (Python 3.4)
-
 from datetime import datetime as _datetime
 from email.errors import MessageDefect
 from email.policy import Policy

stdlib/3/email/iterators.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.iterators (Python 3.4)
-
 from email.message import Message
 from typing import Iterator, Optional
 

stdlib/3/email/message.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.message (Python 3.4)
-
 from email.charset import Charset
 from email.contentmanager import ContentManager
 from email.errors import MessageDefect

stdlib/3/email/mime/application.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.application (Python 3.4)
-
 import sys
 from email.mime.nonmultipart import MIMENonMultipart
 from email.policy import Policy

stdlib/3/email/mime/audio.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.audio (Python 3.4)
-
 import sys
 from email.mime.nonmultipart import MIMENonMultipart
 from email.policy import Policy

stdlib/3/email/mime/base.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.base (Python 3.4)
-
 import email.message
 import sys
 from email.policy import Policy

stdlib/3/email/mime/image.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.image (Python 3.4)
-
 import sys
 from email.mime.nonmultipart import MIMENonMultipart
 from email.policy import Policy

stdlib/3/email/mime/message.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.message (Python 3.4)
-
 import sys
 from email.message import Message
 from email.mime.nonmultipart import MIMENonMultipart

stdlib/3/email/mime/multipart.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.multipart (Python 3.4)
-
 import sys
 from email.message import Message
 from email.mime.base import MIMEBase

stdlib/3/email/mime/nonmultipart.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.nonmultipart (Python 3.4)
-
 from email.mime.base import MIMEBase
 
 class MIMENonMultipart(MIMEBase): ...

stdlib/3/email/mime/text.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.mime.text (Python 3.4)
-
 import sys
 from email.mime.nonmultipart import MIMENonMultipart
 from email.policy import Policy

stdlib/3/email/parser.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.parser (Python 3.4)
-
 import email.feedparser
 from email.message import Message
 from email.policy import Policy

stdlib/3/email/policy.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.policy (Python 3.4)
-
 from abc import abstractmethod
 from email.contentmanager import ContentManager
 from email.errors import MessageDefect

stdlib/3/email/utils.pyi

@@ -1,5 +1,3 @@
-# Stubs for email.utils (Python 3.4)
-
 import datetime
 from email.charset import Charset
 from typing import List, Optional, Tuple, Union

stdlib/3/encodings/__init__.pyi

@@ -1,6 +1,3 @@
-# This comment serves as a workaround for timothycrosley/isort#1027 and can
-# be removed when a release with a fix was released.
-
 import codecs
 from typing import Any
 

stdlib/3/enum.pyi

@@ -1,4 +1,3 @@
-# NB: third_party/2/enum.pyi and stdlib/3.4/enum.pyi must remain consistent!
 import sys
 from abc import ABCMeta
 from typing import Any, Dict, Iterator, List, Mapping, Type, TypeVar, Union

stdlib/3/fnmatch.pyi

@@ -1,8 +1,3 @@
-# Stubs for fnmatch
-
-# Based on http://docs.python.org/3.2/library/fnmatch.html and
-# python-lib/fnmatch.py
-
 from typing import AnyStr, Iterable, List
 
 def fnmatch(name: AnyStr, pat: AnyStr) -> bool: ...

stdlib/3/gc.pyi

@@ -1,5 +1,3 @@
-# Stubs for gc
-
 import sys
 from typing import Any, Dict, List, Optional, Tuple
 

stdlib/3/getopt.pyi

@@ -1,7 +1,3 @@
-# Stubs for getopt
-
-# Based on http://docs.python.org/3.2/library/getopt.html
-
 from typing import List, Tuple
 
 def getopt(args: List[str], shortopts: str, longopts: List[str] = ...) -> Tuple[List[Tuple[str, str]], List[str]]: ...

stdlib/3/getpass.pyi

@@ -1,5 +1,3 @@
-# Stubs for getpass
-
 from typing import Optional, TextIO
 
 def getpass(prompt: str = ..., stream: Optional[TextIO] = ...) -> str: ...

stdlib/3/glob.pyi

@@ -1,6 +1,3 @@
-# Stubs for glob
-# Based on http://docs.python.org/3/library/glob.html
-
 import sys
 from typing import AnyStr, Iterator, List, Union
 

stdlib/3/hashlib.pyi

@@ -1,5 +1,3 @@
-# Stubs for hashlib
-
 import sys
 from _typeshed import ReadableBuffer
 from typing import AbstractSet, Optional

stdlib/3/heapq.pyi

@@ -1,7 +1,3 @@
-# Stubs for heapq
-
-# Based on http://docs.python.org/3.2/library/heapq.html
-
 from typing import Any, Callable, Iterable, List, Optional, TypeVar
 
 _T = TypeVar("_T")

stdlib/3/http/cookies.pyi

@@ -1,5 +1,3 @@
-# Stubs for http.cookies (Python 3.5)
-
 import sys
 from typing import Any, Dict, Generic, List, Mapping, Optional, TypeVar, Union
 

stdlib/3/http/server.pyi

@@ -1,5 +1,3 @@
-# Stubs for http.server (Python 3.4)
-
 import email.message
 import socketserver
 import sys

stdlib/3/itertools.pyi

@@ -1,7 +1,3 @@
-# Stubs for itertools
-
-# Based on http://docs.python.org/3.2/library/itertools.html
-
 import sys
 from typing import Any, Callable, Generic, Iterable, Iterator, Optional, Tuple, TypeVar, overload
 from typing_extensions import Literal

stdlib/3/nntplib.pyi

@@ -1,5 +1,3 @@
-# Stubs for nntplib (Python 3)
-
 import datetime
 import socket
 import ssl

stdlib/3/os/path.pyi

@@ -1,4 +1,3 @@
-# NB: path.pyi and stdlib/2 and stdlib/3 must remain consistent!
 import os
 import sys
 from _typeshed import AnyPath, BytesPath, StrPath

stdlib/3/pipes.pyi

@@ -1,7 +1,3 @@
-# Stubs for pipes
-
-# Based on http://docs.python.org/3.5/library/pipes.html
-
 import os
 
 class Template:

stdlib/3/platform.pyi

@@ -1,5 +1,3 @@
-# Stubs for platform (Python 3.5)
-
 import sys
 
 if sys.version_info < (3, 9):

stdlib/3/queue.pyi

@@ -1,7 +1,3 @@
-# Stubs for queue
-
-# NOTE: These are incomplete!
-
 import sys
 from threading import Condition, Lock
 from typing import Any, Generic, Optional, TypeVar

stdlib/3/random.pyi

@@ -1,11 +1,3 @@
-# Stubs for random
-# Ron Murawski <ron@horizonchess.com>
-# Updated by Jukka Lehtosalo
-
-# based on http://docs.python.org/3.2/library/random.html
-
-# ----- random classes -----
-
 import _random
 import sys
 from typing import AbstractSet, Any, Callable, Iterable, List, MutableSequence, Optional, Sequence, Tuple, TypeVar, Union

stdlib/3/re.pyi

@@ -1,10 +1,3 @@
-# Stubs for re
-# Ron Murawski <ron@horizonchess.com>
-# 'bytes' support added by Jukka Lehtosalo
-
-# based on: http://docs.python.org/3.2/library/re.html
-# and http://hg.python.org/cpython/file/618ea5612e83/Lib/re.py
-
 import sys
 from typing import Any, AnyStr, Callable, Iterator, List, Optional, Tuple, Union, overload
 

stdlib/3/reprlib.pyi

@@ -1,5 +1,3 @@
-# Stubs for reprlib (Python 3)
-
 from array import array
 from typing import Any, Callable, Deque, Dict, FrozenSet, List, Set, Tuple
 

stdlib/3/resource.pyi

@@ -1,5 +1,3 @@
-# Stubs for resource
-
 import sys
 from typing import NamedTuple, Optional, Tuple
 

stdlib/3/signal.pyi

@@ -1,5 +1,3 @@
-"""Stub file for the 'signal' module."""
-
 import sys
 from enum import IntEnum
 from types import FrameType

stdlib/3/socketserver.pyi

@@ -1,6 +1,3 @@
-# NB: SocketServer.pyi and socketserver.pyi must remain consistent!
-# Stubs for socketserver
-
 import sys
 import types
 from socket import SocketType

stdlib/3/sre_constants.pyi

@@ -1,5 +1,3 @@
-# Source: https://github.com/python/cpython/blob/master/Lib/sre_constants.py
-
 from typing import Any, Dict, List, Optional, Union
 
 MAGIC: int

stdlib/3/sre_parse.pyi

@@ -1,5 +1,3 @@
-# Source: https://github.com/python/cpython/blob/master/Lib/sre_parse.py
-
 import sys
 from sre_constants import _NamedIntConstant as _NIC, error as _Error
 from typing import Any, Dict, FrozenSet, Iterable, List, Match, Optional, Pattern as _Pattern, Tuple, Union, overload

stdlib/3/stat.pyi

@@ -1,7 +1,3 @@
-# Stubs for stat
-
-# Based on http://docs.python.org/3.2/library/stat.html
-
 import sys
 
 def S_ISDIR(mode: int) -> bool: ...

stdlib/3/statistics.pyi

@@ -1,5 +1,3 @@
-# Stubs for statistics
-
 import sys
 from decimal import Decimal
 from fractions import Fraction

stdlib/3/string.pyi

@@ -1,7 +1,3 @@
-# Stubs for string
-
-# Based on http://docs.python.org/3.2/library/string.html
-
 from typing import Any, Iterable, Mapping, Optional, Sequence, Tuple, Union
 
 ascii_letters: str

stdlib/3/symbol.pyi

@@ -1,5 +1,3 @@
-# Stubs for symbol (Python 3)
-
 import sys
 from typing import Dict
 

stdlib/3/sys.pyi

@@ -1,8 +1,3 @@
-# Stubs for sys
-# Ron Murawski <ron@horizonchess.com>
-
-# based on http://docs.python.org/3.2/library/sys.html
-
 import sys
 from builtins import object as _object
 from importlib.abc import MetaPathFinder, PathEntryFinder

stdlib/3/tracemalloc.pyi

@@ -1,5 +1,3 @@
-# Stubs for tracemalloc (Python 3.4+)
-
 import sys
 from typing import List, Optional, Sequence, Tuple, Union, overload
 

stdlib/3/types.pyi

@@ -1,8 +1,3 @@
-# Stubs for types
-# Note, all classes "defined" here require special handling.
-
-# TODO parts of this should be conditional on version
-
 import sys
 from typing import (
     Any,
@@ -25,6 +20,8 @@ from typing import (
 # reasons exists in its own stub file (with ModuleSpec and Loader).
 from _importlib_modulespec import ModuleType as ModuleType  # Exported
 
+# Note, all classes "defined" here require special handling.
+
 _T = TypeVar("_T")
 _T_co = TypeVar("_T_co", covariant=True)
 _T_contra = TypeVar("_T_contra", contravariant=True)

stdlib/3/unittest/__init__.pyi

@@ -1,5 +1,3 @@
-# Stubs for unittest
-
 from typing import Optional
 from unittest.async_case import *
 from unittest.case import *

stdlib/3/unittest/util.pyi

@@ -1,4 +1,3 @@
-# undocumented
 from typing import Any, List, Sequence, Tuple, TypeVar
 
 _T = TypeVar("_T")

stdlib/3/urllib/parse.pyi

@@ -1,4 +1,3 @@
-# Stubs for urllib.parse
 import sys
 from typing import Any, AnyStr, Callable, Dict, Generic, List, Mapping, NamedTuple, Optional, Sequence, Tuple, Union, overload
 

stdlib/3/urllib/response.pyi

@@ -1,5 +1,3 @@
-# private module, we only expose what's needed
-
 from email.message import Message
 from types import TracebackType
 from typing import IO, Any, BinaryIO, Callable, Iterable, List, Optional, Tuple, Type, TypeVar

stdlib/3/urllib/robotparser.pyi

@@ -1,5 +1,3 @@
-# Stubs for urllib.robotparser (Python 3.4)
-
 import sys
 from typing import Iterable, List, NamedTuple, Optional
 

stdlib/3/zipapp.pyi

@@ -1,5 +1,3 @@
-# Stubs for zipapp (Python 3.5+)
-
 import sys
 from pathlib import Path
 from typing import BinaryIO, Callable, Optional, Union