Add stub for ftplib to 2and3 (#956)

stdlib/2and3/ftplib.pyi

@@ -0,0 +1,134 @@
+# Stubs for ftplib (Python 2.7/3)
+import sys
+from typing import Optional, BinaryIO, Tuple, TextIO, Iterable, Callable, List, Union, Iterator, Dict, Text, TypeVar, Generic
+from types import TracebackType
+from socket import socket
+from ssl import SSLContext
+
+_T = TypeVar('_T')
+_IntOrStr = Union[int, Text]
+
+MSG_OOB = ...  # type: int
+FTP_PORT = ...  # type: int
+MAXLINE = ...  # type: int
+CRLF = ...  # type: str
+if sys.version_info >= (3,):
+    B_CRLF = ...  # type: bytes
+
+class Error(Exception): ...
+class error_reply(Error): ...
+class error_temp(Error): ...
+class error_perm(Error): ...
+class error_proto(Error): ...
+
+all_errors = Tuple[Exception, ...]
+
+class FTP:
+    debugging = ...  # type: int
+
+    # Note: This is technically the type that's passed in as the host argument.  But to make it easier in Python 2 we
+    # accept Text but return str.
+    host = ...  # type: str
+
+    port = ...  # type: int
+    maxline = ...  # type: int
+    sock = ...  # type: Optional[socket]
+    welcome = ...  # type: Optional[str]
+    passiveserver = ...  # type: int
+    timeout = ...  # type: int
+    af = ...  # type: int
+    lastresp = ...  # type: str
+
+    if sys.version_info >= (3,):
+        file = ...  # type: Optional[TextIO]
+        encoding = ...  # type: str
+        def __enter__(self: _T) -> _T: ...
+        def __exit__(self, exc_type: Optional[type], exc_val: Optional[Exception],
+                     exc_tb: Optional[TracebackType]) -> bool: ...
+    else:
+        file = ...  # type: Optional[BinaryIO]
+
+    if sys.version_info >= (3, 3):
+        source_address = ...  # type: Optional[Tuple[str, int]]
+        def __init__(self, host: Text = ..., user: Text = ..., passwd: Text = ..., acct: Text = ...,
+                     timeout: float = ..., source_address: Optional[Tuple[str, int]] = ...) -> None: ...
+        def connect(self, host: Text = ..., port: int = ..., timeout: float = ...,
+                    source_address: Optional[Tuple[str, int]] = ...) -> str: ...
+    else:
+        def __init__(self, host: Text = ..., user: Text = ..., passwd: Text = ..., acct: Text = ...,
+                     timeout: float = ...) -> None: ...
+        def connect(self, host: Text = ..., port: int = ..., timeout: float = ...) -> str: ...
+
+    def getwelcome(self) -> str: ...
+    def set_debuglevel(self, level: int) -> None: ...
+    def debug(self, level: int) -> None: ...
+    def set_pasv(self, val: Union[bool, int]) -> None: ...
+    def sanitize(self, s: Text) -> str: ...
+    def putline(self, line: Text) -> None: ...
+    def putcmd(self, line: Text) -> None: ...
+    def getline(self) -> str: ...
+    def getmultiline(self) -> str: ...
+    def getresp(self) -> str: ...
+    def voidresp(self) -> str: ...
+    def abort(self) -> str: ...
+    def sendcmd(self, cmd: Text) -> str: ...
+    def voidcmd(self, cmd: Text) -> str: ...
+    def sendport(self, host: Text, port: int) -> str: ...
+    def sendeprt(self, host: Text, port: int) -> str: ...
+    def makeport(self) -> socket: ...
+    def makepasv(self) -> Tuple[str, int]: ...
+    def login(self, user: Text = ..., passwd: Text = ..., acct: Text = ...) -> str: ...
+
+    # In practice, `rest` rest can actually be anything whose str() is an integer sequence, so to make it simple we allow integers.
+    def ntransfercmd(self, cmd: Text, rest: Optional[_IntOrStr] = ...) -> Tuple[socket, int]: ...
+    def transfercmd(self, cmd: Text, rest: Optional[_IntOrStr] = ...) -> socket: ...
+    def retrbinary(self, cmd: Text, callback: Callable[[bytes], None], blocksize: int = ..., rest: Optional[_IntOrStr] = ...) -> str: ...
+    def storbinary(self, cmd: Text, fp: BinaryIO, blocksize: int = ..., callback: Optional[Callable[[bytes], None]] = ..., rest: Optional[_IntOrStr] = ...) -> str: ...
+
+    def retrlines(self, cmd: Text, callback: Optional[Callable[[str], None]] = ...) -> str: ...
+    def storlines(self, cmd: Text, fp: BinaryIO, callback: Optional[Callable[[bytes], None]] = ...) -> str: ...
+
+    def acct(self, password: Text) -> str: ...
+    def nlst(self, *args: Text) -> List[str]: ...
+
+    # Technically only the last arg can be a Callable but ...
+    def dir(self, *args: Union[str, Callable[[str], None]]) -> None: ...
+
+    if sys.version_info >= (3, 3):
+        def mlsd(self, path: Text = ..., facts: Iterable[str] = ...) -> Iterator[Tuple[str, Dict[str, str]]]: ...
+    def rename(self, fromname: Text, toname: Text) -> str: ...
+    def delete(self, filename: Text) -> str: ...
+    def cwd(self, dirname: Text) -> str: ...
+    def size(self, filename: Text) -> str: ...
+    def mkd(self, dirname: Text) -> str: ...
+    def rmd(self, dirname: Text) -> str: ...
+    def pwd(self) -> str: ...
+    def quit(self) -> str: ...
+    def close(self) -> None: ...
+
+class FTP_TLS(FTP):
+    def __init__(self, host: Text = ..., user: Text = ..., passwd: Text = ..., acct: Text = ...,
+                 keyfile: Optional[str] = ..., certfile: Optional[str] = ...,
+                 context: Optional[SSLContext] = ..., timeout: float = ...,
+                 source_address: Optional[Tuple[str, int]] = ...) -> None: ...
+
+    ssl_version = ...  # type: int
+    keyfile = ...  # type: Optional[str]
+    certfile = ...  # type: Optional[str]
+    context = ...  # type: SSLContext
+
+    def login(self, user: Text = ..., passwd: Text = ..., acct: Text = ..., secure: bool = ...) -> str: ...
+    def auth(self) -> str: ...
+    def prot_p(self) -> str: ...
+    def prot_c(self) -> str: ...
+
+    if sys.version_info >= (3, 3):
+        def ccc(self) -> str: ...
+
+if sys.version_info < (3,):
+    class Netrc:
+        def __init__(self, filename: Optional[Text] = ...) -> None: ...
+        def get_hosts(self) -> List[str]: ...
+        def get_account(self, host: Text) -> Tuple[Optional[str], Optional[str], Optional[str]]: ...
+        def get_macros(self) -> List[str]: ...
+        def get_macro(self, macro: Text) -> Tuple[str, ...]: ...