Public Member Functions
def	__init__ (self, filename, lineno, function, content=None)

def	content (self)

def	fromFrame (cls, frame)

def	__repr__ (self)

def	format (self, full=False)

Public Attributes
	filename

	lineno

	function

Detailed Description

A single element of the stack trace.

This differs slightly from the standard system mechanisms for getting a
stack trace by the fact that it does not look up the source code until it
is absolutely necessary, reducing the I/O.

Parameters
----------
filename : `str`
    Name of file containing the code being executed.
lineno : `int`
    Line number of file being executed.
function : `str`
    Function name being executed.
content : `str`, optional
    The actual content being executed. If not provided, it will be loaded
    from the file.

Notes
-----
This differs slightly from the standard system mechanisms for getting a
stack trace by the fact that it does not look up the source code until it
is absolutely necessary, reducing the I/O.

See also
--------
getStackFrame

Definition at line 75 of file callStack.py.

Constructor & Destructor Documentation

◆ init()

def pex.config.callStack.StackFrame.__init__	(	self,
		filename,
		lineno,
		function,
		content = `None`
	)

Definition at line 108 of file callStack.py.

     def __init__(self, filename, lineno, function, content=None):
         loc = filename.rfind(self._STRIP)
         if loc > 0:
             filename = filename[loc + len(self._STRIP):]
         self.filename = filename
         self.lineno = lineno
         self.function = function
         self._content = content
  

Member Function Documentation

◆ repr()

def pex.config.callStack.StackFrame.__repr__ ( self )

Definition at line 152 of file callStack.py.

     def __repr__(self):
         return "%s(%s, %s, %s)" % (self.__class__.__name__, self.filename, self.lineno, self.function)
  

◆ content()

def pex.config.callStack.StackFrame.content ( self )

Content being executed (loaded on demand) (`str`).

Definition at line 118 of file callStack.py.

     def content(self):
         """Content being executed (loaded on demand) (`str`).
         """
         if self._content is None:
             self._content = linecache.getline(self.filename, self.lineno).strip()
         return self._content
  

◆ format()

def pex.config.callStack.StackFrame.format	(	self,
		full = `False`
	)

Format for printing.

Parameters
----------
full : `bool`, optional
    If `True`, output includes the conentent (`StackFrame.content`)
    being executed. Default is `False`.

Returns
-------
result : `str`
    Formatted string.

Definition at line 155 of file callStack.py.

     def format(self, full=False):
         """Format for printing.
  
         Parameters
         ----------
         full : `bool`, optional
             If `True`, output includes the conentent (`StackFrame.content`)
             being executed. Default is `False`.
  
         Returns
         -------
         result : `str`
             Formatted string.
         """
         result = "  File %s:%s (%s)" % (self.filename, self.lineno, self.function)
         if full:
             result += "\n    %s" % (self.content,)
         return result
  
  

◆ fromFrame()

def pex.config.callStack.StackFrame.fromFrame	(	cls,
		frame
	)

Construct from a Frame object.

Parameters
----------
frame : `Frame`
    Frame object to interpret, such as from `inspect.currentframe`.

Returns
-------
stackFrame : `StackFrame`
    A `StackFrame` instance.

Examples
--------
`inspect.currentframe` provides a Frame object. This is a convenience
constructor to interpret that Frame object:

>>> import inspect
>>> stackFrame = StackFrame.fromFrame(inspect.currentframe())

Definition at line 126 of file callStack.py.

     def fromFrame(cls, frame):
         """Construct from a Frame object.
  
         Parameters
         ----------
         frame : `Frame`
             Frame object to interpret, such as from `inspect.currentframe`.
  
         Returns
         -------
         stackFrame : `StackFrame`
             A `StackFrame` instance.
  
         Examples
         --------
         `inspect.currentframe` provides a Frame object. This is a convenience
         constructor to interpret that Frame object:
  
         >>> import inspect
         >>> stackFrame = StackFrame.fromFrame(inspect.currentframe())
         """
         filename = frame.f_code.co_filename
         lineno = frame.f_lineno
         function = frame.f_code.co_name
         return cls(filename, lineno, function)
  

Member Data Documentation

◆ filename

pex.config.callStack.StackFrame.filename

Definition at line 112 of file callStack.py.

◆ function

pex.config.callStack.StackFrame.function

Definition at line 114 of file callStack.py.

◆ lineno

pex.config.callStack.StackFrame.lineno

Definition at line 113 of file callStack.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_config/20.0.0+34a42eae2c/python/lsst/pex/config/callStack.py

Public Member Functions

Public Attributes