From 4cd6d30f93c3a25dfe055b0d47eaa50011076bc8 Mon Sep 17 00:00:00 2001
From: NAUD Maxence <maxence.naud@cea.fr>
Date: Tue, 25 Feb 2025 14:17:29 +0000
Subject: [PATCH 1/2] [Add] Deprecation MACRO working for bothC++ and Python
binding
---
include/aidge/utils/Deprecated.hpp | 61 ++++++++++++++++++++++++++++++
1 file changed, 61 insertions(+)
create mode 100644 include/aidge/utils/Deprecated.hpp
diff --git a/include/aidge/utils/Deprecated.hpp b/include/aidge/utils/Deprecated.hpp
new file mode 100644
index 000000000..92cd190c7
--- /dev/null
+++ b/include/aidge/utils/Deprecated.hpp
@@ -0,0 +1,61 @@
+/********************************************************************************
+ * Copyright (c) 2023 CEA-List
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ ********************************************************************************/
+
+
+#ifndef AIDGE_UTILS_DEPRECATED_H_
+#define AIDGE_UTILS_DEPRECATED_H_
+
+#include <string>
+#include <cctype>
+
+#ifdef PYBIND
+#include <pybind11/pybind11.h>
+#endif
+
+#include "aidge/utils/Log.hpp"
+
+#ifdef PYBIND
+namespace py = pybind11;
+
+static std::string camelToSnakeCase(const std::string &camelCase) {
+ std::string snake;
+ snake.reserve(camelCase.size() + 2); // slightly bigger buffer
+ for (std::size_t i = 0; i < camelCase.size(); ++i) {
+ char ch = camelCase[i];
+ if (std::isupper(static_cast<unsigned char>(ch))) {
+ snake.push_back('_');
+ snake.push_back(std::tolower(static_cast<unsigned char>(ch)));
+ } else {
+ snake.push_back(ch);
+ }
+ }
+ return snake;
+}
+
+#define DEPRECATED_PYBIND(oldName, newName) \
+ /* Under PYBIND, if Python is initialized, convert names to snake_case */ \
+ if (Py_IsInitialized()) { \
+ deprecatedFuncNameStr = toSnakeCase(deprecatedFuncNameStr); \
+ newFuncNameStr = toSnakeCase(newFuncNameStr); \
+ }
+#else
+#define DEPRECATED_PYBIND(oldName, newName) {}
+#endif
+
+#define DEPRECATED(newFuncName) \
+ do { \
+ std::string deprecatedFuncNameStr(__func__); \
+ std::string newFuncNameStr(newFuncName); \
+ DEPRECATED_PYBIND(oldName, newName); \
+ Aidge::Log::warn("'{}()' is deprecated, please use '{}()' instead", deprecatedFuncNameStr, newFuncNameStr); \
+ } while (0)
+
+ #endif // AIDGE_UTILS_DEPRECATED_H_
\ No newline at end of file
--
GitLab
From c53550c16b5ef1a7db9d8d8b66942f9e39e2c928 Mon Sep 17 00:00:00 2001
From: NAUD Maxence <maxence.naud@cea.fr>
Date: Wed, 26 Feb 2025 13:38:31 +0000
Subject: [PATCH 2/2] update deprecation with pybind override
---
include/aidge/utils/Deprecated.hpp | 29 +++++++++++++++++++++++------
1 file changed, 23 insertions(+), 6 deletions(-)
diff --git a/include/aidge/utils/Deprecated.hpp b/include/aidge/utils/Deprecated.hpp
index 92cd190c7..5e73849a2 100644
--- a/include/aidge/utils/Deprecated.hpp
+++ b/include/aidge/utils/Deprecated.hpp
@@ -43,19 +43,36 @@ static std::string camelToSnakeCase(const std::string &camelCase) {
#define DEPRECATED_PYBIND(oldName, newName) \
/* Under PYBIND, if Python is initialized, convert names to snake_case */ \
if (Py_IsInitialized()) { \
- deprecatedFuncNameStr = toSnakeCase(deprecatedFuncNameStr); \
- newFuncNameStr = toSnakeCase(newFuncNameStr); \
+ deprecatedFuncNameStr = camelToSnakeCase(oldName); \
+ newFuncNameStr = camelToSnakeCase(newName); \
}
#else
-#define DEPRECATED_PYBIND(oldName, newName) {}
-#endif
+#define DEPRECATED_PYBIND(oldName, newName) do {} while (0)
+#endif // PYBIND
+// For the C++ interface without Python overrides.
#define DEPRECATED(newFuncName) \
do { \
std::string deprecatedFuncNameStr(__func__); \
std::string newFuncNameStr(newFuncName); \
- DEPRECATED_PYBIND(oldName, newName); \
- Aidge::Log::warn("'{}()' is deprecated, please use '{}()' instead", deprecatedFuncNameStr, newFuncNameStr); \
+ DEPRECATED_PYBIND(deprecatedFuncNameStr, newFuncName); \
+ Aidge::Log::warn("'{}()' is deprecated, please use '{}()' instead", \
+ deprecatedFuncNameStr, newFuncNameStr); \
+ } while (0)
+
+// For the case when you want to provide Python-specific override names.
+// If PYBIND is detected (and Python is initialized), then the names will be
+// replaced as follows:
+// deprecatedFuncNameStr = camelToSnakeCase(pybindNewOverridedName)
+// newFuncNameStr = camelToSnakeCase(pybindOldOverridedName)
+#define DEPRECATED_WITH_PYBIND_OVERRIDES(newFuncName, pybindNewOverridedName, pybindOldOverridedName) \
+ do { \
+ std::string deprecatedFuncNameStr(__func__); \
+ std::string newFuncNameStr(newFuncName); \
+ /* Swap the order of the override names here */ \
+ DEPRECATED_PYBIND(pybindNewOverridedName, pybindOldOverridedName); \
+ Aidge::Log::warn("'{}()' is deprecated, please use '{}()' instead", \
+ deprecatedFuncNameStr, newFuncNameStr); \
} while (0)
#endif // AIDGE_UTILS_DEPRECATED_H_
\ No newline at end of file
--
GitLab