官方再也不支持Python2，如何將你的項目完美遷移到Python3？

Python 2.x 很快就要失去官方支持了，不過不用慌，從 Python 2 遷移到 Python 3 卻並無想象中那麼難。我在上週用了一個晚上的時間將一個 3D 渲染器的前端代碼及其對應的 PySide遷移到 Python 3，回想起來，儘管在遷移過程當中無可避免地會遇到一些牽一髮而動全身的修改，但整個過程相比起痛苦的重構來講簡直是出奇地簡單。

每一個人都別無選擇地有各類必須遷移的緣由：或許是以爲已經拖延過久了，或許是依賴了某個在 Python 2 下再也不維護的模塊。但若是你僅僅是想經過作一些事情來對開源作貢獻，那麼把一個 Python 2 應用遷移到 Python 3 就是一個簡單而又有意義的作法。

不管你從 Python 2 遷移到 Python 3 的緣由是什麼，這都是一項重要的任務。按照如下三個步驟，可讓你把任務完成得更加清晰。

一、使用 2to3

從幾年前開始，Python 在你或許還不知道的狀況下就已經自帶了一個名叫 2to3 的腳本，它能夠幫助你實現大部分代碼從 Python 2 到 Python 3 的自動轉換。

下面是一段使用 Python 2.6 編寫的代碼：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
mystring = u'abcdé'
print ord(mystring[-1])

 

對其執行 2to3 腳本：

$ 2to3 example.py
RefactoringTool: Refactored example.py
--- example.py     (original)
+++ example.py     (refactored)
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-mystring = u'abcdé'
-print ord(mystring[-1])
+mystring = 'abcdé'
+print(ord(mystring[-1]))
RefactoringTool: Files that need to be modified:
RefactoringTool: example.py

 

在默認狀況下，2to3 只會對遷移到 Python 3 時必須做出修改的代碼進行標示，在輸出結果中顯示的 Python 3 代碼是直接可用的，但你能夠在 2to3 加上 -w 或者 --write 參數，這樣它就能夠直接按照給出的方案修改你的 Python 2 代碼文件了。

$ 2to3 -w example.py
[...]
RefactoringTool: Files that were modified:
RefactoringTool: example.py

 

2to3 腳本不只僅對單個文件有效，你還能夠把它用於一個目錄下的全部 Python 文件，同時它也會遞歸地對全部子目錄下的 Python 文件都生效。

二、使用 Pylint 或 Pyflakes

有一些不良的代碼在 Python 2 下運行是沒有異常的，在 Python 3 下運行則會或多或少報出錯誤，這種狀況並不鮮見。由於這些不良代碼沒法經過語法轉換來修復，因此 2to3 對它們沒有效果，但一旦使用 Python 3 來運行就會產生報錯。

要找出這種問題，你須要使用 Pylint、Pyflakes（或 flake8封裝器）這類工具。其中我更喜歡 Pyflakes，它會忽略代碼風格上的差別，在這一點上它和 Pylint 不一樣。儘管代碼優美是 Python 的一大特色，但在代碼遷移的層面上，「讓代碼功能保持一致」無疑比「讓代碼風格保持一致」重要得多。

如下是 Pyflakes 的輸出樣例：

$ pyflakes example/maths
example/maths/enum.py:19: undefined name 'cmp'
example/maths/enum.py:105: local variable 'e' is assigned to but never used
example/maths/enum.py:109: undefined name 'basestring'
example/maths/enum.py:208: undefined name 'EnumValueCompareError'
example/maths/enum.py:208: local variable 'e' is assigned to but never used

 

上面這些由 Pyflakes 輸出的內容清晰地給出了代碼中須要修改的問題。相比之下，Pylint 會輸出多達 143 行的內容，並且多數是諸如代碼縮進這樣可有可無的問題。

值得注意的是第 19 行這個容易產生誤導的錯誤。從輸出來看你可能會覺得 cmp 是一個在使用前未定義的變量，實際上 cmp 是 Python 2 的一個內置函數，而它在 Python 3 中被移除了。並且這段代碼被放在了 try 語句塊中，除非認真檢查這段代碼的輸出值，不然這個問題很容易被忽略掉。

    try:
        result = cmp(self.index, other.index)
    except:
        result = 42
       
    return result

 

在代碼遷移過程當中，你會發現不少本來在 Python 2 中能正常運行的函數都發生了變化，甚至直接在 Python 3 中被移除了。例如 PySide 的綁定方式發生了變化、importlib 取代了 imp 等等。這樣的問題只能見到一個解決一個，而涉及到的功能須要重構仍是直接放棄，則須要你本身權衡。但目前來講，大多數問題都是已知的，而且有完善的文檔記錄。因此難的不是修復問題，而是找到問題，從這個角度來講，使用 Pyflake 是頗有必要的。

三、修復被破壞的 Python 2 代碼

儘管 2to3 腳本可以幫助你把代碼修改爲兼容 Python 3 的形式，但對於一個完整的代碼庫，它就顯得有點無能爲力了，由於一些老舊的代碼在 Python 3 中可能須要不一樣的結構來表示。在這樣的狀況下，只能人工進行修改。

例如如下代碼在 Python 2.6 中能夠正常運行：

class CLOCK_SPEED:
        TICKS_PER_SECOND = 16
        TICK_RATES = [int(i * TICKS_PER_SECOND)
                      for i in (0.5, 1, 2, 3, 4, 6, 8, 11, 20)]
class FPS:
        STATS_UPDATE_FREQUENCY = CLOCK_SPEED.TICKS_PER_SECOND

 

相似 2to3 和 Pyflakes 這些自動化工具並不能發現其中的問題，但若是上述代碼使用 Python 3 來運行，解釋器會認爲 CLOCK_SPEED.TICKS_PER_SECOND 是未被明肯定義的。所以就須要把代碼改爲面向對象的結構：

class CLOCK_SPEED:
        def TICKS_PER_SECOND():
                TICKS_PER_SECOND = 16
                TICK_RATES = [int(i * TICKS_PER_SECOND)
                        for i in (0.5, 1, 2, 3, 4, 6, 8, 11, 20)]
                return TICKS_PER_SECOND
class FPS:
        STATS_UPDATE_FREQUENCY = CLOCK_SPEED.TICKS_PER_SECOND()

 

你也許會認爲若是把 TICKS_PER_SECOND() 改寫爲一個構造函數（用 __init__ 函數設置默認值）能讓代碼看起來更加簡潔，但這樣就須要把這個方法的調用形式從 CLOCK_SPEED.TICKS_PER_SECOND() 改成 CLOCK_SPEED() 了，這樣的改動或多或少會對整個庫形成一些未知的影響。若是你對整個代碼庫的結構爛熟於心，那麼你確實能夠爲所欲爲地做出這樣的修改。但我一般認爲，只要我作出了修改，均可能會影響到其它代碼中的至少三處地方，所以我更傾向於不使代碼的結構發生改變。

在學習Python的過程當中，每每由於沒有資料或者沒人指導從而致使本身不想學下去了，所以我特地準備了個羣 592539176 ，羣裏有大量的PDF書籍、教程都給你們無償使用！不論是學習到哪一個階段的小夥伴均可以獲取到本身相對應的資料！

堅持信念

若是你正在嘗試將一個大項目從 Python 2 遷移到 Python 3，也許你會以爲這是一個漫長的過程。你可能會費盡心思也找不到一條有用的報錯信息，這種狀況下甚至會有將代碼推倒重建的衝動。但從另外一個角度想，代碼本來在 Python 2 中就能夠運行，要讓它能在 Python 3 中繼續運行，你須要作的只是對它稍加轉換而已。

但只要你完成了遷移，你就獲得了這個模塊或者整個應用程序的 Python 3 版本，外加 Python 官方的長期支持。