将应用程序更新为Python 3的3个简单步骤

python2已经走到了生命的尽头，所以是时候把你的python2项目转换成python3了。

Python的2.x系列从2020年1月起正式结束，2020年4月之后不受支持，但将代码转换为Python 3比您想象的要容易。上周末，我花了一个晚上的时间将3D渲染器的前端代码（及其对应的Python for Qt/PySide版本）转换为Python 3，这在回顾起来非常简单，尽管在重构过程中似乎相对没有希望。转换过程看起来有点像迷宫，你所做的每一个改变都揭示了你需要做的更多的改变。

您可能想也可能不想进行转换，但无论是因为您拖延太久，还是因为您依赖于一个除非您进行转换否则将无法维护的模块，有时您只是没有选择。如果您正在寻找一个简单的任务来开始您对开源的贡献，那么将Python2应用程序转换为Python3是一个很好的方法，可以给您留下一个简单但有意义的印象。

无论您出于什么原因将Python 2代码重构为Python 3，这都是一项重要的工作。这是三个步骤，可以清晰地完成任务。

1.运行2to3

在过去的几年里，Python附带了一个名为2to3的脚本，它为您完成了从python2到python3的大部分转换。而且您已经安装了它(不管您是否意识到)。

这是用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代码达到Python 3标准所需的更改。输出是一个可用的补丁，您可以使用它来更改文件，但使用--write（或-w）选项让Python为您轻松完成此操作更容易：

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

2to3脚本不能仅在单个文件上运行。无论是否带有--write选项，您都可以在Python文件的整个目录中运行它，以处理该目录及其子目录中的所有* .py文件。

2.使用Pylint或Pyflakes

发现在Python 2中没有问题但在Python 3中无法正常运行的代码怪异现象并不少见。由于无法通过转换语法来修复这些怪异现象，所以它们会以不变的方式跳过2to3，但是一旦您尝试运行代码，它们就会失败。

要检测此类问题，可以使用诸如Pylint之类的应用程序或诸如Pyflakes（或flake8包装器）之类的工具。我更喜欢Pyflakes，因为与Pylint不同，它忽略了代码风格的偏差。尽管通常将Python的“精美性”作为其优点之一，但将其他人的代码从2移植到3时，将样式和功能作为两个独立的bug进行处理是一个优先级问题。

下面是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

此输出（与Pylint的143行相比，大部分是关于缩进的警示）清楚地显示了您应修复的代码中的问题。

这里最有趣的错误是第19行的第一个错误。这有点误导，因为您可能会认为cmp是一个从未定义的变量，但是cmp实际上是Python 2中的一个函数，在Python 3中不存在。 它包装在try语句中，因此在很明显没有产生try结果之前，这个问题很容易被忽略。

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

在将应用程序维护为Python 2代码库与您决定移植该应用程序之间，有无数个不再存在或已更改的函数示例。PySide（2）绑定已更改，Python函数已消失或已转换（例如，对importlib的imp），等等。遇到它们时，一一修复。即使您需要重新实现或替换那些缺少的功能，但到目前为止，大多数这些问题是已知的并有据可查。真正的挑战更多的是捕获错误而不是修复错误，因此，请使用Pyflakes或类似工具。

3.修复损坏的Python 2代码

2to3脚本使您的代码与Python 3兼容，但只知道Python 2和3之间的区别。它通常无法进行调整以说明库中的更改，这些更改早在2010年就可以使用，但此后进行了重大修订。您必须手动更新该代码。

例如，这段代码显然可以追溯到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没有把GAME_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函数来使其更简洁，但这会将所需的调用从CLOCK_SPEED.TICKS_PER_SECOND（）更改为CLOCK_SPEED（），这可能会或可能不会对代码中的其他部分产生影响。如果您对代码很了解，那么您可以更好地判断需要进行多少修改，但是一般来说，我更愿意假设我所做的每一个更改都不可避免地要求对项目中的每一个其他文件进行多次更改，因此我尝试在现有结构中工作。

一旦您完成了legwork，您将拥有一个Python 3模块或应用程序，并且常规维护（以及那些使Pylint感到高兴的样式更改）可以重新开始！