Python命名規範

来源:https://www.cnblogs.com/wangzhongqiu/archive/2018/09/19/9677682.html
-Advertisement-
Play Games

文件名全小寫,可使用下劃線 包應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。 模塊與包的規範同。如mymodule。 類總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下劃線。 函數&方法函數名應該為小寫,可以用下劃線風格單詞以增加可讀性。如: ...


文件名
全小寫,可使用下劃線



應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。


模塊
與包的規範同。如mymodule。



總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下劃線。

 

函數&方法
函數名應該為小寫,可以用下劃線風格單詞以增加可讀性。如:myfunction,my_example_function。
*註意*:混合大小寫僅被允許用於這種風格已經占據優勢的時候,以便保持向後相容。


函數和方法的參數
總使用“self”作為實例方法的第一個參數。總使用“cls”作為類方法的第一個參數。
如果一個函數的參數名稱和保留的關鍵字衝突,通常使用一個尾碼下劃線好於使用縮寫或奇怪的拼寫。


全局變數
對於from M import *導入語句,如果想阻止導入模塊內的全局變數可以使用舊有的規範,在全局變數上加一個前導的下劃線。
*註意*:應避免使用全局變數


變數
變數名全部小寫,由下劃線連接各個單詞。如color = WHITE,this_is_a_variable = 1
*註意*:
1.不論是類成員變數還是全局變數,均不使用 m 或 g 首碼。
2.私有類成員使用單一下劃線首碼標識,多定義公開成員,少定義私有成員。
3.變數名不應帶有類型信息,因為Python是動態類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。


常量
常量名所有字母大寫,由下劃線連接各個單詞如MAX_OVERFLOW,TOTAL。


異常
以“Error”作為尾碼。


縮寫
命名應當儘量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫,如XML、ID等,在命名時也應只大寫首字母,如XmlParser。
2.命名中含有長單詞,對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等。
前導尾碼下劃線
一個前導下劃線:表示非公有。
一個尾碼下劃線:避免關鍵字衝突。
兩個前導下劃線:當命名一個類屬性引起名稱衝突時使用。
兩個前導和尾碼下劃線:“魔”(有特殊用圖)對象或者屬性,例如__init__或者__file__。絕對不要創造這樣的名字,而只是使用它們。
*註意*:關於下劃線的使用存在一些爭議。


特定命名方式
主要是指 __xxx__ 形式的系統保留字命名法。項目中也可以使用這種命名,它的意義在於這種形式的變數是只讀的,這種形式的類成員函數儘量不要重載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。


附:Google Python命名規範
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 之前裝好tomcat後正常運行 後來重裝系統後,又一次配置環境時卻報錯。 在網上查找了兩篇文章。 https://blog.csdn.net/haleyliu123/article/details/68953796 https://blog.csdn.net/qq_28688909/article/ ...
  • 電腦處理不同的數據需要定義不同的數據類型。改變數字數據類型的值,意味著要重新分配記憶體空間用來存儲新的數值。 int,整數包含正整數和負整數,32位和64位系統的取值範圍不同。32位系統的取值範圍:-2**31 ~ 2**31-164位系統的取值範圍:-2**63 ~ 2**63-1 long,長整 ...
  • 上篇我們知道了關於python的一個hello world的簡單程式代碼,現在我們來瞭解關於python裡面的變數,我們來瞭解下,變數是什麼? 變數:變數是為了存儲程式運算過程中的一些中間結果,為了方便之後的調用,同一變數可以重新賦值。 變數的特點:具有描述性的標記,存儲在記憶體里。 我們來看個列子, ...
  • 前言 大學期間接觸 Java 的時間也不短了,不論學習還是實習,都讓我發覺基礎的重要性。互聯網發展太快了,各種框架各種技術更新迭代的速度非常快,可能你剛好掌握了一門技術的應用,它卻已經走在淘汰的邊緣了。 而學習新技術總要付出一定的時間成本,那麼怎麼降低時間成本呢?那就是打好基礎,技術再怎麼革新,底層 ...
  • 創建laravel應用 laravel new app_name 使用 PHP 內置 web server 驅動我們的網站 cd xxx/public php -S localhost:port 查看所有可用的 Artisan 命令 php artisan list 激活某些功能 eg:auth系統 ...
  • 題意 題目鏈接 給出一個字元串,每次操作可以使得字元串縮短一位,且第$i$位必須要保證與變換前的這一位或下一位相同, 問使得整個字元串全相同最少的操作次數 Sol 300P的題我都要想10min啊,還是太菜了。。 首先我們可以枚舉一個字母,強行讓他成為最後的答案 對於末尾與它不同的數只能一個個刪掉, ...
  • import requests from requests.exceptions import RequestException import re import json from multiprocessing import Pool def get_one_page(url): headers... ...
  • 異常處理,是編程語言或電腦硬體里的一種機制,用於處理軟體或信息系統中出現的異常狀況(即超出程式正常執行流程的某些特殊條件)。 1.異常的類型 異常的類型多種多樣,常見的異常有: 其他的異常: Exception可以捕獲任意異常 2.捕獲異常,處理異常 只有將對應的異常類型捕獲才能進行異常的處理 異 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...