Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

# 

# LSST Data Management System 

# 

# Copyright 2008-2017 AURA/LSST. 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <https://www.lsstcorp.org/LegalNotices/>. 

# 

from __future__ import absolute_import, division, print_function 

import inspect 

 

__all__ = ["get_caller_name"] 

 

 

def 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']`` 

""" 

stack = inspect.stack() 

start = 0 + skip 

if len(stack) < start + 1: 

return '' 

parentframe = stack[start][0] 

 

name = [] 

module = inspect.getmodule(parentframe) 

61 ↛ 64line 61 didn't jump to line 64, because the condition on line 61 was never false if module: 

name.append(module.__name__) 

# add class name, if any 

if 'self' in parentframe.f_locals: 

name.append(type(parentframe.f_locals['self']).__name__) 

elif 'cls' in parentframe.f_locals: 

name.append(parentframe.f_locals['cls'].__name__) 

codename = parentframe.f_code.co_name 

69 ↛ 71line 69 didn't jump to line 71, because the condition on line 69 was never false if codename != '<module>': # top level usually 

name.append(codename) # function or a method 

return ".".join(name)