将你的应用迁移到 Python 3 的三个步骤

开发 后端
Python 2 气数将尽,是时候将你的项目从 Python 2 迁移到 Python 3 了。Python 2.x 很快就要 失去官方支持 了,尽管如此,从 Python 2 迁移到 Python 3 却并没有想象中那么难。

 Python 2.x 很快就要 失去官方支持 了,尽管如此,从 Python 2 迁移到 Python 3 却并没有想象中那么难。我在上周用了一个晚上的时间将一个 3D 渲染器的前端代码及其对应的 PySide 迁移到 Python 3,回想起来,尽管在迁移过程中无可避免地会遇到一些牵一发而动全身的修改,但整个过程相比起痛苦的重构来说简直是出奇地简单。

[[286242]]

每个人都别无选择地有各种必须迁移的原因:或许是觉得已经拖延太久了,或许是依赖了某个在 Python 2 下不再维护的模块。但如果你仅仅是想通过做一些事情来对开源做贡献,那么把一个 Python 2 应用迁移到 Python 3 就是一个简单而又有意义的做法。

无论你从 Python 2 迁移到 Python 3 的原因是什么,这都是一项重要的任务。按照以下三个步骤,可以让你把任务完成得更加清晰。

1、使用 2to3

从几年前开始,Python 在你或许还不知道的情况下就已经自带了一个名叫 2to3 的脚本,它可以帮助你实现大部分代码从 Python 2 到 Python 3 的自动转换。

下面是一段使用 Python 2.6 编写的代码:

 

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

对其执行 2to3 脚本:

 

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

在默认情况下,2to3 只会对迁移到 Python 3 时必须作出修改的代码进行标示,在输出结果中显示的 Python 3 代码是直接可用的,但你可以在 2to3 加上 -w 或者 --write 参数,这样它就可以直接按照给出的方案修改你的 Python 2 代码文件了。

 

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

2to3 脚本不仅仅对单个文件有效,你还可以把它用于一个目录下的所有 Python 文件,同时它也会递归地对所有子目录下的 Python 文件都生效。

2、使用 Pylint 或 Pyflakes

有一些不良的代码在 Python 2 下运行是没有异常的,在 Python 3 下运行则会或多或少报出错误,这种情况并不鲜见。因为这些不良代码无法通过语法转换来修复,所以 2to3 对它们没有效果,但一旦使用 Python 3 来运行就会产生报错。

要找出这种问题,你需要使用 Pylint 、 Pyflakes (或 flake8 封装器)这类工具。其中我更喜欢 Pyflakes,它会忽略代码风格上的差异,在这一点上它和 Pylint 不同。尽管代码优美是 Python 的一大特点,但在代码迁移的层面上,“让代码功能保持一致”无疑比“让代码风格保持一致”重要得多。

以下是 Pyflakes 的输出样例:

 

  1. $ pyflakes example/maths 
  2. example/maths/enum.py:19: undefined name 'cmp' 
  3. example/maths/enum.py:105: local variable 'e' is assigned to but never used 
  4. example/maths/enum.py:109: undefined name 'basestring' 
  5. example/maths/enum.py:208: undefined name 'EnumValueCompareError' 
  6. 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 语句块中,除非认真检查这段代码的输出值,否则这个问题很容易被忽略掉。

 

  1. try: 
  2.     result = cmp(self.index, other.index
  3. except
  4.     result = 42 
  5.     
  6. return result 

在代码迁移过程中,你会发现很多原本在 Python 2 中能正常运行的函数都发生了变化,甚至直接在 Python 3 中被移除了。例如 PySide 的绑定方式发生了变化、importlib 取代了 imp 等等。这样的问题只能见到一个解决一个,而涉及到的功能需要重构还是直接放弃,则需要你自己权衡。但目前来说,大多数问题都是已知的,并且有 完善的文档记录 。所以难的不是修复问题,而是找到问题,从这个角度来说,使用 Pyflake 是很有必要的。

3、修复被破坏的 Python 2 代码

尽管 2to3 脚本能够帮助你把代码修改成兼容 Python 3 的形式,但对于一个完整的代码库,它就显得有点无能为力了,因为一些老旧的代码在 Python 3 中可能需要不同的结构来表示。在这样的情况下,只能人工进行修改。

例如以下代码在 Python 2.6 中可以正常运行:

 

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

类似 2to3 和 Pyflakes 这些自动化工具并不能发现其中的问题,但如果上述代码使用 Python 3 来运行,解释器会认为 CLOCK_SPEED.TICKS_PER_SECOND 是未被明确定义的。因此就需要把代码改成面向对象的结构:

 

  1. class CLOCK_SPEED: 
  2.         def TICKS_PER_SECOND(): 
  3.                 TICKS_PER_SECOND = 16 
  4.                 TICK_RATES = [int(i * TICKS_PER_SECOND) 
  5.                         for i in (0.5, 1, 2, 3, 4, 6, 8, 11, 20)] 
  6.                 return TICKS_PER_SECOND 
  7. class FPS: 
  8.         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 官方的长期支持。

责任编辑:华轩 来源: Linux中国
相关推荐

2018-04-26 10:13:32

云计算迁移云端

2022-02-15 09:36:13

容器应用程序云服务

2011-03-31 13:43:06

WindowsLinux迁移

2021-01-06 10:49:31

云迁移银行

2022-11-09 16:30:12

2019-09-16 08:53:55

云端云迁移安全

2020-03-02 10:33:39

云迁移公共云云计算

2021-12-03 14:34:26

云迁移云端云计算

2022-05-12 12:55:28

容器Kubernetes运行容器

2021-08-19 11:22:22

深度学习编程人工智能

2022-06-27 14:28:22

云端数字化网络

2019-09-25 08:57:24

单体式架构微服务

2023-12-21 16:25:23

WeChatSnapchatShopee

2019-01-29 07:14:41

2022-10-12 14:33:15

数字化转型网络安全数据中心

2021-01-15 10:51:32

物联网安全物联网IOT

2012-04-25 10:03:20

开发编程

2013-12-05 16:58:07

TechEd2013Windows Azu微软

2016-09-13 22:28:08

云计算saaspaas

2010-11-15 09:56:30

点赞
收藏

51CTO技术栈公众号