From 2c63e4cf37a6d3ad7376262e386a16022ed8d719 Mon Sep 17 00:00:00 2001
From: Pierre-Yves David <pierre-yves.david@ens-lyon.org>
Date: Thu, 23 May 2024 12:13:21 +0200
Subject: [PATCH] model: deprecate comparing object_type's enums with string
It do works, but it is now discouraged.
---
swh/model/model.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/swh/model/model.py b/swh/model/model.py
index e8a82b4e..59df80b7 100644
--- a/swh/model/model.py
+++ b/swh/model/model.py
@@ -34,6 +34,7 @@ from typing import (
TypeVar,
Union,
)
+import warnings
import attr
from attr._make import _AndValidator
@@ -359,7 +360,11 @@ class _StringCompatibleEnum(Enum):
def __eq__(self, other):
# stay compatible with legacy string comparison (for now)
if isinstance(other, str):
- # note: we should issue deprecation warning at some point
+ warnings.warn(
+ "Use the enum value instead of string",
+ category=DeprecationWarning,
+ stacklevel=2,
+ )
return self.value == other
return super().__eq__(other)
--
GitLab