Merge pull request #52 from 0Hughman0/improving-typing

Improving typing

cassini/__init__.py

@@ -1,7 +1,13 @@
-from .defaults.tiers import DEFAULT_TIERS
+from .defaults.tiers import (
+    DEFAULT_TIERS,
+    Home,
+    WorkPackage,
+    Experiment,
+    Sample,
+    DataSet,
+)
 from .environment import Project, env
 from .core import TierBase
-from cassini.defaults.tiers import Home
 
 try:
     __IPYTHON__  # type: ignore[name-defined]
@@ -10,3 +16,15 @@
     register()
 except NameError:
     pass
+
+__all__ = [
+    "Project",
+    "DEFAULT_TIERS",
+    "env",
+    "TierBase",
+    "Home",
+    "WorkPackage",
+    "Experiment",
+    "Sample",
+    "DataSet",
+]

cassini/accessors.py

@@ -6,28 +6,45 @@
     Any,
     cast,
     Dict,
+    List,
+    Tuple,
     TypeVar,
     Generic,
     Optional,
     Type,
     overload,
-    ClassVar,
+    TYPE_CHECKING,
 )
 from typing_extensions import Self
 
+if TYPE_CHECKING:
+    from .core import TierBase
+
 T = TypeVar("T")
 V = TypeVar("V")
 
-
-def _null_func(val):
-    return val
+JSONPrimative = Union[str, int, float, bool, None]
+JSONType = Union[dict, list, tuple, JSONPrimative]
+JSONProcessor = Callable[[JSONType], T]
+
+JOut = TypeVar(
+    "JOut",
+    Dict[JSONPrimative, JSONType],
+    List[JSONType],
+    Tuple[JSONType, ...],
+    str,
+    int,
+    float,
+    bool,
+    None,
+)
 
 
-JSONType = Union[dict, list, str, int, float, bool, None]
-JSONProcessor = Callable[[JSONType], Any]
+def _null_func(val: Any) -> Any:
+    return cast(JSONType, val)
 
 
-class MetaAttr:
+class MetaAttr(Generic[JOut, T]):
     """
     Accessor for getting values from a Tier class's meta as an attribute.
 
@@ -58,27 +75,27 @@ class MetaAttr:
 
     def __init__(
         self,
-        post_get: JSONProcessor = _null_func,
-        pre_set: Callable[[Any], JSONType] = _null_func,
+        post_get: Callable[[JOut], T] = _null_func,
+        pre_set: Callable[[T], JOut] = _null_func,
         name: Union[str, None] = None,
-        default: Any = None,
+        default: Union[T, None] = None,
     ):
         self.name: str = cast(str, name)
-        self.post_get = post_get
-        self.pre_set = pre_set
+        self.post_get: Callable[[JOut], T] = post_get
+        self.pre_set: Callable[[T], JOut] = pre_set
         self.default = default
 
-    def __set_name__(self, owner, name: str):
+    def __set_name__(self, owner: object, name: str) -> None:
         if self.name is None:
             self.name = name
 
-    def __get__(self, instance, owner):
+    def __get__(self, instance: "TierBase", owner: object) -> Union[T, None]:
         try:
-            return self.post_get(instance.meta[self.name])
+            return self.post_get(cast(JOut, instance.meta[self.name]))
         except KeyError:
             return self.default
 
-    def __set__(self, instance, value):
+    def __set__(self, instance: "TierBase", value: T) -> None:
         setattr(instance.meta, self.name, self.pre_set(value))
 
 
@@ -142,7 +159,7 @@ def __get__(self, instance: Optional[T], owner: Type[T]) -> Union[V, Self]:
 
         return val
 
-    def __set__(self, instance, value):
+    def __set__(self, instance: Optional[T], value: Any) -> None:
         raise AttributeError("Trying to set a cached property - naughty!")
 
 
@@ -175,7 +192,7 @@ def __get__(self, instance: T, owner: Type[T]) -> V:
 
         return val
 
-    def __set__(self, instance, value):
+    def __set__(self, instance: T, value: Any) -> Any:
         raise AttributeError("Trying to set a cached class property - naughty!")
 
 

cassini/compat/update.py

@@ -1,9 +1,16 @@
-import nbformat
 import re
+from typing import List, Callable, TypeVar
+
+import nbformat
+from nbformat import NotebookNode
+
+CellProcessor = Callable[[NotebookNode], None]
 
 
 class BaseUpdater:
-    def cell_processor(self, f):
+    cell_processors: List[CellProcessor]
+
+    def cell_processor(self, f: CellProcessor):
         self.cell_processors.append(f)
         return f
 
@@ -12,7 +19,9 @@ class V0_1to0_2(BaseUpdater):
     def __init__(self):
         from .. import env
 
-        self.home = env()
+        assert env.project
+
+        self.home = env.project.home
         self.cell_processors = []
 
         @self.cell_processor