Python學習筆記

公眾號搜索--樹莓派OpenCV學舍

Python的小波浪_書寫規范

在Python的IDE中經常會出現一些波浪線，還帶不同顏色的。雖然看著別扭，但對于初學者的我來說也算一種善意的提醒--提示格式不正確或者語法錯誤。對于擁有強迫癥的我來說，必須在此記一筆。同時也是規范自己代碼的書寫規范，有百利而無一害。

代碼編排
1 縮進。4個空格的縮進(編輯器都可以完成此功能)，不要使用Tab，更不能混合使用Tab和空格。Tab 在不同的操作系統平臺、不同的應用里縮進的空格數是不同的，為了在便于共同維護，不建議使用Tab來縮進代碼
2 每行最大長度79，換行可以使用反斜杠，最好使用圓括號。換行點要在操作符的后邊敲回車。
3 類和top-level函數定義之間空兩行；類中的方法定義之間空一行；函數內邏輯無關段落之間空一行；其他地方盡量不要再空行。

文檔編排
1 模塊內容的順序：模塊說明和docstring—import—globals&constants—其他定義。其中import部分，又按標準、三方和自己編寫順序依次排放，之間空一行。
2 不要在一句import中多個庫，比如import os, sys不推薦。
3 如果采用from XX import XX引用庫，可以省略‘module.’，都是可能出現命名沖突，這時就要采用import XX。

空格的使用??? 總體原則，避免不必要的空格。
1 各種右括號前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函數的左括號前不要加空格。如Func(1)。
4 序列的左括號前不要加空格。如list[2]。
5 操作符左右各加一個空格，不要為了對齊增加空格。
6 函數默認參數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行，盡管使用‘；’允許。
8 if/for/while語句中，即使執行語句只有一句，也必須另起一行。

注釋??? 總體原則，錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時，第一件事就是要修改注釋！注釋必須使用英文，最好是完整的句子，首字母大寫，句后要有結束符，結束符后跟兩個空格，開始下一句。如果是短語，可以省略結束符。雖然python3中支持中文，但不推薦。
1 塊注釋，在一段代碼前增加的注釋。在‘#’后加一空格。段落之間以只有‘#’的行間隔。

2 行注釋，在一句代碼后加注釋。比如：x = x + 1 # Increment x
但是這種方式盡量少使用。
3 避免無謂的注釋。

文檔描述??? 為所有的共有模塊、函數、類、方法寫docstrings；非共有的沒有必要，但是可以寫注釋(在def的下一行)。命名規范??? 總體原則，新編代碼必須按下面命名風格進行，現有庫的編碼盡量保持風格。
1 盡量單獨使用小寫字母‘l’，大寫字母‘O’等容易混淆的字母。
2 模塊命名盡量短小，使用全部小寫的方式，可以使用下劃線。
3 包命名盡量短小，使用全部小寫的方式，不可以使用下劃線。
4 類的命名使用CapWords的方式，模塊內部使用的類采用_CapWords的方式。
5 異常命名使用CapWords+Error后綴的方式。
6 全局變量盡量只在模塊內有效，類似C語言中的static。實現方法有兩種，一是__all__機制;二是前綴一個下劃線。
7 函數命名使用全部小寫的方式，可以使用下劃線。
8 常量命名使用全部大寫的方式，可以使用下劃線。
9 類的屬性(方法和變量)命名使用全部小寫的方式，可以使用下劃線。10 類的屬性有3種作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public屬性前，前綴一條下劃線。
11 類的屬性若與關鍵字名字沖突，后綴一下劃線，盡量不要使用縮略等其他方式。
12 為避免與子類屬性命名沖突，在類的一些屬性前，前綴兩條下劃線。比如：類Foo中聲明__a,訪問時，只能通過Foo._Foo__a，避免歧義。如果子類也叫Foo，那就無能為力了。
13 類的方法第一個參數必須是self，而靜態方法第一個參數必須是cls。

編碼建議
1 編碼中考慮到其他python實現的效率等問題，比如運算符‘+’在CPython(Python)中效率很高，但是Jython中卻非常低，所以應該采用.join()的方式。
2 盡可能使用‘is’‘is not’取代‘==’，比如if x is not None 要優于if x。
3 使用基于類的異常，每個模塊或包都有自己的異常類，此異常類繼承自Exception。
4 異常中不要使用裸露的except，except后跟具體的exceptions。
5 異常中try的代碼盡可能少。

6 使用startswith() and endswith()代替切片進行序列前綴或后綴的檢查。例如：

if foo.startswith(‘bar’):優于 if foo[:3] == ‘bar’:
7 使用isinstance()比較對象的類型。比如
if isinstance(obj, int): 優于 if type(obj) is type(1):
8 判斷序列空或不空，有如下規則
if not seq:
if seq:
優于
if len(seq)
not len(seq)
9 字符串不要以空格收尾。
10 二進制數據判斷使用 if boolvalue的方式。

Python開頭注釋

#!/usr/bin/env python

# -*- coding:utf-8 -*-

# Author:XXX?

1.?#!/usr/bin/env python 與?#!/usr/bin/python 的區別

這些注釋并不僅僅是寫給讀者看的注釋，它也寫給操作系統看的，這些注釋決定了系統將如何運行這些文件。linux自帶python解釋器。在編寫.py文件時，只要寫上了#!/usr/bin/python這行注釋，用戶就可以直接在命令行用文件名來執行py文件，例如：testmode.py它的意義就類似于在window命令行中，你必須得寫python testmode.py來運行文件，你要通過文件名前面的關鍵字才能去啟動對應的解釋器。而有了這行注釋，Linux系統就知道了你要用什么來執行這個文件，你就可以直接用文件名去跑它了。

#!/usr/bin/python?注釋的問題在于，Linux只系統默認的py解釋器(也就是自帶的那個)來運行文件。這樣用戶就無法使用自己的python版本了，不同的py版本之間語法有些差異，尤其是變動比較大的py2和py3，這些差異會使得整個程序無法正常運行。而#!/usr/bin/env python 的出現可以讓用戶自行選擇python版本，用戶可以在環境變量中配置自己的py解釋器(ps：用戶安裝的版本默認定位在linux的local文件夾中)。#!/usr/bin/env python?這行注釋，會使linux在解析文件時，知道要去使用環境變量中的py解釋器而非系統自帶的那個。所以如果你要使用該注釋，推薦使用#!/usr/bin/env python?的注釋，而非?#!/usr/bin/python。?

如果是在windows環境中執行文件的話，這行注釋就無所謂了，因為你在cmd中，需要先定位到你py文件所在的文件夾后，再使用 python testmode.py?這樣的語句來執行文件。window系統也不會去看這行注釋.

2.# -*- coding:utf-8 -*-

? ?它的作用：在Linux下指定文件的編碼方式,用于支持中文。

? ?python2需要在首行寫-*- coding:utf-8 -*-才能支持中文，python3開始默認支持中文了，就可以省去這行注釋。

3.所以如果是在windows的Python3下運行你的程序，你完全可以不去寫前兩行注釋的，但是出于好習慣，也為了方便跨平臺以及兼容，寫一寫還是好的。

4.如何在pyCharm中設置文件默認的開頭的注釋格式。如下：

　　1.view中勾選Toolbar 工具條,點擊設置,也可使用ctrl+alt+S進入

　　2.選擇editor下的file and code templates, 在右側file中選擇python script ,右側輸入注釋

　　

總結

以上是生活随笔為你收集整理的ide 波浪线_零基础学习Python_小波浪的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。