fix: better stacklevel for warnings (#487)

* chore: update pre-commit hooks

updates:
- [github.com/charliermarsh/ruff-pre-commit: v0.0.255 → v0.0.257](astral-sh/ruff-pre-commit@v0.0.255...v0.0.257)
- [github.com/nbQA-dev/nbQA: 1.6.3 → 1.6.4](nbQA-dev/nbQA@1.6.3...1.6.4)

* fix: set the stacklevel for warnings

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

* chore: bump Ruff once more

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

* tests: lock seed for numpy

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

---------

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com>

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.255
+  rev: v0.0.258
   hooks:
   - id: ruff
     args: ["--fix", "--show-fixes"]
@@ -35,7 +35,7 @@ repos:
 
 # Notebook formatting
 - repo: https://github.com/nbQA-dev/nbQA
-  rev: 1.6.3
+  rev: 1.6.4
   hooks:
   - id: nbqa-ruff
     additional_dependencies: [ruff==0.0.253]

src/hist/__init__.py

@@ -54,6 +54,6 @@ def __dir__() -> tuple[str, ...]:
 def __getattr__(name: str) -> ModuleType:
     if name == "axes":
         msg = f"Misspelling error, '{name}' should be 'axis'"
-        warnings.warn(msg)
+        warnings.warn(msg, stacklevel=2)
         return axis
     raise AttributeError(f"module {__name__} has no attribute {name}")

src/hist/axestuple.py

@@ -58,7 +58,7 @@ def name(self, values: Iterable[str]) -> None:
                 disallowed_warning = (
                     f"{ax.name} is a protected keyword and cannot be used as axis name"
                 )
-                warnings.warn(disallowed_warning)
+                warnings.warn(disallowed_warning, stacklevel=2)
 
         valid_names = [ax.name for ax in self if ax.name]
         if len(valid_names) != len(set(valid_names)):

src/hist/basehist.py

@@ -93,7 +93,7 @@ def __init__(
             storage = getattr(bh.storage, storage_str)()
         elif isinstance(storage, type):
             msg = f"Please use '{storage.__name__}()' instead of '{storage.__name__}'"
-            warnings.warn(msg)
+            warnings.warn(msg, stacklevel=2)
             storage = storage()
 
         super().__init__(*args, storage=storage, metadata=metadata)  # type: ignore[call-overload]
@@ -104,7 +104,7 @@ def __init__(
                 disallowed_warning = (
                     f"{ax.name} is a protected keyword and cannot be used as axis name"
                 )
-                warnings.warn(disallowed_warning)
+                warnings.warn(disallowed_warning, stacklevel=2)
 
         valid_names = [ax.name for ax in self.axes if ax.name]
         if len(valid_names) != len(set(valid_names)):

tests/test_stacks.py

@@ -8,6 +8,8 @@
 
 from hist import Hist, NamedHist, Stack, axis
 
+np.random.seed(42)
+
 # different histograms here!
 reg_ax = axis.Regular(10, 0, 1)
 boo_ax = axis.Boolean()