python文件编写的一个规范
在py文件中应该只包含功能,也就是不会运行的函数代码,而功能的测试代码应该放在一个条件语句内。
def func1(): pass def func2(): pass def func3(): pass def func4(): pass if __name__ == ‘__main__’ test #测试代码
__name__是一个系统变量,如果只有一个py文件,它的值就是 ‘main’,把测试代码放在这个判断内部,可以保证其它py文件引入这个py文件的时候,不会执行测试代码(只引用功能,不运行测试代码)。
模块
一个.py文件就是一个模块,即Module。
模块分为三种:python标准库、第三方模块、应用程序自定义模块。
# import语句 – 导入模块 # Directory – 文件夹(空的) # Package – 比文件夹多了一个__init__.py """ file: cal.py """ def add(x, y) return x+y def sub(x, y) return x-y print(‘hello cal’) """ file: test.py """ import cal print(cal.add(1, 2))
import做了什么?
import导入模块的时候,首先会把导入的文件执行一遍,比如说我们运行test.py的时候,print(‘hello cal’)也会被执行,因为import cal的时候就把cal.py运行了一遍。所以,我们在模块文件中只写功能(也就是函数),而不要写可执行的语句。
- 执行被引入的py文件,即使只引入一个变量(from cal import add
),也会运行整个文件。 - 引入变量名 → 文件名变量
# 引入多个模块 import cal, time # 只引入一个方法 from cal import add print(add(1, 2)) #可以直接使用add,不用加cal. #引入所有方法 – 不推荐使用,你并不知道都引入了哪些变量,可能会出现本文件变量与引入变量名字重复的情况。 from cal import * #新的变量名会覆盖旧的变量名 #+++++++++++++++++++++++++++ from cal import * def add(x, y) return x+y+100 print(add(1, 2)) #+++++++++++++++++++++++++++ def add(x, y) return x+y+100 from cal import * print(add(1, 2)) #+++++++++++++++++++++++++++
import搜索路径
import sys print(sys.path) #查看路径
path中包含python自己定义的路径,以及当前执行的py文件的路径,也就是说当前执行路径会被自动加入到sys.path中,import就是按照这些路径去搜索被引入的变量的。
也可以通过手动添加路径
from path import cal #path就是cal所在的路径
import导入模块的原理 ★
首先import会根据路径找到文件,根据路径找到模块后把模块加载到内存中执行一遍,执行的时候是把模块的内容拷贝到当前文件执行。import导入是将模块从磁盘中把磁盘文件导入到内存中,这个速度是比较慢的,实际上,在导入时会有一个导入缓存,同一个模块在导入第一次的时候会有一个缓存,以后再导入都是用的缓存的导入,所以有时候你可能遇到这样的问题,被导入的文件已经删除了,但是程序还是能运行,这是因为程序使用的是缓存的导入模块。
from path import mode,它相当于把路径进行了一次拼接path\mode.py,这是from的工作。
路径拼接是在当前执行文件的路径基础上进行拼接。
当引入了很多模块的时候,一个目录下会有很多py文件,一般把bin.py作为要执行的文件,也就是整个程序的入口。而逻辑主文件叫做main.py,这里面包含了程序的主要逻辑,其他功能都放到其它文件中作为一个模块。我们在运行的时候,运行bin.py,由bin.py去调用main.py中的主逻辑。也就是说只有bin是可执行的,其余文件都不应作为执行文件。
前面说过,sys.path中只会加入当前运行程序所在的路径,bin.py是整个程序的运行文件,也就是说sys.path中只会加入bin.py的路径,假如说文件有如下导入关系
假如说main.py和cal.py在同一级目录,那么不用加路径即可导入,但是如果bin.py和这两个文件不在同一级目录(比如在上一级目录),那么bin.py导入main.py的时候就要加上main.py的路径,但是这样在执行的时候会报错,因为bin.py间接导入了cal.py,并且bin.py只加了main.py的路径而没有加cal.py的路径,前面说过sys.py只会包含当前运行路径,也就是bin.py的路径。
解决方法有两个:
- 在main.py中加上cal.py的路径from path import cal;
- 把路径加到sys.path中;
file 获取当前文件名
os.path.dirname(__file__) #获取当前文件路径 os.path.dirname(os.path.dirname(__file__)) #获取当前文件的上一级路径
pycharm会自己根据当前文件名获取绝对路径,并把绝对路径通过os.path.dirname()返回给我们os.path.dirname(file),但是在终端运行的时候,终端并没有这个功能,我们需要自己去找到绝对路径,然后根据绝对路径找到文件名,并反推出上一级目录。
p = os.path.dirname(__file__) #获取当前文件的绝对路径 BASEDIR = os.path.dirname(os.path.dirname(p)) sys.psth.append(BASEDIR)
实际上,这三步的操作相当于把当前运行文件的上一级目录通过相对路径的方式添加到了环境变量。如果我们以绝对路径的方式添加环境变量,当我们换了电脑或者环境,环境变量就失效了。我们这样通过程序找出相对路径来添加到环境变量,只要将当前整个工程一块拷贝到别的机器,就一定可以找到这个环境变量。
包
包含一个__init__.py文件,用于组织模块,可以把功能相似的模块放在同一个包中,并且不同包或者不同层级的目录下可以有相同名字的文件,这样可以避免模块名称冲突(不同包的路径不同,所以可以避免名称冲突)。
包的导入和模块的导入方法相同,如果是嵌套多层包,用.来导入。
_ name _
如果在执行文件中打印print( _ name _ ),那么它的值就是字符串__main__,如果在执行文件的调用文件(被import导入的文件)中打印print(_ name_),那么打印出来的值就是这个被调用模块的路径。
使用场景一:
在被调用模块中加测试代码时可以用到
cal.py if __name__ = ‘__main__’ #测试逻辑
这样做的目的是,我们在调试或测试cal.py模块的时候,可以直接运行测试逻辑,因为我们运行cal.py的时候,该文件就是执行文件,_ name_ = ‘_ main_’满足。当我们使用其它py文件导入该模块cal.py的时候,直接导入即可,此时__name__是cal.py的路径,下面的测试逻辑就不会执行了,因为此时运行文件变了,这样我们可以实现,在保留模块的测试文件的前提下就可以直接导入模块使用,并且模块的测试代码不会运行。
使用场景二:
在bin.py中所有的逻辑前加if _ name_ = ‘_ main_’,这么做的目的是,不希望自己的运行文件作为其它文件的被调用文件,防止其它文件执行自己的主逻辑。
总之,当import导入一个模块的时候会运行这个模块对应的py文件,通过if _ name_ = ‘_ main_’可以防止模块中的可执行代码被执行。