Apakah python menggunakan casing unta?

Penamaan Gaya

Tabel di bawah menguraikan beberapa gaya penamaan umum dalam kode Python dan kapan Anda harus menggunakannya

Ketik Konvensi PenamaanContohFungsiGunakan kata atau kata dengan huruf kecil. Pisahkan kata dengan garis bawah untuk meningkatkan keterbacaan.

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

Ini adalah beberapa konvensi penamaan umum dan contoh cara menggunakannya. Namun untuk menulis kode yang dapat dibaca, Anda tetap harus berhati-hati dengan pilihan huruf dan kata. Selain memilih gaya penamaan yang benar dalam kode Anda, Anda juga harus memilih nama dengan hati-hati. Di bawah ini adalah beberapa petunjuk tentang cara melakukan ini seefektif mungkin

Cara Memilih Nama

Memilih nama untuk variabel, fungsi, kelas, dan sebagainya dapat menjadi tantangan. Anda harus cukup memikirkan pilihan penamaan Anda saat menulis kode karena itu akan membuat kode Anda lebih mudah dibaca. Cara terbaik untuk menamai objek Anda dengan Python adalah dengan menggunakan nama deskriptif untuk memperjelas objek yang diwakilinya

Saat memberi nama variabel, Anda mungkin tergoda untuk memilih nama huruf kecil satu huruf yang sederhana, seperti

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

>>>

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Ini akan berhasil, tetapi Anda harus melacak apa yang

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

from mypkg import example1, \
    example2, example3

from mypkg import example1, \
    example2, example3

>>>

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Demikian pula, untuk mengurangi jumlah pengetikan yang Anda lakukan, Anda mungkin tergoda untuk menggunakan singkatan saat memilih nama. Dalam contoh di bawah ini, saya telah mendefinisikan fungsi

from mypkg import example1, \
    example2, example3

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

# Not recommended
def db(x):
    return x * 2

Sepintas, ini mungkin tampak seperti pilihan yang masuk akal.

from mypkg import example1, \
    example2, example3

Contoh berikut jauh lebih jelas. Jika Anda kembali ke kode ini beberapa hari setelah menulisnya, Anda masih dapat membaca dan memahami tujuan dari fungsi ini

# Recommended
def multiply_by_two(x):
    return x * 2

Filosofi yang sama berlaku untuk semua tipe data dan objek lainnya di Python. Selalu coba gunakan nama yang paling ringkas namun deskriptif

Garis Kosong

Spasi kosong vertikal, atau baris kosong, dapat sangat meningkatkan keterbacaan kode Anda. Kode yang digabungkan menjadi satu dapat membuat Anda kewalahan dan sulit dibaca. Demikian pula, terlalu banyak baris kosong dalam kode Anda membuatnya terlihat sangat jarang, dan pembaca mungkin perlu menggulir lebih dari yang diperlukan. Di bawah ini adalah tiga panduan utama tentang cara menggunakan spasi vertikal

Kelilingi fungsi dan kelas tingkat atas dengan dua baris kosong. Fungsi dan kelas tingkat atas harus cukup mandiri dan menangani fungsionalitas terpisah. Masuk akal untuk menempatkan ruang vertikal tambahan di sekitar mereka, sehingga jelas mereka terpisah

class MyFirstClass:
    pass


class MySecondClass:
    pass


def top_level_function():
    return None

Mengelilingi definisi metode di dalam kelas dengan satu baris kosong. Di dalam kelas, semua fungsi terkait satu sama lain. Merupakan praktik yang baik untuk hanya menyisakan satu baris di antara mereka

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

Gunakan baris kosong dengan hemat di dalam fungsi untuk menunjukkan langkah-langkah yang jelas. Terkadang, fungsi yang rumit harus menyelesaikan beberapa langkah sebelum pernyataan

from mypkg import example1, \
    example2, example3

Pada contoh di bawah ini, terdapat sebuah fungsi untuk menghitung varian dari suatu daftar. Ini adalah masalah dua langkah, jadi saya telah menunjukkan setiap langkah dengan meninggalkan baris kosong di antaranya. Ada juga baris kosong sebelum pernyataan

from mypkg import example1, \
    example2, example3

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

Jika Anda menggunakan spasi vertikal dengan hati-hati, ini dapat sangat meningkatkan keterbacaan kode Anda. Ini membantu pembaca memahami secara visual bagaimana kode Anda dibagi menjadi beberapa bagian, dan bagaimana bagian tersebut berhubungan satu sama lain

Panjang Garis Maksimum dan Pemutusan Garis

PEP 8 menyarankan baris harus dibatasi hingga 79 karakter. Ini karena ini memungkinkan Anda untuk membuka banyak file di samping satu sama lain, sekaligus menghindari pembungkusan baris

Tentu saja, mempertahankan pernyataan hingga 79 karakter atau kurang tidak selalu memungkinkan. PEP 8 menguraikan cara untuk mengizinkan pernyataan berjalan di beberapa baris

Python akan mengasumsikan kelanjutan baris jika kode berada di dalam tanda kurung, tanda kurung, atau tanda kurung

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

Jika tidak mungkin menggunakan kelanjutan tersirat, maka Anda dapat menggunakan garis miring terbalik untuk memutus garis

from mypkg import example1, \
    example2, example3

Namun, jika Anda dapat menggunakan kelanjutan tersirat, maka Anda harus melakukannya

Jika pemutusan garis harus terjadi di sekitar operator biner, seperti

from mypkg import example1, \
    example2, example3

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Di bawah ini adalah contoh pemecahan sebelum operator biner

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Anda dapat langsung melihat variabel mana yang ditambahkan atau dikurangi, karena operator berada tepat di sebelah variabel yang sedang dioperasikan

Sekarang, mari kita lihat contoh pemecahan setelah operator biner

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Di sini, lebih sulit untuk melihat variabel mana yang ditambahkan dan mana yang dikurangi

Melanggar sebelum operator biner menghasilkan kode yang lebih mudah dibaca, jadi PEP 8 mendorongnya. Kode yang secara konsisten rusak setelah operator biner masih mematuhi PEP 8. Namun, Anda dianjurkan untuk istirahat sebelum operator biner

Tab vs. Spasi

Seperti disebutkan di atas, Anda harus menggunakan spasi alih-alih tab saat membuat indentasi kode. Anda dapat menyesuaikan pengaturan di editor teks Anda untuk menampilkan 4 spasi alih-alih karakter tab, saat Anda menekan tombol Tab .

Jika Anda menggunakan Python 2 dan telah menggunakan campuran tab dan spasi untuk memasukkan kode Anda, Anda tidak akan melihat kesalahan saat mencoba menjalankannya. Untuk membantu Anda memeriksa konsistensi, Anda dapat menambahkan bendera

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Sebaliknya, jika Anda menggunakan flag

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Python 3 tidak mengizinkan pencampuran tab dan spasi. Oleh karena itu, jika Anda menggunakan Python 3, kesalahan ini dikeluarkan secara otomatis

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Anda dapat menulis kode Python dengan tab atau spasi yang menunjukkan lekukan. Tapi, jika Anda menggunakan Python 3, Anda harus konsisten dengan pilihan Anda. Jika tidak, kode Anda tidak akan berjalan. PEP 8 menganjurkan agar Anda selalu menggunakan 4 spasi berurutan untuk menunjukkan lekukan

Lekukan Mengikuti Jeda Baris

Saat Anda menggunakan kelanjutan baris untuk mempertahankan baris di bawah 79 karakter, sebaiknya gunakan lekukan untuk meningkatkan keterbacaan. Ini memungkinkan pembaca untuk membedakan antara dua baris kode dan satu baris kode yang mencakup dua baris. Ada dua gaya lekukan yang dapat Anda gunakan

Yang pertama adalah menyelaraskan blok yang terindentasi dengan pembatas pembuka

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

Kadang-kadang Anda dapat menemukan bahwa hanya diperlukan 4 spasi untuk menyelaraskan dengan pembatas pembuka. Ini akan sering terjadi pada pernyataan

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Dalam hal ini, PEP 8 menyediakan dua alternatif untuk membantu meningkatkan keterbacaan

• Tambahkan komentar setelah kondisi terakhir. Karena penyorotan sintaks di sebagian besar editor, ini akan memisahkan kondisi dari kode bersarang

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _8

• Tambahkan lekukan ekstra pada sambungan baris

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _9

Gaya indentasi alternatif setelah jeda baris adalah indentasi gantung. Ini adalah istilah tipografi yang berarti bahwa setiap baris kecuali yang pertama dalam paragraf atau pernyataan diindentasi. Anda dapat menggunakan indentasi gantung untuk merepresentasikan kelanjutan baris kode secara visual. Ini sebuah contoh

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Catatan. Saat Anda menggunakan indentasi gantung, tidak boleh ada argumen apa pun di baris pertama. Contoh berikut tidak sesuai dengan PEP 8

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Saat menggunakan indentasi gantung, tambahkan indentasi ekstra untuk membedakan baris lanjutan dari kode yang terdapat di dalam fungsi. Contoh berikut sulit dibaca karena kode di dalam fungsi berada pada level indentasi yang sama dengan baris lanjutan

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Sebaliknya, lebih baik menggunakan indentasi ganda pada kelanjutan garis. Ini membantu Anda membedakan antara argumen fungsi dan badan fungsi, meningkatkan keterbacaan

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Saat Anda menulis kode yang sesuai dengan PEP 8, batas baris 79 karakter memaksa Anda untuk menambahkan jeda baris dalam kode Anda. Untuk meningkatkan keterbacaan, Anda harus mengindentasi baris bersambung untuk menunjukkan bahwa itu adalah baris bersambung. Ada dua cara untuk melakukan hal ini. Yang pertama adalah menyelaraskan blok yang terindentasi dengan pembatas pembuka. Yang kedua adalah menggunakan indentasi gantung. Anda bebas memilih metode indentasi mana yang Anda gunakan setelah jeda baris

Tempat Menempatkan Penjepit Penutup

Kelanjutan garis memungkinkan Anda untuk memutus garis di dalam tanda kurung, tanda kurung, atau tanda kurung. Sangat mudah untuk melupakan kurung kurawal penutup, tetapi penting untuk meletakkannya di tempat yang masuk akal. Kalau tidak, itu bisa membingungkan pembaca. PEP 8 menyediakan dua opsi untuk posisi penjepit penutup dalam kelanjutan garis tersirat

• Sejajarkan kurung kurawal penutup dengan karakter bukan spasi pertama dari baris sebelumnya

  >>> # Recommended
  >>> name = 'John Smith'
  >>> first_name, last_name = name.split()
  >>> print(last_name, first_name, sep=', ')
  'Smith, John'
  

  4

• Sejajarkan kurung kurawal penutup dengan karakter pertama dari baris yang memulai konstruk

  >>> # Recommended
  >>> name = 'John Smith'
  >>> first_name, last_name = name.split()
  >>> print(last_name, first_name, sep=', ')
  'Smith, John'
  

  5

Anda bebas memilih opsi mana yang Anda gunakan. Namun, seperti biasa, konsistensi adalah kuncinya, jadi cobalah untuk tetap menggunakan salah satu metode di atas

Blokir Komentar

Gunakan komentar blokir untuk mendokumentasikan sebagian kecil kode. Mereka berguna saat Anda harus menulis beberapa baris kode untuk melakukan satu tindakan, seperti mengimpor data dari file atau memperbarui entri database. Mereka penting karena membantu orang lain memahami tujuan dan fungsi dari blok kode yang diberikan

PEP 8 memberikan aturan berikut untuk menulis komentar blok

• Inden blok komentar ke tingkat yang sama dengan kode yang dijelaskan
• Mulailah setiap baris dengan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _09 diikuti dengan satu spasi
• Pisahkan paragraf dengan baris yang berisi satu

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  09

Berikut adalah komentar blok yang menjelaskan fungsi dari

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Terkadang, jika kodenya sangat teknis, maka perlu menggunakan lebih dari satu paragraf dalam komentar blok

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Jika Anda pernah ragu dengan jenis komentar apa yang cocok, maka blokir komentar sering kali merupakan cara yang tepat. Gunakan mereka sebanyak mungkin di seluruh kode Anda, tetapi pastikan untuk memperbaruinya jika Anda membuat perubahan pada kode Anda

Komentar Sebaris

Komentar sebaris menjelaskan satu pernyataan dalam sepotong kode. Mereka berguna untuk mengingatkan Anda, atau menjelaskan kepada orang lain, mengapa baris kode tertentu diperlukan. Inilah yang dikatakan PEP 8 tentang mereka

• Gunakan komentar sebaris dengan hemat
• Tulis komentar sebaris pada baris yang sama dengan pernyataan yang mereka rujuk
• Pisahkan komentar sebaris dengan dua spasi atau lebih dari pernyataan
• Mulai komentar sebaris dengan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _09 dan satu spasi, seperti komentar blokir
• Jangan menggunakannya untuk menjelaskan yang sudah jelas

Di bawah ini adalah contoh komentar sebaris

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Terkadang, komentar sebaris tampaknya diperlukan, tetapi Anda dapat menggunakan konvensi penamaan yang lebih baik. Ini sebuah contoh

>>> # Recommended
>>> name = 'John Smith'
>>> first_name, last_name = name.split()
>>> print(last_name, first_name, sep=', ')
'Smith, John'

Di sini, komentar sebaris memberikan informasi tambahan. Namun menggunakan

def calculate_variance(number_list):
    sum_list = 0
    for number in number_list:
        sum_list = sum_list + number
    mean = sum_list / len(number_list)

    sum_squares = 0
    for number in number_list:
        sum_squares = sum_squares + number**2
    mean_squares = sum_squares / len(number_list)

    return mean_squares - mean**2

# Not recommended
def db(x):
    return x * 2

Akhirnya, komentar sebaris seperti ini adalah praktik yang buruk karena menyatakan kode yang jelas dan berantakan

# Not recommended
def db(x):
    return x * 2

Komentar sebaris lebih spesifik daripada memblokir komentar, dan mudah untuk menambahkannya saat tidak diperlukan, yang menyebabkan kekacauan. Anda bisa lolos hanya dengan menggunakan komentar blokir jadi, kecuali Anda yakin Anda memerlukan komentar sebaris, kode Anda kemungkinan besar akan sesuai dengan PEP 8 jika Anda tetap memblokir komentar

String Dokumentasi

String dokumentasi, atau , adalah string yang diapit dengan tanda kutip ganda (

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Aturan paling penting yang berlaku untuk docstring adalah sebagai berikut

• Kelilingi dokumen dengan tiga tanda kutip ganda di kedua sisi, seperti pada

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  16

• Tuliskan untuk semua modul publik, fungsi, kelas, dan metode

• Letakkan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _14 yang mengakhiri dokumen multibaris pada satu baris dengan sendirinya

  # Not recommended
  def db(x):
      return x * 2
  

  _2

• Untuk dokumen satu baris, pertahankan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  14 di baris yang sama

  # Not recommended
  def db(x):
      return x * 2
  

  _3

Untuk artikel yang lebih detail tentang mendokumentasikan kode Python, lihat oleh James Mertz

Spasi Putih di Sekitar Operator Biner

Kelilingi operator biner berikut dengan satu spasi di kedua sisinya

• Operator penugasan (

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  19,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  20,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  21, dan seterusnya)

• Perbandingan (

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  22,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  23,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  24,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  25.

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _26,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  27) dan (

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  28,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  29,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  30,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  31)

• Boolean (

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  32,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  33,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  34)

Catatan. Ketika

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

# Not recommended
def db(x):
    return x * 2

Jika ada lebih dari satu operator dalam sebuah pernyataan, menambahkan satu spasi sebelum dan sesudah setiap operator dapat terlihat membingungkan. Sebaliknya, lebih baik hanya menambahkan spasi di sekitar operator dengan prioritas terendah, terutama saat melakukan manipulasi matematis. Berikut adalah beberapa contoh

# Not recommended
def db(x):
    return x * 2

Anda juga dapat menerapkan ini pada pernyataan

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

# Not recommended
def db(x):
    return x * 2

Dalam contoh di atas, operator

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

# Not recommended
def db(x):
    return x * 2

Anda bebas memilih mana yang lebih jelas, dengan peringatan bahwa Anda harus menggunakan jumlah spasi yang sama di kedua sisi operator

Berikut ini tidak dapat diterima

# Not recommended
def db(x):
    return x * 2

Dalam irisan, titik dua bertindak sebagai operator biner. Oleh karena itu, aturan yang diuraikan di bagian sebelumnya berlaku, dan harus ada jumlah spasi yang sama di kedua sisi. Contoh irisan daftar berikut ini valid

# Not recommended
def db(x):
    return x * 2

Singkatnya, Anda harus mengelilingi sebagian besar operator dengan spasi. Namun, ada beberapa peringatan untuk aturan ini, seperti argumen fungsi atau saat Anda menggabungkan beberapa operator dalam satu pernyataan

Kapan Harus Menghindari Menambahkan Spasi Putih

Dalam beberapa kasus, menambahkan spasi dapat membuat kode lebih sulit dibaca. Terlalu banyak spasi dapat membuat kode menjadi terlalu jarang dan sulit untuk diikuti. PEP 8 menguraikan contoh yang sangat jelas di mana spasi putih tidak sesuai

Tempat paling penting untuk menghindari penambahan spasi adalah di akhir baris. Ini dikenal sebagai spasi kosong. Itu tidak terlihat dan dapat menghasilkan kesalahan yang sulit dilacak

Daftar berikut menguraikan beberapa kasus di mana Anda harus menghindari penambahan spasi

• Tepat di dalam tanda kurung, tanda kurung, atau kawat gigi

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  0

• Sebelum koma, titik koma, atau titik dua

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  1

• Sebelum tanda kurung buka yang memulai daftar argumen pemanggilan fungsi

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  2

• Sebelum tanda kurung buka yang memulai indeks atau irisan

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  3

• Antara tanda koma dan tanda kurung tutup

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  4

• Untuk menyelaraskan operator penugasan

  # Recommended
  def multiply_by_two(x):
      return x * 2
  

  5

Pastikan tidak ada spasi kosong di mana pun dalam kode Anda. Ada kasus lain di mana PEP 8 melarang penambahan spasi ekstra, seperti tepat di dalam tanda kurung, serta sebelum koma dan titik dua. Anda juga tidak boleh menambahkan spasi ekstra untuk menyelaraskan operator

Linter

Linter adalah program yang menganalisis kode dan menandai kesalahan. Mereka memberikan saran tentang cara memperbaiki kesalahan. Linter sangat berguna saat diinstal sebagai ekstensi untuk editor teks Anda, karena menandai kesalahan dan masalah gaya saat Anda menulis. Di bagian ini, Anda akan melihat garis besar tentang cara kerja linter, dengan tautan ke ekstensi editor teks di bagian akhir

Linter terbaik untuk kode Python adalah sebagai berikut

• >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _77 adalah alat untuk memeriksa kode Python Anda terhadap beberapa konvensi gaya di PEP 8

  Instal

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _77 menggunakan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  79

  class MyFirstClass:
      pass
  
  
  class MySecondClass:
      pass
  
  
  def top_level_function():
      return None
  

  _8

  Anda dapat menjalankan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _77 dari terminal menggunakan perintah berikut

  class MyFirstClass:
      pass
  
  
  class MySecondClass:
      pass
  
  
  def top_level_function():
      return None
  

  _9

• >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _81 adalah alat yang menggabungkan debugger,

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  82, dengan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  77

  Instal

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _81 menggunakan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  79

  class MyClass:
      def first_method(self):
          return None
  
      def second_method(self):
          return None
  

  0

  Jalankan

  >>> # Not recommended
  >>> x = 'John Smith'
  >>> y, z = x.split()
  >>> print(z, y, sep=', ')
  'Smith, John'
  

  _81 dari terminal menggunakan perintah berikut

  class MyClass:
      def first_method(self):
          return None
  
      def second_method(self):
          return None
  

  _1

  Contoh output juga ditampilkan

Catatan. Baris keluaran tambahan menunjukkan kesalahan sintaksis

Ini juga tersedia sebagai ekstensi untuk Atom, Sublime Text, , dan VIM. Anda juga dapat menemukan panduan tentang menyiapkan Sublime Text dan untuk pengembangan Python, serta ikhtisar beberapa editor teks populer di Real Python

Pemformat otomatis

Pemformat otomatis adalah program yang mengubah kode Anda agar sesuai dengan PEP 8 secara otomatis. Setelah program tersebut adalah

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Instal

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

Itu dapat dijalankan melalui baris perintah, seperti halnya linter. Katakanlah Anda memulai dengan kode berikut yang tidak sesuai dengan PEP 8 dalam sebuah file bernama

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

Anda kemudian dapat menjalankan perintah berikut melalui baris perintah

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

Jika Anda ingin mengubah batas panjang garis, maka Anda dapat menggunakan bendera

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

class MyClass:
    def first_method(self):
        return None

    def second_method(self):
        return None

Dua pemformat otomatis lainnya,

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

>>> # Not recommended
>>> x = 'John Smith'
>>> y, z = x.split()
>>> print(z, y, sep=', ')
'Smith, John'

Tutorial Python Nyata lainnya, Kualitas Kode Python. Alat & Praktik Terbaik oleh Alexander van Tol, memberikan penjelasan menyeluruh tentang cara menggunakan alat ini