LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 Sat Nov 16 2019 09:15:53 for LSSTApplications by   doxygen 1.8.13