{"id":6081,"date":"2020-05-28T12:31:59","date_gmt":"2020-05-28T12:31:59","guid":{"rendered":"https:\/\/www.askpython.com\/?p=6081"},"modified":"2022-08-06T13:28:47","modified_gmt":"2022-08-06T13:28:47","slug":"python-help-method","status":"publish","type":"post","link":"https:\/\/www.askpython.com\/python\/built-in-methods\/python-help-method","title":{"rendered":"Python help() method"},"content":{"rendered":"\n

Hey, folks! In this article, we will be focusing on a important explanatory function in Python — Python help() function<\/strong>.<\/p>\n\n\n\n

\n\n\n\n

Need of the help() method<\/h2>\n\n\n\n

While coding in a particular programming language, it is very essential for us to know the basic documentation of the framed language. This is when the help() function comes into picture. <\/p>\n\n\n\n

This function provides us with the basic documentation of Python <\/a>language. It gives us the information about the methods and instances associated with a particular method or class.<\/p>\n\n\n\n

The help() method works with keywords, Classes, functions and modules to help us gain the basic terminologies, instances and working attached with it respectively.<\/p>\n\n\n\n

Usually the help() method<\/code> is used alongside the Python interpreter<\/strong> to gain access to the underlying details about Python objects passed to it as a parameter.<\/p>\n\n\n\n

\n\n\n\n

Working of Python help() method<\/h2>\n\n\n\n

As mentioned above, the help() method provides information about the Python objects passed to it.<\/p>\n\n\n\n

If the help() function<\/code> is mentioned without any parameter, it starts the interpreter console wherein we can mention any module<\/strong>, objects<\/strong>, class<\/strong>, etc to avail the documentation<\/em><\/strong> about the same.<\/p>\n\n\n\n

Example :<\/strong><\/p>\n\n\n

\nhelp()\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
help() function<\/strong><\/figcaption><\/figure><\/div>\n\n\n\n
\n\n\n\n
Python help() function with a Class<\/h3>\n\n\n\n
The help function can be feeded with customized or pre-defined parameters to work with. We can create a customized class and pass it to the help() function to examine the documentation provided by the function.<\/p>\n\n\n\n
Example:<\/strong><\/p>\n\n\n
\nclass Info:\n    lang = "Python"\n    name = "JournalDev"\nobj = Info()\nhelp(Info)\n<\/pre><\/div>\n\n\n
We have created an user-defined class and passed it to the help() function. The help() function has returned the necessary documentation of the class ‘Info’.<\/p>\n\n\n\n
Output:<\/strong><\/p>\n\n\n
\nHelp on class Info in module __main__:\n\nclass Info(builtins.object)\n |  Data descriptors defined here:\n |  \n |  __dict__\n |      dictionary for instance variables (if defined)\n |  \n |  __weakref__\n |      list of weak references to the object (if defined)\n |  \n |  ----------------------------------------------------------------------\n |  Data and other attributes defined here:\n |  \n |  lang = 'Python'\n |  \n |  name = 'JournalDev'\n<\/pre><\/div>\n\n\n
\n\n\n\n
Python help() function with a function<\/h3>\n\n\n\n
The help() function helps us to access the syntax, parameter list and the description about any function passed to it using the below command.<\/p>\n\n\n\n
Syntax:<\/strong><\/p>\n\n\n
\nhelp('function-name')\n<\/pre><\/div>\n\n\n
Example 1:<\/strong><\/p>\n\n\n
\nhelp('getattr')\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
help() With Function getattr()<\/strong><\/figcaption><\/figure>\n\n\n\n
Example 2:<\/strong><\/p>\n\n\n
\nhelp('map')\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
help() With Function map()<\/strong><\/figcaption><\/figure><\/div>\n\n\n\n
\n\n\n\n
Python help() function with a module<\/h3>\n\n\n\n
We can gain information about the module using the help() function. When a module is passed to the help() function, it provides the documentation in terms of the version, file location, contents of the module, and data associated with it.<\/p>\n\n\n\n
Syntax:<\/strong><\/p>\n\n\n
\nhelp('module-name')\n<\/pre><\/div>\n\n\n
Example:<\/strong><\/p>\n\n\n
\nhelp('seaborn')\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
Help on Module Seaborn<\/strong><\/figcaption><\/figure><\/div>\n\n\n\n
\n\n\n\n
 The help() function with a keyword<\/h3>\n\n\n\n
On passing a Python keyword as parameter to the help() function, the function returns the documentation in terms of the class of the keyword, the methods associated with it, etc.<\/p>\n\n\n\n
Syntax:<\/strong><\/p>\n\n\n
\nhelp('keyword-name')\n<\/pre><\/div>\n\n\n
Example 1:<\/strong><\/p>\n\n\n
\nhelp(True)\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
help() function With Keyword True<\/strong><\/figcaption><\/figure><\/div>\n\n\n\n
Example 2:<\/strong><\/p>\n\n\n
\nhelp(int)\n<\/pre><\/div>\n\n\n
Output:<\/strong><\/p>\n\n\n\n
\"Python
help() Function With Keyword int<\/strong><\/figcaption><\/figure><\/div>\n\n\n\n
\n\n\n\n
Conclusion<\/h2>\n\n\n\n
By this we have come to the end of this topic. We have understood the need and working of the help() function. I hope this concept is clear to all the readers. <\/p>\n\n\n\n
Please feel free to comment, in case you happen to come across any doubt.<\/p>\n\n\n\n
\n\n\n\n
References<\/h2>\n\n\n\n