LSST Applications  21.0.0-142-gef555c1e+42c9bccae2,22.0.0+052faf71bd,22.0.0+1c4650f311,22.0.0+40ce427c77,22.0.0+5b6c068b1a,22.0.0+7589c3a021,22.0.0+81ed51be6d,22.0.1-1-g7d6de66+6cae67f2c6,22.0.1-1-g87000a6+314cd8b7ea,22.0.1-1-g8760c09+052faf71bd,22.0.1-1-g8e32f31+5b6c068b1a,22.0.1-10-g779eefa+a163f08322,22.0.1-12-g3bd7ecb+bbeacc25a9,22.0.1-15-g63cc0c1+2a7037787d,22.0.1-17-ge5a99e88+3d2c1afe2e,22.0.1-19-g88addfe+6cae67f2c6,22.0.1-2-g1cb3e5b+84de06d286,22.0.1-2-g8ef0a89+6cae67f2c6,22.0.1-2-g92698f7+1c4650f311,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gb66926d+5b6c068b1a,22.0.1-2-gcb770ba+0723a13595,22.0.1-2-ge470956+ff9f1dc8d5,22.0.1-22-g608e23ac+2ac85e833c,22.0.1-29-g184b6e44e+8b185d4e2d,22.0.1-3-g59f966b+11ba4df19d,22.0.1-3-g8c1d971+f90df4c6d0,22.0.1-3-g997b569+d69a7aa2f8,22.0.1-3-gaaec9c0+4d194bf81c,22.0.1-4-g1930a60+283d9d2f1a,22.0.1-4-g5b7b756+c1283a92b8,22.0.1-4-g8623105+6cae67f2c6,22.0.1-7-gba73697+283d9d2f1a,22.0.1-8-g47d23f5+43acea82f3,master-g5f2689bdc5+40ce427c77,w.2021.38
LSST Data Management Base Package
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)
table::Key< int > type
Definition: Detector.cc:163