python自定义模块的写法 python自定义模块并调用

python自定义模块与第三方模块

1.自定义模块

1.1模块和包

python中一般对文件和文件的称呼(很多开发者平时开发中也有人称为模块)

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

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

• py2必须有，如果没有就会报错
• py3可有可无

1.2导入

导入，就是将模块或包加载到内存中，以后再去内存中去拿

关于导入路径：

在python内部默认设置了一些路径，导入模块和包时，会按照指定顺序查找

想要导入任意模块和包，都必须在如下路径下，才能找到(自己电脑的路径)

import os
print(sys.path)

['E:\\pycharm_shixun\\python数据分析\\模块二函数与模块\\day14模块和内置模块', 'E:\\pycharm_shixun\\python数据分析', 'E:\\Pycharmpage\\anzhuangdizhi\\PyCharm 2020.1\\plugins\\python\\helpers\\pycharm_display', 'D:\\python\\python38\\python38.zip', 'D:\\python\\python38\\DLLs', 'D:\\python\\python38\\lib', 'D:\\python\\python38', 'C:\\Users\\wangxiaoyu\\AppData\\Roaming\\Python\\Python38\\site-packages', 'D:\\python\\python38\\lib\\site-packages', 'D:\\python\\python38\\lib\\site-packages\\win32', 'D:\\python\\python38\\lib\\site-packages\\win32\\lib', 'D:\\python\\python38\\lib\\site-packages\\Pythonwin', 'E:\\Pycharmpage\\anzhuangdizhi\\PyCharm 2020.1\\plugins\\python\\helpers\\pycharm_matplotlib_backend']

可以再sys.path中添加指定路径，再导入

import sys
sys.path.append('路径')
import 路径

注意：

• 自己写的模块名称，不能和内置和第三方模块同名
• 项目执行文件一般在项目根目录，如果执行文件嵌套的内存目录，就需要自己手动在sys.path中添加路径



• pycharm默认会将项目目录加入到sys.path中
• 关于导入的方式：
  导入本质上是将某个文件中的内容先加载到内存中，然后再去内存中拿过来使用。
  常用的导入的方式有2类方式，每类方式都也多种情况。
• 第一类：import xxxx（开发中，一般多用于导入sys.path目录下的一个py文件）

• 模块级别(1个py文件)

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

import many
import commons.page
 import commons.tencent.sms

• 包级别(1个文件夹)

├── commons
 │   ├── __init__.py
 │   ├── convert.py
 │   ├── page.py
 │   └── utils.py
 ├── third
 │   ├── __init__.py
 │   ├── ali
 │   │   └── oss.py
 │   └── tencent
 │       ├── __init__.py
 │       ├── __pycache__
 │       ├── sms.py
 │       └── wechat.py
 └── run.py

import commons
   import third.tencent

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

• 成员级别(py文件里的函数等成员)

├── commons
│   ├── __init__.py
│   ├── convert.py
│   ├── page.py
│   └── utils.py
├── many.py
└── run.py
 
from commons.page import pagination
from commons.untils import encrypt,NAME
from many import show

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

• 模块级别(py文件)

├── commons
  │   ├── __init__.py
  │   ├── convert.py
  │   ├── page.py
  │   └── utils.py
  ├── many.py
  └── run.py
  
  from commons import page
  from commons import utils

• 包级别(文件夹)

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

1.3 相对导入

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

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

1.4 导入别名

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

from commons.page import pagination as pag
import x1.x2 as pg

1.5 主文件

• 执行一个py文件时

__name__ = "__main__"

• 导入一个py文件时

__name__ = "模块名"#模块名==py文件名

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

├── 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
def start():
    v1 = many.show()
if __name__ == '__main__':
    start()

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

2. 第三方模块下载

Python内部提供的模块有限，所以在平时在开发的过程中，经常会使用第三方模块。

3种安装第三方模块的方式。

2.1 pip（最常用）

pip3 install 模块名称

这是Python中最最最常用的安装第三方模块的方式。

pip其实是一个第三方模块包管理工具，默认安装Python解释器时自动会安装，默认目录：

MAC系统，即：Python安装路径的bin目录下
	/Library/Frameworks/Python.framework/Versions/3.9/bin/pip3
	/Library/Frameworks/Python.framework/Versions/3.9/bin/pip3.9
	
Windows系统，即：Python安装路径的scripts目录下
	C:\Python39\Scripts\pip3.exe
	C:\Python39\Scripts\pip3.9.exe

提示：为了方便在终端运行pip管理工具，我们也会把它所在的路径添加到系统环境变量中。

没有找到pip，也可以自己手动安装：

• 下载 get-pip.py 文件，到任意目录

地址：https://bootstrap.pypa.io/get-pip.py

• 打开终端进入目录，用Python解释器去运行已下载的 get-pip.py文件即刻安装成功。

默认安装的是最新的版本，如果想要指定版本：

pip3 install 模块名称==版本

2.1.1 pip更新

2.1.2 豆瓣源

• 一次性使用

pip3.9 install 模块名称  -i  https://pypi.douban.com/simple/

• 永久使用

• 配置

# 在终端执行如下命令
pip3.9 config set global.index-url https://pypi.douban.com/simple/

# 执行完成后，提示在我的本地文件中写入了豆瓣源，以后再通过pip去安装第三方模块时，就会默认使用豆瓣源了。
# 自己以后也可以打开文件直接修改源地址。
Writing to /Users/wupeiqi/.config/pip/pip.conf

阿里云：http://mirrors.aliyun.com/pypi/simple/
中国科技大学：https://pypi.mirrors.ustc.edu.cn/simple/ 
清华大学：https://pypi.tuna.tsinghua.edu.cn/simple/
中国科学技术大学：http://pypi.mirrors.ustc.edu.cn/simple/

2.2 源码

如果要安装的模块在pypi.org中不存在 或 因特殊原因无法通过pip install 安装时，可以直接下载源码，然后基于源码安装，例如：

• 下载requests源码（压缩包zip、tar、tar.gz）并解压。

下载地址：https://pypi.org/project/requests/#files

• 进入目录
• 执行编译和安装命令

python3 setup.py build
python3 setup.py install

2.3 wheel

wheel是Python的第三方模块包的文件格式的一种，我们也可以基于wheel去安装一些第三方模块。

• 安装wheel格式支持，这样pip再安装第三方模块时，就可以处理wheel格式的文件了。

pip3.9 install wheel

• 下载第三方的包（wheel格式），例如：https://pypi.org/project/requests/#files

无论通过什么形式去安装第三方模块，默认模块的安装路径在：

Max系统：
	/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages
Windows系统：
	C:\Python39\Lib\site-packages\

3.开发规范

2.1单文件应用

基于文件开发应用（1个文件），注意点

2.2 单可执行文件

新创建一个项目，假设名字叫 【crm】，可以创建如下文件和文件夹来存放代码和数据。

crm
├── app.py        文件，程序的主文件（尽量精简）
├── config.py     文件，配置文件（放相关配置信息，代码中读取配置信息，如果想要修改配置，即可以在此修改，不用再去代码中逐一修改了）
├── db            文件夹，存放数据
├── files         文件夹，存放文件
├── src           包，业务处理的代码
└── utils         包，公共功能

2.3 多可执行文件

新创建项目，假设名称叫【killer】，可以创建如下文件和文件夹来存放代码和数据。

killer
├── bin					文件夹，存放多个主文件（可运行）
│   ├── app1.py
│   └── app2.py
├── config              包，配置文件
│   ├── __init__.py
│   └── settings.py
├── db                  文件夹，存放数据
├── files               文件夹，存放文件
├── src                 包，业务代码
│   └── __init__.py
└── utils               包，公共功能
    └── __init__.py