Daftar Referensi Python

help() adalah fungsi bawaan untuk menampilkan dokumentasi interaktif tentang fungsi, class, module, keyword, atau objek Python.

Sintaks

help(objek)

Parameter

Parameter Wajib? Keterangan
objek Tidak Objek yang dokumentasinya ingin dilihat. Bisa juga string nama topik, misalnya "for"

Nilai balik: None. Dokumentasi ditampilkan ke layar, bukan dikembalikan sebagai string. Tanpa argumen, help() membuka sistem bantuan interaktif di console.

Contoh

import contextlib
import io

def luas(sisi):
    """Menghitung luas persegi."""
    return sisi * sisi

buffer = io.StringIO()
with contextlib.redirect_stdout(buffer):
    help(luas)

teks = buffer.getvalue()
print("luas" in teks)
print("Menghitung luas persegi." in teks)

Coba di IDE

Output:

True
True

Pada pemakaian biasa, cukup tulis help(luas). Contoh di atas menangkap output agar hasilnya dapat diperiksa secara ringkas.

Contoh Lainnya

Dokumentasi fungsi bawaan

import contextlib
import io

buffer = io.StringIO()
with contextlib.redirect_stdout(buffer):
    help(len)

teks = buffer.getvalue()
print("len" in teks)
print(len(teks) > 50)

Coba di IDE

Output:

True
True

Mencari bantuan berdasarkan nama topik

import contextlib
import io

buffer = io.StringIO()
with contextlib.redirect_stdout(buffer):
    help("for")

teks = buffer.getvalue()
print("for" in teks.lower())
print(len(teks) > 100)

Coba di IDE

Output:

True
True

Kesalahan Umum

  • help() menampilkan dokumentasi, tetapi nilai baliknya None. Karena itu, print(help(len)) akan mencetak dokumentasi lalu baris None.
  • Tulis help(len) untuk objek yang sudah dikenal Python. Gunakan string seperti help("for") untuk keyword atau topik dokumentasi.
  • Output bantuan dapat berbeda antarversi Python karena berasal dari dokumentasi objek yang terpasang.
  • Tanpa argumen, help() menunggu perintah interaktif. Gunakan quit untuk keluar di console biasa.

Pelajari Lebih Lanjut

← id()dir() →