ChatGPT解决这个技术问题 Extra ChatGPT

How can I get the source code of a Python function?

Suppose I have a Python function as defined below:

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

I can get the name of the function using foo.func_name. How can I programmatically get its source code, as I typed above?

Note, in Python 3 you can get the function name using foo.__name__
You can get a lot of other things as well.

S
Smart Manoj

If the function is from a source file available on the filesystem, then inspect.getsource(foo) might be of help:

If foo is defined as:

def foo(arg1,arg2):         
    #do something with args 
    a = arg1 + arg2         
    return a  

Then:

import inspect
lines = inspect.getsource(foo)
print(lines)

Returns:

def foo(arg1,arg2):         
    #do something with args 
    a = arg1 + arg2         
    return a                

But I believe that if the function is compiled from a string, stream or imported from a compiled file, then you cannot retrieve its source code.


Returns a tuple; tuple[0] is list of strings representing the lines of source code, and tuple[1] is the line number in the context of execution where it was run. In IPython; this is the line number within the cell not the overall notebook
This answer doesn't explicitly mention it, but inspect.getsource(foo) returns the source in a single string instead of a tuple where tuple[0] is a list of the lines. getsource will be more useful if you need to peek in the repl
it doesn't work with e.g. the function len. Where can I find the source code for the len function?
or inspect.getsourcelines(foo)
@oaklander113 inspect.getsource doesn't work with built-ins like most of the functions from the standard library. You can check the source code for cpython at their website or their Github
A
André C. Andersen

The inspect module has methods for retrieving source code from python objects. Seemingly it only works if the source is located in a file though. If you had that I guess you wouldn't need to get the source from the object.

The following tests inspect.getsource(foo) using Python 3.6:

import inspect

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

source_foo = inspect.getsource(foo)  # foo is normal function
print(source_foo)

source_max = inspect.getsource(max)  # max is a built-in function
print(source_max)

This first prints:

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

Then fails on inspect.getsource(max) with the following error:

TypeError: <built-in function max> is not a module, class, method, function, traceback, frame, or code object

Yes, it seems to work only for objects defined in a file. Not for those defined in interpreter.
to my surprise, it works in Ipython/Jupyter notebooks also
I tried using inspect in a python 3.5.3 interpreter. import inspect + inspect.getsource(foo) worked fine.
@AndréChristofferAndersen Yeah but it shouldn't work for functions defined in the interpreter
+1 but it is useful if answers provide more information that just a link to the documentation. @AndréC.Andersen's comment contains the actual answer.
p
prashanth

Just use foo?? or ??foo.

If you are using IPython, then you need to type foo?? or ??foo to see the complete source code. To see only the docstring in the function, use foo? or ?foo. This works in Jupyter notebook as well.

In [19]: foo??
Signature: foo(arg1, arg2)
Source:
def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

File:      ~/Desktop/<ipython-input-18-3174e3126506>
Type:      function

Very helpful in IPython and Jupyter notebook if/when you accidentally delete more than one cell that contains functions you've just spent the day creating and testing....
To whom, who lost the whole class: you can restore it method by method: dir(MyClass), then MyClass.__init__?? and so on.
@Valerij could youplease elaborate more?
s
schlamar

dis is your friend if the source code is not available:

>>> import dis
>>> def foo(arg1,arg2):
...     #do something with args
...     a = arg1 + arg2
...     return a
...
>>> dis.dis(foo)
  3           0 LOAD_FAST                0 (arg1)
              3 LOAD_FAST                1 (arg2)
              6 BINARY_ADD
              7 STORE_FAST               2 (a)

  4          10 LOAD_FAST                2 (a)
             13 RETURN_VALUE

Throws a TypeError for builtins.
@Noumenon because they have usually no source code in Python, they are written in C
M
Mike McKerns

While I'd generally agree that inspect is a good answer, I'd disagree that you can't get the source code of objects defined in the interpreter. If you use dill.source.getsource from dill, you can get the source of functions and lambdas, even if they are defined interactively. It also can get the code for from bound or unbound class methods and functions defined in curries... however, you might not be able to compile that code without the enclosing object's code.

>>> from dill.source import getsource
>>> 
>>> def add(x,y):
...   return x+y
... 
>>> squared = lambda x:x**2
>>> 
>>> print getsource(add)
def add(x,y):
  return x+y

>>> print getsource(squared)
squared = lambda x:x**2

>>> 
>>> class Foo(object):
...   def bar(self, x):
...     return x*x+x
... 
>>> f = Foo()
>>> 
>>> print getsource(f.bar)
def bar(self, x):
    return x*x+x

>>> 

@Ant6n: well, that's just being sneaky. dill.source.getsource inspects the interpreter's history for functions, classes, lambdas, etc -- it doesn't inspect the content of strings passed to exec.
This seems very interesting. Is it possible to use dill to answer this question: stackoverflow.com/questions/13827543/…
@ArtOfWarfare: partially, yes. dill.source has functions like getname and importable and getsource that focus on getting the source code (or an importable that yields the object) for any given object. For simple things like an int there is no source, so it doesn't work as expected (i.e. for 'a = 10' it returns '10').
This does work for globals however: >>> a = 10; print( [key for key, val in globals().items() if val is a][0] )
@MikeMcKerns: I've done my best to answer that question without using dill, but my answer leaves a bit to be desired (IE, if you have multiple names for the same value, it can't figure out which was used. If you pass in an expression, it can't say what that expression was. Heck, if you pass in an expression that evaluates to the same as a name, it'll give that name instead.) Can dill solve any of those shortcomings of my answer here: stackoverflow.com/a/28634996/901641
T
TomDotTom

To expand on runeh's answer:

>>> def foo(a):
...    x = 2
...    return x + a

>>> import inspect

>>> inspect.getsource(foo)
u'def foo(a):\n    x = 2\n    return x + a\n'

print inspect.getsource(foo)
def foo(a):
   x = 2
   return x + a

EDIT: As pointed out by @0sh this example works using ipython but not plain python. It should be fine in both, however, when importing code from source files.


This won't work, since the interpreter would compile foo to bytecode and throw away the source code, raising an OSError if you try running getsource(foo).
@0sh good point as far as the vanilla python interpreter is concerned. However the above code example works when using IPython.
s
smarie

Since this post is marked as the duplicate of this other post, I answer here for the "lambda" case, although the OP is not about lambdas.

So, for lambda functions that are not defined in their own lines: in addition to marko.ristin's answer, you may wish to use mini-lambda or use SymPy as suggested in this answer.

mini-lambda is lighter and supports any kind of operation, but works only for a single variable

SymPy is heavier but much more equipped with mathematical/calculus operations. In particular it can simplify your expressions. It also supports several variables in the same expression.

Here is how you can do it using mini-lambda:

from mini_lambda import x, is_mini_lambda_expr
import inspect

def get_source_code_str(f):
    if is_mini_lambda_expr(f):
        return f.to_string()
    else:
        return inspect.getsource(f)

# test it

def foo(arg1, arg2):
    # do something with args
    a = arg1 + arg2
    return a

print(get_source_code_str(foo))
print(get_source_code_str(x ** 2))

It correctly yields

def foo(arg1, arg2):
    # do something with args
    a = arg1 + arg2
    return a

x ** 2

See mini-lambda documentation for details. I'm the author by the way ;)


S
Szabolcs

You can use inspect module to get full source code for that. You have to use getsource() method for that from the inspect module. For example:

import inspect

def get_my_code():
    x = "abcd"
    return x

print(inspect.getsource(get_my_code))

You can check it out more options on the below link. retrieve your python code


d
douardo

to summarize :

import inspect
print( "".join(inspect.getsourcelines(foo)[0]))

m
marko.ristin

Please mind that the accepted answers work only if the lambda is given on a separate line. If you pass it in as an argument to a function and would like to retrieve the code of the lambda as object, the problem gets a bit tricky since inspect will give you the whole line.

For example, consider a file test.py:

import inspect

def main():
    x, f = 3, lambda a: a + 1
    print(inspect.getsource(f))

if __name__ == "__main__":
    main()

Executing it gives you (mind the indention!):

    x, f = 3, lambda a: a + 1

To retrieve the source code of the lambda, your best bet, in my opinion, is to re-parse the whole source file (by using f.__code__.co_filename) and match the lambda AST node by the line number and its context.

We had to do precisely that in our design-by-contract library icontract since we had to parse the lambda functions we pass in as arguments to decorators. It is too much code to paste here, so have a look at the implementation of this function.


c
cherplunk

If you're strictly defining the function yourself and it's a relatively short definition, a solution without dependencies would be to define the function in a string and assign the eval() of the expression to your function.

E.g.

funcstring = 'lambda x: x> 5'
func = eval(funcstring)

then optionally to attach the original code to the function:

func.source = funcstring

The use of eval() strikes me as being really, REALLY bad, unless you're writing some kind of interactive Python interpreter. Eval opens up drastic security problems. If you adopt a policy of only eval'ing string literals, you still lose out on a variety of helpful behavior, ranging from syntax highlighting to proper reflection of classes which contain eval'ed members.
Upvoting. @mehaase: security is obviously not an issue here. Your other comments though are quite relevant, though I'd say lack of syntax highlighting is a combination of the fault of the IDE and the fact that python is not a homoiconic language.
@ninjagecko Security is always an issue when you're giving advice to the general public. Most readers are coming here because they are googling questions. I don't think many people are going to copy this answer verbatim; instead, they are going to take the concept they learned and apply it to their own problem.
@MarkE.Haase you're right that security is always an issue to be mindful of, but there are definitely valid use-cases for eval (or it wouldn't be in the spec). The attrs library uses eval to build customized dunder methods for classes. Not eval-ing user input solves the vast majority of relevant security concerns. Still, not something to trifle with.
m
mtoor

Rafał Dowgird's answer states:

I believe that if the function is compiled from a string, stream or imported from a compiled file, then you cannot retrieve its source code.

However, it is possible to retrieve the source code of a function compiled from a string, provided that the compiling code also added an entry to the linecache.cache dict:

import linecache
import inspect

script = '''
def add_nums(a, b):
    return a + b
'''

bytecode = compile(script, 'unique_filename', 'exec')
tmp = {}
eval(bytecode, {}, tmp)
add_nums = tmp["add_nums"]

linecache.cache['unique_filename'] = (
    len(script),
    None,
    script.splitlines(True),
    'unique_filename',
)

print(inspect.getsource(add_nums))

# prints:
# """
# def add_nums(a, b):
#    return a + b
# """

This is how the attrs library creates various methods for classes automatically, given a set of attributes that the class expects to be initialized with. See their source code here. As the source explains, this is a feature primarily intended to enable debuggers such as PDB to step through the code.


A
Abgan

I believe that variable names aren't stored in pyc/pyd/pyo files, so you can not retrieve the exact code lines if you don't have source files.