Is it possible to read Doc Strings of a Python file w/o using python shell?

Question

I was wondering if there is any way we can read doc strings present in a python file from command line, prior to importing it, or w/o using any Ipython or Python kernel, just like 'man' command does.

Since Python comes with this functionality built-in, why would you want to use another tool for this? Any other tool would be duplicating this functionality & so why would it be worthwhile installing another tool vs just using Python? — Gerrat
– Gerrat, Commented Aug 5, 2017 at 14:19
But Python requires you to manually import file, then only we can read it. If there is any work around which does not require you to fire python shell? — Adarsh Maurya
– Adarsh Maurya, Commented Aug 5, 2017 at 14:31

Gerrat · Accepted Answer · 2017-08-05 14:40:51Z

1

You can execute some python code from the command line, so given a module named my_module.py, and a function named my_function, the following:

python -c "from my_module import my_function;print my_function.__doc__"

will print out the docstring

answered Aug 5, 2017 at 14:40

Gerrat

29.9k9 gold badges78 silver badges104 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Is it possible to read Doc Strings of a Python file w/o using python shell?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related