Lonely patients

时光不回头,当下最重要。

跟我读python3文档:025_模块(6. Modules)

贯穿始终的理念:别废话,就是干!


往期回顾

  • 匿名函数lambda
  • 列表的方法
  • del关键字
  • 列表推导式
  • 数据结构

文档解读

python3文档第六小节链接地址:6. Modules

本章主要讲解6. Modules(模块)这个小节


模块入门知识点相对较少,只要理解了基本概念,很快就能上手。
如果长篇大论看不下去的,可以直接翻到最后看总结。从而快速了解模块章节的知识点。

1. 首先要理解模块是什么。
我们到目前为止,都是在交互模式里输入代码,通过python解释器执行代码。
不知道大家有没有感觉到,这是一个非常笨拙的写代码的方法。

当我们要输入的代码比较多时,就会遇到一个问题:修改麻烦!
或者说,是不能修改。
我们一旦输入错误,那么之前的代码就废掉了,只能重新输入。

目前我们一次输入的代码量还比较少,最多也就十来行。重新输入一次到还可以接受。但是以后,我们的代码量越来越庞大,比如一次要输入上百行,那么,如果你中间有写错的部分,再把这些从头来过可能就很麻烦了。(ps:上古程序员被这件事折磨了很久。。)而且,你不能保证,下一次就不会犯错了。

为了解决这样的问题,我们一般是提前把代码写在一个文本文件里,然后用python解释器去解释执行。如果有错误的地方,只要修改下文本内容就可以了。

而这个提前写好的文本文件,就是我们说的模块

不过,一般我们会把官方自带的模块成为内置模块。
自己写的文件一般就叫做脚本文件。。
但其实他俩在本质上是一样的。

所以,你可以理解为:模块即脚本,脚本即模块

关键得看是谁写的。。。


2. 模块的特征
模块都是以.py结尾的文本文件。
比如 gali.py,知道galipy名字的由来了吧~
比如 sys.py、math.py、rhinoscriptsyntax.py
这些模块,有的是官方自带的,有的是别人写的,也有的是自己写的。不一而足。


3. 编写脚本
随便打开一个文本编辑器,开始写代码就行了。但是要记住,名字要以.py结尾。
下面,我们以atom编辑器,展示脚本编写。
在命令行直接用atom创建fibo.py文件。

atom fibo.py

参考截图如下:

创建脚本.png

注:如果电脑里没有atom编辑器,可以通过homebrew安装。
执行如下代码安装

brew cask install atom

如果不知道homebrew是是什么,请阅读如下章节
跟我读python3文档:004_mac与python3配置


执行完atom fibo.py之后,会打开一个新页面,我们在里面输入如下代码:

# Fibonacci numbers module

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while b < n:
        print(b, end=' ')
        a, b = b, a+b
    print()

def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while b < n:
        result.append(b)
        a, b = b, a+b
    return result

保存,关闭。
这样我们的第一个脚本就编写完了。
该脚本用来生成指定范围的斐波那契数列。


4. 调用模块(1)
使用import关键字就可以调用模块了。
打开pyhon交互模式,
然后试试调用自己编写的模块,也就是我们上面的那个fibo.py脚本文件

>>> import fibo                 #.py被省略。
>>> fibo.fib(100)               #fibo是脚本名,fib是脚本内的函数名。
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

fibo.fib(100)这句的意思是,调用fibo脚本内部的fib函数,参数是100 。
脚本名与函数名用连接。

问:为什么调用模块内的函数要这么麻烦呢?

答:因为我们以后写程序会导入很多模块,经常会碰到函数重名的问题。
为了解决这个问题,只好在函数名前指明是哪个模块的函数。
以后,你可能还会遇到模块也重名的情况。。。到时还会通过相似方法,指明这个模块是放在哪个文件夹的。
而这种以文件夹分类的方法就叫做包(Packages)
一个包里可以有多个模块。
相当于:一个文件夹里有多个以.py结尾的文本文件。
理解了吗?
而为了区分哪些文件夹是包,哪些不是,于是规定,文件夹里有名为:__init__.py的文件就是包。该文件可以是空文件,内部什么都可以不写。


5. 调用模块(2)
虽然我们借用其他模块的函数一般都是以如下形式
模块名.函数( )的形式,但是,有时模块名过长,并且该模块下的特定函数调用频繁。每次写起来都很麻烦。
为了解决这样的问题,在保证函数没有重名的情况下,可以用如下方法,只导入特定模块的特定函数。
以我们自己写的模块举例,从fibo模块导入fib( )和fib2( )两个函数,并调用。

>>> from fibo import fib, fib2
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377
>>> fib2(50)
[1, 1, 2, 3, 5, 8, 13, 21, 34]

6. 运行脚本
有时我们会需要在终端(shell)中直接运行我们的脚本。
我们需要怎么做呢?

我们先来了解两个知识点
知识点1
每个模块,都有一个名为:__name__的内置变量,它存储了模块的名字。

>>> import fibo
>>> fibo.__name__
'fibo'

我们自己写的模块也会有这个变量。
但是,当我们直接在终端(shell)中运行而不是在python交互环境中。这个变量存储的值就会变为:”__main__”
知识点2
sys模块的argv变量
详情参见http://www.jianshu.com/p/4269882480aa

如果你掌握了上面两个知识点,那么继续跟我往下看。
当我们在终端运行我们的脚本时,python解释器会执行我们写好的脚本,但我们什么信息也得不到。为什么呢?因为我们没有明确的函数调用。也就是说,我们只告诉了计算机,你都可以做什么。但是我们没有让他做。
这就好比你启动了计算器,虽然计算器可以运行加、减、乘、除,但它什么也不会做。因为我们没有明确告诉计算器做什么。

所以,我们要额外添加明确的指令。

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

结合上面的两个知识点,你看明白这段代码吗?

如果__name__变量的值为 “__main__”,则执行之后的操作。
导入sys模块,取得终端输入的参数,转化为int型,并将其作为参数,被fib( )函数调用。

那么,什么时候__name__变量的值为 “__main__”呢?
就是我们在知识点1中讲到的,当我们在终端直接调用脚本时。

所以,把上面的代码添加进我们自己写的脚本结尾,保存。
然后试着在终端调用它吧。

$ python3 fibo.py 50
1 1 2 3 5 8 13 21 34

可以参考下面的截图:

调用fibo.py脚本.png

解释下调用代码的意思。

  • $是终端的输入提示符。
  • python3是python解释器
  • fibo.py是我们写好的脚本
  • 50是函数用来调用的参数

7. 搜索路径
有的同学,虽然按照我说的做了,但可能会发现自己的脚本并不能被成功运行。
一个常见的原因就是:你的脚本放错了文件夹。

还记得我们之前讲解的环境变量吗?
你的python解释器会去指定路径的文件夹寻找文件,但如果你放在了其他文件夹,你的pyton解释器就会找不到你的脚本了。
所以,我们一般会把脚本文件放在你的主目录下。
在终端中,主目录一般会以波浪号表示。
我们可以通过在终端输入:

pwd

来查看我们当前的工作目录。

工作目录.png

我现在的工作目录就是我的主目录,它的实际位置是:
/Users/Galipy

所以,我的脚本文件都会存储在这个名为Galipy的文件夹里。

那么,python解释器都会搜索哪几个文件夹呢?
我们可以通过sys模块的path来查看

>>> import sys
>>> sys.path

我们会得到一个列表,列表里的元素值就是python解释器会搜索的路径了。

思考:既然我们的到的搜索路径是一个列表,那么如何让这个列表里添加其他路径值呢?
提示:append方法


以上就是你目前需要了解的关于模块的知识点了。

我们总结一下,你可以着重记忆一下:

  1. import 模块
    例如:import sys

  2. from 模块 import 函数或变量
    例如:from fibo import fib2

  3. __name__ == “__main__”
    例如:

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

好好背诵这三个知识点吧~

点赞