Python 2 氣數將盡,是時候將你的專案從 Python 2 遷移到 Python 3 了。
Python 2.x 很快就要了,儘管如此,從 Python 2 遷移到 Python 3 卻並沒有想象中那麼難。我在上週用了一個晚上的時間將一個 3D 渲染器的前端程式碼及其對應的 PySide 遷移到 Python 3,回想起來,儘管在遷移過程中無可避免地會遇到一些牽一髮而動全身的修改,但整個過程相比起痛苦的重構來說簡直是出奇地簡單。
每個人都別無選擇地有各種必須遷移的原因:或許是覺得已經拖延太久了,或許是依賴了某個在 Python 2 下不再維護的模組。但如果你僅僅是想通過做一些事情來對開源做貢獻,那麼把一個 Python 2 應用遷移到 Python 3 就是一個簡單而又有意義的做法。
無論你從 Python 2 遷移到 Python 3 的原因是什麼,這都是一項重要的任務。按照以下三個步驟,可以讓你把任務完成得更加清晰。
從幾年前開始,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.pyRefactoringTool: 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 檔案都生效。
有一些不良的程式碼在 Python 2 下執行是沒有異常的,在 Python 3 下執行則會或多或少報出錯誤,這種情況並不鮮見。因為這些不良程式碼無法通過語法轉換來修復,所以 2to3
對它們沒有效果,但一旦使用 Python 3 來執行就會產生報錯。
要找出這種問題,你需要使用 Pylint、Pyflakes(或 flake8 封裝器)這類工具。其中我更喜歡 Pyflakes,它會忽略程式碼風格上的差異,在這一點上它和 Pylint 不同。儘管程式碼優美是 Python 的一大特點,但在程式碼遷移的層面上,“讓程式碼功能保持一致”無疑比“讓程式碼風格保持一致”重要得多。
以下是 Pyflakes 的輸出樣例:
$ pyflakes example/mathsexample/maths/enum.py:19: undefined name 'cmp'example/maths/enum.py:105: local variable 'e' is assigned to but never usedexample/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 是很有必要的。
儘管 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_SECONDclass FPS: STATS_UPDATE_FREQUENCY = CLOCK_SPEED.TICKS_PER_SECOND()
你也許會認為如果把 TICKS_PER_SECOND()
改寫為一個建構函式(用 __init__
函數設定預設值)能讓程式碼看起來更加簡潔,但這樣就需要把這個方法的呼叫形式從 CLOCK_SPEED.TICKS_PER_SECOND()
改為 CLOCK_SPEED()
了,這樣的改動或多或少會對整個庫造成一些未知的影響。如果你對整個程式碼庫的結構爛熟於心,那麼你確實可以隨心所欲地作出這樣的修改。但我通常認為,只要我做出了修改,都可能會影響到其它程式碼中的至少三處地方,因此我更傾向於不使程式碼的結構發生改變。
如果你正在嘗試將一個大專案從 Python 2 遷移到 Python 3,也許你會覺得這是一個漫長的過程。你可能會費盡心思也找不到一條有用的報錯資訊,這種情況下甚至會有將程式碼推倒重建的衝動。但從另一個角度想,程式碼原本在 Python 2 中就可以執行,要讓它能在 Python 3 中繼續執行,你需要做的只是對它稍加轉換而已。
但只要你完成了遷移,你就得到了這個模組或者整個應用程式的 Python 3 版本,外加 Python 官方的長期支援。