keep linter happy? (#1)

* Add extended typing through janus_types module

* one

---------

Co-authored-by: Jacob Wilkins <jacob.wilkins@stfc.ac.uk>
Co-authored-by: Jacob Wilkins <46597752+oerc0122@users.noreply.github.com>

docs/source/conf.py

@@ -38,7 +38,7 @@
 numpydoc_validation_exclude = {
     r"\.__weakref__$",
     r"\.__repr__$",
-    "janus_core\.janus_types\.",
+    r"janus_core\.janus_types",
 }
 
 intersphinx_mapping = {

janus_core/janus_types.py

@@ -1,9 +1,10 @@
 """
-Module containing types used in Janus-Core
+Module containing types used in Janus-Core.
 """
 
+from collections.abc import Sequence
 from pathlib import Path, PurePath
-from typing import IO, Literal, Optional, Sequence, TypedDict, TypeVar, Union
+from typing import IO, Literal, Optional, TypedDict, TypeVar, Union
 
 from ase import Atoms
 import numpy as np
@@ -21,9 +22,7 @@
 
 
 class ASEReadArgs(TypedDict, total=False):
-    """
-    Main arguments for ase.io.read.
-    """
+    """Main arguments for ase.io.read."""
 
     filename: Union[str, PurePath, IO]
     index: Union[int, slice, str]
@@ -33,9 +32,7 @@ class ASEReadArgs(TypedDict, total=False):
 
 
 class ASEWriteArgs(TypedDict, total=False):
-    """
-    Main arguments for ase.io.write.
-    """
+    """Main arguments for ase.io.write."""
 
     filename: Union[str, PurePath, IO]
     images: MaybeSequence[Atoms]
@@ -45,19 +42,15 @@ class ASEWriteArgs(TypedDict, total=False):
 
 
 class ASEOptArgs(TypedDict, total=False):
-    """
-    Main arugments for ase optimisers.
-    """
+    """Main arugments for ase optimisers."""
 
     restart: Optional[bool]
     logfile: Optional[PathLike]
     trajectory: PathLike
 
 
 class ASEOptRunArgs(TypedDict, total=False):
-    """
-    Main arugments for running ase optimisers.
-    """
+    """Main arugments for running ase optimisers."""
 
     fmax: float
     steps: int
@@ -69,9 +62,7 @@ class ASEOptRunArgs(TypedDict, total=False):
 
 
 class CalcResults(TypedDict, total=False):
-    """
-    Return type from calculations.
-    """
+    """Return type from calculations."""
 
     energy: MaybeList[float]
     forces: MaybeList[NDArray[np.float64]]