第二章 共享你的Python代码

上一章结尾我们讲到用函数来封装代码以便于复用。但是你有没有发现我们写的代码在IDLE里,无法保存下来,如果我们进行真正开发工作,而且肯定会和其他人合作开发 ,都将代码写在IDLE里是不行的。所以我们现在需要解决两个问题:

  • 使用真正的IDE
  • 将代码放在多个文件中

Python的编辑器选择

用什么IDE开发Python这个真不好说,看个人喜好、公司规范都行。比如Windows下的同学可以使用NotePad++,Mac可以使用Sublime Text。我在这里建议大家可以试试Visual Studio Code,它是微软推出的轻量级、跨平台IDE,这款IDE有很好的Python支持,智能提示、语法检测、调试等。而且有很多实用的插件供大家使用。

这里附上下载地址:http://code.visualstudio.com/Download


安装IDE中...

将Python代码模块化

已经准备好了开发工具,那么就继续开始学习了。首先我们把上一篇的代码再写一遍,这次使用IDE来编写,然后文件保存为list_loop.py。代码如下:

def loop(list_item):
    for item in list_item:
        if isinstance(item, list):
            loop(item)
        else:
            print(item)      

然后在目录下找到这个文件,使用右键-打开方式用IDLE打开这个list_loop.py。这时候你应该会看到刚才写的函数代码。按F5执行,会出现一个新的命令界面,这时候我们创建一个列表,然后调用刚才的函数。

>>> books = [['机械工业出版社',['C++入门', 50.9],['Java编程思想', 60.5]],
         ['人民邮电出版社',['Android开发详解', 76.5],['HTML5技术探索', 78.9]],
         ['中国电力出版社' ,['iOS设计模式', 88.3]]]
>>> loop(books)
机械工业出版社
C++入门
50.9
Java编程思想
60.5
人民邮电出版社
Android开发详解
76.5
HTML5技术探索
78.9
中国电力出版社
iOS设计模式
88.3
>>> 

在使用函数的时候,你可以试试用TAB,IDLE会有相应的代码提示。这样我们就成功的引用外部函数了。


Pyhton代码中引用其它模块

但是我们的列表不是在py文件中创建的,我们再来改造一下代码,将列表数据也单独写到一个文件中。在list_loop.py同级目录新建一个文件test_list_loop.py,内容如下:

import list_loop

books = [['机械工业出版社',['C++入门', 50.9],['Java编程思想', 60.5]],
         ['人民邮电出版社',['Android开发详解', 76.5],['HTML5技术探索', 78.9]],
         ['中国电力出版社' ,['iOS设计模式', 88.3]]]

print(loop(books))

可以看到首行有一句话imoprt list_loop 它的含义是将list_loop.py模块引入我们当前的代码中。现在我们用IDLE打开test_list_loop.py文件,还是按F5来执行。不出意外,你应该得到一个错误提示:

Traceback (most recent call last):
  File "/test_list_loop.py", line 7, in 
    print(loop(books))
NameError: name 'loop' is not defined
>>> 

提示说loop没有定义,这是为什么呢?其实很好理解,我们在第一行告诉IDLE导入了list_loop模块,而list_loop是一个命名空间,命名空间就像是一个地区名称,比如你想找小明,1班有个小明,2班也有个小明,你需要给出完整的地址才可以帮你找到。也就是说你想用loop这个方法,你需要告诉IDEloop具体是哪个命名空间里的函数才可以,于是我们可以这么改:

print(list_loop.loop(books))

将loop函数前面加上命名空间,这样就可以成功的运行了。Python的所有代码都与一个命名空间关联。我们使用的BIF都是在一个名字为__main__的命名空间中,所以我们才可以便捷的使用这些函数。
还有一种方式也可以解决这个问题:

from list_loop import loop
#省略代码...
print(loop(books))

使用from list_loop import loop来指定引用的函数,这样一来就不必再使用命名空间来调用函数了。不过这样也会带来一个问题,如果你当前的命名空间中已经定义了相同的函数名称,它将会被import进来的函数所覆盖,所以尽量使用完成的命名空间来处理这些函数一个不错的习惯。


总结

今天我们学习了:

  • 使用更加强壮的开发工具来写Python。
  • 将Python代码放在不同文件中。
  • 使用import 导入其它模块。

本章总的来说内容还是很轻松的,如果大家喜欢请点赞、收藏,我会继续更新后面的章节。
上一章结尾我们讲到用函数来封装代码以便于复用。但是你有没有发现我们写的代码在IDLE里,无法保存下来,如果我们进行真正开发工作,而且肯定会和其他人合作开发 ,都将代码写在IDLE里是不行的。所以我们现在需要解决两个问题:

  • 使用真正的IDE
  • 将代码放在多个文件中

Python的编辑器选择

用什么IDE开发Python这个真不好说,看个人喜好、公司规范都行。比如Windows下的同学可以使用NotePad++,Mac可以使用Sublime Text。我在这里建议大家可以试试Visual Studio Code,它是微软推出的轻量级、跨平台IDE,这款IDE有很好的Python支持,智能提示、语法检测、调试等。而且有很多实用的插件供大家使用。

这里附上下载地址:http://code.visualstudio.com/Download


安装IDE中...

将Python代码模块化

已经准备好了开发工具,那么就继续开始学习了。首先我们把上一篇的代码再写一遍,这次使用IDE来编写,然后文件保存为list_loop.py。代码如下:

def loop(list_item):
    for item in list_item:
        if isinstance(item, list):
            loop(item)
        else:
            print(item)      

然后在目录下找到这个文件,使用右键-打开方式用IDLE打开这个list_loop.py。这时候你应该会看到刚才写的函数代码。按F5执行,会出现一个新的命令界面,这时候我们创建一个列表,然后调用刚才的函数。

>>> books = [['机械工业出版社',['C++入门', 50.9],['Java编程思想', 60.5]],
         ['人民邮电出版社',['Android开发详解', 76.5],['HTML5技术探索', 78.9]],
         ['中国电力出版社' ,['iOS设计模式', 88.3]]]
>>> loop(books)
机械工业出版社
C++入门
50.9
Java编程思想
60.5
人民邮电出版社
Android开发详解
76.5
HTML5技术探索
78.9
中国电力出版社
iOS设计模式
88.3
>>> 

在使用函数的时候,你可以试试用TAB,IDLE会有相应的代码提示。这样我们就成功的引用外部函数了。


Pyhton代码中引用其它模块

但是我们的列表不是在py文件中创建的,我们再来改造一下代码,将列表数据也单独写到一个文件中。在list_loop.py同级目录新建一个文件test_list_loop.py,内容如下:

import list_loop

books = [['机械工业出版社',['C++入门', 50.9],['Java编程思想', 60.5]],
         ['人民邮电出版社',['Android开发详解', 76.5],['HTML5技术探索', 78.9]],
         ['中国电力出版社' ,['iOS设计模式', 88.3]]]

print(loop(books))

可以看到首行有一句话imoprt list_loop 它的含义是将list_loop.py模块引入我们当前的代码中。现在我们用IDLE打开test_list_loop.py文件,还是按F5来执行。不出意外,你应该得到一个错误提示:

Traceback (most recent call last):
  File "/test_list_loop.py", line 7, in 
    print(loop(books))
NameError: name 'loop' is not defined
>>> 

提示说loop没有定义,这是为什么呢?其实很好理解,我们在第一行告诉IDLE导入了list_loop模块,而list_loop是一个命名空间,命名空间就像是一个地区名称,比如你想找小明,1班有个小明,2班也有个小明,你需要给出完整的地址才可以帮你找到。也就是说你想用loop这个方法,你需要告诉IDEloop具体是哪个命名空间里的函数才可以,于是我们可以这么改:

print(list_loop.loop(books))

将loop函数前面加上命名空间,这样就可以成功的运行了。Python的所有代码都与一个命名空间关联。我们使用的BIF都是在一个名字为__main__的命名空间中,所以我们才可以便捷的使用这些函数。
还有一种方式也可以解决这个问题:

from list_loop import loop
#省略代码...
print(loop(books))

使用from list_loop import loop来指定引用的函数,这样一来就不必再使用命名空间来调用函数了。不过这样也会带来一个问题,如果你当前的命名空间中已经定义了相同的函数名称,它将会被import进来的函数所覆盖,所以尽量使用完成的命名空间来处理这些函数一个不错的习惯。


合理升级你的模块代码

在真正的开发中,需求变更是常有的。现在我们就有一个新的需求,之前的数据输出都是一行一个排版很不好看,现在想做一些UI的美化,这里我们简单设计下,在出版社内的书籍价格多加一个\t,这是最后效果:

        机械工业出版社
            C++入门
            50.9
            Java编程思想
            60.5
        人民邮电出版社
            Android开发详解
            76.5
            HTML5技术探索
            78.9
        中国电力出版社
            iOS设计模式
            88.3

接来下开始改造loop()这个方法,增加一个索引标记:

def loop(list_item,item_tab):
    for item in list_item:
        if isinstance(item, list):
            loop(item,item_tab+1)
        else:
            for tab in range(item_tab):
                print('\t',end='')
            print(item)

这里用到了新的BIFrange(),请自行help(range)查阅文档。每次到if的时候item_tab+1保证内部的列表比外部多一个tab,然后在else内进行循环打印print('\t',end=''),这是print其它参数重载形式,可以很方便的控制打印规则,有不清楚的可以使用help(print)来查看文档。

现在开始尝试运行test_list_loop.py这个文件,还是右键-IDLE打开,然后F5执行,如果你按照我说的来做的话,就会发现又出现错误了:

Traceback (most recent call last):
  File "/test_list_loop.py", line 7, in 
    print(loop(books))
TypeError: loop() missing 1 required positional argument: 'item_tab'
>>> 

TypeError提示说缺少一个参数,原来是刚才修改loop()函数忘记改调用的地方了,那我们就再改下调用的文件:

print(loop(books, 0))

虽然解决了问题,但是我们也是费了不少劲,不但要改公用的模块,还需改调用的代码,显然这种牵一发动全身的编码方式我们是不能接受的。为了避免这种事情再次发生,我们要想出一种兼容方式来处理,就是不在改调用方的情况下,合理的升级我们的公用模块代码。

脑洞开启中...

我们重新写一个函数,让旧函数调用新函数,这样就可以对调用方隐藏:

def loop(list_item):
    loop2(list_item,1)

这是一个好办法,对调用方来说不用修改任何地方就能完成升级代码了。但是我们模块方会因此而增加维护开销,如果以后有新人加入,他会很困惑究竟用哪个函数。显然这种方式只能对一部分人带来好处。
在一番研究下,发现Python有个神奇的功能,刚好可以解决我们的问题,函数的入参可以提供默认值,而且调用方可以不用填写有默认值的参数:

def loop(list_item,item_tab=1):

调用方:

print(loop(books))

F5执行可以顺利的打印出来了,真是喜大普奔。这样就完美解决了不管是模块维护还是业务调用,都可以用很低的成本来完成这个重大的改变。有时候多了解一些事情,就能有意想不到的收获。


总结

今天我们学习了:

  • 使用更加强壮的开发工具来写Python。
  • 将Python代码放在不同文件中。
  • 使用import 导入其它模块。
  • 新学了一个BIF:rang(),还学习了print的其它重载方式。
  • 使用巧妙的方式来解决公用模块的修改而不影响其他调用者。

本章总的来说内容还是很轻松的,如果大家喜欢请点赞、收藏,我会继续更新后面的章节。


恭喜你达成成就。


你可能感兴趣的:(第二章 共享你的Python代码)