[go: up one dir, main page]

File: _deprecation.py

package info (click to toggle)
unyt 3.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,444 kB
  • sloc: python: 11,454; makefile: 20
file content (22 lines) | stat: -rw-r--r-- 476 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import warnings
from typing import Optional


def warn_deprecated(
    name,
    /,
    *,
    stacklevel: int = 3,
    replacement: Optional[str] = None,
    since_version: str,
) -> None:
    msg = (
        f"{name} is deprecated and will be removed in a future version\n"
        f"Instead, {replacement}\n"
        f"(deprecated since unyt v{since_version})"
    )
    warnings.warn(
        msg,
        category=DeprecationWarning,
        stacklevel=stacklevel,
    )