Tighen up the typing

Author: pelson

pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
   "pkginfo>=1.12",
   "readme-renderer[md]",
   "simple-repository~=0.9",
+  "typing-extensions",
   "uvicorn",
   "authlib",
   "starlette[full]",
@@ -64,6 +65,11 @@ ensure_newline_before_comments = true
 line_length = 88
 force_sort_within_sections = true
 
+# [tool.mypy]
+# check_untyped_defs = true
+# disallow_untyped_defs = true
+# disallow_untyped_calls = true
+
 [[tool.mypy.overrides]]
 module = [
     "diskcache",

simple_repository_browser/controller.py

@@ -1,3 +1,5 @@
+# from __future__ import annotations
+
 import asyncio
 import dataclasses
 from enum import Enum
@@ -10,7 +12,7 @@
 from packaging.version import InvalidVersion, Version
 
 from . import errors, model, view
-from .static_files import HashedStaticFileHandler
+from .static_files import HashedStaticFileHandler, StaticFilesManifest
 
 
 @dataclasses.dataclass(frozen=True)
@@ -81,7 +83,7 @@ def __init__(self, model: model.Model, view: view.View) -> None:
         self.model = model
         self.view = view
 
-    def create_router(self, static_files_manifest) -> fastapi.APIRouter:
+    def create_router(self, static_files_manifest: StaticFilesManifest) -> fastapi.APIRouter:
         router = self.router.build_fastapi_router(self)
         router.mount("/static", HashedStaticFileHandler(manifest=static_files_manifest), name="static")
         return router

simple_repository_browser/static_files.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import argparse
 from hashlib import sha256
 import json
@@ -9,14 +11,20 @@
 
 from starlette.responses import Response
 from starlette.staticfiles import StaticFiles
+from starlette.types import Scope
 from typing_extensions import override
 
+#: A StaticFilesManifest maps the relative path to the static files root
+#: (i.e. the input value of a template requiring a static file) to the relative
+#: path that should be rendered in a template, and the full path of the file on
+#: disk.
+StaticFilesManifest: typing.TypeAlias = dict[str, tuple[str, pathlib.Path]]
+
 
-def compile_static_files(*, destination: pathlib.Path, sources: typing.Sequence[pathlib.Path]):
+def compile_static_files(*, destination: pathlib.Path, manifest: StaticFilesManifest) -> None:
     """Compile a static directory from one or more source directories."""
     # This function is designed to write the static files, could be useful for serving static
     # files via apache/nginx/etc.
-    manifest = generate_manifest(sources)
     file_map: dict[str, dict[str, str]] = {'file-map': {}}
 
     for input_filename, (hashed_relpath, source_path) in manifest.items():
@@ -29,7 +37,7 @@ def compile_static_files(*, destination: pathlib.Path, sources: typing.Sequence[
     (destination / '.gitignore').write_text('*')
 
 
-def generate_manifest(sources: typing.Sequence[pathlib.Path]) -> dict[str, tuple[str, pathlib.Path]]:
+def generate_manifest(sources: typing.Sequence[pathlib.Path]) -> StaticFilesManifest:
     """
     Generate a manifest which maps template_rel_path to a (hashed_relpath, full_path) tuple.
     """
@@ -54,7 +62,7 @@ def generate_manifest(sources: typing.Sequence[pathlib.Path]) -> dict[str, tuple
 
 
 class HashedStaticFileHandler(StaticFiles):
-    def __init__(self, *, manifest, **kwargs):
+    def __init__(self, *, manifest: StaticFilesManifest, **kwargs) -> None:
         super().__init__(**kwargs)
         self.manifest = manifest
         self._inverted_manifest = {src: path for src, path in manifest.values()}
@@ -64,10 +72,10 @@ def lookup_path(self, path: str) -> tuple[str, os.stat_result | None]:
         actual_path = self._inverted_manifest.get(path)
         if actual_path is None:
             return super().lookup_path(path)
-        return actual_path, os.stat(actual_path)
+        return str(actual_path), os.stat(actual_path)
 
     @override
-    async def get_response(self, path: str, scope) -> Response:
+    async def get_response(self, path: str, scope: Scope) -> Response:
         response = await super().get_response(path, scope)
         if response.status_code in [200, 304]:
             response.headers["Cache-Control"] = "public, max-age=31536000, immutable"
@@ -95,7 +103,8 @@ def main(argv: typing.Sequence[str]) -> None:
 
 def handle_compile(args: argparse.Namespace):
     print(f'Writing static files to {args.destination}')
-    compile_static_files(destination=args.destination, sources=args.source)
+    manifest = generate_manifest(args.source)
+    compile_static_files(destination=args.destination, manifest=manifest)
 
 
 if __name__ == '__main__':

simple_repository_browser/view.py

@@ -7,10 +7,11 @@
 from starlette.datastructures import URL
 
 from . import model
+from .static_files import StaticFilesManifest
 
 
 class View:
-    def __init__(self, templates_paths: typing.Sequence[Path], browser_version: str, static_files_manifest: dict[str, tuple[str, Path]]):
+    def __init__(self, templates_paths: typing.Sequence[Path], browser_version: str, static_files_manifest: StaticFilesManifest):
         self.templates_paths = templates_paths
         self.version = browser_version
         self.static_files_manifest = static_files_manifest