From 3a91cc4a619e87dab28db9584065c0b7138070fa Mon Sep 17 00:00:00 2001 From: Niklas Neugebauer Date: Mon, 20 Jan 2025 14:27:13 +0100 Subject: [PATCH] add version to deprecation warning --- rosys/helpers/deprecation.py | 4 ++-- rosys/vision/rtsp_camera/rtsp_camera.py | 2 +- rosys/vision/rtsp_camera/rtsp_camera_provider.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/rosys/helpers/deprecation.py b/rosys/helpers/deprecation.py index 69f9f1c3..b694d99f 100644 --- a/rosys/helpers/deprecation.py +++ b/rosys/helpers/deprecation.py @@ -3,14 +3,14 @@ from functools import wraps -def deprecated_param(param_name: str) -> Callable: +def deprecated_param(param_name: str, *, remove_in_version: str | None = None) -> Callable: """Mark a function parameter as deprecated.""" def decorator(func: Callable) -> Callable: @wraps(func) def wrapper(*args, **kwargs): if param_name in kwargs: warnings.warn( - f'The parameter "{param_name}" is deprecated and will be removed in future versions.', + f'The parameter "{param_name}" is deprecated and will be removed in {remove_in_version if remove_in_version else "future versions"}.', category=DeprecationWarning, stacklevel=2, ) diff --git a/rosys/vision/rtsp_camera/rtsp_camera.py b/rosys/vision/rtsp_camera/rtsp_camera.py index c7f9bace..f27008ce 100644 --- a/rosys/vision/rtsp_camera/rtsp_camera.py +++ b/rosys/vision/rtsp_camera/rtsp_camera.py @@ -15,7 +15,7 @@ class RtspCamera(ConfigurableCamera, TransformableCamera): - @deprecated_param('jovision_profile') + @deprecated_param('jovision_profile', remove_in_version='0.27.0') def __init__(self, *, id: str, # pylint: disable=redefined-builtin diff --git a/rosys/vision/rtsp_camera/rtsp_camera_provider.py b/rosys/vision/rtsp_camera/rtsp_camera_provider.py index 194907c2..7b6e985f 100644 --- a/rosys/vision/rtsp_camera/rtsp_camera_provider.py +++ b/rosys/vision/rtsp_camera/rtsp_camera_provider.py @@ -11,7 +11,7 @@ class RtspCameraProvider(CameraProvider[RtspCamera], persistence.PersistentModul """This module collects and provides real RTSP streaming cameras.""" SCAN_INTERVAL = 10 - @deprecated_param('jovision_profile') + @deprecated_param('jovision_profile', remove_in_version='0.27.0') def __init__(self, *, frame_rate: int = 6, substream: int = 0,