__init__.py 的使用

在python的模块化中,__init__.py 文件就是模块的入口,它告诉使用者那些功能会被导出和使用。有几种import的方式,每种方式都有它的优点和缺点。

假设一个package中有以下三个模块:
bread.py

def get_bread():
    print('A bread.')

coffee.py

def get_coffee():
    print('A cup of coffee.')

milk.py

def get_milk():
    print('Some milk.')

1. Wild import

如果我们的 __init__.py 是以下的样子:

from .bread import *
from .coffee import *
from .milk import *

那么三个模块中的所有方法或变量都会暴露给外界。使用如下:

import grocery
grocery.get_bread()

总结一下这种模块化的优缺点:

优点
  • 可暴露模块的所有功能。
  • 可以使用tab(自动补全)来查找功能。
  • 每一次更新模块功能的时候,不用再去手动修改 __init__.py 文件去包含新添加的功能,因为 * 会导入所有的内容。
缺点
  • 当这个package大了之后会不好维护,因为你不知道具体都导入了什么东西。
  • 需要解决重名问题,例如两个模块同时包含了 print() 函数。

2. Explicit import

如果我们的 __init__.py 是以下的样子:

from .bread import get_bread
from .coffee import get_coffee
from .milk import get_milk

使用这种方法可以只导入你想要暴露的内容。

优点
  • 明确想要暴露的内容。
缺点
  • 当增加了新功能时,需要去 __init__.py 添加功能的导出。
  • 当功能增多的时候,__init__.py 可能变得很大而不好维护。

3. Export modularly

如果我们的 __init__.py 是以下的样子:

from .bread import get_bread
from .coffee import get_coffee
from .milk import get_milk

如果使用这种方法定义导出的内容,就可以保留package中的模块结构。

import grocery

grocery.bread.get_bread()
优点
  • 保留模块结构有利于功能的归类和管理,用户在使用的时候也能更清楚地知道这个功能是从哪个模块引入的。
  • 用户可以导入需要的模块,而不是整个package。
  • __init__.py 文件会变得精简。
  • 可以解决模块之间重名的问题。
缺点
  • 随着package的拓展,结构也会变得复杂。用户需要参照文档来使用。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349