Python在处理功能复用和功能颗粒度划分时采用了类、模块、包的结构。
模块
模块，在Python可理解为对应于一个文件。在创建了一个脚本文件后，定义了某些函数和变量。你在其他需要这些功能的文件中，导入这模块，就可重用这些函数和变量。一般用module_name.fun_name，和module_name.var_name进行使用。这样的语义用法使模块看起来很像类或者命名空间
模块分为三种：
- 自定义模块
- 内置标准模块
- 开源模块（第三方）
模块属性__name__:
值由Python解释器设定。如果脚本文件是作为主程序调用，其值就设为main，如果是作为模块被其他文件导入，它的值就是其文件名。
#moduel1.py
def say(word):
print word]
#caller.py
import module1
print __name__
print module1.__name__
module1.say('hello')
>>>>
__main__
module1
hello
模块搜索路径
Python import module 的搜索路径由sys.path指定，实质为一个列表，列表索引先后决定搜索优先级。
sys.path列表优先级排序:
第一优先级为当前执行脚本的目录
第二优先级为PYTHONPATH；
第三优先级为安装位置。
通过函数添加自编译的模块
- sys.path.append(PATH/filename) 加在sys.path的最后
- sys.path.insert(0,PATH/filename) 加在sys.path的最前
其实增加自编译的模块较为官方的方法是通过.pth文件添加:
Ubuntu第三方模块目录名为：dist-packages
Windows和Redhat第三方模块目录名为：site-packages
在site-packages/ dist-packages添加一个路径文件，如mypkpath.pth，必须以.pth为后缀，写上你要加入的模块文件所在的目录名称就是了。
导入模块四种方法
import module1,module2
from 模块名 import 函数名
from 模块名 import 函数名 as 函数别名
import 模块名 as 函数别名
包
包名的 命名方式 和变量名一致，小写字母 + _
如果您将一个或多个模块放在 文件中，那么您有一个包。简而言之，包本质上是一个包含代码的文件夹。包实际上只是一个目录，但是所有包都必须包含一个__init__.py 文件。该文件告诉Python将目录视为包含包
常见的包结构如下：
image.png
最简单的情况下，只需要一个空的 init.py 文件即可。
导入包的方法:
import 包名.模块名
from 包名 import 模块名
import 包名(注意__init__.py函数的内容)
注意: 第一种 from 包名 import 模块名，不用在包里的__init__写入 import 模块名
pip 安装第三方模块
第三方模块 通常是指由 知名的第三方团队 开发的 并且被 程序员广泛使用 的 Python 包 / 模块
-
pip 是一个现代的，通用的 Python 包管理工具
提供了对 Python 包的查找、下载、安装、卸载等功能 -
安装和卸载命令如下：
# 将模块安装到 Python 2.x 环境
$ sudo pip install pygame
$ sudo pip uninstall pygame
# 将模块安装到 Python 3.x 环境
$ sudo pip3 install pygame
$ sudo pip3 uninstall pygame
发布模块
如果希望自己开发的模块，分享 给其他人，可以按照以下步骤操作：
1. 创建 setup.py
-
setup.py的文件
安装、部署、打包的脚本。在 setup.py 文件中写明依赖的库和版本，以便到目标机器上能够使用python setup.py install安装。
from distutils.core import setup
setup(name="hm_message", # 包名
version="1.0", # 版本
description="itheima's 发送和接收消息模块", # 描述信息
long_description="完整的发送和接收消息模块", # 完整描述信息
author="itheima", # 作者
author_email="itheima@itheima.com", # 作者邮箱
url="www.itheima.com", # 主页
py_modules=["hm_message.send_message",
"hm_message.receive_message"])
有关字典参数的详细信息，可以参阅官方网站：https://docs.python.org/2/distutils/apiref.html
2. 构建模块
$ python3 setup.py build
3. 生成发布压缩包
$ python3 setup.py sdist
注意：要制作哪个版本的模块，就使用哪个版本的解释器执行！
项目结构
对于开发人员而言，可以遵循一系列准则，以确保为每个项目形成良好的结构。这创造了一种通常被大多数程序员接受的通用方法。这样做的好处是每个人都学会按照这些指导方针工作，从而消除了在查看人员项目时可能发生的许多混乱。
-
myproject(项目名)/
__init__.py该文件告诉Python将目录视为包含包
__main__.py写主要逻辑
test/一个常犯的错误是将单元测试部分代码放在包目录的外面。这些测试实际上应该被包含在软件的子包中 -
自述文件 -拥有一段文本可以让其他开发人员和潜在用户受益。它还为开发人员提供了一种传达程序特定内容的方法，例如某个特性。README.rst /README.md
-
requirements.txt - 此文件列出项目所需的任何第三方依赖项。它让其他人知道为了处理项目需要哪些库。简单来说，它是一个pip安装要求列表。
示例:
Flask == 0.12
Jinja == 2.9.5
MarkupSafe == 0.23
Werkzeug == 0.11.15
argparse == 1.2.1
click == 6.7
wsgiref == 0.1.2
- setup.py - 安装、部署、打包的脚本。在 setup.py 文件中写明依赖的库和版本，以便到目标机器上能够使用python setup.py install安装。
- scripts/ 项目用到的各种脚本
下面这些顶层目录也经常出现：
- docs/ 项目文档 ,一般来说里面还包含config.py
- etc/ 用来存放配置文件的样例
- tools/ 用来存放与工具有关的shell脚本
- bin/ 用来存放将被setup.py安装的二进制脚本
- data/ 用来存放其他类型的文件，如媒体文件
如果需要发行自己的模块,那么顶层目录还需要下面三个文件:
-
setup.cfg： 包含 setup.py 默认命令选项的 ini 文件
-
LICENSE.txt 项目许可说明文件。--如果需要使用setuptools等工具进打包发行, 那么需要一个许可文件。
-
MANIFEST.in：装箱清单文件 ,当需要打包源码中不自动包含的附加文件时使用
快速生成项目结构工具
这里介绍两款工具： hatch、cookiecutter
cookiecutter使用
一、按流程生成项目
- 1、安装
$ pip install --user cookiecutter
- 2、然后，克隆一个Cookiecutter项目模板：
# 按提示输入内容即可,可以去寻找相应工程模板,如果Django项目结构是 https://github.com/pydanny/cookiecutter-django
$ git clone https://github.com/audreyr/cookiecutter-pypackage.git
- 3、修改cookiecutter.json中定义的变量。然后生成你的项目打开骨架项目。如果您需要稍微更改它，请执行此操作。
{
"full_name": "Audrey Roy Greenfeld",#版权所有者命名
"email": "644812368@qq.com",
"github_username": "LittleTrue", #项目模板作者名
"project_name": "Python SpiderTest", #项目名
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
"project_short_description": "Python Boilerplate contains all the boilerplate you need to create a Python package.", #项目描述
"pypi_username": "{{ cookiecutter.github_username }}",
"version": "0.1.0", #项目版本
"use_pytest": "n",
"use_pypi_deployment_with_travis": "y",
"add_pyup_badge": "n",
"command_line_interface": [
"Click",
"No command-line interface"
],
"create_author_file": "y",
"open_source_license": [
"MIT license",
"BSD license",
"ISC license",
"Apache Software License 2.0",
"GNU General Public License v3",
"Not open source"
]
}
cookiecutter cookiecutter-pypackage/
二、直接生成项目
cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git
也可以直接使用上面命令代替上面2,3步, 不过生成项目时，系统将提示您输入一组值，例如full_name，email和project_name。输入您的信息，或者只需按返回/输入即可接受默认值。
此信息将用于填写项目的空白。例如，您的姓名和年份将被放入LICENSE文件中。
三、cookiecutter-pypackage.git默认样本文件
AUTHORS.rst MANIFEST.in docs tox.ini
CONTRIBUTING.rst Makefile requirements.txt
HISTORY.rst README.rst setup.py
LICENSE boilerplate tests
这些文件对应github.com:audreyr/cookiecutter-pypackage.git上文件名为{{cookiecutter.project_slug}}的目录里的文件
四、定制私人项目模板
您可能还想创建一个repo，以不同的名称命名，并将其作为您自己的新Cookiecutter项目模板推送，以方便将来使用
定制自己的项目模板带github或本地,是更高级的学习
参考
使用问题
1、构建时设置的cookiecutter.json中的值会在构建时按ENTER当成默认值
2、如果cookiecutter命令失效,需要配环境变量 ,把C:\Users\LittleTrue\AppData\Roaming\Python\Python37\Scripts 加入系统Path变量
网友评论