Master Python’s help() Utility: Quick Guide to Accessing Docs and Exiting

What is help()?

The help() function is a built‑in Python utility that displays the documentation string of modules, classes, functions, or objects. It provides detailed information about usage, parameters, and examples directly in the interpreter.

Syntax and Parameters

Typical syntax: help([object]) object – the module, class, function, or any object whose documentation you want to view. If omitted, help() starts an interactive help session.

Return Value

The function prints the help text to the console and returns None. The displayed information includes the object's description, its methods, attributes, and usage examples.

Basic Usage Examples

>>help('sys')          # Show documentation for the sys module
>>>help('str')          # Show documentation for the str type
>>>a = [1, 2, 3]
>>>help(a)              # Show help for a list object
>>>help(a.append)       # Show help for the list.append method

You can also request help for built‑in functions directly:

>>help(sum)
Help on built-in function sum in module builtins:
sum(iterable, start=0, /)
    Return the sum of a 'start' value (default: 0) plus an iterable of numbers.
    When the iterable is empty, return the start value.
    This function is intended specifically for use with numeric values and may reject non‑numeric types.

Interactive Help Session

Start an interactive session by typing help() at the Python prompt:

>>help()
Welcome to Python 3.6's help utility!
Type "help", "keywords", "modules", "topics", or the name of any module to get more information.
To quit, type "quit" or press the <strong>q</strong> key followed by Enter.

Browsing Modules

Enter modules to list all available modules. You can filter the list, e.g., modules sets shows modules whose name or summary contains "sets".

Example output includes entries such as:

PIL.JpegPresets – JPEG quality settings equivalent to Photoshop.

django.core.management.color – Sets up the terminal color scheme.

django.db.models.sql.query – Create SQL statements for QuerySets.

pandas._libs.tslibs.offsets – Offset utilities for pandas.

Listing Keywords and Topics

Use keywords to see all Python keywords and topics for a list of help topics. The following screenshots illustrate the prompts:

Exiting Help

To leave the help utility, simply press the q key and then Enter . This returns you to the normal Python interpreter prompt.

Quick Recap

Start Python interpreter (e.g., python).

Enter help() for an interactive session.

Use modules, keywords, or topics to explore available documentation.

Query a specific object with help(object).

Press q to quit the help mode.