fix PatchType and SpoolType type var

DASDAE · Nov 8, 2024 · c26966c · c26966c
1 parent aa0f62d
commit c26966c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/dascore/constants.py b/dascore/constants.py
@@ -8,11 +8,11 @@
 import numpy as np
 import pandas as pd
 
-import dascore as dc
+import dascore
 
-PatchType = TypeVar("PatchType", bound="dc.Patch")
+PatchType = TypeVar("PatchType", bound="dascore.Patch")
 
-SpoolType = TypeVar("SpoolType", bound="dc.BaseSpool")
+SpoolType = TypeVar("SpoolType", bound="dascore.BaseSpool")
 
 
 @runtime_checkable

diff --git a/dascore/utils/patch.py b/dascore/utils/patch.py
@@ -234,9 +234,14 @@ def patch_function(
 
     Notes
     -----
-    The original function can still be accessed with the raw_function
-    attribute. This may be useful for avoiding calling the patch_func
-    machinery multiple times from within another patch function.
+    - The original function can still be accessed with the raw_function
+      attribute. This may be useful for avoiding calling the patch_func
+      machinery multiple times from within another patch function.
+
+    - If using `PatchType` or `SpoolType` type variables from the
+      [constants module](`dascore.constants`), you may need to import
+      dascore (not import dascore as dc) in the same file the patch function
+      is defined.
     """
 
     def _wrapper(func):

diff --git a/tests/test_utils/test_patch_utils.py b/tests/test_utils/test_patch_utils.py
@@ -10,6 +10,7 @@
 import pytest
 from pydantic import Field
 
+import dascore  # noqa needed for PatchType
 import dascore as dc
 from dascore import patch_function
 from dascore.constants import PatchType