Python常用模块二

一.time & datetime 

 1 #_*_coding:utf-8_*_
 2 
 3 
 4 import time
 5 
 6 
 7 # print(time.clock()) #返回处理器时间,3.3开始已废弃 , 改成了time.process_time()测量处理器运算时间,不包括sleep时间,不稳定,mac上测不出来
 8 # print(time.altzone)  #返回与utc时间的时间差,以秒计算\
 9 # print(time.asctime()) #返回时间格式"Fri Aug 19 11:14:16 2016",
10 # print(time.localtime()) #返回本地时间 的struct time对象格式
11 # print(time.gmtime(time.time()-800000)) #返回utc时间的struc时间对象格式
12 
13 # print(time.asctime(time.localtime())) #返回时间格式"Fri Aug 19 11:14:16 2016",
14 #print(time.ctime()) #返回Fri Aug 19 12:38:29 2016 格式, 同上
15 
16 
17 
18 # 日期字符串 转成  时间戳
19 # string_2_struct = time.strptime("2016/05/22","%Y/%m/%d") #将 日期字符串 转成 struct时间对象格式
20 # print(string_2_struct)
21 # #
22 # struct_2_stamp = time.mktime(string_2_struct) #将struct时间对象转成时间戳
23 # print(struct_2_stamp)
24 
25 
26 
27 #将时间戳转为字符串格式
28 # print(time.gmtime(time.time()-86640)) #将utc时间戳转换成struct_time格式
29 # print(time.strftime("%Y-%m-%d %H:%M:%S",time.gmtime()) ) #将utc struct_time格式转成指定的字符串格式
30 
31 
32 
33 
34 
35 #时间加减
36 import datetime
37 
38 # print(datetime.datetime.now()) #返回 2016-08-19 12:47:03.941925
39 #print(datetime.date.fromtimestamp(time.time()) )  # 时间戳直接转成日期格式 2016-08-19
40 # print(datetime.datetime.now() )
41 # print(datetime.datetime.now() + datetime.timedelta(3)) #当前时间+3天
42 # print(datetime.datetime.now() + datetime.timedelta(-3)) #当前时间-3天
43 # print(datetime.datetime.now() + datetime.timedelta(hours=3)) #当前时间+3小时
44 # print(datetime.datetime.now() + datetime.timedelta(minutes=30)) #当前时间+30分
45 
46 
47 #
48 # c_time  = datetime.datetime.now()
49 # print(c_time.replace(minute=3,hour=2)) #时间替换

二.random

1 import random
2 print(random.random())
3 print(random.randint(1,2))
4 print(random.randrange(1,10))

生成随机验证码

 1 import random
 2 checkcode = ''
 3 for i in range(4):
 4     current = random.randrange(0,4)
 5     if current != i:
 6         temp = chr(random.randint(65,90))
 7     else:
 8         temp = random.randint(0,9)
 9     checkcode += str(temp)
10 print(checkcode)

三.shutil模块

shutil模块提供了大量的文件的高级操作。特别针对文件拷贝和删除,主要功能为目录和文件操作以及压缩操作。对单个文件的操作也可参见os模块。

(1) 拷贝

1 >>> import shutil
2 >>> shutil.chown('test.txt',user='mysql',group='mysql') #改变文件的属主和属组
3 >>> shutil.copy('test.txt','test_copy.txt') #拷贝文件
4 >>> shutil.copy2('test.txt','test_copy2.txt') #拷贝文件并复制所有统计信息,如修改时间等。
5 >>> shutil.copyfile('test_ln.txt','test_copyfile.txt') #如果是链接文件,将复制新文件,不复制链接
 1 >>> dstf = open('test_copyfileobj.txt','r+')
 2 >>> srcf = open('test.txt','r')
 3 >>> shutil.copyfileobj(srcf,dstf,length=2)  #按长度拷贝文件对象
 4 
 5 >>> shutil.copymode('test.txt','test_copymode.txt')  #拷贝文件的权限到目标文件上
 6 
 7 >>> shutil.copystat('test.txt','test_copymode.txt')  #拷贝文件的访问和修改时间,其他不受影响
 8 #shutil.copytree(src, dst, symlinks=False, ignore=None) 递归的去拷贝文件夹
 9 #shutil.rmtree(path[, ignore_errors[, onerror]])  递归的去删除文件
10 #shutil.move(src, dst)  递归的去移动文件,它类似mv命令,其实就是重命名。

(2)压缩与解压缩

make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,
dry_run=0, owner=None, group=None, logger=None)
创建压缩包并返回文件路径:
base_name:压缩包的文件名,也可以是压缩包的路径,只是文件名时,保存到当前目录,否则保存到指定路径
format:压缩包种类,‘zip’,'tar','bztar','gztar'
root_dir:要压缩的文件夹路径(默认当前目录)
owner:用户,默认当前用户
group:组,默认当前组
logger:用于记录日志,通常是logging.Logger对象
1 >>>import shutil
2 #将/root目录下的所有文件压缩到media目录下取名为www,压缩格式为tar
3 >>> ret = shutil.make_archive("/media/www",'tar',root_dir='/root')
4 
5 #将文件已tar格式压缩到当前目录下
6  ret = shutil.make_archive("ipython55",'tar',root_dir='/root/ipython-5.5.0')

shutil 对压缩包的处理是通过调用ZipFile 和 TarFile两个模块来进行的。

 1 >>> import zipfile
 2 #压缩
 3 >>> z = zipfile.ZipFile('xin.tar.gz','w')   #创建名为xin.tar.gz的压缩文件
 4 >>> z.write('test.txt')   #写入文件到压缩文件中
 5 >>> z.write('log.txt')
 6 >>> z.close()   #关闭文件
 7 #解压缩
 8 >>> z = zipfile.ZipFile('xin.tar.gz','r')   #打开压缩文件
 9 >>> z.extractall(path='/python/day7')  #解压到指定路径下
10 >>> z.close()
11 
12 
13 >>> import tarfile
14 #压缩
15 >>> tar = tarfile.open('/usr/targzfile.tar.gz','w')  #指定目录创建压缩文件
16 >>> tar.add('/python/day7/test1.py',arcname='test1.py')  #添加文件到压缩文件中
17 >>> tar.add('/python/day7/test1.py',arcname='test2.py')
18 >>> tar.close()
19 
20 #解压缩
21 >>> tar = tarfile.open('/usr/targzfile.tar.gz','r')
22 >>> tar.extractall(path='/pyhton/day8')
23 >>> tar.close()

四.xml模块

XML 指可扩展标记语言(eXtensible Markup Language),标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。

XML 被设计用来传输和存储数据。

XML是一套定义语义标记的规则,这些标记将文档分成许多部件并对这些部件加以标识。

它也是元标记语言,即定义了用于定义其他与特定领域有关的、语义的、结构化的标记语言的句法语言。

python对XML的解析:

常见的XML编程接口有DOM和SAX,这两种接口处理XML文件的方式不同,当然使用场合也不同。

python有三种方法解析XML,SAX,DOM,以及ElementTree:

使用xml.etree.ElementTree模块来解析XML文件,ElementTree模块中提供了两个类用来完成这个目的:

ElementTree表示整个XML文件(一个树形结构)

Element表示树种的一个元素(结点)

示例xml文件:

 1 <collection shelf="New Arrivals">
 2 <movie title="Enemy Behind">
 3    <type>War, Thriller</type>
 4    <format>DVD</format>
 5    <year>2003</year>
 6    <rating>PG</rating>
 7    <stars>10</stars>
 8    <description>Talk about a US-Japan war</description>
 9 </movie>
10 <movie title="Transformers">
11    <type>Anime, Science Fiction</type>
12    <format>DVD</format>
13    <year>1989</year>
14    <rating>R</rating>
15    <stars>8</stars>
16    <description>A schientific fiction</description>
17 </movie>
18    <movie title="Trigun">
19    <type>Anime, Action</type>
20    <format>DVD</format>
21    <episodes>4</episodes>
22    <rating>PG</rating>
23    <stars>10</stars>
24    <description>Vash the Stampede!</description>
25 </movie>
26 <movie title="Ishtar">
27    <type>Comedy</type>
28    <format>VHS</format>
29    <rating>PG</rating>
30    <stars>2</stars>
31    <description>Viewable boredom</description>
32 </movie>
33 </collection>

首先需要导入ElementTree模块:import xml.etree.ElementTree as ET

然后使用ET下的方法parse解析XML文档:ET.parse()

 1 >>> import tab
 2 >>> import xml.etree.ElementTree as ET   #导入模块
 3 >>> tree = ET.parse("xmltest.xml")  #解析xml文档
 4 >>> root = tree.getroot()   #获取根节点
 5 >>> print(root.tag)   #打印节点
 6 collection
 7 >>> print(root[1][1].tag,root[1][1].text)  #通过索引解析根的子节点和数值
 8 format DVD
 9 #取出整个xml文档的内容
10 >>> for child in root:   #循环根节点
11 ...   print(child.tag,child.attrib)  #打印节点和属性
12 ...   for i in child:   #再循环内层节点
13 ...     print("---",i.tag,i.text)  #打印节点和数值
14 ... 
15 #输出内容:
16 movie {'title': 'Enemy Behind'}
17 --- type War, Thriller
18 --- format DVD
19 --- year 2003
20 --- rating PG
21 --- stars 10
22 --- description Talk about a US-Japan war
23 movie {'title': 'Transformers'}
24 --- type Anime, Science Fiction
25 --- format DVD
26 --- year 1989
27 --- rating R
28 --- stars 8
29 --- description A schientific fiction
30 movie {'title': 'Trigun'}
31 --- type Anime, Action
32 --- format DVD
33 --- episodes 4
34 --- rating PG
35 --- stars 10
36 --- description Vash the Stampede!
37 movie {'title': 'Ishtar'}
38 --- type Comedy
39 --- format VHS
40 --- rating PG
41 --- stars 2
42 --- description Viewable boredom
43 
44 #只遍历type节点
45 >>> for i in root.iter('type'):  #iter检索节点名
46 ...   print(i.tag,i.text)
47 ... 
48 type War, Thriller
49 type Anime, Science Fiction
50 type Anime, Action
51 type Comedy

修改和添加属性,删除节点:

 1 >>> import tab
 2 >>> import xml.etree.ElementTree as ET
 3 >>> tree = ET.parse("xmltest.xml")
 4 >>> root = tree.getroot()
 5 
 6 >>> root[1][2].text = "2017"  #通过索引修改某个节点的值
 7 >>> tree.write('xmltest.xml')  #将修改写入文档中
 8 #循环修改索引的year节点数值
 9 >>> for i in root.iter('year'):
10 ...   new_year = int(i.text)+1
11 ...   i.text = str(new_year)
12 ...   i.set("updated","yes")  #为每个year节点添加属性
13 ... 
14 >>> tree.write("xmltest.xml")
15 
16 #删除某个节点
17 >>> for i in root.findall('stars'):   #查询所有stars节点并删除
18 ...   root.remove(i)

创建xml文档:

 1 #!/usr/bin/env python
 2 #coding:utf8
 3 
 4 import xml.etree.ElementTree as ET
 5 
 6 new_xml = ET.Element('namelist')  #创建根节点
 7 name = ET.SubElement(new_xml,"root",attrib={'enrolled':'yes'})   #根节点下创建子节点并设置属性
 8 age = ET.SubElement(name,"head",attrib={"cheched":"no"}) #root节点下创建节点,配置属性
 9 sex = ET.SubElement(name,"sex")  #root下创建节点
10 sex.text = '88'   #设置节点值
11 name2 = ET.SubElement(new_xml,"root",attrib={"enrolled":"no"})
12 age2 = ET.SubElement(name2,'age2')
13 age2.text = '99'
14 
15 et = ET.Element(new_xml)   #生成xml文件对象
16 #et.write("test_1.xml",encoding="utf-8",xml_declaration=True)
17 ET.dump(new_xml)   #打印生成格式
18 
19 #output:
20 <namelist>
21     <root enrolled="yes">
22         <head cheched="no" />
23         <sex>88</sex>
24     </root>
25     <root enrolled="no">
26         <age2>99</age2>
27     </root>
28 </namelist>

 五.ConfigParser模块

ConfigParser 是用来读取配置文件的包。配置文件的格式如下:中括号“[ ]”内包含的为section。section 下面为类似于key-value 的配置内容。

使用ConfigParser首先需要初始化实例,并读取配置文件,下面以MySQL的配置文件为例:

 1 [mysqld]
 2 innodb_buffer_pool_size = 128M
 3 join_buffer_size = 128M
 4 sort_buffer_size = 2M
 5 read_rnd_buffer_size = 2M
 6 datadir=/var/lib/mysql
 7 socket=/var/lib/mysql/mysql.sock
 8 
 9 symbolic-links=0
10 sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES 
11 
12 [mysqld_safe]
13 log-error=/var/log/mysqld.log
14 pid-file=/var/run/mysqld/mysqld.pid
 1 import configparser
 2 
 3 config = configparser.ConfigParser()  #初始化实例
 4 config.read('my.cnf',encoding='utf-8')  #读取配置文件
 5 #读取模块名到列表中,也就是[]中的内容
 6 print(config.sections())
 7 #output
 8 ['mysqld', 'mysqld_safe']
 9 
10 #读取指定sections内的所有key
11 print('se_keys:',config.options('mysqld'))
12 #output:
13 se_keys: ['innodb_buffer_pool_size', 'join_buffer_size', 'sort_buffer_size', 'read_rnd_buffer_size', 'datadir', 'socket', 'symbolic-links', 'sql_mode']
14 
15 #获取指定sections的配置信息
16 print(config.items('mysqld'))
17 #output:
18 [('innodb_buffer_pool_size', '128M'), ('join_buffer_size', '128M'), ('sort_buffer_size', '2M'), ('read_rnd_buffer_size', '2M'), ('datadir', '/var/lib/mysql'), ('socket', '/var/lib/mysql/mysql.sock'), ('symbolic-links', '0'), ('sql_mode', 'NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES')]
19 
20 #在指定的sections中通过key找出value
21 print(config.get('mysqld','datadir'))
22 
23 #output:
24 /var/lib/mysql
25 
26 #设置某个key的值
27 config.set('mysqld','datadir','/usr/local/lib/mysql')
28 config.write(open('my.cnf','w'))   #回写到文件中
29 print(config.get('mysqld','datadir'))
30 
31 #output:
32 /usr/local/lib/mysql
33 
34 #添加一个section,需要回写到文件中
35 config.add_section('mysql')
36 config.set('mysql','user','root')
37 config.set('mysql','port','3306')
38 config.set('mysql','passwd','123')
39 config.write(open('my.cnf','w'))
40 print(config.items('mysql'))
41 
42 #output:
43 [('user', 'root'), ('port', '3306'), ('passwd', '123')]
44 
45 #移除section或option
46 config.remove_option('mysql','passwd')
47 print(config.items('mysql'))
48 
49 #output:
50 [('user', 'root'), ('port', '3306')]
51 
52 config.remove_section('mysql')
53 config.write(open('my.cnf','w'))
54 print(config.sections())
55 
56 #output:
57 ['mysqld', 'mysqld_safe']

六.subprocess模块

运行python的时候,我们都是在创建并运行一个进程,linux中一个进程可以fork一个子进程,并让这个子进程exec另外一个程序。在python中,我们通过标准库中的subprocess包来fork一个子进程,并且运行一个外部的程序。subprocess包中定义有数个创建子进程的函数,这些函数分别以不同的方式创建子进程,所欲我们可以根据需要来从中选取一个使用。另外subprocess还提供了一些管理标准流(standard stream)和管道(pipe)的工具,从而在进程间使用文本通信。

1)call方法

执行命令时,返回状态码,shell=True允许shell命令字符串形式

 1 >>> import subprocess
 2 >>> subprocess.call(['ifconfig','eth0']) #多选项时使用[]隔开
 3 eth0      Link encap:Ethernet  HWaddr 00:0C:29:78:0E:5A  
 4           inet addr:192.168.146.129  Bcast:192.168.146.255  Mask:255.255.255.0
 5           inet6 addr: fe80::20c:29ff:fe78:e5a/64 Scope:Link
 6           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
 7           RX packets:637524 errors:0 dropped:0 overruns:0 frame:0
 8           TX packets:180621 errors:0 dropped:0 overruns:0 carrier:0
 9           collisions:0 txqueuelen:1000 
10           RX bytes:131549223 (125.4 MiB)  TX bytes:21560909 (20.5 MiB)
11 >>> subprocess.call('ifconfig eth0',shell=True) #指定shell为True时将使用shell原生格式执行。
12 eth0      Link encap:Ethernet  HWaddr 00:0C:29:78:0E:5A  
13           inet addr:192.168.146.129  Bcast:192.168.146.255  Mask:255.255.255.0
14           inet6 addr: fe80::20c:29ff:fe78:e5a/64 Scope:Link
15           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
16           RX packets:644202 errors:0 dropped:0 overruns:0 frame:0
17           TX packets:182941 errors:0 dropped:0 overruns:0 carrier:0
18           collisions:0 txqueuelen:1000 
19           RX bytes:132048205 (125.9 MiB)  TX bytes:21810181 (20.7 MiB)

2)check_call方法

执行命令时如果执行状态码为0,则返回0,否则抛出异常

1 >>>import subprocess
2 >>> subprocess.check_call('pwd')
3 /root
4 >>> subprocess.check_call(['df','-Th'])
5 Filesystem     Type   Size  Used Avail Use% Mounted on
6 /dev/sda3      ext4    97G  3.1G   89G   4% /
7 tmpfs          tmpfs  495M     0  495M   0% /dev/shm
8 /dev/sda1      ext4   190M   27M  153M  16% /boot

3)check_output

#执行命令,并返回结果,注意是返回结果,不是打印

1 >>>import subprocess
2 >>> subprocess.check_output('pwd')
3 b'/root\n'
4 >>> s = subprocess.check_output('pwd')
5 >>> s
6 b'/root\n'

4)getstatusoutput()

#接收字符串格式命令,返回元组形式,第1个元素是执行状态,第2个是命令结果

1 >>> import subprocess
2 >>> subprocess.getstatusoutput('pwd')
3 (0, '/root')

5)getoutput()

#接收字符串格式命令,并返回结果

1 >>> import subprocess
2 >>> subprocess.getoutput(['df','-Th'])
3 'Filesystem     1K-blocks    Used Available Use% Mounted on\n/dev/sda3      100813224 3173844  92511652   4% /\ntmpfs             506144       0    506144   0% /dev/shm\n/dev/sda1         194241   27607    156394  16% /boot'

6)run()

使用subprocess时建议使用run()函数去处理所有它可以处理的情况,因为高级用法可以直接使用底层POPEN接口。
run()函数是Python 3.5中新添加的。
使用方法:
subprocess.run(args*stdin=Noneinput=Nonestdout=Nonestderr=Noneshell=Falsetimeout=Nonecheck=False)
 1 >>> import subprocess
 2 >>> subprocess.run(['ls','/'])  #返回结果
 3 bin   etc   lib64    media1    proc    root     srv  usr
 4 boot  home  lost+found    mnt    pyhton    sbin     sys  var
 5 dev   lib   media    opt    python    selinux  tmp
 6 CompletedProcess(args=['ls', '/'], returncode=0)
 7 
 8 >>> subprocess.run(['ls','/'],stdout=subprocess.PIPE) #命令返回不会输出
 9 CompletedProcess(args=['ls', '/'], returncode=0, stdout=b'bin\nboot\ndev\netc\nhome\nlib\nlib64\nlost+found\nmedia\nmedia1\nmnt\nopt\nproc\npyhton\npython\nroot\nsbin\nselinux\nsrv\nsys\ntmp\nusr\nvar\n')
10 >>> a = subprocess.run(['ls','/'],stdout=subprocess.PIPE)
11 >>> print(a.stdout)  #对返回值进行输出操作
12 b'bin\nboot\ndev\netc\nhome\nlib\nlib64\nlost+found\nmedia\nmedia1\nmnt\nopt\nproc\npyhton\npython\nroot\nsbin\nselinux\nsrv\nsys\ntmp\nusr\nvar\n'
13 >>> print(a.args)   #返回参数
14 ['ls', '/']
15 >>> print(a.returncode)  #返回状态码
16 >>> print(a.stderr)  #返回错误输出
17 None

7)Popen()

#上面那些方法,底层都是封装的subprocess.Popen

参数包括:

  • args: 可以是字符串或者序列类型(如:list, tuple)。默认的,要执行的程序应该是序列的第一个字段,如果是单个字符串,它的解析依赖于平台。在unix中,如果args是一个字符串,那么这个字符串解释成被执行程序的名字或路径,然而,这种情况只能用在不需要参数的程序。
  • bufsieze: 指定缓冲。0表示无缓冲,1表示缓冲,任何其他的整数值表示缓冲大小,负数值表示使用系统默认缓冲,通常表示完全缓冲。默认值为0即没有缓冲。
  • stdin, stdout, stderr:分别表示程序的标准输入,输出,错误句柄
  • preexec_fn : 只在unix平台有效,用于指定一个可执行对象,它将在子进程中运行之前被调用
  • close_fds : 在windows平台下,如果close_fds被设置为true,则新创建的子进程将不会继承父进程的输入,输出,错误管道。所以不能将close_fds设置为true同时重定向子进程的标准输入,输出与错误。
  • shell : 默认值为False, 声明了是否使用shell来执行程序,如果shell=True,它将args看做一个字符串,而不是一个序列。在unix系统中,且shell=True, shell默认使用/bin/sh。
  • cwd : 用于设置子进程的当前目录。当它不为None时,子程序在执行前,它的当前路径会被替换成cwd的值。这个路径并不会被添加到可执行程序的搜索路径,所以cwd不能是相对路径。
  • env : 用于指定子进程的环境变量。如果env=None,子进程的环境变量将从父进程中继承。当它不为None时,它是新进程的环境变量的映射。可以用它来代替当前进程的环境。
  • universal_newlines : 不同系统的换行符不同, 文件对象stdout和stderr都被以文本文件的方式打开,指定True为同意使用\n
  • startupinfo 与 createionflags只在windows下生效。将被传递给底层的CreateProcess()函数,用于设置子进程的一些属性,如:主窗口的外观,进程的优先级等等
 1 >>> import subprocess
 2 >>> subprocess.Popen(['mkdir','test_sub.txt']) #在当前目录下创建文件夹
 3 >>> st = subprocess.Popen(['uname','-r']) #只会打印结果
 4 >>> 2.6.32-504.el6.x86_64
 5 
 6 >>> st   #返回的是一个对象
 7 <subprocess.Popen object at 0x7f3baeceae48>
 8 #使用cwd指定目录创建目录
 9 >>> subprocess.Popen('mkdir t3',shell=True,cwd='/python')
10 <subprocess.Popen object at 0x7f3baecea2b0>

#打开一个python子进程,并通过父进程与子进程交互

 1 >>> import subprocess
 2 >>> a = subprocess.Popen(['python35'],stdin=subprocess.PIPE,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
 3 
 4 >>> a.stdin.write("print(1)\n")  #需要输入字节对象,否则会报错
 5 Traceback (most recent call last):
 6   File "<stdin>", line 1, in <module>
 7 TypeError: a bytes-like object is required, not 'str'
 8 >>> a.stdin.write(b"print(1)\n")
 9 >>> a.stdin.write(b"print(2)\n")
10 >>> a.stdin.write(b"print(3)\n")
11 >>> out_li = a.communicate()  #关闭管道
12 >>> print(out_li)   #打印结果
13 (b'1\n2\n3\n', b'')

自动密码输入实例:

 1 #!/usr/bin/env python35
 2 #coding:utf8
 3 
 4 import subprocess,sys
 5 def mypass():
 6   mypass = 'zhang.com'
 7   return mypass
 8 
 9 echo = subprocess.Popen(['echo',mypass()],stdout=subprocess.PIPE,)
10 #sudo = subprocess.Popen(['sudo','-S','iptables','-L'],stdin=echo.stdout,stdout=subprocess.PIPE,)
11 
12 sudo = subprocess.Popen(sys.argv[1],shell=True,stdin=echo.stdout,stdout=subprocess.PIPE,)
13 end_of_pipe = sudo.stdout
14 print('output:',end_of_pipe.read())
15 
16 
17 [zhang@python ~]$ python35 sub_sudo.py "sudo -S iptables -L"     #使用脚本直接带参数输入命令
18 [sudo] password for zhang: output: b'Chain INPUT (policy ACCEPT)\ntarget     prot opt source               destination         \n\nChain FORWARD (policy ACCEPT)\ntarget     prot opt source               destination         \n\nChain OUTPUT (policy ACCEPT)\ntarget     prot opt source               destination         \n'

七.logging模块

Python的logging模块提供了通用的日志系统,可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别,并可以采用不同的方式记录日志,比如文件,HTTP GET/POST,SMTP,Socket等,甚至可以自己实现具体的日志记录方式。

logging框架中主要由四个部分组成:

  • Loggers: 提供应用直接调用的接口
  • Handlers: 决定将日志记录发送至正确的目的地
  • Filters: 提供更精细的决定哪些日志输出的能力,简单点说就是决定哪些输出哪些不输出
  • Formatters: 制定最终输出的格式。

1)logger对象

logger是不直接实例化的,但是我们可以通过模块级别的函数logging.getLogger(name)来调用。如果多次通过同一个名字调用getLogger()将只能得到对同一个对象的引用。

每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名,比如聊天工具的图形界面模块可以这样获得它的Logger:
LOG=logging.getLogger(”chat.gui”)
而核心模块可以这样:
LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志级别,低于lel的级别将被忽略。debug是最低的内置级别,critical为最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr):增加或删除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以设置的日志级别

 1 import logging
 2 
 3 logging.info('this is info message')
 4 logging.warning('this is warning message')
 5 logging.debug('this is debug message')
 6 
 7 #output
 8 WARNING:root:this is warning message
 9 
10 #默认情况下,logging将日志打印到屏幕,日志级别为WARNING;
11 #日志级别大小关系为:CRITICAL > ERROR > WARNING > INFO > #DEBUG > NOTSET,当然也可以自己定义日志级别。

2)handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台,有些Logger可以把信息输出到文件,还有些 Handler可以把信息发送到网络上。如果觉得不够用,还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler
Handler.setLevel(lel):指定被处理的信息级别,低于lel级别的信息将被忽略
Handler.setFormatter():给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt):新增或删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler:
(1) logging.StreamHandler
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是:
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr

 

(2) logging.FileHandler
和StreamHandler类似,用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是:
FileHandler(filename[,mode])
filename是文件名,必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a',即添加到文件末尾。

(3) logging.handlers.RotatingFileHandler
这个Handler类似于上面的FileHandler,但是它可以管理文件大小。当文件达到一定大小之后,它会自动将当前日志文件改名,然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后,RotatingFileHandler自动把 文件改名为chat.log.1。不过,如果chat.log.1已经存在,会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log,继续输出日志信息。它的构造函数是:
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode两个参数和FileHandler一样。
maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。
backupCount用于指定保留的备份文件的个数。比如,如果指定为2,当上面描述的重命名过程发生时,原有的chat.log.2并不会被更名,而是被删除。

(4) logging.handlers.TimedRotatingFileHandler
这个Handler和RotatingFileHandler类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似,不过新的文件不是附加数字,而是当前时间。它的构造函数是:
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
interval是时间间隔。
when参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值:
S 秒
M 分
H 小时
D 天
W 每星期(interval==0时代表星期一)
midnight 每天凌晨

#日志切割示例:

 

 1 #!/usr/bin/env python
 2 #coding:utf8
 3 
 4 import logging
 5 from logging import handlers
 6 #创建一个logger对象
 7 logger = logging.getLogger(__name__)
 8 #日志文件名
 9 log_file = 'timelog.log'
10 #配置自动日志切割backupCount指定回滚日志次数
11 fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=5)
12 #配置日志格式
13 formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
14 #指定日志格式
15 fh.setFormatter(formatter)
16 #指定发送日志Handler
17 logger.addHandler(fh)
18 
19 #生成日志
20 logger.warning('test1')
21 logger.warning('test2')
22 logger.warning('test3')
23 logger.warning('test4')
24 logger.warning('test5')
25 logger.warning('test6')
26 logger.warning('test7')
27 logger.warning('test8')

3)Filters

(提供更精细的决定哪些日志输出的能力,简单点说就是决定哪些输出哪些不输出)

设置级别 logger.setLevel(logging.DEBUG),Logging中有NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL这几种级别,日志会记录设置级别以上的日志

DEBUG:详细的信息,通常只出现在诊断问题上
INFO:  确认一切按预期运行
WARNING:一个迹象表明,一些意想不到的事情发生了,或表明一些问题在不久的将来(例如。磁盘空间低”)。这个软件还能按预期工作。
ERROR:   更严重的问题,软件没能执行一些功能
CRITICAL:一个严重的错误,这表明程序本身可能无法继续运行

这5个等级,也分别对应5种打日志的方法: debug 、info 、warning 、error 、critical。默认的是WARNING,当在WARNING或之上时才被跟踪。

4)Formatters

制定最终输出的格式。

通过logging.basicConfig函数对日志的输出格式及方式做相关配置

 1 import logging
 2 
 3 logging.basicConfig(level=logging.DEBUG,
 4                     format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
 5                     datefmt='%Y-%m-%d %H:%M:%S',
 6                     filemode='w',filename='access.log')
 7 
 8 logging.debug('this is debug message')
 9 logging.info('this is debug message')
10 logging.warning('this is debug message')
11 
12 
13 #output
14 2017-12-17 16:58:47 formatter_f.py[line:13] DEBUG this is debug message
15 2017-12-17 16:58:47 formatter_f.py[line:14] INFO this is debug message
16 2017-12-17 16:58:47 formatter_f.py[line:15] WARNING this is debug message

ogging.basicConfig函数各参数:
filename: 指定日志文件名
filemode: 和file函数意义相同,指定日志文件的打开模式,'w'或'a'
format: 指定输出的格式和内容,format可以输出很多有用信息,如上例所示:

%(name)s:logger的名字
 %(levelno)s: 打印日志级别的数值
 %(levelname)s: 打印日志级别名称
 %(pathname)s: 打印当前执行程序的路径,其实就是sys.argv[0]
 %(filename)s: 打印当前执行程序名
 %(funcName)s: 打印日志的当前函数
 %(lineno)d: 打印日志的当前行号
 %(asctime)s: 打印日志的时间
 %(thread)d: 打印线程ID
 %(threadName)s: 打印线程名称
 %(process)d: 打印进程ID
 %(message)s: 打印日志信息
datefmt: 指定时间格式,同time.strftime()
level: 设置日志级别,默认为logging.WARNING
stream: 指定将日志的输出流,可以指定输出到sys.stderr,sys.stdout或者文件,默认输出到sys.stderr,当stream和filename同时指定时,stream被忽略

 

 1 #!/usr/bin/env python
 2 #coding:utf8
 3 
 4 import logging
 5 #创建一个logger对象
 6 logger = logging.getLogger()
 7 logger.setLevel(logging.DEBUG)
 8 
 9 #定义日志输出格式
10 formatter = logging.Formatter('%(asctime)s %(thread)d %(threadName)s %(process)d[line:%(lineno)d] %(levelname)s %(message)s')
11 
12 #创建屏幕输出对象并设置级别
13 console = logging.StreamHandler()
14 console.setLevel(logging.INFO)
15 
16 #创建文件输出对象并设置级别
17 file = logging.FileHandler('all_acc.log')
18 file.setLevel(logging.ERROR)
19 
20 #定义对象的日志输出格式
21 file.setFormatter(formatter)
22 console.setFormatter(formatter)
23 
24 #添加日志到文件和屏幕
25 logger.addHandler(console)
26 logger.addHandler(file)
27 
28 #输入日志
29 logging.debug('this is debug message')
30 logging.info('this is info message')
31 logging.warning('this is warning message')
32 logging.error('this is error message')
33 logging.critical('this is critical message')
34 
35 #OUTPUT:
36 #console:
37 2017-12-17 21:42:28,356 6056 MainThread 1088[line:30] INFO this is info message
38 2017-12-17 21:42:28,356 6056 MainThread 1088[line:31] WARNING this is warning message
39 2017-12-17 21:42:28,356 6056 MainThread 1088[line:32] ERROR this is error message
40 2017-12-17 21:42:28,356 6056 MainThread 1088[line:33] CRITICAL this is critical message
41 #file
42 2017-12-17 21:41:17,199 9000 MainThread 8448[line:33] CRITICAL this is critical message
43 2017-12-17 21:42:28,356 6056 MainThread 1088[line:32] ERROR this is error message
44 2017-12-17 21:42:28,356 6056 MainThread 1088[line:33] CRITICAL this is critical message
 1 #!/usr/bin/env python
 2 #coding:utf8
 3 
 4 import os
 5 import logging.config
 6 
 7 # 定义三种日志输出格式 开始
 8 standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \
 9                   '[%(levelname)s][%(message)s]' #其中name为getlogger指定的名字
10 simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
11 id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'
12 
13 logfile_dir = os.path.dirname(os.path.abspath(__file__))
14 # log文件的目录
15 #print(logfile_dir)
16 logfile_name = 'all2.log'  # log文件名
17 logfile_path = os.path.join(logfile_dir, logfile_name)
18 
19 # log配置字典
20 LOGGING_DIC = {
21     'version': 1,
22     'disable_existing_loggers': False,
23     'formatters': {
24         'standard': {
25             'format': standard_format
26         },
27         'simple': {
28             'format': simple_format
29         },
30     },
31     'filters': {},
32     'handlers': {
33         #打印到终端的日志
34         'console': {
35             'level': 'DEBUG',
36             'class': 'logging.StreamHandler',  # 打印到屏幕
37             'formatter': 'simple'
38         },
39         #打印到文件的日志,收集info及以上的日志
40         'default': {
41             'level': 'DEBUG',
42             'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件
43             'formatter': 'standard',
44             'filename': logfile_path,  # 日志文件
45             'maxBytes': 1024*1024*5,  # 日志大小 5M
46             'backupCount': 5,
47             'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
48         },
49     },
50     'loggers': {
51         #logging.getLogger(__name__)拿到的logger配置
52         '': {
53             'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
54             'level': 'DEBUG',
55             'propagate': True,  # 向上(更高level的logger)传递
56         },
57     },
58 }
59 
60 
61 def load_my_logging_cfg():
62     logging.config.dictConfig(LOGGING_DIC)  # 导入上面定义的logging配置
63     logger = logging.getLogger(__name__)  # 生成一个log实例
64     logger.info('It works!')  # 记录该文件的运行状态
65 
66 if __name__ == '__main__':
67     load_my_logging_cfg()
68 
69 logging config

 

posted @ 2018-10-10 12:33  it_works  阅读(256)  评论(0编辑  收藏  举报