[转载] python中模块的__all__属性

参考链接: Python的__name __(特殊变量)

python模块中的__all__属性,可用于

模块导入时限制,如:

 from module import *

 此时被导入模块若定义了__all__属性,则只有__all__内指定的属性、方法、类可被导入。


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


# kk.py

class A():

    def __init__(self,name,age):

        self.name=name

        self.age=age

class B():

    def __init__(self,name,id):

        self.name=name

        self.id=id

def func():

    print 'func() is called!'

def func1():

    print 'func1() is called!'

#test_kk.py

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

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

print a.name,a.age

b=B('python',123456)

print b.name,b.id

func()

func1()运行结果:

 python 24

 python 123456

 func() is called!


func1() is called! 


#kk.py

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

class A():

    def __init__(self,name,age):

        self.name=name

        self.age=age

class B():

    def __init__(self,name,id):

        self.name=name

        self.id=id

def func():

    print 'func() is called!'

def func1():

    print 'func1() is called!'

#test_kk.py

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

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

print a.name,a.age

func()

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

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


运行结果: 

python 24 func() is called!  

#kk.py

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

    print 'func() is called!'


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

    print '_func() is called!'


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

    print '__func() is called!' 


#test_kk.py

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

func()

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

#__func() #NameError: name '__func' is not defined运行结果:

 func() is called! 


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

class _A():

    def __init__(self,name):

        self.name=name

def func():  

    print 'func() is called!'  


def func1():  

    print 'func1() is called!'  


def _func():  

    print '_func() is called!'  


def __func():  

    print '__func() is called!'  



from kk import *    

func()  

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

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

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

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

print a.name 


运行结果: 

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


#kk.py

def func():

    print 'func() is called!'


def _func():

    print '_func() is called!'


def __func():

    print '__func() is called!'

#test_kk.py

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

func()

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

__func() #NameError: name '__func' is not defined运行结果:

 func() is called!

 _func() is called!

 __func() is called! 



#kk.py

def func():

    print 'func() is called!'


def _func():

    print '_func() is called!'


def __func():

    print '__func() is called!'

#test_kk.py

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

kk.func()

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

kk.__func() #NameError: name '__func' is not defined运行结果:

 func() is called!

 _func() is called!


__func() is called! 


#kk.py

import sys

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

def func():

    print 'func() is called!'

#test_kk.py

from kk import *

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

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> 导入方式并没有影响,仍然可以从外部导入。 


 (完)

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 230,501评论 6 544
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 99,673评论 3 429
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 178,610评论 0 383
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,939评论 1 318
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 72,668评论 6 412
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 56,004评论 1 329
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 44,001评论 3 449
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 43,173评论 0 290
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 49,705评论 1 336
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 41,426评论 3 359
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 43,656评论 1 374
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 39,139评论 5 364
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,833评论 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 35,247评论 0 28
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 36,580评论 1 295
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 52,371评论 3 400
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 48,621评论 2 380

推荐阅读更多精彩内容