Fungsi Bantuan Python

Perkenalan

Pada artikel ini, saya akan menjelaskan fungsi bantuan di python, bagaimana kita dapat menggunakannya dan kesalahan umum. Jadi mari kita mulai.

Apa Itu Fungsi Bantuan Dan Kegunaannya

Ini digunakan untuk melihat dokumentasi berbagai fungsi, modul, kelas python, dll. Berikut ini contohnya-

def square(num):
    '''
        this function is used to calculate the square of the number
    '''
    
    return num * num
help(square)

Keluaran:

Help on function square in module __main__:
square(num)
    this function is used to calculate the square of the number

Catatan: Dokumentasi fungsi, kelas, atau apa pun diapit oleh tiga tanda kutip tunggal.

Baris pertama keluaran menunjukkan fungsi (dan nama modul) yang memanggil fungsi bantuan. Baris ketiga dimulai dengan nama fungsi dan parameternya, sedangkan baris ke-4 berisi dokumentasi sebenarnya.

Kesalahan Umum

def return_2_function():
    return 2
    
help(return_2_function())

Perhatikan perbedaan cuplikan kode di atas dan sebelumnya, disini saya telah melewatkan fungsinya dengan tanda kurung. Python akan menjalankan fungsi kuadrat dan kemudian meneruskan hasilnya ke fungsi bantuan. Hal ini akan menyebabkan ekstraksi dokumentasi hasil tersebut, bukan fungsi itu sendiri.

Keluaran:

Help on int object:
class int(object)
 |  int([x]) -> integer
 |  int(x, base=10) -> integer
 |
 |  Convert a number or string to an integer, or return 0 if no arguments
 |  are given.  If x is a number, return x.__int__().  For floating point
 |  numbers, this truncates towards zero.
 |
 |  If x is not a number or if base is given, then x must be a string,
 |  bytes, or bytearray instance representing an integer literal in the
 |  given base.  The literal can be preceded by '+' or '-' and be surrounded
 |  by whitespace.  The base defaults to 10.  Valid bases are 0 and 2-36.
 |  Base 0 means to interpret the base from the string as an integer literal.

Catatan : Saya telah mempersingkat keluaran di atas karena sudah lama berhenti.

Kesimpulan:

Ringkasnya, fungsi bantuan adalah fungsi bawaan yang dapat mengekstrak dokumentasi apa pun yang diteruskan ke sana dan jangan lupakan kesalahan itu. Dengan itu, Anda siap menggunakan fungsi bantuan di python.