Python–包/模块/第三方库mengyb1、包与模块Python 中除了函数库以外还有非常多且优秀的第三方库、包、模块。模块(module) : 以.py为后缀的文件称之为 模块包(package) : 即文件夹传统包里有一个__init__.py文件。可以为空文件但一定要有该文件它是包的标志性文件在需要情况下可以在里面进行一些包的初始化工作。库 一定功能的代码集合 如os、sys、math等库-包-模块是从大到小的层级关系库 一个库可能由多个包和模块组成包一个包可能由多个模块组成模块一堆函数、类、变量的集合1.1、__init__.py作用__ init __.py 定义了包的「公共接口」隐藏内部模块结构让调用者更方便。(注意Python3.3之后发生了变化)1.1.1、示例my_project/ ├── main.py └── my_package/ ├── __init__.py ├── core/ │ ├── __init__.py │ ├── engine.py │ └── parser.py └── utils/ ├── __init__.py └── helper.py开始使用# 在 __init__.py 中集中管理# my_package/__init__.pyfrom.core.engineimportEnginefrom.core.parserimportParserfrom.utils.helperimportformat_data# main.py 可以直接使用不需要再去找frommy_packageimportEngine,Parser,format_data# 简单清晰这种方式对使用者非常友好你只需要暴露一个经过设计的、干净的 API 入口。1.1.2、使用__all__控制from package import *的行为当用户使用from my_package import *时Python 默认不会导入所有子模块。你可以通过__init__.py中的__all__变量来显式指定允许被导入的模块列表。# my_package/__init__.py# 定义 from my_package import * 时会导入哪些模块__all__[Engine,Parser,format_data]这是一种明确的 API 声明可以防止意外暴露内部实现细节。1.1.3、特殊用法只运行一次的“单例”初始化因为init.py 在包第一次被导入时只执行一次所以它非常适合用来创建“单例模式”的对象。# my_package/__init__.pyclassDatabaseConnection:def__init__(self):self.connectedTrue# 在包导入时创建一个唯一的数据库连接对象dbDatabaseConnection()# 对外暴露创建好的实例__all__[db]这样无论在项目的哪个地方导入 my_package.db拿到的都是同一个对象。1.1.4、注意事项空文件没问题但推荐利用它即使你的__init__.py是空的也请保留它。这能确保你的代码在所有 Python 版本下都被正确识别为包。把__init__.py当作包的“门面”使用相对导入from .module import something把内部模块的关键函数和类“提升”到包的最顶层。谨慎编写初始化代码记住这段代码在包被导入时就会运行。不要在__init__.py中执行耗时过长的操作否则会拖慢首次导入的速度。保持__init__.py简洁它主要用于导入和协调不要在里面写太多复杂的业务逻辑。业务逻辑应该放在模块.py文件中。使用__all__明确 API这可以提升代码的可读性也是一种良好的文档化实践。1.1.5、总结让python知道这是一个[包]只要目录中有__init__.py文件即使是空的python也会把这个目录当成包允许从里面导入模块是包的“入口文件”当包被导入时其中的代码会优先执行主要用于“暴露 API”简化用户的导入路径并提供包级别的初始化在__ init __.py中明确功能是谁你直接去就行了。__ init __.py定义了包的「公共接口」隐藏内部模块结构让调用者更方便。初始化全局配置如数据库连接的引入适合单例模式控制隐私禁止乱翻仓库引入包时如果用到*了则必须在__init__中用all声明公开接口否则会报错作用明确包的对外接口避免内部实现被误用就像给仓库加了「员工专用」门禁。2、创建模块# math_tools.pydefadd(a:int,b:int)-int:returnabdefdecrement(a:int,b:int)-int:returna-bif__name____main__:print(测试模块,add(3,7))3、导入模块3.1、基本语法# 导入整个模块importmodule_name# 导入模块的一个fun_name函数frommodule_nameimportfun_name# 导入整个模块并未模块命名为alias_nameimportmodule_nameasalias_name# 导入所有 (不推荐)frommodule_nameimport*3.2、示例importmath_toolsprint(math_tools.add(3,5))frommath_toolsimportdecrementprint(decrement(5,2))importmath_toolsasmtprint(mt.add(3,2))frommath_toolsimport*print(add(1,2))3.3、模块的__name__属性当模块被直接运行时__name__为__main__。当模块被导入时__name__为模块名。# 直接运行模块时执行测试代码if__name____main__:print(模块测试通过)4、包package包是一个包含多个模块的目录必须包含一个__init__.py文件可以是空文件用于标识当前目录是一个包。4.1、包结构my_package/ ├── __init__.py ├── module1.py └── subpackage/ ├── __init__.py └── module2.py4.2、包的引入方式# 导入包中的模块frommy_packageimportmodule1print(module1.fun())# 导入子包中的模块frommy_package.subpackageimportmodule2print(module2.fun())# 在 __init__.py 中预先导入可选# my_package/__init__.pyfrom.module1importfunc4.3、相对导入包内部使用在包内部的模块中可以使用相对路径导入其他模块# module2.py位于subpackage中from..module1importfunc# 从上级目录导入4.4、相关函数与工具4.4.1、重新加载模块importlib.reload()适用于调试importimportlib importlib.reload(math_tools)4.4.2、 动态导入模块较少使用__import__()module_namemath_toolsmath_tools__import__(module_name)4.4.3、sys.path查看模块搜索路径或添加自定义路径importsys sys.path.append(/path/to/module_directory)4.5、示例4.5.1、结构my_package/ ├── __init__.py ├── utils.py └── sub_package/ ├── __init__.py └── sort.py4.5.2、utils.pydefadd(a:int,b:int)-int:returnab4.5.3、sort.pydefarea(a:int)-double:returna**2*3.144.5.4、在外部使用包frommy_package.utilsimportaddfrommy_package.sub_packageimportareaprint(add(3,3))print(area(3))4.5.5、问题处理路径问题模块不在当前目录时手动添加路径importsys sys.path.append(/path/to/my_package)循环导入避免模块A导入模块B同时模块B导入模块A。解决方法将导入语句移到函数内部或重构代码。__init__.py的作用标识目录为包。定义__all__变量如__all__ [module1]控制from package import *的行为。执行包级别的初始化代码。绝对导入 vs 相对导入绝对导入from my_package.module import func相对导入from .submodule import func仅限包内部模块缓存Python会缓存导入的模块sys.modules重复导入时直接使用缓存。5、常见问题ModuleNotFoundError检查路径或包结构。ImportError确认导入语句是否正确避免循环导入。AttributeError确保模块中存在被导入的属性。
Python--包/模块/第三方库
Python–包/模块/第三方库mengyb1、包与模块Python 中除了函数库以外还有非常多且优秀的第三方库、包、模块。模块(module) : 以.py为后缀的文件称之为 模块包(package) : 即文件夹传统包里有一个__init__.py文件。可以为空文件但一定要有该文件它是包的标志性文件在需要情况下可以在里面进行一些包的初始化工作。库 一定功能的代码集合 如os、sys、math等库-包-模块是从大到小的层级关系库 一个库可能由多个包和模块组成包一个包可能由多个模块组成模块一堆函数、类、变量的集合1.1、__init__.py作用__ init __.py 定义了包的「公共接口」隐藏内部模块结构让调用者更方便。(注意Python3.3之后发生了变化)1.1.1、示例my_project/ ├── main.py └── my_package/ ├── __init__.py ├── core/ │ ├── __init__.py │ ├── engine.py │ └── parser.py └── utils/ ├── __init__.py └── helper.py开始使用# 在 __init__.py 中集中管理# my_package/__init__.pyfrom.core.engineimportEnginefrom.core.parserimportParserfrom.utils.helperimportformat_data# main.py 可以直接使用不需要再去找frommy_packageimportEngine,Parser,format_data# 简单清晰这种方式对使用者非常友好你只需要暴露一个经过设计的、干净的 API 入口。1.1.2、使用__all__控制from package import *的行为当用户使用from my_package import *时Python 默认不会导入所有子模块。你可以通过__init__.py中的__all__变量来显式指定允许被导入的模块列表。# my_package/__init__.py# 定义 from my_package import * 时会导入哪些模块__all__[Engine,Parser,format_data]这是一种明确的 API 声明可以防止意外暴露内部实现细节。1.1.3、特殊用法只运行一次的“单例”初始化因为init.py 在包第一次被导入时只执行一次所以它非常适合用来创建“单例模式”的对象。# my_package/__init__.pyclassDatabaseConnection:def__init__(self):self.connectedTrue# 在包导入时创建一个唯一的数据库连接对象dbDatabaseConnection()# 对外暴露创建好的实例__all__[db]这样无论在项目的哪个地方导入 my_package.db拿到的都是同一个对象。1.1.4、注意事项空文件没问题但推荐利用它即使你的__init__.py是空的也请保留它。这能确保你的代码在所有 Python 版本下都被正确识别为包。把__init__.py当作包的“门面”使用相对导入from .module import something把内部模块的关键函数和类“提升”到包的最顶层。谨慎编写初始化代码记住这段代码在包被导入时就会运行。不要在__init__.py中执行耗时过长的操作否则会拖慢首次导入的速度。保持__init__.py简洁它主要用于导入和协调不要在里面写太多复杂的业务逻辑。业务逻辑应该放在模块.py文件中。使用__all__明确 API这可以提升代码的可读性也是一种良好的文档化实践。1.1.5、总结让python知道这是一个[包]只要目录中有__init__.py文件即使是空的python也会把这个目录当成包允许从里面导入模块是包的“入口文件”当包被导入时其中的代码会优先执行主要用于“暴露 API”简化用户的导入路径并提供包级别的初始化在__ init __.py中明确功能是谁你直接去就行了。__ init __.py定义了包的「公共接口」隐藏内部模块结构让调用者更方便。初始化全局配置如数据库连接的引入适合单例模式控制隐私禁止乱翻仓库引入包时如果用到*了则必须在__init__中用all声明公开接口否则会报错作用明确包的对外接口避免内部实现被误用就像给仓库加了「员工专用」门禁。2、创建模块# math_tools.pydefadd(a:int,b:int)-int:returnabdefdecrement(a:int,b:int)-int:returna-bif__name____main__:print(测试模块,add(3,7))3、导入模块3.1、基本语法# 导入整个模块importmodule_name# 导入模块的一个fun_name函数frommodule_nameimportfun_name# 导入整个模块并未模块命名为alias_nameimportmodule_nameasalias_name# 导入所有 (不推荐)frommodule_nameimport*3.2、示例importmath_toolsprint(math_tools.add(3,5))frommath_toolsimportdecrementprint(decrement(5,2))importmath_toolsasmtprint(mt.add(3,2))frommath_toolsimport*print(add(1,2))3.3、模块的__name__属性当模块被直接运行时__name__为__main__。当模块被导入时__name__为模块名。# 直接运行模块时执行测试代码if__name____main__:print(模块测试通过)4、包package包是一个包含多个模块的目录必须包含一个__init__.py文件可以是空文件用于标识当前目录是一个包。4.1、包结构my_package/ ├── __init__.py ├── module1.py └── subpackage/ ├── __init__.py └── module2.py4.2、包的引入方式# 导入包中的模块frommy_packageimportmodule1print(module1.fun())# 导入子包中的模块frommy_package.subpackageimportmodule2print(module2.fun())# 在 __init__.py 中预先导入可选# my_package/__init__.pyfrom.module1importfunc4.3、相对导入包内部使用在包内部的模块中可以使用相对路径导入其他模块# module2.py位于subpackage中from..module1importfunc# 从上级目录导入4.4、相关函数与工具4.4.1、重新加载模块importlib.reload()适用于调试importimportlib importlib.reload(math_tools)4.4.2、 动态导入模块较少使用__import__()module_namemath_toolsmath_tools__import__(module_name)4.4.3、sys.path查看模块搜索路径或添加自定义路径importsys sys.path.append(/path/to/module_directory)4.5、示例4.5.1、结构my_package/ ├── __init__.py ├── utils.py └── sub_package/ ├── __init__.py └── sort.py4.5.2、utils.pydefadd(a:int,b:int)-int:returnab4.5.3、sort.pydefarea(a:int)-double:returna**2*3.144.5.4、在外部使用包frommy_package.utilsimportaddfrommy_package.sub_packageimportareaprint(add(3,3))print(area(3))4.5.5、问题处理路径问题模块不在当前目录时手动添加路径importsys sys.path.append(/path/to/my_package)循环导入避免模块A导入模块B同时模块B导入模块A。解决方法将导入语句移到函数内部或重构代码。__init__.py的作用标识目录为包。定义__all__变量如__all__ [module1]控制from package import *的行为。执行包级别的初始化代码。绝对导入 vs 相对导入绝对导入from my_package.module import func相对导入from .submodule import func仅限包内部模块缓存Python会缓存导入的模块sys.modules重复导入时直接使用缓存。5、常见问题ModuleNotFoundError检查路径或包结构。ImportError确认导入语句是否正确避免循环导入。AttributeError确保模块中存在被导入的属性。
