add type hints

.black.toml

@@ -0,0 +1,3 @@
+[tool.black]
+line-length = 120
+target-version = ['py311']

.github/workflows/ci.yml

@@ -6,43 +6,53 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - run: |
-          pip install flake8
-          flake8 aioftp tests
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
+    - name: black
+      run: |
+        pip install black
+        black --config .black.toml --diff --check .
+    - name: ruff
+      run: |
+        pip install ruff
+        ruff check .
+    - name: mypy
+      run: |
+        pip install mypy
+        mypy
 
   tests:
     needs: lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.11']
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - run: |
-          pip install -e ./[tests]
-          pytest
-      - uses: codecov/codecov-action@v2
-        if: github.ref == 'refs/heads/master'
-        with:
-          fail_ci_if_error: true
-          verbose: true
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: |
+        pip install -e ./[dev]
+        pytest
+    - uses: codecov/codecov-action@v2
+      if: github.ref == 'refs/heads/master'
+      with:
+        fail_ci_if_error: true
+        verbose: true
+        token: ${{ secrets.CODECOV_TOKEN }}
 
   deploy:
     needs: tests
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/master'
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - uses: casperdcl/deploy-pypi@v2
-        with:
-          password: ${{ secrets.PYPI_TOKEN }}
-          build: true
-          skip_existing: true
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: casperdcl/deploy-pypi@v2
+      with:
+        password: ${{ secrets.PYPI_TOKEN }}
+        build: true
+        skip_existing: true

.mypy.ini

@@ -0,0 +1,16 @@
+[mypy]
+files = aioftp
+strict = true
+ignore_missing_imports = true
+allow_subclassing_any = true
+allow_untyped_calls = true
+pretty = true
+show_error_codes = true
+implicit_reexport = true
+allow_untyped_decorators = true
+warn_unused_ignores = false
+warn_return_any = false
+namespace_packages = true
+
+[mypy-tests.*]
+ignore_errors = true

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+.python-linters: &python-linters
+  pass_filenames: false
+  language: system
+  types: [python]
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.4.0
+  hooks:
+  - id: check-ast
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+
+- repo: https://github.com/asottile/add-trailing-comma
+  rev: v2.1.0
+  hooks:
+  - id: add-trailing-comma
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.1.0
+  hooks:
+  - id: pretty-format-yaml
+    args:
+    - --autofix
+    - --preserve-quotes
+    - --indent=2
+
+- repo: local
+  hooks:
+  - <<: *python-linters
+    id: black
+    name: Format with Black
+    entry: black
+    args: ["--config", ".black.toml", "."]
+
+  - <<: *python-linters
+    id: ruff
+    name: Check with ruff
+    entry: ruff
+    args: ["check", "--fix", "."]
+
+  - <<: *python-linters
+    id: mypy
+    name: Validate types with MyPy
+    entry: mypy

.ruff.toml

@@ -0,0 +1,4 @@
+line-length = 120
+target-version = "py311"
+select = ["E", "W", "F", "Q", "UP", "I", "ASYNC"]
+exclude = ["docs"]

README.rst

@@ -100,12 +100,14 @@ pyftpdlib 1.5.2
 Dependencies
 ------------
 
-- Python 3.7+
+- Python 3.11+
 
 0.13.0 is the last version which supports python 3.5.3+
 
 0.16.1 is the last version which supports python 3.6+
 
+0.21.4 is the last version which supports python 3.7-3.10
+
 License
 -------
 

aioftp/__init__.py

@@ -1,20 +1,19 @@
 """ftp client/server for asyncio"""
 # flake8: noqa
 
-from .client import *
-from .common import *
-from .errors import *
-from .pathio import *
-from .server import *
+from aioftp.client import *
+from aioftp.common import *
+from aioftp.errors import *
+from aioftp.pathio import *
+from aioftp.server import *
+from aioftp.client import __all__ as client_all
+from aioftp.server import __all__ as server_all
+from aioftp.errors import __all__ as errors_all
+from aioftp.common import __all__ as common_all
+from aioftp.pathio import __all__ as pathio_all
+
 
 __version__ = "0.21.4"
 version = tuple(map(int, __version__.split(".")))
 
-__all__ = (
-    client.__all__ +
-    server.__all__ +
-    errors.__all__ +
-    common.__all__ +
-    pathio.__all__ +
-    ("version", "__version__")
-)
+__all__ = client_all + server_all + errors_all + common_all + pathio_all + ("version", "__version__")

aioftp/__main__.py

@@ -1,4 +1,3 @@
-"""Simple aioftp-based server with one user (anonymous or not)"""
 import argparse
 import asyncio
 import contextlib
@@ -10,24 +9,36 @@
 parser = argparse.ArgumentParser(
     prog="aioftp",
     usage="%(prog)s [options]",
-    description="Simple aioftp-based server with one user (anonymous or not)."
+    description="Simple aioftp-based server with one user (anonymous or not).",
+)
+parser.add_argument("--user", metavar="LOGIN", dest="login", help="user name to login")
+parser.add_argument("--pass", metavar="PASSWORD", dest="password", help="password to login")
+parser.add_argument(
+    "-d",
+    metavar="DIRECTORY",
+    dest="home",
+    help="the directory to share (default current directory)",
+)
+parser.add_argument(
+    "-q",
+    "--quiet",
+    action="store_true",
+    help="set logging level to 'ERROR' instead of 'INFO'",
 )
-parser.add_argument("--user", metavar="LOGIN", dest="login",
-                    help="user name to login")
-parser.add_argument("--pass", metavar="PASSWORD", dest="password",
-                    help="password to login")
-parser.add_argument("-d", metavar="DIRECTORY", dest="home",
-                    help="the directory to share (default current directory)")
-parser.add_argument("-q", "--quiet", action="store_true",
-                    help="set logging level to 'ERROR' instead of 'INFO'")
 parser.add_argument("--memory", action="store_true", help="use memory storage")
-parser.add_argument("--host", default=None,
-                    help="host for binding [default: %(default)s]")
-parser.add_argument("--port", type=int, default=2121,
-                    help="port for binding [default: %(default)s]")
-parser.add_argument("--family", choices=("ipv4", "ipv6", "auto"),
-                    default="auto",
-                    help="Socket family [default: %(default)s]")
+parser.add_argument("--host", default=None, help="host for binding [default: %(default)s]")
+parser.add_argument(
+    "--port",
+    type=int,
+    default=2121,
+    help="port for binding [default: %(default)s]",
+)
+parser.add_argument(
+    "--family",
+    choices=("ipv4", "ipv6", "auto"),
+    default="auto",
+    help="Socket family [default: %(default)s]",
+)
 
 args = parser.parse_args()
 print(f"aioftp v{aioftp.__version__}")
@@ -40,7 +51,7 @@
     )
 if args.memory:
     user = aioftp.User(args.login, args.password, base_path="/")
-    path_io_factory = aioftp.MemoryPathIO
+    path_io_factory: type[aioftp.MemoryPathIO] | type[aioftp.PathIO] = aioftp.MemoryPathIO
 else:
     if args.home:
         user = aioftp.User(args.login, args.password, base_path=args.home)