模块(1)

一、模块介绍

1、什么是模块
模块是一系列功能的集合体

模块有4种形式
1、一个py文件就是一个模块
2、一个包含有__init__.py文件的文件夹也是一个模块,称之为包

3、已被编译为共享库或DLL的C或C++扩展
4、使用C编写并链接到python解释器的内置模块

模块有三种来源:
1、python自带的
2、第三方的
3、自定义


2、为何要用模块
1、拿来主义,提升开发效率
2、把自己程序中各部分组件要重复使用的功能放到一个模块中,然后通过导入的方式使用
可以达到减少代码冗余
3、以spam.py为例来介绍模块的使用:文件名spam.py,模块名spam
模块(1)
#spam.py
print('from the spam.py')

money=1000

def read1():
    print('spam模块:',money)

def read2():
    print('spam模块')
    read1()

def change():
    global money
    money=0
View Code

 

二、模块使用-import

  1、import使用

模块(1)
#模块可以包含可执行的语句和函数的定义,这些语句的目的是初始化模块,它们只在模块名第一次遇到导入import语句时才执行(import语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入,python的优化手段是:第一次导入后就将模块名加载到内存了,后续的import语句仅是对已经加载到内存中的模块对象增加了一次引用,不会重新执行模块内的语句),如下 
#test.py
import spam #只在第一次导入时才执行spam.py内代码,此处的显式效果是只打印一次'from the spam.py',当然其他的*代码也都被执行了,只不过没有显示效果.
import spam
import spam
import spam
'''
执行结果:
from the spam.py
'''
View Code

  2、在第一次导入模块时会做三件事,重复导入会直接引用内存中已经加载好的结果

模块(1)View Code
首次导入模块发生的事情
1、创建一个模块的名称空间
2、运行模块文件内的代码,然后将运行过程中产生的名字都丢到模块的名称空间中
3、在当前名称空间中产生一个名字spam,该名字指向模块的名称空间

之后的导入都是在直接引用内存中已经创造好的模块空间,不会重复执行文件、重复创建名称空间
import spam
import spam
import spam
import spam
import spam

3、被导入模块有独立的名称空间

每个模块都是一个独立的名称空间,定义在这个模块中的函数,把这个模块的名称空间当做全局名称空间,

这样我们在编写自己的模块时,就不用担心我们定义在自己模块中全局变量会在被导入时,与使用者的全局变量冲突。

模块(1)
#test.py
import spam 
money=10
print(spam.money)

'''
执行结果:
from the spam.py
1000
'''

测试一:money与spam.money不冲突
测试一:money与spam.money不冲突 模块(1)
#test.py
import spam
def read1():
    print('========')
spam.read1()

'''
执行结果:
from the spam.py
spam->read1->money 1000
'''

测试二:read1与spam.read1不冲突
测试二:read1与spam.read1不冲突 模块(1)
#test.py
import spam
money=1
spam.change()
print(money)

'''
执行结果:
from the spam.py
1
'''

测试三:执行spam.change()操作的全局变量money仍然是spam中的
测试三:执行spam.change()操作的全局变量money仍然是spam中

4、为模块名起别名

为已经导入的模块起别名的方式对编写可扩展的代码很有用

1 import spam as sm
2 print(sm.money)

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

模块(1)
#mysql.py
def sqlparse():
    print('from mysql sqlparse')
#oracle.py
def sqlparse():
    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()
View Code

假设有两个模块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)

5、在一行导入多个模块

import os
import time
import subprocess

三 、使用模块之from ... import...

1、from...import...的使用

x=111
from spam import money,read1,change
首次导入模块发生3件的事情
1、创建一个模块的名称空间
2、运行模块文件内的代码,然后将运行过程中产生的名字都丢到模块的名称空间中
3、在当前名称空间中产生一个名字money,该名字指向模块的名称空间对应的名字

2、from...import 与import的对比

#唯一的区别就是:使用from...import...则是将spam中的名字直接导入到当前的名称空间中,所以在当前名称空间中,直接使用名字就可以了、无需加前缀:spam.

#from...import...的方式有好处也有坏处
    好处:使用起来方便了
    坏处:容易与当前执行文件中的名字冲突

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

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

'''
执行结果:
from the spam.py
spam->read2 calling read
spam->read1->money 1000
'''
验证一:当前位置直接使用read1和read2就好了,执行时,仍然以spam.py文件全局名称空间 模块(1)
#测试三:导入的函数read1,被当前位置定义的read1覆盖掉了
#test.py
from spam import read1
def read1():
    print('==========')
read1()
'''
执行结果:
from the spam.py
==========
'''
验证二:如果当前有重名read1或者read2,那么会有覆盖效果。 模块(1)
from spam import money,read1
money=100 #将当前位置的名字money绑定到了100
print(money) #打印当前的名字
read1() #读取spam.py中的名字money,仍然为1000

'''
from the spam.py
100
spam->read1->money 1000
'''
验证三:导入的方法在执行时,始终是以源文件为准的

3、支持as

from spam import read1 as read

模块(1)
from spam import money as m,read1 as r,change as c
from spam import money as m
from spam import read1 as r
from spam import change as c
print(m)
print(r)
print(c)
View Code

4、一行导入多个名字

from spam import read1,read2,money

5、from...import *

#from spam import * 把spam中所有的不是以下划线(_)开头的名字都导入到当前位置

#大部分情况下我们的python程序不应该使用这种导入方式,因为*你不知道你导入什么名字,很有可能会覆盖掉你之前已经定义的名字。而且可读性极其的差,在交互式环境中导入时没有问题。

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

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

可以使用__all__来控制*(用来发布新版本),在spam.py中新增一行

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

 

四、模块循环导入问题

模块循环/嵌套导入抛出异常的根本原因是由于在python中模块被导入一次之后,就不会重新导入,只会在第一次导入时执行模块内代码

在我们的项目中应该尽量避免出现循环/嵌套导入,如果出现多个模块都需要共享的数据,可以将共享的数据集中存放到某一个地方

在程序出现了循环/嵌套导入后的异常分析、解决方法如下

模块(1)
#示范文件内容如下
#m1.py
print('正在导入m1')
from m2 import y

x='m1'

#m2.py
print('正在导入m2')
from m1 import x

y='m2'

#run.py
import m1

#测试一
执行run.py会抛出异常
正在导入m1
正在导入m2
Traceback (most recent call last):
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/aa.py", line 1, in <module>
    import m1
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m2.py", line 2, in <module>
    from m1 import x
ImportError: cannot import name 'x'

#测试一结果分析
先执行run.py--->执行import m1,开始导入m1并运行其内部代码--->打印内容"正在导入m1"
--->执行from m2 import y 开始导入m2并运行其内部代码--->打印内容“正在导入m2”--->执行from m1 import x,由于m1已经被导入过了,所以不会重新导入,所以直接去m1中拿x,然而x此时并没有存在于m1中,所以报错


#测试二:执行文件不等于导入文件,比如执行m1.py不等于导入了m1
直接执行m1.py抛出异常
正在导入m1
正在导入m2
正在导入m1
Traceback (most recent call last):
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m2.py", line 2, in <module>
    from m1 import x
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
ImportError: cannot import name 'y'


#测试二分析
执行m1.py,打印“正在导入m1”,执行from m2 import y ,导入m2进而执行m2.py内部代码--->打印"正在导入m2",执行from m1 import x,此时m1是第一次被导入,执行m1.py并不等于导入了m1,于是开始导入m1并执行其内部代码--->打印"正在导入m1",执行from m1 import y,由于m1已经被导入过了,所以无需继续导入而直接问m2要y,然而y此时并没有存在于m2中所以报错



# 解决方法:
方法一:导入语句放到最后
#m1.py
print('正在导入m1')

x='m1'

from m2 import y

#m2.py
print('正在导入m2')
y='m2'

from m1 import x

方法二:导入语句放到函数中
#m1.py
print('正在导入m1')

def f1():
    from m2 import y
    print(x,y)

x = 'm1'

# f1()

#m2.py
print('正在导入m2')

def f2():
    from m1 import x
    print(x,y)

y = 'm2'

#run.py
import m1

m1.f1()

示例文件
示例

五、py文件区分两种用途:模块与脚本

#编写好的一个python文件可以有两种用途:
    一:脚本,一个文件就是整个程序,用来被执行
    二:模块,文件中存放着一堆功能,用来被导入使用


#python为我们内置了全局变量__name__,
    当文件被当做脚本执行时:__name__ 等于'__main__'
    当文件被当做模块导入时:__name__等于模块名

#作用:用来控制.py文件在不同的应用场景下执行不同的逻辑
    if __name__ == '__main__':
模块(1)
#fib.py

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while b < n:
        print(b, end=' ')
        a, b = b, a+b
    print()

def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while b < n:
        result.append(b)
        a, b = b, a+b
    return result

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))


#执行:python fib.py <arguments>
python fib.py 50 #在命令行
View Code

六、模块搜索路径

模块的查找顺序是:内存中已经加载的模块->内置模块->sys.path路径中包含的模块

模块(1)
#模块的查找顺序
1、在第一次导入某个模块时(比如spam),会先检查该模块是否已经被加载到内存中(当前执行文件的名称空间对应的内存),如果有则直接引用
    ps:python解释器在启动时会自动加载一些模块到内存中,可以使用sys.modules查看
2、如果没有,解释器则会查找同名的内建模块
3、如果还没有找到就从sys.path给出的目录列表中依次寻找spam.py文件。


#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,路径放到前面的优先于标准库被加载。
1 >>> import sys
2 >>> sys.path.append('/a/b/c/d')
3 >>> sys.path.insert(0,'/x/y/z') #排在前的目录,优先被搜索
注意:搜索时按照sys.path中从左到右的顺序查找,位于前的优先被查找,sys.path中还可能包含.zip归档文件和.egg文件,python会把.zip归档文件当成一个目录去处理,

#首先制作归档文件:zip module.zip foo.py bar.py 
import sys
sys.path.append('module.zip')
import foo,bar

#也可以使用zip中目录结构的具体位置
sys.path.append('module.zip/lib/python')


#windows下的路径不加r开头,会语法错误
sys.path.insert(0,r'C:\Users\Administrator\PycharmProjects\a')
 

#至于.egg文件是由setuptools创建的包,这是按照第三方python库和扩展时使用的一种常见格式,.egg文件实际上只是添加了额外元数据(如版本号,依赖项等)的.zip文件。

#需要强调的一点是:只能从.zip文件中导入.py,.pyc等文件。使用C编写的共享库和扩展块无法直接从.zip文件中加载(此时setuptools等打包系统有时能提供一种规避方法),且从.zip中加载文件不会创建.pyc或者.pyo文件,因此一定要事先创建他们,来避免加载模块是性能下降。

详细的
详细介绍 模块(1)
#官网链接:https://docs.python.org/3/tutorial/modules.html#the-module-search-path
搜索路径:
当一个命名为spam的模块被导入时
    解释器首先会从内建模块中寻找该名字
    找不到,则去sys.path中找该名字

sys.path从以下位置初始化
    1 执行文件所在的当前目录
    2 PTYHONPATH(包含一系列目录名,与shell变量PATH语法一样)
    3 依赖安装时默认指定的

注意:在支持软连接的文件系统中,执行脚本所在的目录是在软连接之后被计算的,换句话说,包含软连接的目录不会被添加到模块的搜索路径中

在初始化后,我们也可以在python程序中修改sys.path,执行文件所在的路径默认是sys.path的第一个目录,在所有标准库路径的前面。这意味着,当前目录是优先于标准库目录的,需要强调的是:我们自定义的模块名不要跟python标准库的模块名重复,除非你是故意的,傻叉。
官方解释

七、日志模块

模块(1)
import logging

# 一:日志配置
# logging.basicConfig(
#     # 1、日志输出位置:1、终端 2、文件
#     filename='access.txt', # 不指定,默认打印到终端
#     #
#     #     # 2、日志格式
#     #     format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
#     #
#     #     # 3、时间格式
#     #     datefmt='%Y-%m-%d %H:%M:%S %p',
#     #
#     #     # 4、日志级别
#     #     # critical => 50
#     #     # error => 40
#     #     # warning => 30
#     #     # info => 20
#     # debug => 10
#     level=30,
# )

# 二:输出日志
# logging.debug('调试debug')
# logging.info('消息info')
# logging.warning('警告warn')
# logging.error('错误error')
# logging.critical('严重critical')
#

import settings
import logging.config
logging.config.dictConfig(settings.LOGGING_DIC)
# logger1=logging.getLogger('交易日志')
# logger1.info("egon给他儿子alex转了3亿冥币")

logger2=logging.getLogger('权限')



logger2.debug("测试")
View Code

八、序列化模块

模块(1)
import json
# 序列化
dic={'name':'egon','age':23.0,'sex':None,'is_ok':True}

res=json.dumps(dic)
res=json.dumps({1,2,3,45})  # json不识别集合类型
print(res,type(res))

with open('a.json',mode='wt',encoding='utf-8') as f:
    f.write(res)

# 反序列化
with open('a.json',mode='rt',encoding='utf-8') as f:
    data_json=f.read()

dic=json.loads(data_json)
print(dic["name"])

# =================》ps: dump与load
序列化
dic={'name':'egon','age':23.0,'sex':None,'is_ok':True}

with open('a.json',mode='wt',encoding='utf-8') as f:
    json.dump(dic,f)

反序列化
with open('a.json',mode='rt',encoding='utf-8') as f:
    dic=json.load(f)
    print(dic,type(dic))


# import pickle
# 序列化
dic={'name':'egon','age':23.0,'sex':None,'is_ok':True}

res=pickle.dumps(dic)
# res=pickle.dumps({1,2,3,45})  # pickle可以识别所有python类型
print(res,type(res))

with open('a.pkl',mode='wb') as f:
    f.write(res)

# 反序列化
with open('a.pkl',mode='rb') as f:
    data_pkl=f.read()

dic=pickle.loads(data_pkl)
print(dic["name"])
View Code

九、setting

1、定义三种日志输出格式,日志中可能用到的格式化串如下

模块(1)
%(name)s Logger的名字
%(levelno)s 数字形式的日志级别
%(levelname)s 文本形式的日志级别
%(pathname)s 调用日志输出函数的模块的完整路径名,可能没有
%(filename)s 调用日志输出函数的模块的文件名
%(module)s 调用日志输出函数的模块名
%(funcName)s 调用日志输出函数的函数名
%(lineno)d 调用日志输出函数的语句所在的代码行
%(created)f 当前时间,用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d 输出日志信息时的,自Logger创建以 来的毫秒数
%(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d 线程ID。可能没有
%(threadName)s 线程名。可能没有
%(process)d 进程ID。可能没有
%(message)s用户输出的消息
View Code

2、强调:其中的%(name)s为getlogger时指定的名字

模块(1)
standard_format = '%(asctime)s - %(threadName)s:%(thread)d - %(name)s - %(filename)s:%(lineno)d - %(levelname)s - %(message)s'

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

test_format = '%(asctime)s - %(message)s'
View Code

3、日志配置字典

模块(1)
LOGGING_DIC = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
        'test': {
            'format': test_format
        },
    },
    'filters': {},
    'handlers': {
        #打印到终端的日志
        'tty': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple'
        },
        #打印到文件的日志,收集info及以上的日志
        # 'fh1': {
        #     'level': 'DEBUG',
        #     'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
        #     'formatter': 'standard',
        #     # 可以定制日志文件路径
        #     # BASE_DIR = os.path.dirname(os.path.abspath(__file__))  # log文件的目录
        #     # LOG_PATH = os.path.join(BASE_DIR,'a1.log')
        #     'filename': 'a1.log',  # 日志文件
        #     'maxBytes': 1024*1024*5,  # 日志大小 5M
        #     'backupCount': 5,
        #     'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        # },
        'fh2': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',  # 保存到文件
            'formatter': 'test',
            'filename': 'a2.log',
            'encoding': 'utf-8',
        },
        'fh1': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',  # 保存到文件
            'formatter': 'standard',
            'filename': 'a1.log',
            'encoding': 'utf-8',
        },
    },
    'loggers': {
        #logging.getLogger(__name__)拿到的logger配置

        '': {
            'handlers': ['fh1', 'fh2'],
            'level': 'DEBUG',
            'propagate': False,
        },

    },
}
View Code

 

 

 

 

 

 



上一篇:为你揭秘知乎是如何搞AI的——窥大厂 | 数智方法论第1期


下一篇:ICPC Latin American Regional Contests 2019 I. Improve SPAM (拓扑排序,两点间路径数)