Google實踐中總結的Python規範,get了嗎?

来源:https://www.cnblogs.com/xxpythonxx/archive/2019/05/17/10883509.html
-Advertisement-
Play Games

好的代碼風格,給人舒服的感覺,今天介紹一下谷歌的Python風格規範 1 分號 不要在行尾加分號, 也不要用分號將兩條命令放在同一行。 2 行長度 每行不超過80個字元;不要使用反斜杠連接行。Python會將圓括弧、中括弧和花括弧的行隱式的連接起來,可以利用這個特點。如果需要,可以在表達式外圍增加一 ...


好的代碼風格,給人舒服的感覺,今天介紹一下谷歌的Python風格規範

1 分號

不要在行尾加分號, 也不要用分號將兩條命令放在同一行。

2 行長度

每行不超過80個字元;不要使用反斜杠連接行。Python會將圓括弧、中括弧和花括弧的行隱式的連接起來,可以利用這個特點。如果需要,可以在表達式外圍增加一堆額外的圓括弧。

3 括弧

寧缺毋濫得使用括弧。除非是用於實現行連接,否則不要在返回語句或條件語句中使用括弧。不過在元組兩遍使用括弧是可以的。

4 縮進

用四個空格來縮進代碼。絕對不要用tab,也不要tab和空格混用。對於行連接的情況,應該垂直對其換行的元素,或者使用4空格的懸掛式縮進:

5 空行

頂級定義(比如函數或者類定義)之間空兩行,方法定義之間空一行。

6 空格

按照標準的排版規範來使用標點兩邊的空格。

括弧內不要有空格。

不要在逗號,分號,冒號前面加空格,但應該在它們後面加(除了在行尾)。

參數列表, 索引或切片的左括弧前不應加空格。

在二元操作符兩邊都加上一個空格, 比如賦值(=), 比較(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布爾(and, or, not)。至於算術操作符兩邊的空格該如何使用, 需要你自己好好判斷。不過兩側務必要保持一致。

當’=’用於指示關鍵字參數或預設參數值時, 不要在其兩側使用空格。

不要用空格來垂直對齊多行間的標記, 因為這會成為維護的負擔(適用於:, #, =等):

7 Shebang

大部分.py文件不必以#!作為文件的開始. 根據 PEP-394, 程式的main文件應該以 #!/usr/bin/python2或者 #!/usr/bin/python3開始。在電腦科學中,Shebang(也稱為 Hashbang )是一個由井號和嘆號構成的字元序列 #! ,其出現在文本文件的第一行的前兩個字元。在文件中存在 Shebang 的情況下,類 Unix 操作系統的程式載入器會分析 Shebang 後的內容,將這些內容作為解釋器指令,並調用該指令,並將載有 Shebang 的文件路徑作為該解釋器的參數。

8 註釋

確保對模塊, 函數, 方法和行內註釋使用正確的風格。

文檔字元串

Python有一種獨一無二的的註釋方式:使用文檔字元串。文檔字元串是包, 模塊, 類或函數里的第一個語句。這些字元串可以通過對象的doc成員被自動提取,並且被pydoc所用。我們對文檔字元串的慣例是使用三重雙引號。一個文檔字元串應該這樣組織:首先是一行以句號、問號或驚嘆號結尾的概述(或者該文檔字元串單純只有一行)、 接著是一個空行, 接著是文檔字元串剩下的部分,它應該與文檔字元串的第一行的第一個引號對齊。下麵有更多文檔字元串的格式化規範。

模塊

每個文件應該包含一個許可樣板。根據項目使用的許可(例如:Apache 2.0,,BSD,LGPL, GPL), 選擇合適的樣板。

函數和方法

一個函數必須要有文檔字元串, 除非它滿足以下條件:

文檔字元串應該包含函數做什麼,以及輸入和輸出的詳細描述。通常, 不應該描述”怎麼做”,除非是一些複雜的演算法。文檔字元串應該提供足夠的信息, 當別人編寫代碼調用該函數時,他不需要看一行代碼,只要看文檔字元串就可以了。對於複雜的代碼, 在代碼旁邊加註釋會比使用文檔字元串更有意義。

類應該在其定義下有一個用於描述該類的文檔字元串。如果你的類有公共屬性(Attributes),那麼文檔中應該有一個屬性(Attributes)段。並且應該遵守和函數參數相同的格式。

塊註釋和行註釋

最需要寫註釋的是代碼中那些技巧性的部分。如果你在下次 代碼審查的時候必須解釋一下,那麼你應該現在就給它寫註釋。對於複雜的操作, 應該在其操作開始前寫上若幹行註釋。對於不是一目瞭然的代碼,應在其行尾添加註釋。

9 類

如果一個類不繼承自其它類, 就顯式的從object繼承. 嵌套類也一樣。繼承自 object 是為了使屬性(properties)正常工作, 並且這樣可以保護你的代碼, 使其不受 PEP-3000的一個特殊的潛在不相容性影響。這樣做也定義了一些特殊的方法, 這些方法實現了對象的預設語義, 包括 __new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__ 。


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

-Advertisement-
Play Games
更多相關文章
  • hibernate介紹 hibernate是一個開源的輕量級的框架, hibernate框架應用在javaee三層結構中的dao層框架,在dao層對資料庫進行crud操作,使用hibernate框架實現crud操作; hibernate底層就是jdbc,hibernate對jdbc進行了封裝;使用h ...
  • Recently, I was made a service which can provide a simple way to get best model. so, i spent lot of time to read source code of auto-sklearn, auto-skl ...
  • 1、JAVA 語言如何進行異常處理,關鍵字:throws,throw,try,catch,finally分別代表什麼意義?在try 塊中可以拋出異常嗎? 答:Java 通過面向對象的方法進行異常處理,把各種不同的異常進行分類,並提供了良好的介面。在Java 中,每個異常都是一個對象,它是Throwa ...
  • 第1題:動態載入又對及時性要求很高怎麼處理? 如何知道一個網站是動態載入的數據? 用火狐或者谷歌瀏覽器 打開你網頁,右鍵查看頁面源代碼,ctrl +F 查詢輸入內容,源代碼裡面並沒有這個值,說明是動態載入數據。 1. Selenium+Phantomjs 2. 儘量不使用 sleep 而使用 Web ...
  • 斐波那契數列、(引用float(‘inf’)無窮大的特性來比對,從而提取數組中的最小值)float(“inf”)正無窮大 float(“-inf”)負無窮大 ...
  • 本隨筆旨在強化理解傳值與傳引用 如下代碼的運行結果 其中i沒有改變,s也沒有改變。 但model中的值均改變了。 i :100s :hellomodel :testchangemodel2 :changeModel i :100s :hellomodel :testchangemodel2 :cha ...
  • 有時候maven真的很坑! 有時候提示invalid LOC header (bad signat signature), 但又有時候什麼都不提示,工程報錯,情況有肯多中,不知道大家遇到過幾種詭異的. ...
  • 之前寫了一個版本的,不過代碼繁瑣而且不好用,效率有些問題。尤其pdf轉圖片速度太慢。下麵是優化版本的代碼。 spriing_boot 版本信息:2.0.1.RELEASE 1、配置信息: application.yml 2、轉換入口 pdf 轉圖片參考 https://gitee.com/cycmy ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...