当前位置:   article > 正文

【python知识】__init__.py的来龙去脉_python创建init.py

python创建init.py

目录

一、说明

二、包-模块-函数结构

2.1 包、模块、函数的关系

2.2 __init__.py的角色

2.3 识别包

三、__init__.py的功效

3.1 建立一个工程包

3.2 用__init__.py简化工程包

3.3 过滤

3.4 设置顶级全局变量

四、其它更多用法

4.1 高级应用

4.3 Python 3.3 及更高版本中可以不要__init__.py


一、说明

        我们常见__init__.py文件,但说不清楚它的用途,在本文,我将首先把它的来龙去脉说清楚,然后告诉大家,如何编制python工程,培养全局的编程格局。

二、包-模块-函数结构

        在Python工程里,当python检测到一个目录下存在__init__.py文件时,python就会把它当成一个包来对待。其内部文件就是模块(module)。Module跟C++的命名空间和Java的Package的概念很像,都是为了科学地组织工程。

        关于包

        Python 定义了两种类型的包,常规包和命名空间包。常规包是传统包,因为它们存在于 Python 3.2 及更早版本中。常规包通常实现为包含 __init__.py 文件的目录。导入常规包时,隐式执行此 __init__.py 文件,并将其定义的对象绑定到包命名空间中的名称。 __init__.py 文件可以包含任何其他模块可以包含的相同 Python 代码,并且 Python 会在模块导入时添加一些额外的属性。

2.1 包、模块、函数的关系

概念意义表现形式备注
工程,命名空间;目录工程内包含许多模块
模块工程的部分文件python文件模块定义若干函数(或类)
函数用户的调用单元def 函数代码

        包、模块、函数的关系如下:

         包内部有多个模块,模块内部有多个函数。

2.2 __init__.py的角色

        __init__.py可以是一个空文件,也可以有非常丰富的内容。本文将举一个非常简单的例子,来介绍__init__.py的用法;

  • 1)一个目录下如果有一个 __init__.py说明这个目录是个工程包。
  • 2)在其它软件调用该工程包,势必先执行__init__.py文件,这与class内部的__init__函数是一致的。
  • 3)外部用户程序调用包内函数时,需要import中将路径清楚地告诉系统。

2.3 识别包

        它有助于导入其他 python 文件。当您将此文件放在包含其他 py 文件的目录(比如 stuff)中时,您可以执行类似 import stuff.other 的操作。

  1. root\
  2. stuff\
  3. other.py
  4. morestuff\
  5. another.py

        如果目录 stuff 中没有这个 __init__.py,您将无法导入 other.py,因为 Python 不知道 stuff 的源代码在哪里,也无法将其识别为包。

三、__init__.py的功效

3.1 建立一个工程包

  •         建立一个工程,起名为package。
  •         在package中建立两个文件,名称为add_sub.py, div_mul.py并编制代码如下:

文件add_sub.py内:

  1. # @file add_sub.py
  2. def add(a, b):
  3. return a + b
  4. def sub(a, b):
  5. return a - b
'
运行

文件div_mul.py内:

  1. # @file div_mul.py
  2. def mul(a, b):
  3. return a * b
  4. def dev(a, b):
  5. return a / b
'
运行

制作一个调用函数文件:

main.py代码如下:

  1. from package.add_sub import *
  2. from package.div_mul import *
  3. x = 101
  4. y = 33
  5. print( add(x,y))
  6. print( sub(x,y))
  7. print(dev(x,y))
  8. print(mul(x,y))
  9. >>>
  10. 134
  11. 68
  12. 3.0606060606060606
  13. 3333

        到此,工程包运行正常。

        但是有一个问题:

                from package.add_sub import *
                from package.div_mul import *

        这种调用模式是穷举的,如果有100个模块,那么,用户将写出100个import语句,如何简化之?

3.2 用__init__.py简化工程包

  • 在__init__.py编制代码:
  1. from package.add_sub import *
  2. from package.div_mul import *

 在main,py文件可以写成:

  1. from package import *
  2. x = 101
  3. y = 33
  4. print( add(x,y))
  5. print( sub(x,y))
  6. print(dev(x,y))
  7. print(mul(x,y))

这好比将客户端写的:

from package.add_sub import *
from package.div_mul import *

转移到init,然后将init作为笼统名称交代给main函数。

3.3 过滤

        在init中可以过滤模块的函数,具体实现是在init中加入列表:

                __all__ = ['add',‘mul’] 

        这样,客户端只能使用'add',‘mul’函数,不可用其它函数了。

3.4 设置顶级全局变量

        在init中设置变量:

                FOO = "Hello world"

        于是在导入包后,任何地方都可以用FOO变量。

四、其它更多用法

4.1 高级应用

  • 您可以在导入时使用 __init__.py 配置包。例如,您可以设置变量或执行包正常工作所需的其他初始化任务。
  • 您可以使用 __init__.py 来定义当有人使用 from package import * 时应该导入哪些符号。这是通过设置 __all__ 变量来完成的,该变量是包含应导入的符号名称的字符串列表。
  • 您可以使用 __init__.py 在包中定义子模块或子包。这是通过在包中创建子目录并将 __init__.py 文件也放置在这些目录中来完成的。这允许您将包组织成逻辑单元,并使其更易于使用和维护。
  • 您可以使用 __init__.py 来定义包的 API,它是一组函数、类和其他供公众使用的符号。这可以帮助您的包的用户了解他们可以使用什么以及如何使用它们。
  • 您可以使用 __init__.py 为您的包定义自定义导入挂钩或其他自定义行为。这对于高级用例很有用,例如实现对替代模块语法的支持或自定义包的导入方式。

4.3 Python 3.3 及更高版本中可以不要__init__.py

        在 Python 3.3 及更高版本中,不再需要 __init__.py 文件来定义包。这是因为作为导入系统核心的 importlib 模块已更新为自动检测包而无需 __init__.py 文件。这意味着您只需创建一个目录并将模块文件放入其中即可创建包,而无需创建 __init__.py 文件。见文章:

The '__init__.py' File: What Is It? How to Use It? (Complete Guide)

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小惠珠哦/article/detail/964240
推荐阅读
相关标签
  

闽ICP备14008679号