style: apply ruff fixes (post template ruff config)

Author: ChrsBaur

hooks/post_gen_project.py

@@ -7,9 +7,9 @@
 import os
 import shutil
 import sys
+from collections.abc import Iterable
 from glob import glob
 from pathlib import Path
-from typing import Iterable, Optional
 
 module_dir = 'src/{{ cookiecutter.module_name }}'
 
@@ -146,10 +146,10 @@ def handle_config():
     if config_file == 'yaml':
         _delete_files(files_config_hocon)
         shutil.rmtree(f'{module_dir}/res')
-        _rename_files(f'src/**/*__yaml.py', '__yaml', '')
+        _rename_files('src/**/*__yaml.py', '__yaml', '')
     elif config_file == 'hocon':
         _delete_files(files_config_yaml)
-        _rename_files(f'src/**/*__hocon.py', '__hocon', '')
+        _rename_files('src/**/*__hocon.py', '__hocon', '')
     else:
         _delete_files(files_config_hocon + files_config_yaml + ['tests/test_util.py'])
         os.rmdir(f'{module_dir}/res')
@@ -201,7 +201,7 @@ def _rename_files(file_pattern, old, new):
         path.rename(path.with_name(path.name.replace(old, new)))
 
 
-def _delete_files(files: Iterable[str], exclude: Optional[str] = None):
+def _delete_files(files: Iterable[str], exclude: str | None = None):
     try:
         for file in files:
             if file != exclude:
@@ -211,7 +211,7 @@ def _delete_files(files: Iterable[str], exclude: Optional[str] = None):
         sys.exit(1)
 
 
-def _delete_folders(folders: Iterable[str], exclude: Optional[str] = None):
+def _delete_folders(folders: Iterable[str], exclude: str | None = None):
     for folder in folders:
         if folder != exclude:
             shutil.rmtree(folder, ignore_errors=True)

tests/test_validation.py

@@ -1,5 +1,6 @@
+from collections.abc import Callable
 from runpy import run_path
-from typing import Any, Callable
+from typing import Any
 
 import pytest
 from cookiecutter.exceptions import CookiecutterException

tests/util.py

@@ -1,9 +1,9 @@
 import os
 import subprocess
 import sys
+from collections.abc import Callable
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Callable, Dict, List, Union
 
 from cookiecutter.main import cookiecutter
 
@@ -26,11 +26,11 @@ def get_module_name(project_dir: Path) -> str:
     return module_name
 
 
-def resolve_module_dir(files: List[str], module_name: str) -> List[str]:
+def resolve_module_dir(files: list[str], module_name: str) -> list[str]:
     return [(s.format(module_name=module_name) if '{' in s else s) for s in files] if files else []
 
 
-def check_files(project_dir: Path, files: List[str], exist=True):
+def check_files(project_dir: Path, files: list[str], exist=True):
     for file in files:
         path = (project_dir / file).resolve()
         assert path.exists() == exist, f"file '{path}' should {'' if exist else 'not '}have existed"
@@ -47,8 +47,8 @@ def list_files(base_dir, indent=4):
 
 
 def check_project(
-        project_name="Test Project", settings: Dict[str, str] = None, files_existent: List = None,
-        files_non_existent: List = None, test_cli=False, run_pytest=False,
+        project_name="Test Project", settings: dict[str, str] = None, files_existent: list = None,
+        files_non_existent: list = None, test_cli=False, run_pytest=False,
         fun: Callable[[Path], None] = None):
     # define cookiecutter settings
     if settings is None:
@@ -81,7 +81,7 @@ def check_project(
             fun(project_dir)
 
 
-def assert_file_contains(file: Union[str, Path], contains: str = None, not_contains: str = None):
+def assert_file_contains(file: str | Path, contains: str = None, not_contains: str = None):
     with open(file) as fp:
         content = fp.read()
         if contains:

{{cookiecutter.project_slug}}/.ruff.toml

@@ -1,13 +1,12 @@
-# Ruff configuration file
-# Template version for generated projects
+# Ruff configuration file for generated projects (standalone .ruff.toml)
+# This file will be copied into generated projects and must be valid TOML
 
-[tool.ruff]
 line-length = 100
 target-version = "py311"
 exclude = ["__init__.py"]
 extend-exclude = ["notebooks/*"]
 
-[tool.ruff.lint]
+[lint]
 select = [
     "E",  # Pycodestyle errors
     "F",  # Pyflakes errors
@@ -19,5 +18,5 @@ select = [
 ]
 task-tags = ["TODO", "FIXME", "NOTE"]
 
-[tool.isort]
-known_first_party = ["{{ cookiecutter.project_slug }}"]
+[isort]
+known-first-party = ["{{ cookiecutter.project_slug }}"]

{{cookiecutter.project_slug}}/src/{{cookiecutter.module_name}}/util__hocon.py

@@ -1,14 +1,13 @@
+import importlib.resources as resources
 import logging
 from pathlib import Path
-from typing import Union
 
-import importlib.resources as resources
-from pyhocon import ConfigTree, ConfigFactory
+from pyhocon import ConfigFactory, ConfigTree
 
 logger = logging.getLogger('{{ cookiecutter.module_name }}')
 
 
-def get_resource_string(path: str, decode=True) -> Union[str, bytes]:
+def get_resource_string(path: str, decode=True) -> str | bytes:
     """
     Load a package resource (i.e. a file from within this package)
 
@@ -23,7 +22,7 @@ def get_resource_string(path: str, decode=True) -> Union[str, bytes]:
     return s.decode(errors='ignore') if decode else s
 
 
-def load_config(config_file: Union[str, Path] = None) -> ConfigTree:
+def load_config(config_file: str | Path = None) -> ConfigTree:
     """
     Load the config from the specified file and use it to override fields in the default config.
     If no config file is specified, only the default config is loaded.

{{cookiecutter.project_slug}}/src/{{cookiecutter.module_name}}/util__yaml.py

@@ -1,14 +1,14 @@
+import importlib.resources as resources
 import logging
 from pathlib import Path
-from typing import Any, Dict, Union
+from typing import Any
 
-import importlib.resources as resources
 import yaml
 
 logger = logging.getLogger('{{ cookiecutter.module_name }}')
 
 
-def get_resource_string(path: str, decode=True) -> Union[str, bytes]:
+def get_resource_string(path: str, decode=True) -> str | bytes:
     """
     Load a package resource (i.e. a file from within this package)
 
@@ -23,7 +23,7 @@ def get_resource_string(path: str, decode=True) -> Union[str, bytes]:
     return s.decode(errors='ignore') if decode else s
 
 
-def load_config(config_file: Union[str, Path]) -> Dict[str, Any]:
+def load_config(config_file: str | Path) -> dict[str, Any]:
     """
     Load the config from the specified yaml file
 
@@ -34,7 +34,7 @@ def load_config(config_file: Union[str, Path]) -> Dict[str, Any]:
         return yaml.safe_load(fp)
 
 
-def logging_setup(config: Dict):
+def logging_setup(config: dict):
     """
     setup logging based on the configuration