2-3-02 模块-自定义模块

1.1 模块和包

在开发简单的程序时，使用一个py文件就可以搞定，如果程序比较庞大，需要些10w行代码，此时为了，代码结构清晰，将功能按照某种规则拆分到不同的py文件中，使用时再去导入即可。另外，当其他项目也需要此项目的某些模块时，也可以直接把模块拿过去使用，增加重用性。

在Python中一般对文件和文件的称呼（很多开发者的平时开发中也有人都称为模块）

• 一个py文件，模块（module）
• 含多个py文件的文件夹，包（package）

注意：在包（文件夹）中有一个默认内容为空的__init__.py的文件，一般用于描述当前包的信息（在导入他下面的模块时，也会自动加载）。

• py2必须有，如果没有导入包就会失败。
• py3可有可无。

1.2 导入

导入，其实就是将模块或包加载的内存中，以后再去内存中去拿就行。

关于导如时的路径：

在Python内部默认设置了一些路径，导入模块或包时，都会按照指定顺序逐一去特定的路径查找。

import sys
print(sys.path)

[
    '当前执行脚本所在的目录', /Users/wupeiqi/PycharmProjects/luffyCourse/day14/bin
	/Users/wupeiqi/PycharmProjects/luffyCourse/day14
    '/Applications/PyCharm.app/Contents/plugins/python/helpers/pycharm_display',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python39.zip',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/lib-dynload',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages',
    '/Applications/PyCharm.app/Contents/plugins/python/helpers/pycharm_matplotlib_backend'
    
]

想要导入任意的模块和包，都必须写在如下路径下，才能被找到。

也可以自动手动在sys.path中添加指定路径，然后再导入可以，例如：

import sys
sys.path.append("路径A")

import xxxxx  # 导入路径A下的一个xxxxx.py文件

1. 你以后写模块名称时，千万不能和内置和第三方的同名（新手容易犯错误）。

2. 项目执行文件一般都在项目根目录，如果执行文件嵌套的内存目录，就需要自己手动在sys.path中添加路径。
   

3. pycharm中默认会将项目目录加入到sys.path中

关于导入的方式

导入本质上是将某个文件中的内容先加载到内存中，然后再去内存中拿过来使用。而在Python开发中常用的导入的方式有2类方式，每类方式都也多种情况。

• 第一类：import xxxx（开发中，一般多用于导入sys.path目录下的一个py文件）
  模块级别
  

包级别

第二类：from xxx import xxx 【常用】，一般适用于多层嵌套和导入模块中某个成员的情况。

成员级别

• 提示：基于from模式也可以支持 from many import *，即：导入一个模块中所有的成员（可能会重名，所以用的少）。

模块级别

包级别

1.3 相对导入

在导入模块时，对于 from xx import xx这种模式，还支持相对到导入。例如：

切记，相对导入只能用在包中的py文件中（即：嵌套在文件中的py文件才可以使用，项目根目录下无法使用）。

1.4 导入别名

如果项目中导入 成员/模块/包 有重名，那么后导入的会覆盖之前导入，为了避免这种情况的发生，Python支持重命名，即：

from xxx.xxx import xx as xo
import x1.x2 as pg

除此之外，有了as的存在，让 import xx.xxx.xxxx.xxx 在调用执行时，会更加简单（不常用，了解即可）。

• 原来

  import commons.page
  
  v1 = commons.page.pagination()
  

• 现在

  import commons.page as pg
  
  v1 = pg.pagination()
  

1.5 主文件

• 执行一个py文件时

  __name__ = "__main__"
  

• 导入一个py文件时

  __name__ = "模块名"
  

主文件，其实就是在程序执行的入口文件，例如：

├── commons
│   ├── __init__.py
│   ├── convert.py
│   ├── page.py
│   ├── tencent
│   │   ├── __init__.py
│   │   ├── sms.py
│   │   └── wechat.py
│   └── utils.py
├── many.py
└── run.py

我们通常是执行 run.py 去运行程序，其他的py文件都是一些功能代码。当我们去执行一个文件时，文件内部的 __name__变量的值为 __main__，所以，主文件经常会看到：

import many
from commons import page
from commons import utils


def start():
    v1 = many.show()
    v2 = page.pagination()
    v3 = utils.encrypt()


if __name__ == '__main__':
    start()

只有是以主文件的形式运行此脚本时start函数才会执行，被导入时则不会被执行。

小结

1. 模块和包的区别

2. 导入模块的两种方式：

   import xx
   from xxx import xxx
   

3. 相对导入，需要有包名称。

4. 模块重名可以通过as取别名。

5. 执行py文件时，内部__name__=="__main__"，导入模块时，被导入的模块 __name__="模块名"

6. 在项目开发中，一般在主文件中会写上 main （主文件标记，不是绝对的，因为其他文件在开发调试时候有时候也可能有main）。