python中變量命名規范有哪些

這篇文章給大家介紹python中變量命名規范有哪些，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

1、使用有意義而且可讀的變量名

差

ymdstr = datetime.date.today().strftime("%y-%m-%d")

鬼知道 ymd 是什么？

好

current_date: str = datetime.date.today().strftime("%y-%m-%d")

看到 current_date，一眼就懂。

2、同類型的變量使用相同的詞匯

差 這三個函數都是和用戶相關的信息，卻使用了三個名字

get_user_info()
get_client_data()
get_customer_record()

好 如果實體相同，你應該統一名字

get_user_info()
get_user_data()
get_user_record()

極好 因為 Python 是一門面向對象的語言，用一個類來實現更加合理，分別用實例屬性、property 方法和實例方法來表示。

class User:
  info : str

  @property
  def data(self) -> dict:
    # ...

  def get_record(self) -> Union[Record, None]:
    # ...

3、使用可搜索的名字

大部分時間你都是在讀代碼而不是寫代碼，所以我們寫的代碼可讀且可被搜索尤為重要，一個沒有名字的變量無法幫助我們理解程序，也傷害了讀者，記住：確保可搜索。

差

time.sleep(86400);

What the fuck， 上帝也不知道86400是個什么概念

好

# 在全局命名空間聲明變量，一天有多少秒
SECONDS_IN_A_DAY = 60 * 60 * 24

time.sleep(SECONDS_IN_A_DAY)

清晰多了。

4、使用可自我描述的變量

差

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)

save_city_zip_code(matches[1], matches[2])

matches[1] 沒有自我解釋自己是誰的作用

一般

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)

city, zip_code = matches.groups()
save_city_zip_code(city, zip_code）

你應該看懂了， matches.groups() 自動解包成兩個變量，分別是 city，zip_code

好

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(?P<city>.+?)\s*(?P<zip_code>\d{5})?$'
matches = re.match(city_zip_code_regex, address)

save_city_zip_code(matches['city'], matches['zip_code'])

5、 不要強迫讀者猜測變量的意義，明了勝于晦澀

差

seq = ('Austin', 'New York', 'San Francisco')

for item in seq:
  do_stuff()
  do_some_other_stuff()
  # ...
  # Wait, what's `item` for again?
  dispatch(item)

seq 是什么？序列？什么序列呢？沒人知道，只能繼續往下看才知道。

好

locations = ('Austin', 'New York', 'San Francisco')

for location in locations:
  do_stuff()
  do_some_other_stuff()
  # ...
  dispatch(location)

用 locations 表示，一看就知道這是幾個地區組成的元組

6、不要添加無謂的上下文

如果你的類名已經可以告訴了你什么，就不要在重復對變量名進行描述

差

class Car:
  car_make: str
  car_model: str
  car_color: str

感覺畫蛇添足，如無必要，勿增實體。

好

class Car:
  make: str
  model: str
  color: str

7、使用默認參數代替短路運算和條件運算

差

def create_micro_brewery(name):
  name = "Hipster Brew Co." if name is None else name
  slug = hashlib.sha1(name.encode()).hexdigest()
  # etc.

好

def create_micro_brewery(name: str = "Hipster Brew Co."):
  slug = hashlib.sha1(name.encode()).hexdigest()
  # etc.

關于python中變量命名規范有哪些就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。