adding migration warnings for internal model

conan-io · Jan 15, 2025 · db23cef · db23cef
1 parent 67ea889
commit db23cef
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 141 deletions.
diff --git a/conan/cli/formatters/list/binary_html_table.py b/conan/cli/formatters/list/binary_html_table.py
diff --git a/conans/model/__init__.py b/conans/model/__init__.py
diff --git a/conans/model/package_ref.py b/conans/model/package_ref.py
@@ -0,0 +1,28 @@
+from conan.api.output import ConanOutput
+from conan.internal.model.package_ref import PkgReference as _PkgReference
+
+_msg = """
+*******************************************************************
+private '{}'
+detected in user code (custom commands, extensions, recipes, etc).
+Stop using it, use only public documented APIs.
+*******************************************************************
+"""
+
+
+class PkgReference(_PkgReference):
+    usage_counter = 0
+
+    def __init__(self, *args, **kwargs):
+        if PkgReference.usage_counter == 0:
+            ConanOutput().warning(_msg.format("from conans.model.package_ref import PkgReference"))
+        PkgReference.usage_counter += 1
+        super(PkgReference, self).__init__(*args, **kwargs)
+
+    @staticmethod
+    def loads(*args, **kwargs):
+        if PkgReference.usage_counter == 0:
+            ConanOutput().warning(_msg.format("from conans.model.package_ref import PkgReference"),
+                                  warn_tag="deprecated")
+        PkgReference.usage_counter += 1
+        return _PkgReference.loads(*args, **kwargs)
diff --git a/conans/model/recipe_ref.py b/conans/model/recipe_ref.py
@@ -0,0 +1,29 @@
+from conan.api.output import ConanOutput
+from conan.internal.model.recipe_ref import RecipeReference as _RecipeReference
+
+_msg = """
+*******************************************************************
+private '{}'
+detected in user code (custom commands, extensions, recipes, etc).
+Stop using it, use only public documented APIs.
+*******************************************************************
+"""
+
+
+class RecipeReference(_RecipeReference):
+    usage_counter = 0
+
+    def __init__(self, *args, **kwargs):
+        if RecipeReference.usage_counter == 0:
+            ConanOutput().warning(_msg.format("from conans.model.recipe_ref import RecipeReference"),
+                                  warn_tag="deprecated")
+        RecipeReference.usage_counter += 1
+        super(RecipeReference, self).__init__(*args, **kwargs)
+
+    @staticmethod
+    def loads(*args, **kwargs):
+        if RecipeReference.usage_counter == 0:
+            ConanOutput().warning(_msg.format("from conans.model.recipe_ref import RecipeReference"),
+                                  warn_tag="deprecated")
+        RecipeReference.usage_counter += 1
+        return _RecipeReference.loads(*args, **kwargs)