[Add] Deprecation system

Context

Solves aidge#32 (closed).

To mark a function as deprecated, simply add the MACRO DEPRECATED("new_func_name"); at the beginning where "new_func_name" is the name of the function that should be used instead.

Function name is automatically converted to snake_case if a Python environment is detected.

// in Tensor::setdataFormat()
DEPRECATED("toDataFormat");

>>> import aidge_core as ai
>>> ai.Tensor(dims=[1,2,3,4])
>>> a.set_data_format(ai.dformat.nchw)
[WARNING] - 'set_data_format()' is deprecated, please use 'to_data_format()' instead

Add macro when Python binded function name cannot be automatically deduced DEPRECATED_WITH_PYBIND_OVERRIDES

// in Tensor::setdataFormat()
DEPRECATED_WITH_PYBIND_OVERRIDES("toDataFormat", "set_dformat", "to_dformat");

>>> import aidge_core as ai
>>> ai.Tensor(dims=[1,2,3,4])
>>> a.set_dformat(ai.dformat.nchw)
[WARNING] - 'set_dformat()' is deprecated, please use 'to_dformat()' instead

Major modifications

• add: utils/Deprecation.hpp

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