python安全編碼規范

① 「python編程規范」為Python代碼添加註釋

功能要求

為Python代碼添加註釋，對Python程序代碼進行說明。

實例代碼

'''多行注釋開始

下面的代碼根據變數x的值計算y

注意代碼中使用縮進表示代碼塊

多行注釋結束'''

x = 5

if x > 100:

y = x * 5 - 1 # 單行注釋：x>100時執行該語句

else:

y = 0 # x <= 100時執行該語句

print(y) # 輸出y

運行結果

知識說明

注釋用於為程序添加說明性的文字，幫助程序員更好的閱讀和理解程序代碼。Python解釋器會忽略注釋的內容，即注釋的內容不會被Python解釋器執行。

Python注釋分為單行注釋和多行注釋。

單行注釋以符號「#」開始，當前行中符號「#」及其後的內容為注釋語句。單行注釋可以獨佔一行，也可放在語句末尾。 說明： 在Pycharm中使用「ctrl + /」可以添加/取消單行注釋。

多行注釋是用3個英文單引號「'''多行注釋文本'''」或3個雙引號「"""注釋文本"""」進行注釋。 注意： 由一對三個單引號或一對三個雙引號括起來的內容被認為是注釋，但不能由三個單引號和三個雙引號混合使用。

② 如何規范的編寫python代碼

PEP8 Python 編碼規范
一 代碼編排
1 縮進。4個空格的縮進（編輯器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。
2 每行最大長度79，換行可以使用反斜杠，最好使用圓括弧。換行點要在操作符的後邊敲回車。
3 類和top-level函數定義之間空兩行；類中的方法定義之間空一行；函數內邏輯無關段落之間空一行；其他地方盡量不要再空行。
二 文檔編排
1 模塊內容的順序：模塊說明和docstring—import—globals&constants—其他定義。其中import部分，又按標准、三方和自己編寫順序依次排放，之間空一行。
2 不要在一句import中多個庫，比如import os, sys不推薦。
3 如果採用from XX import XX引用庫，可以省略『mole.』，都是可能出現命名沖突，這時就要採用import XX。
三 空格的使用
總體原則，避免不必要的空格。
1 各種右括弧前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函數的左括弧前不要加空格。如Func(1)。
4 序列的左括弧前不要加空格。如list[2]。
5 操作符左右各加一個空格，不要為了對齊增加空格。
6 函數默認參數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行，盡管使用『；』允許。
8 if/for/while語句中，即使執行語句只有一句，也必須另起一行。

四 注釋
總體原則，錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時，第一件事就是要修改注釋！
注釋必須使用英文，最好是完整的句子，首字母大寫，句後要有結束符，結束符後跟兩個空格，開始下一句。如果是短語，可以省略結束符。
1 塊注釋，在一段代碼前增加的注釋。在『#』後加一空格。段落之間以只有『#』的行間隔。比如：
# Description : Mole config.
#
# Input : None
#
# Output : None

2 行注釋，在一句代碼後加註釋。比如：x = x + 1 # Increment x
但是這種方式盡量少使用。
3 避免無謂的注釋。
五 文檔描述
1 為所有的共有模塊、函數、類、方法寫docstrings；非共有的沒有必要，但是可以寫注釋（在def的下一行）。
2 如果docstring要換行，參考如下例子,詳見PEP 257
"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名規范
總體原則，新編代碼必須按下面命名風格進行，現有庫的編碼盡量保持風格。
1 盡量單獨使用小寫字母『l』，大寫字母『O』等容易混淆的字母。
2 模塊命名盡量短小，使用全部小寫的方式，可以使用下劃線。
3 包命名盡量短小，使用全部小寫的方式，不可以使用下劃線。
4 類的命名使用CapWords的方式，模塊內部使用的類採用_CapWords的方式。
5 異常命名使用CapWords+Error後綴的方式。
6 全局變數盡量只在模塊內有效，類似C語言中的static。實現方法有兩種，一是__all__機制;二是前綴一個下劃線。
7 函數命名使用全部小寫的方式，可以使用下劃線。
8 常量命名使用全部大寫的方式，可以使用下劃線。
9 類的屬性（方法和變數）命名使用全部小寫的方式，可以使用下劃線。
9 類的屬性有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()代替切片進行序列前綴或後綴的檢查。
7 使用isinstance()比較對象的類型。
8 判斷序列空或不空
9 字元串不要以空格收尾。
10 二進制數據判斷使用 if boolvalue的方式。

③ 為了讓代碼更加緊湊，編寫Python程序時應盡量避免加入空格和空行

python 有明確的代碼規范可以遵物循，其中對空行以及空格的使用有明確的要求。按照其要求使用空行及空格即可。
這個規范是對python代碼編寫者通用的，因此，在大家都按此規范編寫代碼時，大家對其它人編寫的代碼更容易閱讀。這也是python提倡的。
所以，對於python來說（或者說對於所有可以自由選擇使用空行與空格的編程語言來說），為了代碼緊湊而盡量不使用空格與空行的做法是不可取的。
請閱讀python之禪：
import this

④ Python基本編碼格式

1、一般來說，聲明編碼格式在腳本中是必需的。2、如果Python源碼文件沒有聲明編碼格式，Python解釋器會默認使用ASCII編碼。但出現非ASCII編碼的字元，Python解釋器就會報錯。

1、Python 採用代碼縮進和冒號（ : ）來區分代碼塊之間的層次。2、在 Python 中，對於類定義、函數定義、流程式控制制語句、異常處理語句等，行尾的冒號和下一行的縮進，表示下一個代碼塊的開始，而縮進的結束則表示此代碼塊的結束。3、Python 中實現對代碼的縮進，可以使用空格或者 Tab 鍵實現。但無論是手動敲空格，還是使用 Tab 鍵，通常情況下都是採用 4 個空格長度作為一個縮進量（默認情況下，一個 Tab 鍵就表示 4 個空格）。4、對於 Python 縮進規則，初學者可以這樣理解，Python 要求屬於同一作用域中的各行代碼，它們的縮進量必須一致，但具體縮進量為多少，並不做硬性規定。

正確示例代碼:

錯誤示例代碼:

Python中使用 # 進行注釋，我們在使用# 的時候，# 號後面要空一格在行內注釋的時候，中間應該至少加兩個空格

print("你好，世界") # 注釋

** 使用的一般性原則：**

1、在二元運算符兩邊各空一格，算術操作符兩邊的空格可靈活使用，但兩側務必要保持一致2、不要在逗號、分號、冒號前面加空格，但應該在它們後面加（除非在行尾）3、函數的參數列表中，逗號之後要有空格4、函數的參數列表中，默認值等號兩邊不要添加空格5、左括弧之後，右括弧之前不要加添加空格6、參數列表， 索引或切片的左括弧前不應加空格

使用的一般性原則：

1、編碼格式聲明、模塊導入、常量和全局變數聲明、頂級定義和執行代碼之間空兩行2、頂級定義之間空兩行，方法定義之間空一行3、在函數或方法內部，可以在必要的地方空一行以增強節奏感，但應避免連續空行

1、導入總應該放在文件頂部，位於模塊注釋和文檔字元串之後，模塊全局變數和常量之前。

2、導入應該按照從最通用到最不通用的順序分組，分組之間空一行：

3、每個 import 語句只導入一個模塊，盡量避免一次導入多個模塊

命名規范這一塊的大家應該都比較熟悉了，但是不同的編程語言之間的明明規范也是有所區別的~

Python命名建議遵循的一般性原則：

引號使用的一般性原則：

Python跟其他幾個主流編程語言的分號使用區別很大Python的代碼末尾不需要加分號，而Java和C#等都需要添加

不要在行尾添加分號，也不要用分號將兩條命令放在同一行，例如：

Python學習日記

⑤ 怎麼在Python里使用UTF-8編碼

概述

在python代碼即.py文件的頭部聲明即可

解析

py文件中的編碼

Python 默認腳本文件都是 ANSCII 編碼的，當文件 中有非 ANSCII 編碼范圍內的字元的時候就要使用"編碼指示"來修正一個 mole 的定義中，如果.py文件中包含中文字元（嚴格的說是含有非anscii字元），則需要在第一行或第二行指定編碼聲明：

# -*- coding=utf-8 -*-

#coding=utf-8

# 以上兩種選其一即可

其他的編碼如：gbk、gb2312也可以；否則會出現:

SyntaxError: Non-ASCII character 'xe4' in file test.py on line 3, but no encoding declared; see http://www.python.org/peps/pep-0263.html for details

python中的編碼與解碼

先說一下python中的字元串類型，在python中有兩種字元串類型，分別是 str 和 unicode，他們都是basestring的派生類；

str類型是一個包含Characters represent (at least) 8-bit bytes的序列；

unicode 的每個 unit 是一個 unicode obj;

在str的文檔中有這樣的一句話：

The string data type is also used to represent arrays of bytes, e.g., to hold data read from a file.

也就是說在讀取一個文件的內容，或者從網路上讀取到內容時，保持的對象為str類型；如果想把一個str轉換成特定編碼類型，需要把str轉為Unicode,然後從unicode轉為特定的編碼類型如：utf-8、gb2312等。

拓展內容

utf-8編碼

UTF-8（8-bit Unicode Transformation Format）是一種針對Unicode的可變長度字元編碼，也是一種前綴碼。它可以用來表示Unicode標准中的任何字元，且其編碼中的第一個位元組仍與ASCII兼容，這使得原來處理ASCII字元的軟體無須或只須做少部分修改，即可繼續使用。因此，它逐漸成為電子郵件、網頁及其他存儲或發送文字的應用中，優先採用的編碼。

UTF-8使用一至六個位元組為每個字元編碼（盡管如此，2003年11月UTF-8被RFC 3629重新規范，只能使用原來Unicode定義的區域，U+0000到U+10FFFF，也就是說最多四個位元組）：

1、128個US-ASCII字元只需一個位元組編碼（Unicode范圍由U+0000至U+007F）。

2、帶有附加符號的拉丁文、希臘文、西里爾字母、亞美尼亞語、希伯來文、阿拉伯文、敘利亞文及它拿字母則需要兩個位元組編碼（Unicode范圍由U+0080至U+07FF）。

3、其他基本多文種平面（BMP）中的字元（這包含了大部分常用字，如大部分的漢字）使用三個位元組編碼（Unicode范圍由U+0800至U+FFFF）。

4、其他極少使用的Unicode輔助平面的字元使用四至六位元組編碼（Unicode范圍由U+10000至U+1FFFFF使用四位元組，Unicode范圍由U+200000至U+3FFFFFF使用五位元組，Unicode范圍由U+4000000至U+7FFFFFFF使用六位元組）。

對上述提及的第四種字元而言，UTF-8使用四至六個位元組來編碼似乎太耗費資源了。但UTF-8對所有常用的字元都可以用三個位元組表示，而且它的另一種選擇，UTF-16編碼，對前述的第四種字元同樣需要四個位元組來編碼，所以要決定UTF-8或UTF-16哪種編碼比較有效率，還要視所使用的字元的分布范圍而定。不過，如果使用一些傳統的壓縮系統，比如DEFLATE，則這些不同編碼系統間的的差異就變得微不足道了。若顧及傳統壓縮演算法在壓縮較短文字上的效果不大，可以考慮使用Unicode標准壓縮格式（SCSU）。

互聯網工程工作小組（IETF）要求所有互聯網協議都必須支持UTF-8編碼。互聯網郵件聯盟（IMC）建議所有電子郵件軟體都支持UTF-8編碼。

⑥ python程序有哪些編碼規范

編碼格式聲明
通常，編碼格式聲明是必需的。如果 python 源碼文件沒有聲明編碼格式，python 解釋器會默認使用 ASCII 編碼，一旦源碼文件包含非ASCII編碼的字元，python 解釋器就會報錯。以 UTF-8 為例，以下兩種編碼格式聲明都是合乎規則的。
縮進
統一使用 4 個空格進行縮進。絕對不要用tab, 也不要tab和空格混用。對於行連接的情況，我一般使用4空格的懸掛式縮進。例如：
引號
自然語言使用雙引號
機器標識使用單引號
正則表達式使用雙引號
空行
編碼格式聲明、模塊導入、常量和全局變數聲明、頂級定義和執行代碼之間空兩行
頂級定義之間空兩行，方法定義之間空一行
在函數或方法內部，可以在必要的地方空一行以增強節奏感，但應避免連續空行
導入模塊
導入總應該放在文件頂部，位於模塊注釋和文檔字元串之後，模塊全局變數和常量之前。導入應該按照從最通用到最不通用的順序分組，分組之間空一行
標准庫導入
第三方庫導入
應用程序指定導入
命名規范
模塊盡量使用小寫命名，首字母保持小寫，盡量不要用下劃線
類名使用駝峰(CamelCase)命名風格，首字母大寫，私有類可用一個下劃線開頭
函數名一律小寫，如有多個單詞，用下劃線隔開
私有函數可用一個下劃線開頭
變數名盡量小寫, 如有多個單詞，用下劃線隔開
常量採用全大寫，如有多個單詞，使用下劃線隔開