LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
callStack.py
Go to the documentation of this file.
1 # This file is part of pex_config.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This software is dual licensed under the GNU General Public License and also
10 # under a 3-clause BSD license. Recipients may choose which of these licenses
11 # to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12 # respectively. If you choose the GPL option then the following text applies
13 # (but note that there is still no warranty even if you opt for BSD instead):
14 #
15 # This program is free software: you can redistribute it and/or modify
16 # it under the terms of the GNU General Public License as published by
17 # the Free Software Foundation, either version 3 of the License, or
18 # (at your option) any later version.
19 #
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
24 #
25 # You should have received a copy of the GNU General Public License
26 # along with this program. If not, see <http://www.gnu.org/licenses/>.
27 
28 __all__ = ['getCallerFrame', 'getStackFrame', 'StackFrame', 'getCallStack']
29 
30 import inspect
31 import linecache
32 
33 
34 def getCallerFrame(relative=0):
35  """Get the frame for the user's caller.
36 
37  Parameters
38  ----------
39  relative : `int`, optional
40  Number of frames (0 or more) above the caller to retrieve.
41  Default is 0.
42 
43  Returns
44  -------
45  frame : `__builtin__.Frame`
46  Frame for the caller.
47 
48  Notes
49  -----
50  This function is excluded from the frame.
51  """
52  frame = inspect.currentframe().f_back.f_back # Our caller's caller
53  for ii in range(relative):
54  frame = frame.f_back
55  return frame
56 
57 
58 def getStackFrame(relative=0):
59  """Get the `StackFrame` for the user's caller.
60 
61  Parameters
62  ----------
63  relative : `int`, optional
64  Number of frames (0 or more) above the caller to retrieve.
65 
66  Returns
67  -------
68  frame : `StackFrame`
69  Stack frame for the caller.
70  """
71  frame = getCallerFrame(relative + 1)
72  return StackFrame.fromFrame(frame)
73 
74 
75 class StackFrame:
76  """A single element of the stack trace.
77 
78  This differs slightly from the standard system mechanisms for getting a
79  stack trace by the fact that it does not look up the source code until it
80  is absolutely necessary, reducing the I/O.
81 
82  Parameters
83  ----------
84  filename : `str`
85  Name of file containing the code being executed.
86  lineno : `int`
87  Line number of file being executed.
88  function : `str`
89  Function name being executed.
90  content : `str`, optional
91  The actual content being executed. If not provided, it will be loaded
92  from the file.
93 
94  Notes
95  -----
96  This differs slightly from the standard system mechanisms for getting a
97  stack trace by the fact that it does not look up the source code until it
98  is absolutely necessary, reducing the I/O.
99 
100  See also
101  --------
102  getStackFrame
103  """
104 
105  _STRIP = "/python/lsst/"
106  """String to strip from the ``filename`` in the constructor."""
107 
108  def __init__(self, filename, lineno, function, content=None):
109  loc = filename.rfind(self._STRIP_STRIP)
110  if loc > 0:
111  filename = filename[loc + len(self._STRIP_STRIP):]
112  self.filenamefilename = filename
113  self.linenolineno = lineno
114  self.functionfunction = function
115  self._content_content = content
116 
117  @property
118  def content(self):
119  """Content being executed (loaded on demand) (`str`).
120  """
121  if self._content_content is None:
122  self._content_content = linecache.getline(self.filenamefilename, self.linenolineno).strip()
123  return self._content_content
124 
125  @classmethod
126  def fromFrame(cls, frame):
127  """Construct from a Frame object.
128 
129  Parameters
130  ----------
131  frame : `Frame`
132  Frame object to interpret, such as from `inspect.currentframe`.
133 
134  Returns
135  -------
136  stackFrame : `StackFrame`
137  A `StackFrame` instance.
138 
139  Examples
140  --------
141  `inspect.currentframe` provides a Frame object. This is a convenience
142  constructor to interpret that Frame object:
143 
144  >>> import inspect
145  >>> stackFrame = StackFrame.fromFrame(inspect.currentframe())
146  """
147  filename = frame.f_code.co_filename
148  lineno = frame.f_lineno
149  function = frame.f_code.co_name
150  return cls(filename, lineno, function)
151 
152  def __repr__(self):
153  return "%s(%s, %s, %s)" % (self.__class__.__name__, self.filenamefilename, self.linenolineno, self.functionfunction)
154 
155  def format(self, full=False):
156  """Format for printing.
157 
158  Parameters
159  ----------
160  full : `bool`, optional
161  If `True`, output includes the conentent (`StackFrame.content`)
162  being executed. Default is `False`.
163 
164  Returns
165  -------
166  result : `str`
167  Formatted string.
168  """
169  result = " File %s:%s (%s)" % (self.filenamefilename, self.linenolineno, self.functionfunction)
170  if full:
171  result += "\n %s" % (self.contentcontent,)
172  return result
173 
174 
175 def getCallStack(skip=0):
176  """Retrieve the call stack for the caller.
177 
178  Parameters
179  ----------
180  skip : `int`, non-negative
181  Number of stack frames above caller to skip.
182 
183  Returns
184  -------
185  output : `list` of `StackFrame`
186  The call stack. The `list` is ordered with the most recent frame to
187  last.
188 
189  Notes
190  -----
191  This function is excluded from the call stack.
192  """
193  frame = getCallerFrame(skip + 1)
194  stack = []
195  while frame:
196  stack.append(StackFrame.fromFrame(frame))
197  frame = frame.f_back
198  return list(reversed(stack))
def format(self, full=False)
Definition: callStack.py:155
def __init__(self, filename, lineno, function, content=None)
Definition: callStack.py:108
daf::base::PropertyList * list
Definition: fits.cc:913
bool strip
Definition: fits.cc:911
def getCallStack(skip=0)
Definition: callStack.py:175
def getStackFrame(relative=0)
Definition: callStack.py:58
def getCallerFrame(relative=0)
Definition: callStack.py:34