如何將你的應(yīng)用遷移到Python3的三個(gè)步驟

Python 2.x 很快就要 失去官方支持 了，盡管如此，從 Python 2 遷移到 Python 3 卻并沒(méi)有想象中那么難。我在上周用了一個(gè)晚上的時(shí)間將一個(gè) 3D 渲染器的前端代碼及其對(duì)應(yīng)的 PySide 遷移到 Python 3，回想起來(lái)，盡管在遷移過(guò)程中無(wú)可避免地會(huì)遇到一些牽一發(fā)而動(dòng)全身的修改，但整個(gè)過(guò)程相比起痛苦的重構(gòu)來(lái)說(shuō)簡(jiǎn)直是出奇地簡(jiǎn)單。

每個(gè)人都別無(wú)選擇地有各種必須遷移的原因：或許是覺(jué)得已經(jīng)拖延太久了，或許是依賴了某個(gè)在 Python 2 下不再維護(hù)的模塊。但如果你僅僅是想通過(guò)做一些事情來(lái)對(duì)開源做貢獻(xiàn)，那么把一個(gè) Python 2 應(yīng)用遷移到 Python 3 就是一個(gè)簡(jiǎn)單而又有意義的做法。

無(wú)論你從 Python 2 遷移到 Python 3 的原因是什么，這都是一項(xiàng)重要的任務(wù)。按照以下三個(gè)步驟，可以讓你把任務(wù)完成得更加清晰。

1、使用 2to3

從幾年前開始，Python 在你或許還不知道的情況下就已經(jīng)自帶了一個(gè)名叫 2to3 的腳本，它可以幫助你實(shí)現(xiàn)大部分代碼從 Python 2 到 Python 3 的自動(dòng)轉(zhuǎn)換。

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

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

對(duì)其執(zhí)行 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 

在默認(rèn)情況下，2to3 只會(huì)對(duì)遷移到 Python 3 時(shí)必須作出修改的代碼進(jìn)行標(biāo)示，在輸出結(jié)果中顯示的 Python 3 代碼是直接可用的，但你可以在 2to3 加上 -w 或者 --write 參數(shù)，這樣它就可以直接按照給出的方案修改你的 Python 2 代碼文件了。

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

2to3 腳本不僅僅對(duì)單個(gè)文件有效，你還可以把它用于一個(gè)目錄下的所有 Python 文件，同時(shí)它也會(huì)遞歸地對(duì)所有子目錄下的 Python 文件都生效。

2、使用 Pylint 或 Pyflakes

有一些不良的代碼在 Python 2 下運(yùn)行是沒(méi)有異常的，在 Python 3 下運(yùn)行則會(huì)或多或少報(bào)出錯(cuò)誤，這種情況并不鮮見(jiàn)。因?yàn)檫@些不良代碼無(wú)法通過(guò)語(yǔ)法轉(zhuǎn)換來(lái)修復(fù)，所以 2to3 對(duì)它們沒(méi)有效果，但一旦使用 Python 3 來(lái)運(yùn)行就會(huì)產(chǎn)生報(bào)錯(cuò)。

要找出這種問(wèn)題，你需要使用 Pylint 、 Pyflakes (或 flake8 封裝器)這類工具。其中我更喜歡 Pyflakes，它會(huì)忽略代碼風(fēng)格上的差異，在這一點(diǎn)上它和 Pylint 不同。盡管代碼優(yōu)美是 Python 的一大特點(diǎn)，但在代碼遷移的層面上，“讓代碼功能保持一致”無(wú)疑比“讓代碼風(fēng)格保持一致”重要得多。

以下是 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 輸出的內(nèi)容清晰地給出了代碼中需要修改的問(wèn)題。相比之下，Pylint 會(huì)輸出多達(dá) 143 行的內(nèi)容，而且多數(shù)是諸如代碼縮進(jìn)這樣無(wú)關(guān)緊要的問(wèn)題。

值得注意的是第 19 行這個(gè)容易產(chǎn)生誤導(dǎo)的錯(cuò)誤。從輸出來(lái)看你可能會(huì)以為 cmp 是一個(gè)在使用前未定義的變量，實(shí)際上 cmp 是 Python 2 的一個(gè)內(nèi)置函數(shù)，而它在 Python 3 中被移除了。而且這段代碼被放在了 try 語(yǔ)句塊中，除非認(rèn)真檢查這段代碼的輸出值，否則這個(gè)問(wèn)題很容易被忽略掉。

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

在代碼遷移過(guò)程中，你會(huì)發(fā)現(xiàn)很多原本在 Python 2 中能正常運(yùn)行的函數(shù)都發(fā)生了變化，甚至直接在 Python 3 中被移除了。例如 PySide 的綁定方式發(fā)生了變化、importlib 取代了 imp 等等。這樣的問(wèn)題只能見(jiàn)到一個(gè)解決一個(gè)，而涉及到的功能需要重構(gòu)還是直接放棄，則需要你自己權(quán)衡。但目前來(lái)說(shuō)，大多數(shù)問(wèn)題都是已知的，并且有 完善的文檔記錄 。所以難的不是修復(fù)問(wèn)題，而是找到問(wèn)題，從這個(gè)角度來(lái)說(shuō)，使用 Pyflake 是很有必要的。

3、修復(fù)被破壞的 Python 2 代碼

盡管 2to3 腳本能夠幫助你把代碼修改成兼容 Python 3 的形式，但對(duì)于一個(gè)完整的代碼庫(kù)，它就顯得有點(diǎn)無(wú)能為力了，因?yàn)橐恍├吓f的代碼在 Python 3 中可能需要不同的結(jié)構(gòu)來(lái)表示。在這樣的情況下，只能人工進(jìn)行修改。

例如以下代碼在 Python 2.6 中可以正常運(yùn)行：

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 這些自動(dòng)化工具并不能發(fā)現(xiàn)其中的問(wèn)題，但如果上述代碼使用 Python 3 來(lái)運(yùn)行，解釋器會(huì)認(rèn)為 CLOCK_SPEED.TICKS_PER_SECOND 是未被明確定義的。因此就需要把代碼改成面向?qū)ο蟮慕Y(jié)構(gòu)：

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() 

你也許會(huì)認(rèn)為如果把 TICKS_PER_SECOND() 改寫為一個(gè)構(gòu)造函數(shù)(用 __init__ 函數(shù)設(shè)置默認(rèn)值)能讓代碼看起來(lái)更加簡(jiǎn)潔，但這樣就需要把這個(gè)方法的調(diào)用形式從 CLOCK_SPEED.TICKS_PER_SECOND() 改為 CLOCK_SPEED() 了，這樣的改動(dòng)或多或少會(huì)對(duì)整個(gè)庫(kù)造成一些未知的影響。如果你對(duì)整個(gè)代碼庫(kù)的結(jié)構(gòu)爛熟于心，那么你確實(shí)可以隨心所欲地作出這樣的修改。但我通常認(rèn)為，只要我做出了修改，都可能會(huì)影響到其它代碼中的至少三處地方，因此我更傾向于不使代碼的結(jié)構(gòu)發(fā)生改變。

堅(jiān)持信念

如果你正在嘗試將一個(gè)大項(xiàng)目從 Python 2 遷移到 Python 3，也許你會(huì)覺(jué)得這是一個(gè)漫長(zhǎng)的過(guò)程。你可能會(huì)費(fèi)盡心思也找不到一條有用的報(bào)錯(cuò)信息，這種情況下甚至?xí)袑⒋a推倒重建的沖動(dòng)。但從另一個(gè)角度想，代碼原本在 Python 2 中就可以運(yùn)行，要讓它能在 Python 3 中繼續(xù)運(yùn)行，你需要做的只是對(duì)它稍加轉(zhuǎn)換而已。

但只要你完成了遷移，你就得到了這個(gè)模塊或者整個(gè)應(yīng)用程序的 Python 3 版本，外加 Python 官方的長(zhǎng)期支持。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。