LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
Functions
lsst.utils.get_caller_name Namespace Reference

Functions

def get_caller_name (skip=2)
 

Function Documentation

◆ get_caller_name()

def lsst.utils.get_caller_name.get_caller_name (   skip = 2) 
Get the name of the caller method.

Any item that cannot be determined (or is not relevant, e.g. a free
function has no class) is silently omitted, along with an
associated separator.

Parameters
----------
skip : `int`
    How many levels of stack to skip while getting caller name;
    1 means "who calls me", 2 means "who calls my caller", etc.

Returns
-------
name : `str`
    Name of the caller as a string in the form ``module.class.method``.
    An empty string is returned if ``skip`` exceeds the stack height.

Notes
-----
Adapted from from http://stackoverflow.com/a/9812105
by adding support to get the class from ``parentframe.f_locals['cls']``

Definition at line 27 of file get_caller_name.py.

27 def get_caller_name(skip=2):
28  """Get the name of the caller method.
29 
30  Any item that cannot be determined (or is not relevant, e.g. a free
31  function has no class) is silently omitted, along with an
32  associated separator.
33 
34  Parameters
35  ----------
36  skip : `int`
37  How many levels of stack to skip while getting caller name;
38  1 means "who calls me", 2 means "who calls my caller", etc.
39 
40  Returns
41  -------
42  name : `str`
43  Name of the caller as a string in the form ``module.class.method``.
44  An empty string is returned if ``skip`` exceeds the stack height.
45 
46  Notes
47  -----
48  Adapted from from http://stackoverflow.com/a/9812105
49  by adding support to get the class from ``parentframe.f_locals['cls']``
50  """
51  stack = inspect.stack()
52  start = 0 + skip
53  if len(stack) < start + 1:
54  return ''
55  parentframe = stack[start][0]
56 
57  name = []
58  module = inspect.getmodule(parentframe)
59  if module:
60  name.append(module.__name__)
61  # add class name, if any
62  if 'self' in parentframe.f_locals:
63  name.append(type(parentframe.f_locals['self']).__name__)
64  elif 'cls' in parentframe.f_locals:
65  name.append(parentframe.f_locals['cls'].__name__)
66  codename = parentframe.f_code.co_name
67  if codename != '<module>': # top level usually
68  name.append(codename) # function or a method
69  return ".".join(name)
70 
type
table::Key< int > type
Definition: Detector.cc:163
lsst::utils.get_caller_name.get_caller_name
def get_caller_name(skip=2)
Definition: get_caller_name.py:27
Generated on Wed Jan 8 2020 09:12:44 for LSSTApplications by   doxygen 1.8.13