python基礎知識之 代碼規範,千萬不要小瞧它,要認真學哦~!

来源:https://www.cnblogs.com/jnjnj/archive/2022/05/07/16230768.html
-Advertisement-
Play Games

Python代碼規範 代碼規範這東西也是很重要的,一定要註意 給你舉個例子: 你代碼全部寫對了,但是你的代碼規範沒弄好,找個半天,不知道錯哪了,那感覺,簡直不要太崩潰 好啦,下麵我們開始學習吧~ 一、簡明概述 1、編碼 如無特殊情況, 文件一律使用 UTF-8 編碼如無特殊情況, 文件頭部必須加入 ...


Python代碼規範

代碼規範這東西也是很重要的,一定要註意

給你舉個例子:

你代碼全部寫對了,但是你的代碼規範沒弄好,找個半天,不知道錯哪了,那感覺,簡直不要太崩潰

好啦,下麵我們開始學習吧~

一、簡明概述

1、編碼

如無特殊情況, 文件一律使用 UTF-8 編碼
如無特殊情況, 文件頭部必須加入 #--coding:utf-8-- 標識

2、代碼格式

2.1、縮進

統一使用 4 個空格進行縮進

2.2、行寬

每行代碼儘量不超過 80 個字元(在特殊情況下可以略微超過 80 ,但最長不得超過 120)

理由:

  • 這在查看 side-by-side 的 diff 時很有幫助
  • 方便在控制臺下查看代碼
  • 太長可能是設計有缺陷

2.3、引號

簡單說,自然語言使用雙引號,機器標示使用單引號,因此 代碼里 多數應該使用 單引號

  • 自然語言 使用雙引號 "..."
    例如錯誤信息;很多情況還是 unicode,使用 u"你好世界"
  • 機器標識 使用單引號 '...'
    例如 dict 里的 key
  • 正則表達式 使用原生的雙引號 r"..."
  • 文檔字元串 (docstring) 使用三個雙引號 """......"""

2.4、空行

  • 模塊級函數和類定義之間空兩行;
  • 類成員函數之間空一行;
class A:
   def __init__(self):
pass
   def hello(self):
pass
def main():
   pass  

  

  • 可以使用多個空行分隔多組相關的函數
  • 函數中可以使用空行分隔出邏輯相關的代碼

3、import 語句

  • import 語句應該分行書寫
# 正確的寫法
import os
import sys
# 不推薦的寫法 import sys,os
# 正確的寫法 from subprocess import Popen, PIPE

  

  • import語句應該使用 absolute import
# 正確的寫法
from foo.bar import Bar
# 不推薦的寫法 from ..bar import Bar

  

  • import語句應該放在文件頭部,置於模塊說明及docstring之後,於全局變數之前;
  • import語句應該按照順序排列,每組之間用一個空行分隔
import os
import sys
import msgpack
import zmq
import foo

  

  • 導入其他模塊的類定義時,可以使用相對導入
from myclass import MyClass

  

  • 如果發生命名衝突,則可使用命名空間
import bar
import foo.bar
bar.Bar()
foo.bar.Bar()

  

4、空格

在二元運算符兩邊各空一格 [=,-,+=,==,>,in,is not, and] :

# 正確的寫法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# 不推薦的寫法
i=i+1
submitted +=1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

  

函數的參數列表中, , 之後要有空格

# 正確的寫法
def complex(real, imag):
   pass
# 不推薦的寫法 def complex(real,imag): pass

  

函數的參數列表中,預設值等號兩邊不要添加空格

# 正確的寫法
def complex(real, imag=0.0):
   pass
# 不推薦的寫法 def complex(real, imag = 0.0): pass

  

左括弧之後,右括弧之前不要加多餘的空格

# 正確的寫法
spam(ham[1], {eggs: 2})
# 不推薦的寫法 spam( ham[1], { eggs : 2 } )

  

字典對象的左括弧之前不要多餘的空格

# 正確的寫法
dict['key'] = list[index]

# 不推薦的寫法
dict ['key'] = list [index]

  

不要為對齊賦值語句而使用的額外空格

# 正確的寫法
x = 1
y = 2
long_variable = 3
# 不推薦的寫法 x = 1 y = 2 long_variable = 3

  

5、換行

Python 支持括弧內的換行。這時有兩種情況。

  1. 第二行縮進到括弧的起始處
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

  

  1. 第二行縮進 4 個空格,適用於起始括弧就換行的情形
def long_function_name(
       var_one, var_two, var_three,
       var_four):
   print(var_one)

  

  1. 使用反斜杠 \ 換行,二元運算符 + . 等應出現在行末;長字元串也可以用此法換行
session.query(MyTable).\
       filter_by(id=1).\
       one()
print 'Hello, '\
     '%s %s!' %\
     ('Harry', 'Potter')

  

  1. 禁止複合語句,即一行中包含多個語句:
# 正確的寫法
do_first()
do_second()
do_third()
# 不推薦的寫法 do_first();do_second();do_third();

  

  1. if/for/while 一定要換行:
# 正確的寫法
if foo == 'blah':
   do_blah_thing()
# 不推薦的寫法 if foo == 'blah': do_blash_thing()

  

6、docstring

docstring 的規範中最其本的兩點:

  1. 所有的公共模塊、函數、類、方法,都應該寫 docstring 。私有方法不一定需要,但應該在 def 後
    提供一個塊註釋來說明。
  2. docstring 的結束"""應該獨占一行,除非此 docstring 只有一行。
"""Return a foobar
Optional plotz says to frobnicate the bizbaz first.
"""
"""Oneline docstring"""

  

二、註釋

1、註釋

1.1、塊註釋

“#”號後空一格,段落件用空行分開(同樣需要“#”號)

# 塊註釋
# 塊註釋
#
# 塊註釋
# 塊註釋

  

1.2、行註釋

至少使用兩個空格和語句分開,註意不要使用無意義的註釋

# 正確的寫法
x = x + 1 # 邊框加粗一個像素
# 不推薦的寫法(無意義的註釋) x = x + 1 # x加1

  

1.3、建議

在代碼的關鍵部分(或比較複雜的地方), 能寫註釋的要儘量寫註釋
比較重要的註釋段, 使用多個等號隔開, 可以更加醒目, 突出重要性

app = create_app(name, options)
# =====================================
# 請勿在此處添加 get post等app路由行為 !!!
# =====================================
if __name__ == '__main__':
   app.run()

  

2、文檔註釋(Docstring)

作為文檔的Docstring一般出現在模塊頭部、函數和類的頭部,這樣在python中可以通過對象的doc對象
獲取文檔. 編輯器和IDE也可以根據Docstring給出自動提示.

  • 文檔註釋以 """ 開頭和結尾, 首行不換行, 如有多行, 末行必需換行, 以下是Google的docstring風格 示例
# -*- coding: utf-8 -*-
"""Example docstrings.
This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.
Example:
   Examples can be given using either the ``Example`` or ``Examples``
   sections. Sections support any reStructuredText formatting, including
   literal blocks::
       $ python example_google.py
Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""

  

  • 不要在文檔註釋複製函數定義原型, 而是具體描述其具體內容, 解釋具體參數和返回值等
# 不推薦的寫法(不要寫函數原型等廢話)
def function(a, b):
   """function(a, b) -> list"""
   ... ...
# 正確的寫法
def function(a, b):
   """計算並返回a到b範圍內數據的平均值"""
   ... ...

  

  • 對函數參數、返回值等的說明採用numpy標準, 如下所示
def func(arg1, arg2):
   """在這裡寫函數的一句話總結(如: 計算平均值).
   這裡是具體描述.
   參數
   ----------
   arg1 : int
       arg1的具體描述
   arg2 : int
       arg2的具體描述
   返回值
   -------
   int
       返回值的具體描述
   參看
   --------
   otherfunc : 其它關聯函數等...
   示例
   --------
   示例使用doctest格式, 在`>>>`後的代碼可以被文檔測試工具作為測試用例自動運行
   >>> a=[1,2,3]
   >>> print [x + 3 for x in a]
   [4, 5, 6]
   """

  

  • 文檔註釋不限於中英文, 但不要中英文混用
  • 文檔註釋不是越長越好, 通常一兩句話能把情況說清楚即可
  • 模塊、公有類、公有方法, 能寫文檔註釋的, 應該儘量寫文檔註釋

三、命名規範

1、模塊

  • 模塊儘量使用小寫命名,首字母保持小寫,儘量不要用下劃線(除非多個單詞,且數量不多的情況)
# 正確的模塊名
import decoder
import html_parser
# 不推薦的模塊名 import Decoder

  

2、類名

  • 類名使用駝峰(CamelCase)命名風格,首字母大寫,私有類可用一個下劃線開頭
class Farm():
   pass
class AnimalFarm(Farm):
   pass
class _PrivateFarm(Farm):
   pass

  

  • 將相關的類和頂級函數放在同一個模塊里. 不像Java, 沒必要限制一個類一個模塊.

3、函數

  • 函數名一律小寫,如有多個單詞,用下劃線隔開
def run():
   pass
def run_with_env():
   pass

  

  • 私有函數在函數前加一個下劃線_
class Person():
   def _private_func():
       pass

  

4、變數名

  • 變數名儘量小寫, 如有多個單詞,用下劃線隔開
if __name__ == '__main__':
   count = 0
   school_name = ''

  

  • 常量採用全大寫,如有多個單詞,使用下劃線隔開
MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

  

5、常量

  • 常量使用以下劃線分隔的大寫命名
MAX_OVERFLOW = 100
Class FooBar:
   def foo_bar(self, print_):
       print(print_)

我們的這篇文章就到這裡啦~對你有幫助的話記得推薦一下它,好讓更多的人看到它哦 ,
也可以在下方留言評論,你學到了啥,或者遇到了什麼問題,希望我下期更新啥,都可以說的哈~

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

-Advertisement-
Play Games
更多相關文章
  • 寫在前面,本文主要介紹Python基礎排序和自定義排序的一些規則,如果都比較熟悉,可以直接翻到第三節,看下實際的筆試面試題中關於自定義排序的應用。 一、基礎排序 排序是比較基礎的演算法,與很多語言一樣,Python也提供了對列表的排序方法和內建排序函數。 1、兩種排序方式 方式一: li = [1, ...
  • 第一個Python程式 每個編程語言的學習,第一個程式都是先向世界問好,Python 也不例外,這節我們先寫下第一個Python 程式 —— Hello World 。 一、Python 簡介 Python 是著名的“龜叔” Guido van Rossum 在 1989 年聖誕節期間,為了打發無聊 ...
  • Spring Ioc源碼分析系列--Ioc源碼入口分析 本系列文章代碼基於Spring Framework 5.2.x 前言 上一篇文章Spring Ioc源碼分析系列--Ioc的基礎知識準備介紹了Ioc的基礎概念以及Spring Ioc體系的部分基礎知識。那麼這一篇就會真正通過一個例子,啟動Ioc ...
  • 前言 有時候我們些代碼是總發此疑惑? 為什麼別人採集 xx 網站的時候能成功,而我卻總是不返回給數據 出現這種原因時往往是我們沒有給夠偽裝, 被識別了出來~ 就像人,你出門肯定是要穿衣服的對不,如果你不穿! 走在外面,肯定是最顯眼的一個,不抓你抓誰 還有一種就是明明我之前運行成功了,為什麼我現在再次 ...
  • 用python的pandas庫進行數據分析,分析對象是老番茄B站數據。 pandas常用基礎數據分析代碼。 ...
  • 給開源項目尤其是Spring這種知名度高的項目貢獻代碼是比較難的,起碼胖哥是這麼認為的。有些時候我們的靈感未必契合作者的設計意圖,即使你的代碼十分優雅。 我曾經給Spring Security提交了一個我認為非常重要的一項優化,和作者溝通了幾十個來回無法說服他。人家說留了抽象介面,你覺得不對自己實現 ...
  • 作者:CadeCode 地址:https://juejin.cn/post/7043403364020781064 斷言 斷言是一個邏輯判斷,用於檢查不應該發生的情況 Assert 關鍵字在 JDK1.4 中引入,可通過 JVM 參數-enableassertions開啟 SpringBoot 中提 ...
  • Python 是一種極其多樣化和強大的編程語言!當需要解決一個問題時,它有著不同的方法。在本文中,將會展示列表解析式 (List Comprehension)。我們將討論如何使用它?什麼時候該或不該使用它? 列表解析式的優勢 •比迴圈更節省時間和空間。 •需要更少的代碼行。 •可將迭代語句轉換為公式 ...
一周排行
    -Advertisement-
    Play Games
  • 前言 本文將以 C# 語言來實現一個簡單的布隆過濾器,為簡化說明,設計得很簡單,僅供學習使用。 感謝@時總百忙之中的指導。 布隆過濾器簡介 布隆過濾器(Bloom filter)是一種特殊的 Hash Table,能夠以較小的存儲空間較快地判斷出數據是否存在。常用於允許一定誤判率的數據過濾及防止緩存 ...
  • 目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 「簡單有價值的事情長期堅持做」 這是成功最簡單,但也最難學的秘訣。不經過訓練,人很難意識到時間複利的威力。 仙劍奇俠傳的「十里坡劍神」和金庸群俠傳的「十級野球拳」,就是簡單的事情持之以恆反覆做,最後就有巨大的威力 唐家三少成為網文收入第一,最重要的一步是十四年從未斷日更 這樣的案例很多,一開始可能成 ...
  • 迎面走來了你的面試官,身穿格子衫,挺著啤酒肚,髮際線嚴重後移的中年男子。 手拿泡著枸杞的保溫杯,胳膊夾著MacBook,MacBook上還貼著公司標語:“我愛加班”。 面試開始,直入正題。 面試官: 看你簡歷上面寫著精通MySQL,我先問你事務的特性是什麼? 老生常談,這個還有誰不會背的嗎? 我: ...
  • 基礎知識 python是一門腳本語言,它是解釋執行的。 python使用縮進做為語法,而且python2環境下同一個py文件中不能同時存在tab和空格縮進,否則會出錯,建議在IDE中顯示縮進符。 python在聲明變數時不寫數據類型,可以type(xx)來獲取欄位的類型,然後可以int(),list ...
  • 為什麼要多線程下載 俗話說要以終為始,那麼我們首先要明確多線程下載的目標是什麼,不外乎是為了更快的下載文件。那麼問題來了,多線程下載文件相比於單線程是不是更快? 對於這個問題可以看下圖。 橫坐標是線程數,縱坐標是使用對應線程數下載對應文件時花費的時間,藍橙綠代表下載文件的大小,每個線程下載對應文件2 ...
  • 詳細講解python爬蟲代碼,爬微博搜索結果的博文數據。 爬取欄位: 頁碼、微博id、微博bid、微博作者、發佈時間、微博內容、轉發數、評論數、點贊數。 爬蟲技術: 1、requests 發送請求 2、datetime 時間格式轉換 3、jsonpath 快速解析json數據 4、re 正則表達式提... ...
  • 背景: 一般我們可以用HashMap做本地緩存,但是HashMap功能比較弱,不支持Key過期,不支持數據範圍查找等。故在此實現了一個簡易的本地緩存,取名叫fastmap。 功能: 1.支持數據過期 2.支持等值查找 3.支持範圍查找 4.支持key排序 實現思路: 1.等值查找採用HashMap2 ...
  • 目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 本章是系列文章的第八章,用著色演算法進行寄存器的分配過程。 本文中的所有內容來自學習DCC888的學習筆記或者自己理解的整理,如需轉載請註明出處。周榮華@燧原科技 寄存器分配 寄存器分配是為程式處理的值找到存儲位置的問題 這些值可以存放到寄存器,也可以存放在記憶體中 寄存器更快,但數量有限 記憶體很多,但 ...