Loading...
Searching...
No Matches
pyExceptionState.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24
25#include "pxr/pxr.h"
26#include "pxr/base/tf/api.h"
27#include <boost/python/handle.hpp>
28
29PXR_NAMESPACE_OPEN_SCOPE
30
31struct TfPyExceptionState {
32 TfPyExceptionState(boost::python::handle<> const &type,
33 boost::python::handle<> const &value,
34 boost::python::handle<> const &trace) :
35 _type(type), _value(value), _trace(trace) {}
36
37 TF_API
38 ~TfPyExceptionState();
39
40 TF_API
41 TfPyExceptionState (TfPyExceptionState const &);
42
43 TF_API
44 TfPyExceptionState &operator=(TfPyExceptionState const &);
45
46 // Extract Python's current exception state as by PyErr_Fetch() and return
47 // it in a TfPyExceptionState. This leaves Python's current exception state
48 // clear.
49 TF_API
50 static TfPyExceptionState Fetch();
51
52 boost::python::handle<> const &GetType() const { return _type; }
53 boost::python::handle<> const &GetValue() const { return _value; }
54 boost::python::handle<> const &GetTrace() const { return _trace; }
55
56 // Move this object's exception state into Python's current exception state,
57 // as by PyErr_Restore(). This leaves this object's exception state clear.
58 TF_API
59 void Restore();
60
61 // Format a Python traceback for the exception state held by this object, as
62 // by traceback.format_exception().
63 TF_API
64 std::string GetExceptionString() const;
65
66private:
67 boost::python::handle<> _type, _value, _trace;
68};
69
70PXR_NAMESPACE_CLOSE_SCOPE