"""Basic local file fetcher."""
from __future__ import annotations
from dataclasses import dataclass
from pathlib import Path
from furl import furl
from nitpick.generic import url_to_python_path
from nitpick.style.fetchers import Scheme
from nitpick.style.fetchers.base import StyleFetcher
[docs]@dataclass(frozen=True)
class FileFetcher(StyleFetcher): # pylint: disable=too-few-public-methods
"""Fetch a style from a local file."""
protocols: tuple[str, ...] = (Scheme.FILE,) # type: ignore[assignment]
[docs] def preprocess_relative_url(self, url: str) -> str:
"""Preprocess a relative URL.
Only called for urls that lack a scheme (at the very least), being resolved
against a base URL that matches this specific fetcher.
Relative paths are file paths; any ~ home reference is expanded at this point.
"""
# We have to expand ~ values before trying to resolve a path as a file URL
path = Path(url).expanduser()
# return absolute paths as URLs as on Windows they could otherwise not resolve
# cleanly against a file:// base. Relative paths should use POSIX conventions.
return path.as_uri() if path.is_absolute() else path.as_posix()
def _normalize_url_path(self, url: furl) -> furl:
local_path = url_to_python_path(super()._normalize_url_path(url))
return furl(local_path.resolve().as_uri())
[docs] def fetch(self, url: furl) -> str:
"""Fetch a style from a local file."""
return url_to_python_path(url).read_text(encoding="UTF-8")