add conftest and improve type-hints

Author: mscheltienne

template/commands/sys_info.py

@@ -3,7 +3,7 @@
 from .. import sys_info
 
 
-def run():
+def run() -> None:
     """Run sys_info() command."""
     parser = argparse.ArgumentParser(
         prog=f"{__package__.split('.')[0]}-sys_info", description="sys_info"

template/conftest.py

@@ -0,0 +1,17 @@
+from __future__ import annotations  # c.f. PEP 563, PEP 649
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pytest import Config
+
+
+def pytest_configure(config: Config) -> None:
+    """Configure pytest options."""
+    warnings_lines = r"""
+    error::
+    """
+    for warning_line in warnings_lines.split("\n"):
+        warning_line = warning_line.strip()
+        if warning_line and not warning_line.startswith("#"):
+            config.addinivalue_line("filterwarnings", warning_line)

template/utils/_checks.py

@@ -1,15 +1,20 @@
 """Utility functions for checking types and values. Inspired from MNE."""
 
+from __future__ import annotations  # c.f. PEP 563, PEP 649
+
 import logging
 import operator
 import os
 from pathlib import Path
-from typing import Any, Optional
+from typing import TYPE_CHECKING
 
 import numpy as np
 
 from ._docs import fill_doc
 
+if TYPE_CHECKING:
+    from typing import Any, Optional
+
 
 def ensure_int(item: Any, item_name: Optional[str] = None) -> int:
     """Ensure a variable is an integer.

template/utils/_docs.py

@@ -4,8 +4,13 @@
 Inspired from mne.utils.docs.py by Eric Larson <larson.eric.d@gmail.com>
 """
 
+from __future__ import annotations  # c.f. PEP 563, PEP 649
+
 import sys
-from typing import Callable, Dict, List
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Callable, Dict, List
 
 # ------------------------- Documentation dictionary -------------------------
 docdict: Dict[str, str] = dict()

template/utils/_fixes.py

@@ -11,7 +11,7 @@ class WrapStdOut(object):
     properly.
     """
 
-    def __getattr__(self, name):  # noqa: D105
+    def __getattr__(self, name: str):  # noqa: D105
         # Even more ridiculous than this class, this must be sys.stdout (not
         # just stdout) in order for this to work (tested on OSX and Linux).
         if hasattr(sys.stdout, name):

template/utils/config.py

@@ -1,14 +1,19 @@
+from __future__ import annotations  # c.f. PEP 563, PEP 649
+
 import platform
 import sys
 from functools import partial
 from importlib.metadata import requires, version
-from typing import IO, Callable, List, Optional
+from typing import TYPE_CHECKING
 
 import psutil
 from packaging.requirements import Requirement
 
 from ._checks import check_type
 
+if TYPE_CHECKING:
+    from typing import IO, Callable, List, Optional
+
 
 def sys_info(fid: Optional[IO] = None, developer: bool = False):
     """Print the system information for debugging.

template/utils/logs.py

@@ -1,12 +1,17 @@
+from __future__ import annotations  # c.f. PEP 563, PEP 649
+
 import logging
 from functools import wraps
 from pathlib import Path
-from typing import Callable, Optional, Union
+from typing import TYPE_CHECKING
 
 from ._checks import check_verbose
 from ._docs import fill_doc
 from ._fixes import WrapStdOut
 
+if TYPE_CHECKING:
+    from typing import Callable, Optional, Union
+
 
 @fill_doc
 def _init_logger(*, verbose: Optional[Union[bool, str, int]] = None) -> logging.Logger: