python中模块的__all__属性解读

python模块中的__all__属性,可用于模块导入时限制,如:
from module import *
此时被导入模块若定义了__all__属性,则只有__all__内指定的属性、方法、类可被导入。

若没定义,则导入模块内的所有公有属性,方法和类 。

 
  1. # kk.py

  2. class A():

  3. def __init__(self,name,age):

  4. self.name=name

  5. self.age=age

  6.  
  7. class B():

  8. def __init__(self,name,id):

  9. self.name=name

  10. self.id=id

  11.  
  12. def func():

  13. print 'func() is called!'

  14. def func1():

  15. print 'func1() is called!'

 
  1. #test_kk.py

  2. from kk import * #由于kk.py中没有定义__all__属性,所以导入了kk.py中所有的公有属性、方法、类

  3. a=A('python','24')

  4. print a.name,a.age

  5. b=B('python',123456)

  6. print b.name,b.id

  7. func()

  8. func1()

运行结果:
python 24
python 123456
func() is called!

func1() is called!

 
  1. #kk.py

  2. __all__=('A','func') #在别的模块中,导入该模块时,只能导入__all__中的变量,方法和类

  3. class A():

  4. def __init__(self,name,age):

  5. self.name=name

  6. self.age=age

  7.  
  8. class B():

  9. def __init__(self,name,id):

  10. self.name=name

  11. self.id=id

  12.  
  13. def func():

  14. print 'func() is called!'

  15. def func1():

  16. print 'func1() is called!'

 
  1. #test_kk.py

  2. from kk import * #kk.py中定义了__all__属性,只能导入__all__中定义的属性,方法和类

  3. a=A('python','24')

  4. print a.name,a.age

  5. func()

  6. #func1() #NameError: name 'func1' is not defined

  7. #b=B('python',123456) #NameError: name 'B' is not defined

运行结果:

python 24
func() is called!

 
  1. #kk.py

  2. def func(): #模块中的public方法

  3. print 'func() is called!'

  4.  
  5. def _func(): #模块中的protected方法

  6. print '_func() is called!'

  7.  
  8. def __func():#模块中的private方法

  9. print '__func() is called!'

 
  1. #test_kk.py

  2. from kk import * #这种方式只能导入公有的属性,方法或类【无法导入以单下划线开头(protected)或以双下划线开头(private)的属性,方法或类】

  3. func()

  4. #_func() #NameError: name '_func' is not defined

  5. #__func() #NameError: name '__func' is not defined

运行结果:
func() is called!

 
  1. __all__=('func','__func','_A') #放入__all__中所有属性均可导入,即使是以下划线开头

  2.  
  3. class _A():

  4. def __init__(self,name):

  5. self.name=name

  6.  
  7. def func():

  8. print 'func() is called!'

  9.  
  10. def func1():

  11. print 'func1() is called!'

  12.  
  13. def _func():

  14. print '_func() is called!'

  15.  
  16. def __func():

  17. print '__func() is called!'

 
  1. from kk import *

  2. func()

  3. #func1() #func1不在__all__中,无法导入 NameError: name 'func1' is not defined

  4. #_func() #_func不在__all__中,无法导入 NameError: name '_func' is not defined

  5. __func() #__func在__all__中,可以导入

  6. a=_A('python') #_A在__all__中,可以导入

  7. print a.name

运行结果:

func() is called!
__func() is called!
python

 
  1. #kk.py

  2. def func():

  3. print 'func() is called!'

  4.  
  5. def _func():

  6. print '_func() is called!'

  7.  
  8. def __func():

  9. print '__func() is called!'

 
  1. #test_kk.py

  2. from kk import func,_func,__func #可以通过这种方式导入public,protected,private

  3. func()

  4. _func() #NameError: name '_func' is not defined

  5. __func() #NameError: name '__func' is not defined

运行结果:
func() is called!
_func() is called!
__func() is called!

 
  1. #kk.py

  2. def func():

  3. print 'func() is called!'

  4.  
  5. def _func():

  6. print '_func() is called!'

  7.  
  8. def __func():

  9. print '__func() is called!'

 
  1. #test_kk.py

  2. import kk #也可以通过这种方式导入public,protected,private

  3. kk.func()

  4. kk._func() #NameError: name '_func' is not defined

  5. kk.__func() #NameError: name '__func' is not defined

运行结果:
func() is called!
_func() is called!

__func() is called!

 
  1. #kk.py

  2. import sys

  3.  
  4. __all__ = ["func"] # 排除了 'sys'

  5.  
  6. def func():

  7. print 'func() is called!'

 
  1. #test_kk.py

  2. from kk import *

  3.  
  4. #print sys.path #NameError: name 'sys' is not defined

  5. func()

运行结果:
func() is called!
如果一个模块需要暴露的接口改动频繁,__all__ 可以这样定义:
__all__ = [
    "foo",
    "bar",
    "egg",
]
最后多出来的逗号在 Python 中是允许的,也是符合 PEP8 风格的。

模块中不使用__all__属性,则导入模块内的所有公有属性,方法和类 。

模块中使用__all__属性,则表示只导入__all__中指定的属性,因此,使用__all__可以隐藏不想被import的默认值。

__all__变量是一个由string元素组成的list变量。
它定义了当我们使用 from <module> import * 导入某个模块的时候能导出的符号(这里代表变量,函数,类等)。
from <module> import * 默认的行为是从给定的命名空间导出所有的符号(当然下划线开头的变量,方法和类除外)。
需要注意的是 __all__ 只影响到了 from <module> import * 这种导入方式,
对于 from <module> import <member> 导入方式并没有影响,仍然可以从外部导入。

猜你喜欢

转载自blog.csdn.net/lovedingd/article/details/81536135