__doc__ of current function?

[Trevor Taylor]

Hi,

I thought it would be simple but couldn't figure it out, nor find it
addressed already:

I can do:

def validatePassword(p):
'do something'
print validatePassword.__doc__

.... can I write a general docOfCurrentFunction() function so that I
can rewrite it:

def validatePassword(p):
'do something'
print docOfCurrentFunction()

Thanks,

Trevor

 

[Ksenia Marasanova]

... can I write a general docOfCurrentFunction() function so that I
can rewrite it:

def validatePassword(p):
'do something'
print docOfCurrentFunction()

def docOfCurrentFunction():
import sys
func_name = sys._getframe(1).f_code.co_name
return eval(func_name + '.__doc__')

But I hope that a more intelligent way exists than using 'eval'


Ksenia.

 

[Peter Otten]

def docOfCurrentFunction():
import sys
func_name = sys._getframe(1).f_code.co_name
return eval(func_name + '.__doc__')

But I hope that a more intelligent way exists than using 'eval'
Maybe

.... f = sys._getframe(1)
.... return f.f_globals[f.f_code.co_name]
........ "Demo docstring"
.... print caller().__doc__
....
Or can that fail in some cases?

Peter

 

[Sean Ross]

def docOfCurrentFunction():
import sys
func_name = sys._getframe(1).f_code.co_name
return eval(func_name + '.__doc__')

But I hope that a more intelligent way exists than using 'eval'
Maybe

... f = sys._getframe(1)
... return f.f_globals[f.f_code.co_name]
...... "Demo docstring"
... print caller().__doc__
...
Or can that fail in some cases?

Peter

Hi.
Yes, it fails for methods:
.... f = sys._getframe(1)
.... return f.f_globals[f.f_code.co_name]
........ def m(self):
.... "mmmmmmmmmm"
.... print caller().__doc__
....Traceback (most recent call last):
File "<interactive input>", line 1, in ?
File "<interactive input>", line 4, in m