模块和包

如何使用模块

示例：自定义模块my_module.py,文件名my_module.py,模块名my_module

#my_module.py
print('from the my_module.py')

money=1000

def read1():
    print('my_module->read1->money',money)

def read2():
    print('my_module->read2 calling read1')
    read1()

def change():
    global money
    money=0

 

模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入import语句时才执行(import语句是可以在程序中的任意位置使用的，且如果针对同一个模块import多次，为了防止你重复导入，python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅仅是对已经加载到内存中的模块对象增加了一次引用，不会重新执行模块内的语句)，如下：

#demo.py
import my_module
#只在第一次导入时才执行my_module.py内的代码，此处的显示效果是只打印一次‘from the my_module.py’，当然其他的顶级代码也都执行了，只不过没有显示效果
import my_module
import my_module
import my_module

'''
执行结果：
from the my_module.py

'''

 

 

为什么模块不会被重复导入：

我们再导入一个sys模块，来看一下为什么模块不会被重复导入：

#demo.py
import my_module

import sys

print(sys.modules.keys())

#执行结果：

from the my_module.py
dict_keys(['errno', 'codecs', 'sre_constants', 'sre_compile', 'encodings.mbcs', '_codecs', 'encodings', '_thread', 'stat', '_weakrefset', 'encodings.utf_8', '_stat', 'sre_parse', 'nt', 'zipimport', '__main__', 're', 'ntpath', '_imp', 'encodings.gbk', '_warnings', 'sysconfig', 'genericpath', 'io', 'abc', '_sre', '_locale', 'os.path', 'builtins', '_weakref', '_collections_abc', '_sitebuiltins', 'sys', '_io', 'encodings.cp437', '_frozen_importlib', 'encodings.aliases', 'sitecustomize', 'copyreg', 'site', 'winreg', 'os', '_frozen_importlib_external', '_signal', 'marshal', '_bootlocale', '_multibytecodec', 'my_module', '_codecs_cn', 'encodings.latin_1'])

我们可以从sys.modules中找到当前已经加载的模块，sys.modules是一个字典，内部包含模块名与模块对象的映射，所以sys.modules.keys()是这个字典的所有键，可见my_modules在这个字典的键中，该字典决定了导入模块时是否需要重新导入，python检查模块是否已经导入流程是这样的：先从sys.modules里查看模块是否已经被导入，如果没有（就说明这个模块还没有被导入），就依据sys.path路径去寻找模块，找到了，就导入，然后创建这个模块的命名空间，执行文件，把模块中的名字都放到命名空间里去，没找到，就报错

 

每个模块都是一个独立的命名空间，定义在这个模块中的函数把这个模块的命名空间当作全局命名空间，这样我们在编写自己的模块时，就不用担心我们定义在自己模块中全局变量会在被导入时与使用者的全局变量冲突。

#demo.py

import my_module
money=10
print(my_module.money)

'''
执行结果：
from the my_module.py
1000
'''

#demo.py

import my_module
def read1():
    print('****')
my_module.read1()

'''
执行结果：
from the my_module.py
my_module-->read1-->money 1000
'''

import my_module
money=1
my_module.change()
print(my_module.money)
print(money)

'''
执行结果：
from the my_module.py
0
1
'''

 

总结：首次导入模块my_module时会做三件事：

1.为源文件(my_module模块)创建新的名称空间，在my_module中定义的函数和方法若是使用到了global时访问的就是这个名称空间。

2.在新创建的命名空间中执行模块中包含的代码，详见文章开头的举例

 提示:导入模块时到底执行了什么？

 In fact function definitions are also ‘statements’ that are ‘executed’; the execution of a module-level function definition enters the function name in the module’s global symbol table.
 事实上函数定义也是“被执行”的语句，模块级别函数定义的执行将函数名放入模块全局名称空间表，用globals()可以查看

3.创建名字my_module来引用该命名空间

这个名字和变量名没什么区别，都是‘第一类的’，且使用my_module.名字的方式可以访问my_module.py文件中定义的名字，my_module.名字与test.py中的名字来自两个完全不同的地方。

 

为模块起别名，相当于m1=1；m2=m1

import my_module as sm
print(sm.money)

 

示例用法一:

有两中sql模块mysql和oracle，根据用户的输入，选择不同的sql功能

#mysql.py
def sqlparse():
    print('from mysql sqlparse')
#oracle.py
def sqlarse():
    print('from oracle sqlparse')
    
#test.py
db_type=input('>>:')
if db_type=='mysql':
    import mysql as db
elif db_type=='oracle':
    import oracle as db
    
db.sqlparse()

#这样无论使用哪种数据库都只要使用db就行了

 

示例用法二：

为已经导入的模块起别名的方式编写可扩展的代码很有用，假设有两个模块xmlreader.py和csvreader.py。它们都定义了函数read_data(filename):用来从文件中读取一些数据，但采用不同的输入格式。可以编写代码来选择性的挑选读取的模块，例如：

if file_format == 'xml':
     import xmlreader as reader
elif file_format == 'csv':
     import csvreader as reader
data=reader.read_date(filename)

 

 

在一行导入多个模块

import sys,os,re

 

from……import……

对比import my_module，会将源文件的命名空间‘my_module’带到当前命名空间，使用时必须是

my_module.名字的方式

而from语句相当于import，也会创建新的命名空间，但是将my_module中的名字直接导入到当前的命名空间中，在当前的命名空间中，直接使用名字就可以了

from my_module import read1,read2

这样在当前位置直接使用read1和read2就好了，执行时，仍然以my_module.py文件全局命名空间

 

#测试一：导入的函数read1，执行时仍然回到my_module.py中寻找全局变量money
#demo.py
from my_module import read1
money=1000
read1()
'''
执行结果:
from the my_module.py
spam->read1->money 1000
'''

#测试二:导入的函数read2，执行时需要调用read1(),仍然回到my_module.py中找read1()
#demo.py
from my_module import read2
def read1():
    print('==========')
read2()

'''
执行结果:
from the my_module.py
my_module->read2 calling read1
my_module->read1->money 1000
'''

 

如果当前有重名read1或者read2，那么会有覆盖效果

#测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
#demo.py
from my_module import read1
def read1():
    print('==========')
read1()
'''
执行结果:
from the my_module.py
==========
'''

 

需要特别强调的一点是：python中的变量赋值不是一种存储操作，而是一种绑定关系，如下：

from my_module import money,read1
money=100 #将当前位置的名字money绑定到了100
print(money) #打印当前的名字
read1() #读取my_module.py中的名字money,仍然为1000

'''
from the my_module.py
100
my_module->read1->money 1000
'''

 

也支持as

as可以修改导入模块中的变量或函数的名字

from my_module import read1 as read

 

也支持导入多行

 from my_module import (read1,
                   read2,
                   money)

 

from ……import *

from my_module import * 把my_module中所有的不是以下划线（_）开头的名字都导入到当前位置(_开头的名字属于私有)，大部分情况下我们的python程序不应该使用这种导入方式，因为*你不知道导入什么名字，很有可能会覆盖掉你之前已经定义的名字，而且可读性极其的差，在交互式环境中导入时没有问题

from my_module import * #将模块my_module中所有的名字都导入到当前名称空间
print(money)
print(read1)
print(read2)
print(change)

'''
执行结果:
from the my_module.py
1000
<function read1 at 0x1012e8158>
<function read2 at 0x1012e81e0>
<function change at 0x1012e8268>
'''

 

在my_module.py中新增一行

__all__=['money','read1'] #这样在另外一个文件中用from my_module import *就只能导入列表中规定的两个名字

 

*如果my_module.py中的名字前加_,即_money，则from my_module import *,则_money不能被导入

 

把模块当作脚本执行

我们可以通过模块的全局变量__name__来查看模块名：

当做脚本运行：

__name__=='__main__'

当作模块导入

__name__=模块名

作用：用来控制.py文件在不同的应用场景下执行不同的逻辑

if __name__=='__main__':

def fib(n):   
    a, b = 0, 1
    while b < n:
        print(b, end=' ')
        a, b = b, a+b
    print()

if __name__ == "__main__":
    print(__name__)
    num = input('num :')
    fib(int(num))

 

模块搜索路径

python解释器在启动时会自动加载一些模块，可以使用sys.modules查看

在第一次导入某个模块时(比如my_module),会先检查该模块是否已经被加载到内存中（当前执行文件的命名空间对应的内存），如果有则直接引用，如果没有，解释器会查找同名的内建模块，如果还没有找到就从sys.path给出的目录列表中依次寻找my_module.py文件。

所以总结模块的查找顺序是：内存中已经加载的模块—>内置模块—>sys.path路径中包含的模块

sys.path的初始化的值来自于：

The directory containing the input script (or the current directory when no file is specified).
PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
The installation-dependent default.

 

需要特别注意的是：我们自定义的模块名不应该与系统内置模块重名。 

在初始化后，python程序可以修改sys.path。路径放到前面的优先于标准库被加载

>>> import sys
>>> sys.path.append('/a/b/c/d')
>>> sys.path.insert(0,'/x/y/z') #排在前的目录，优先被搜索

 

包

包是通过使用‘.模块名’来组织python模块名称空间的方式。

1.无论是import形式还是from……import……形式，凡是在导入语句中（而不是在使用时）遇到带点的，都要第一时间提高警觉：这是关于包才有的导入语法

 2.包是目录级的（文件夹级），文件夹是用来组成py文件（包的本质就是一个包含__init__.py文件的目录）

3.import导入文件的时候，产生命名空间中的名字来源于文件，import包，产生的命名空间的名字同样来源于文件，但是是包下的__init__.py文件，导入包本质就是在导入该文件

强调：

1. 在python3中，即使包下没有__init__.py文件，import包仍然不会报错，而在python2中，包下一定要有该文件，否则import包会报错
2. 创建包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包即模块

包A和包B下有同名的模块也不会冲突，如A.a与B.b来自两个命名空间

import os
os.makedirs('glance/api')
os.makedirs('glance/cmd')
os.makedirs('glance/db')
l = []
l.append(open('glance/__init__.py','w'))
l.append(open('glance/api/__init__.py','w'))
l.append(open('glance/api/policy.py','w'))
l.append(open('glance/api/versions.py','w'))
l.append(open('glance/cmd/__init__.py','w'))
l.append(open('glance/cmd/manage.py','w'))
l.append(open('glance/db/models.py','w'))
map(lambda f:f.close() ,l)

glance/                   #Top-level package

├── __init__.py      #Initialize the glance package

├── api                  #Subpackage for api

│   ├── __init__.py

│   ├── policy.py

│   └── versions.py

├── cmd                #Subpackage for cmd

│   ├── __init__.py

│   └── manage.py

└── db                  #Subpackage for db

    ├── __init__.py

    └── models.py

 

#文件内容

#policy.py
def get():
    print('from policy.py')

#versions.py
def create_resource(conf):
    print('from version.py: ',conf)

#manage.py
def main():
    print('from manage.py')

#models.py
def register_models(engine):
    print('from models.py: ',engine)

 

注意事项：

 1.关于包相关的导入语句也分为import和from……import……两种，但是无论哪一种，无论在什么位置，在导入时都必须遵循一个规则：凡是在导入时带点的，点的左边都必须是一个包，否则非法，可以带有一连串的点，如item.subitem.subsubitem,但都必须遵循这个原则

2.对于导入后，在使用时就没有这种限制了，点的左边可以是一个包，模块，函数，类（它们都可以用点的方式调用自己的属性）。

3.对比import item和from itemimport name的应用场景：

如果我们想直接使用name那必须使用后者

 

import

我们在与包glance同级别的文件中测试：

import glance.db.models
glance.db.models.register_models('mysql')

'''
输出：
from models.py:mysql
'''

 

from……import……

需要注意的是import后面导入的模块必须是明确的一个不能带点的，否则会有语法错误，如from a import b.c是错误语法

 

from glance.db import models
models.register_models('mysql')

from glance.db.models import register_models
register_models('mysql')

'''
输出：
from models.py:mysql
from models.py:mysql
'''

 

__init__.py文件

不管是哪种方式，只要是第一次导入包或者是包的任何其他部分，都会依次执行包下的__init__.py文件（我们可以在每个包的文件内都打印一行内容来验证一下），这个文件可以为空，但是也可以存放一些初始化包的代码

 

from glance.api import *

上面讲到模块的时候，我们已经讨论过了从一个模块内导入所有*，此处我们研究从一个包导入所有*。

此处是想从包api中导入所有，实际上该语句只会导入包api下__init__.py文件中定义的名字，我们可以在这个文件中定义__all__:

此时我们在与glance同级的文件中执行from glance.api import *就导入__all__中的内容（versions仍然不能导入）。

glance/                   

├── __init__.py      

├── api                  

│   ├── __init__.py   __all__ = ['policy','versions'] 

│   ├── policy.py

│   └── versions.py

├── cmd               __all__ = ['manage']    

│   ├── __init__.py

│   └── manage.py    

└── db                __all__ = ['models']              

    ├── __init__.py

    └── models.py



from glance.api import *
policy.get()

 

 

绝对导入和相对导入

我们的最顶级包glance是写给别人用的，让那后在glance包内部也会有彼此之间相互导入的需求，这是由就有绝对导入和相对导入两种方式：

绝对导入：以glance作为起始

相对导入：用 . 或者 . . 的方式作为起始（只能在一个包中使用，不能用于不同目录内）

例如：我们在glance/api/version.py中想要导入glance/cmd/manage.py

在glance/api/version.py

#绝对导入
from glance.cmd import manage
manage.main()

#相对导入
from ..cmd import manage
manage.main()

使用相对导入的时候，如果在version中执行代码（即在包内部执行代码），会报错，因为解释器找不到cmd的上一级目录，只有在包外面执行代码才不会报错，因为在包外面执行代码就可以记录各个文件的层级关系，在内部就不行，相当于‘不识庐山真面目，只缘身在此山中’，说的就是这个道理。

如果我们在version.py文件中执行，就会报错

SystemError: Parent module '' not loaded, cannot perform relative import

如果在包外面（与glance同级）的文件中执行:

from glance.api import versions
'''
输出：
from manage.py
'''

 

特别需要注意的是：可以用import导入内置或者第三方模块（已经在sys.path中的），但是要绝对避免使用import来导入自定义包的子模块（没有在sys.path中），应该使用from……import……的绝对或者相对导入，且包的相对导入只能用from形式

 

比如我们想在glance/api/version.py中导入glance/api/policy.py，有的人一看这两个模块是在同一个目录下，十分开心的就去做了，它直接这么写：

#在version.py中
import policy
policy.get()

这样我们单独运行version.py是一点问题没有的，运行version.py的路径搜索就是从当前路径开始的，于是在导入policy时能在当前目录下找到

但是子包中的模块version.py很有可能是被一个glance包同一级别的其他文件导入，比如我们在与glance同级下的一个test.py中导入version.py，如下

from glance.api import versions

'''
执行结果:
ImportError: No module named 'policy'
'''

'''
分析:
此时我们导入versions在versions.py中执行
import policy需要找从sys.path也就是从当前目录找policy.py,
这必然是找不到的
'''

glance/                   

├── __init__.py      from glance import api
                             from glance import cmd
                             from glance import db

├── api                  

│   ├── __init__.py  from glance.api import policy
                              from glance.api import versions

│   ├── policy.py

│   └── versions.py

├── cmd                 from glance.cmd import manage

│   ├── __init__.py

│   └── manage.py

└── db                   from glance.db import models

    ├── __init__.py

    └── models.py

glance/                   

├── __init__.py      from . import api  #.表示当前目录
                     from . import cmd
                     from . import db

├── api                  

│   ├── __init__.py  from . import policy
                     from . import versions

│   ├── policy.py

│   └── versions.py

├── cmd              from . import manage

│   ├── __init__.py

│   └── manage.py    from ..api import policy   
                     #..表示上一级目录，想再manage中使用policy中的方法就需要回到上一级glance目录往下找api包，从api导入policy

└── db               from . import models

    ├── __init__.py

    └── models.py

这样只要import glance就讲所有模块都一同导入

 

单独导入包

单独导入包名称时不会导入包中所有包含的所有子模块，如：

#在与glance同级的test.py中
import glance
glance.cmd.manage.main()

'''
执行结果：
AttributeError: module 'glance' has no attribute 'cmd'

'''

解决办法

1 #glance/__init__.py
2 from . import cmd
3 
4 #glance/cmd/__init__.py
5 from . import manage

执行：

1 #在于glance同级的test.py中
2 import glance
3 glance.cmd.manage.main()

千万别问：__all__不能解决吗，__all__是用于控制from...import * 

例：用__all__解决

glance/                   

├── __init__.py     from .api import *
                    from .cmd import *
                    from .db import *    
├── api                  

│   ├── __init__.py   __all__ = ['policy','versions'] 

│   ├── policy.py

│   └── versions.py

├── cmd               __all__ = ['manage']    

│   ├── __init__.py

│   └── manage.py    

└── db                __all__ = ['models']              

    ├── __init__.py

    └── models.py


import glance
policy.get()

 

软件开发规范

#=============>bin目录：存放执行脚本
#start.py
import sys,os

BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)

from core import core
from conf import my_log_settings

if __name__ == '__main__':
    my_log_settings.load_my_logging_cfg()
    core.run()

#=============>conf目录：存放配置文件
#config.ini
[DEFAULT]
user_timeout = 1000

[egon]
password = 123
money = 10000000

[alex]
password = alex3714
money=10000000000

[yuanhao]
password = ysb123
money=10

#settings.py
import os
config_path=r'%s\%s' %(os.path.dirname(os.path.abspath(__file__)),'config.ini')
user_timeout=10
user_db_path=r'%s\%s' %(os.path.dirname(os.path.dirname(os.path.abspath(__file__))),\
                     'db')


#my_log_settings.py
"""
logging配置
"""

import os
import logging.config

# 定义三种日志输出格式 开始

standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \
                  '[%(levelname)s][%(message)s]' #其中name为getlogger指定的名字

simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

# 定义日志输出格式 结束

logfile_dir = r'%s\log' %os.path.dirname(os.path.dirname(os.path.abspath(__file__)))  # log文件的目录

logfile_name = 'all2.log'  # log文件名

# 如果不存在定义的日志目录就创建一个
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)

# log文件的全路径
logfile_path = os.path.join(logfile_dir, logfile_name)

# log配置字典
LOGGING_DIC = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
    },
    'filters': {},
    'handlers': {
        #打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple'
        },
        #打印到文件的日志,收集info及以上的日志
        'default': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件
            'formatter': 'standard',
            'filename': logfile_path,  # 日志文件
            'maxBytes': 1024*1024*5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码，再也不用担心中文log乱码了
        },
    },
    'loggers': {
        #logging.getLogger(__name__)拿到的logger配置
        '': {
            'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',
            'propagate': True,  # 向上（更高level的logger）传递
        },
    },
}


def load_my_logging_cfg():
    logging.config.dictConfig(LOGGING_DIC)  # 导入上面定义的logging配置
    logger = logging.getLogger(__name__)  # 生成一个log实例
    logger.info('It works!')  # 记录该文件的运行状态

if __name__ == '__main__':
    load_my_logging_cfg()

#=============>core目录：存放核心逻辑
#core.py
import logging
import time
from conf import settings
from lib import read_ini

config=read_ini.read(settings.config_path)
logger=logging.getLogger(__name__)

current_user={'user':None,'login_time':None,'timeout':int(settings.user_timeout)}
def auth(func):
    def wrapper(*args,**kwargs):
        if current_user['user']:
            interval=time.time()-current_user['login_time']
            if interval < current_user['timeout']:
                return func(*args,**kwargs)
        name = input('name>>: ')
        password = input('password>>: ')
        if config.has_section(name):
            if password == config.get(name,'password'):
                logger.info('登录成功')
                current_user['user']=name
                current_user['login_time']=time.time()
                return func(*args,**kwargs)
        else:
            logger.error('用户名不存在')

    return wrapper

@auth
def buy():
    print('buy...')

@auth
def run():

    print('''
购物
查看余额
转账
    ''')
    while True:
        choice = input('>>: ').strip()
        if not choice:continue
        if choice == '1':
            buy()



if __name__ == '__main__':
    run()

#=============>db目录：存放数据库文件
#alex_json
#egon_json

#=============>lib目录：存放自定义的模块与包
#read_ini.py
import configparser
def read(config_file):
    config=configparser.ConfigParser()
    config.read(config_file)
    return config

#=============>log目录：存放日志
#all2.log
[2017-07-29 00:31:40,272][MainThread:11692][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:31:41,789][MainThread:11692][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:31:46,394][MainThread:12348][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:31:47,629][MainThread:12348][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:31:57,912][MainThread:10528][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:32:03,340][MainThread:12744][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:32:05,065][MainThread:12916][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:32:08,181][MainThread:12916][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:32:13,638][MainThread:7220][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:32:23,005][MainThread:7220][task_id:core.core][core.py:20][INFO][登录成功]
[2017-07-29 00:32:40,941][MainThread:7220][task_id:core.core][core.py:20][INFO][登录成功]
[2017-07-29 00:32:47,222][MainThread:7220][task_id:core.core][core.py:20][INFO][登录成功]
[2017-07-29 00:32:51,949][MainThread:7220][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:33:00,213][MainThread:7220][task_id:core.core][core.py:20][INFO][登录成功]
[2017-07-29 00:33:50,118][MainThread:8500][task_id:conf.my_log_settings][my_log_settings.py:75][INFO][It works!]
[2017-07-29 00:33:55,845][MainThread:8500][task_id:core.core][core.py:20][INFO][登录成功]
[2017-07-29 00:34:06,837][MainThread:8500][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:34:09,405][MainThread:8500][task_id:core.core][core.py:25][ERROR][用户名不存在]
[2017-07-29 00:34:10,645][MainThread:8500][task_id:core.core][core.py:25][ERROR][用户名不存在]