xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/python/util.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2022 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_COMPILER_XLA_PYTHON_UTIL_H_
17 #define TENSORFLOW_COMPILER_XLA_PYTHON_UTIL_H_
18 
19 #include "absl/strings/str_format.h"
20 #include "pybind11/pybind11.h"
21 
22 namespace xla {
23 
24 // Issues a Python deprecation warning. Throws a C++ exception if issuing the
25 // Python warning causes a Python exception to be raised.
26 template <typename... Args>
PythonDeprecationWarning(const absl::FormatSpec<Args...> & format,const Args &...args)27 void PythonDeprecationWarning(const absl::FormatSpec<Args...>& format,
28                               const Args&... args) {
29   if (PyErr_WarnEx(PyExc_DeprecationWarning,
30                    absl::StrFormat(format, args...).c_str(), 1) < 0) {
31     throw pybind11::error_already_set();
32   }
33 }
34 
35 }  // namespace xla
36 
37 #endif  // TENSORFLOW_COMPILER_XLA_PYTHON_UTIL_H_
38