#!/usr/bin/env python3
#
# config.py
"""
Read and parse formate configuration.
"""
#
# Copyright © 2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from operator import attrgetter
from types import MappingProxyType
from typing import Callable, List, Mapping, TypeVar
# 3rd party
import dom_toml
from domdf_python_tools.typing import PathLike
# this package
from formate.classes import FormateConfigDict, Hook
from formate.utils import import_entry_points
__all__ = (
"parse_hooks",
"parse_global_config",
"load_toml",
"wants_global_config",
"wants_filename",
"_C_str",
"HookConfigError",
"NoHooksError",
"NoSupportedHooksError",
"formats_filetypes",
"get_hooks_for_filetype",
)
_C_str = TypeVar("_C_str", bound=Callable[..., str])
[docs]class HookConfigError(ValueError):
"""
Base exception for errors with hook configuration.
"""
[docs]class NoHooksError(HookConfigError):
"""
Exception for when no hooks are configured.
"""
def __init__(self):
super().__init__("No hooks configured")
[docs]class NoSupportedHooksError(HookConfigError):
"""
Exception for when no hooks support the given file type.
:param filetype:
"""
def __init__(self, filetype: str):
super().__init__(f"No supported hooks for this file type ({filetype})")
self.filetype = filetype
[docs]def parse_hooks(config: Mapping) -> List[Hook]:
"""
Given a mapping parsed from a TOML file (or similar), return a list of hooks selected by the user.
:param config: The ``formate`` configuration, parsed from a TOML file (or similar).
:rtype:
.. latex:clearpage::
"""
hooks = list(Hook.parse(config["hooks"]))
entry_points = import_entry_points(hooks)
global_config = parse_global_config(config)
for hook in hooks:
hook.entry_point = entry_points[hook.name]
hook.global_config = global_config
hooks = sorted(hooks, key=attrgetter("priority"))
return hooks
[docs]def get_hooks_for_filetype(filetype: str, hooks: List[Hook]) -> List[Hook]:
"""
Filters the hooks to those that support the given filetype.
:param filetype:
:param hooks:
"""
if not hooks:
raise NoHooksError()
supported_hooks: List[Hook] = []
for hook in hooks:
if filetype in hook.supported_filetypes:
supported_hooks.append(hook)
if not supported_hooks:
raise NoSupportedHooksError(filetype=filetype)
return supported_hooks
[docs]def parse_global_config(config: Mapping) -> MappingProxyType:
"""
Returns a read-only view on the global configuration mapping, for hooks to do with as they wish.
:param config: The ``formate`` configuration, parsed from a TOML file (or similar).
"""
return MappingProxyType(config.get("config", {}))
[docs]def load_toml(filename: PathLike) -> FormateConfigDict:
"""
Load the ``formate`` configuration mapping from the given TOML file.
:param filename:
"""
config = dom_toml.load(filename)
if "formate" in config.get("tool", {}):
config = config["tool"]["formate"]
formate_config: FormateConfigDict = {}
if "hooks" in config:
formate_config["hooks"] = config["hooks"]
if "config" in config:
formate_config["config"] = config["config"]
return formate_config
[docs]def wants_global_config(func: _C_str) -> _C_str:
"""
Decorator to indicate to ``formate`` that the global configuration should be passed to this hook.
The configuration will be provided as the ``formate_global_config``: :class:`~typing.Mapping` keyword argument.
:param func:
"""
func.wants_global_config = True # type: ignore[attr-defined]
return func
[docs]def wants_filename(func: _C_str) -> _C_str:
"""
Decorator to indicate to ``formate`` that the filename being reformatted should be passed to this hook.
The configuration will be provided as the
``formate_filename``: :py:obj:`~domdf_python_tools.typing.PathLike` keyword argument.
.. versionadded:: 0.2.0
:param func:
"""
func.wants_filename = True # type: ignore[attr-defined]
return func