Python 中函式、類、常量和變數的命名約定

Vaibhav Vaibhav 2023年1月30日 2022年5月17日
  1. Python 中函式的命名約定
  2. Python 類的命名約定
  3. Python 中常量的命名約定
  4. Python 中變數的命名約定
Python 中函式、類、常量和變數的命名約定

PEP 8 或 Python Enhancement Proposal 8 是編寫 Python 程式碼的指南和最佳實踐指南。這些指南旨在提高 Python 程式碼庫的可讀性、理解力和一致性。由於 PEP 8 有一個標準並且主要在行業和專業人士中使用,因此初學者最好堅持使用它,因為幾乎所有的 Python 程式碼庫都使用它,並且在新新增的程式碼中使用它可以促進向後相容編碼。

PEP 8 還討論了用於在 Python 中命名變數、函式、常量和類的命名約定。本文將討論這些約定以及一些相關示例。

Python 中函式的命名約定

PEP 8 建議使用由下劃線分隔的小寫單詞來命名函式。例如,hello_worldcomputer_sciencesend_mail_to_userget_updates_from_userdelete_all_users 等。

def hello_world:
    pass

def computer_science:
    pass

def send_mail_to_user:
    pass

def get_updates_from_user:
    pass

def delete_all_users:
    pass

Python 類的命名約定

PEP 8 建議使用 Upper Camel Case 或 Pascal Case 來命名類。例如,PersonHelloWorldHumanPythonIsFunMyCustomClass 等。

class Person:
    pass

class HelloWorld:
    pass

class Human:
    pass

class PythonIsFun:
    pass

class MyCustomClass:
    pass

Python 中常量的命名約定

PEP 8 建議使用下劃線分隔的大寫單詞來命名常量。例如,HELLO_WORLDCOMPUTER_SCIENCENUMBER_OF_USERSEMAIL_LIMITEMAIL_USERNAME 等。

HELLO_WORLD = "A string"
COMPUTER_SCIENCE = "A subject"
NUMBER_OF_USERS = 450
EMAIL_LIMIT = 100
EMAIL_USERNAME = "vaibhav"

Python 中變數的命名約定

PEP 8 建議使用由下劃線分隔的小寫單詞來命名變數。例如,hello_worldcomputer_sciencenumber_of_usersemail_limitemail_username 等。

hello_world = "A string"
computer_science = "A subject"
number_of_users = 450
email_limit = 100
email_username = "vaibhav"
Vaibhav Vaibhav avatar Vaibhav Vaibhav avatar

Vaibhav is an artificial intelligence and cloud computing stan. He likes to build end-to-end full-stack web and mobile applications. Besides computer science and technology, he loves playing cricket and badminton, going on bike rides, and doodling.

LinkedIn GitHub