Python模块与包

Python模块与包

模块

模块是非常简单的Python文件,单个Python文件就是一个模块,两个文件就是两个模块。

import语句是用来导入模块或者从模块里导入特定的类或者函数。如前面我们用过的math模块,从而可以使用sqrt函数来计算距离。

假如有一个包含Database类的database.py的模块。现有另一个模块为product.py,它需要从database.py里实例化一个Database类,然后就可以在数据库中执行相关产品查询。

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">import database
db = database.Database() #数据库搜索操作</pre>

这时任何在database这个模块里面的类或者函数,都可以通过database.<something>这种激发访问。或者,也可以用from ... import语法来导入一个类。

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from database import Database
db = Database()</pre>

也可以将导入的类进行重命名

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from database import Database as DB # 重命名
db = DB()</pre>

也可以在一行里面导入多项,比如database还含有Query类

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from database import Database, Query</pre>

但是,很多教程与经验建议不要导入模块里面所有的类,如下的写法是不采用的。

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from database import * </pre>

组织模块

一个包(package)就是放在一个文件夹里的模块集合。包的名字就是文件夹的名字。我们需要做的是告诉python这个文件夹是一个包,并且把一个名为init.py的文件(通常是空的)放在这个文件夹里。如果我们忘记创建这个文件夹,就没法从这个文件夹里面导入那些模块。

例如在我们的工作目录里,把我们的模块放在了一个叫ecommerce(电子商务)的包里,这个目录同样包含一个main.py的文件用来启动程序。在ecommerce包里再添加一个payments的包用来管理不同的付款方式,文件夹的层次结构如下所示:

[
复制代码

](javascript:void(0); "复制代码")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">parent_directory/ main.py
ecommerce/
init.py
database.py
products.py
payments/
init.py
paypal.py
authorizenet.py</pre>

[
复制代码

](javascript:void(0); "复制代码")

其中producs.py的有Product类

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">class Product: pass</pre>

database.py有Database类

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">class Database: pass</pre>

模块的导入方式有两种:绝对导入和相对导入。

绝对导入

要先给出这个模块、函数的完整路径,如在main.py需要访问produces模块中的Product类,使用使用如下的方法进行绝对导入:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">import ecommerce.products
product = ecommerce.products.Product()</pre>

或者(个人比较喜欢这种方式):

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from ecommerce.products import Product
product = Product()</pre>

或者:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from ecommerce import products
product = products.Product()</pre>

import语句使用点号作为分隔符来分隔包或者模块。

上述的都可以使用,如果要导入一个模块中的很多类,使用使用第三种方法,如果是指导入一个模块的一两个类,则可以使用第二种方法具体指明。

相对导入

在包(package)的情况下,如果知道父模块的名称,那么就可以使用相对导入。比如当前在products模块下工作,想从隔壁的database模块导入Database类,就可以使用相对导入:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from .database import Database # 点号表示使用当前路径的database模块</pre>

如果我们正在编辑ecommerce.payments包里的paypal模块,需要引用父包里的database模块:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from ..database import Database # 使用两个点号表示访问上层的父类</pre>

如果ecommerce有contact包,该包里有email模块,需要将该模块的sendEmail函数导入到paypal模块中,

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from ..contact.email import sendEmail </pre>

数据访问权限

大部分的面向对象的编程语言都有一个“访问控制”的概念,比如私有的(private)、受保护的(protected)和公共的(public)。但python并没有这种强制规定。在技术层面上,一个类里的所有方法和属性都是公共可访问的,以下有三种形式建议不同的访问形式:

1、使用注释进行提示建议。如可以在docstring里面放一个提示来表明这个方法只是内部使用的

2、给某个属性或者方法加一个下划线的前缀,大部分python程序员会把这个解释为“这是个内部变量,使用之前要三思”

3、给某个属性或者方法添加一个双下划线的前缀,强烈建议为内部变量。访问时需要名称改编(name mangling),即在该方法或者属性前面自动加一个_<classname>的前缀(单下划线)。

一般情况下,不会使用加下划线或者双下划线的变量。

[
复制代码

](javascript:void(0); "复制代码")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">class SecretString: ''' A not-at-all secure way to store a secret string'''

def __init__(self, plain_string, pass_phrase):
    self.__plain_string = plain_string
    self.__pass_phrase = pass_phrase def decrypt(self, pass_phrase): ''' Only show the string if the pass_phrase is correct.'''
    if pass_phrase == self.__pass_phrase: return self.__plain_string
    else: return </pre>

[
复制代码

](javascript:void(0); "复制代码")

将上述代码存储为filename.py,然后使用python -i filename.py执行这个脚本,然后在交互的解释器里进行如下的测试:

[
复制代码

](javascript:void(0); "复制代码")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">>>> secret_string = SecretString("ACME: Top Secret", "antwerp") >>> print(secret_string.decrypt("antwerp"))
ACME: Top Secret >>> print(secret_string.__plain_text)
Traceback (most recent call last):
File "<stdin>", line 1, in <module> AttributeError: 'SecretString' object has no attribute '__plain_text'

print(secret_string._SecretString__plain_string)
ACME: Top Secret</pre>

[
复制代码

](javascript:void(0); "复制代码")

从包里直接导入变量

在ecommerce包里有两个模块,一个是database.py,另一个是products.py,假设database里面有一个db变量,这个变量在很多地方都会被访问,那么我们下面的代码将可以实现用import ecommerce.db取代import ecommerce.database.db。

通过在init.py文件(定义目录为包),在这里文件中可以包含任意变量或者类的生命,而且它会作为这个包的一部分被我们使用。在这个例子中,如果有ecommerce/init.py文件里包含这么一行:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from .database import db</pre>

那么我们就可以用下面的语句,在mian.py或者其他文件访问这个db属性了:

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from ecommerce import db</pre>

以上主要在于导致ecommerce.py这个文件是一个模块而不是包的原因在于init.py。

如果你把所有代码放在了一个单独的模块,之后又决定拆成一个包里的多个包,init.py文件同样对你有帮忙。

其他模块如果想要访问这个新包,init.py文件仍然是主要的切入点。但是在内部,代码仍然可以被组织成许多不同模块或者子包。

参考:

1、《Python3 面向对象编程》 [加]Dusty Philips 著

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

推荐阅读更多精彩内容