add type annotations (closes #164)

.gitignore

@@ -15,3 +15,7 @@ __pycache__
 .pytest_cache
 .ruff_cache
 coverage.xml
+.coverage
+.venv
+venv
+.DS_Store

pyproject.toml

@@ -37,6 +37,9 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Topic :: Internet :: File Transfer Protocol (FTP)",
 ]
+dependencies = [
+    "typing_extensions >= 4.10,<5.0",
+]
 
 [project.urls]
 Github = "https://github.com/aio-libs/aioftp"
@@ -60,6 +63,10 @@ dev = [
     "black",
     "ruff",
 
+    # typecheckers
+    "pyright",
+    "mypy",
+
     # docs
     "sphinx",
     "alabaster",
@@ -81,9 +88,11 @@ target-version = ["py38"]
 [tool.ruff]
 line-length = 120
 target-version = "py38"
-select = ["E", "W", "F", "Q", "UP", "I", "ASYNC"]
 src = ["src"]
 
+[tool.ruff.lint]
+select = ["E", "W", "F", "Q", "UP", "I", "ASYNC"]
+
 [tool.coverage]
 run.source = ["./src/aioftp"]
 run.omit = ["./src/aioftp/__main__.py"]
@@ -96,3 +105,28 @@ log_format = "%(asctime)s.%(msecs)03d %(name)-20s %(levelname)-8s %(filename)-15
 log_date_format = "%H:%M:%S"
 log_level = "DEBUG"
 asyncio_mode = "strict"
+
+[tool.pyright]
+pythonVersion = "3.8"
+strict = ["src"]
+reportImplicitOverride = true
+exclude = ["venv", ".venv", "build", "tests", "docs", "ftpbench.py"]
+
+[tool.mypy]
+files = "src/aioftp"
+show_absolute_path = true
+pretty = true
+strict = true
+enable_error_code = [
+    "explicit-override",
+    "redundant-self", "redundant-expr", "possibly-undefined",
+]
+warn_unreachable = true
+disallow_any_generics = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "tests"
+strict = false
+disallow_any_generics = false
+disallow_untyped_defs = false

src/aioftp/__init__.py

@@ -4,15 +4,106 @@
 
 import importlib.metadata
 
-from .client import *
-from .common import *
-from .errors import *
-from .pathio import *
-from .server import *
+from .client import BaseClient, Client, Code, DataConnectionThrottleStreamIO
+from .common import (
+    DEFAULT_ACCOUNT,
+    DEFAULT_BLOCK_SIZE,
+    DEFAULT_PASSWORD,
+    DEFAULT_PORT,
+    DEFAULT_USER,
+    END_OF_LINE,
+    AbstractAsyncLister,
+    AsyncListerMixin,
+    AsyncStreamIterator,
+    StreamIO,
+    StreamThrottle,
+    Throttle,
+    ThrottleStreamIO,
+    async_enterable,
+    setlocale,
+    with_timeout,
+    wrap_with_container,
+)
+from .errors import AIOFTPException, NoAvailablePort, PathIOError, PathIsNotAbsolute, StatusCodeError
+from .pathio import (
+    AbstractPathIO,
+    AsyncPathIO,
+    MemoryPathIO,
+    PathIO,
+    PathIONursery,
+)
+from .server import (
+    AbstractUserManager,
+    AvailableConnections,
+    Connection,
+    ConnectionConditions,
+    MemoryUserManager,
+    PathConditions,
+    PathPermissions,
+    Permission,
+    Server,
+    User,
+    worker,
+)
+from .types import NotEmptyCodes, check_not_empty_codes
 
-__version__ = importlib.metadata.version(__package__)
+__version__ = importlib.metadata.version(__package__)  # pyright: ignore[reportArgumentType]
 version = tuple(map(int, __version__.split(".")))
 
+
 __all__ = (
-    client.__all__ + server.__all__ + errors.__all__ + common.__all__ + pathio.__all__ + ("version", "__version__")
+    # client
+    "BaseClient",
+    "Client",
+    "DataConnectionThrottleStreamIO",
+    "Code",
+    # server
+    "Server",
+    "Permission",
+    "User",
+    "AbstractUserManager",
+    "MemoryUserManager",
+    "Connection",
+    "AvailableConnections",
+    "ConnectionConditions",
+    "PathConditions",
+    "PathPermissions",
+    "worker",
+    # errors
+    "AIOFTPException",
+    "StatusCodeError",
+    "PathIsNotAbsolute",
+    "PathIOError",
+    "NoAvailablePort",
+    # common
+    "with_timeout",
+    "StreamIO",
+    "Throttle",
+    "StreamThrottle",
+    "ThrottleStreamIO",
+    "END_OF_LINE",
+    "DEFAULT_BLOCK_SIZE",
+    "wrap_with_container",
+    "AsyncStreamIterator",
+    "AbstractAsyncLister",
+    "AsyncListerMixin",
+    "async_enterable",
+    "DEFAULT_PORT",
+    "DEFAULT_USER",
+    "DEFAULT_PASSWORD",
+    "DEFAULT_ACCOUNT",
+    "setlocale",
+    # pathio
+    "AbstractPathIO",
+    "PathIO",
+    "AsyncPathIO",
+    "MemoryPathIO",
+    "PathIONursery",
+    #
+    # types
+    "NotEmptyCodes",
+    "check_not_empty_codes",
+    #
+    "version",
+    "__version__",
 )

src/aioftp/__main__.py

@@ -5,6 +5,7 @@
 import contextlib
 import logging
 import socket
+from typing import Type
 
 import aioftp
 
@@ -65,6 +66,7 @@
         format="%(asctime)s [%(name)s] %(message)s",
         datefmt="[%H:%M:%S]:",
     )
+path_io_factory: Type[aioftp.AbstractPathIO]
 if args.memory:
     user = aioftp.User(args.login, args.password, base_path="/")
     path_io_factory = aioftp.MemoryPathIO
@@ -81,7 +83,7 @@
 }[args.family]
 
 
-async def main():
+async def main() -> None:
     server = aioftp.Server([user], path_io_factory=path_io_factory)
     await server.run(args.host, args.port, family=family)