临近年关,不少在外的游子都急着买票回家,但这时候的火车票,总是供不应求的。
我想到了几年前徐峥主演的《人在囧途》,春运期间,一个老板,一个民工,同时都因为买不到火车票而囧态百出,甚至辗转到了坐拖拉机回家的地步。
但回家,始终是春节期间,一个无法阻挡的词汇。
实验楼的项目《Python3 实现火车票查询工具》可以在帮助大家练习Python的同时,实时查询火车票,感兴趣的同学还能实现一些拓展功能,比如有票时的邮件提醒,显示有无座位,显示时间格式等。
项目简介:使用 Python3 抓取 12306 网站信息提供一个命令行的火车票查询工具。通过该项目的实现,可以熟悉 Python3 基础及网络编程,以及 docopt,requests,prettytable 等库的使用。
项目由小蜗牛发布在实验楼,完整教程及在线练习地址:Python3 实现火车票查询工具,可以直接在教程中下载代码使用demo。
一、实验简介
当你想查询一下火车票信息的时候,你还在上 12306 官网吗?或是打开你手机里的 APP?
下面让我们来用 Python 写一个命令行版的火车票查看器, 只要在命令行敲一行命令就能获得你想要的火车票信息!如果你刚掌握了Python基础,这将是个不错的小练习。
1.1 知识点
Python 基础知识的综合运用
docopt、requests、colorama 及 prettytable 库的使用
setuptools 的使用
1.2 效果截图
二、接口设计
一个应用写出来最终是要给人使用的,哪怕只是给你自己使用。
所以,首先应该想想你希望怎么使用它?让我们先给这个小应用起个名字吧,既然涉及查询票务信息,那就叫它 tickets 好了。
我们希望用户只要输入出发站,到达站以及日期就能获得想要的信息,比如要查看10月10号上海-北京的火车余票, 我们只需输入:
$ python3 tickets.py 上海 北京 -10-10
**注意:**上面的日期(包括后面的)是笔者写文章时确定的日期,当你在做这个项目的时候可能要根据当前时间做适当调整。
转化为程序语言就是:
$ python tickets.py from to date
另外,火车有各种类型,高铁、动车、特快、快速和直达,我们希望可以提供选项只查询特定的一种或几种的火车,所以,我们应该有下面这些选项:
-g 高铁-d 动车-t 特快-k 快速-z 直达
这几个选项应该能被组合使用,所以,最终我们的接口应该是这个样子的:
$ python3 tickets.py [-gdtkz] from to date
接口已经确定好了,剩下的就是实现它了。
三、代码实现
首先安装一下实验需要用到的库:
$ sudo pip3 install requests prettytable docopt$ sudo pip3 install --upgrade colorama #升级环境中的 colorama
requests
,使用 Python 访问 HTTP 资源的必备库。docopt
,Python3 命令行参数解析工具。prettytable
, 格式化信息打印工具,能让你像 MySQL 那样打印数据。colorama
,命令行着色工具
3.1 解析参数
Python有很多写命令行参数解析工具,如 argparse, docopt, click,这里我们选用的是 docopt 这个简单易用的工具。docopt 可以按我们在文档字符串中定义的格式来解析参数.
我们在 /home/shiyanlou/ 目录下新建 tickets.py 文件,并向其中写入下面的内容(实验楼环境下,通过点击右下角的键盘小图标可以选择中文输入法):
# coding: utf-8"""命令行火车票查看器Usage:tickets [-gdtkz] <from> <to> <date>Options:-h,--help 显示帮助菜单-g高铁-d动车-t特快-k快速-z直达Example:tickets 北京 上海 -10-10tickets -dg 成都 南京 -10-10"""from docopt import docoptdef cli():"""command-line interface"""arguments = docopt(__doc__)print(arguments)if __name__ == '__main__':cli()
上面的程序中, docopt 会根据我们在 docstring 中的定义的格式自动解析出参数并返回一个字典,也就是 arguments, 我们打印出了这个字典的内容。下面我们运行一下这个程序, 比如查询一下10月30号从成都到南京的动车和高铁:
$ python3 tickets.py -dg 成都 南京 -10-10
我们得到下面的参数解析结果:
3.2 获取数据
参数已经解析好了,下面就是如何获取数据了,这也是最主要的部分。首先我们用实验楼环境的Firefox浏览打开 12306,进入余票查询页面,按下F12
打开开发者工具,选中Network
一栏,在查询框中随便查询一次,我们在调试工具观察下请求和响应:
注意到上面的请求 URL ,它是由基 URL/otn/leftTicket/queryO加四个参数构成的,这四个参数分别代表,查询的类型(成人?学生?),日期,出发车站,到达车站:
再来看看响应:
返回的是JSON格式的数据! 我们打开返回的数据看看:
可以看到一列火车的数据用 Python 的语言说就是一个字典。
接下来问题就简单了,我们只需要利用这个接口, 构建请求URL然后解析返回的JSON数据就可以了。但是我们发现,URL里面参数 from_station 和 to_station 并不是汉字,而是一个代号,而我们想要输入的是汉字,我们要如何获取代号呢?我们打开网页源码看看有没有什么发现。
果然,这里有个关于 station 的文件,打开看看:
station_names 是一个很长的字符串, 这里面貌似是包含了所有车站的中文名,拼音,简写和代号等信息。但是这些信息挤在一起,而我们只想要车站的拼音和大写字母的代号信息,怎么办呢? 正则表达式!我们写个小脚本来匹配提取出想要的信息吧。
在 /home/shiyanlou/ 目录下新建 parse_station.py ,并向其中写入如下代码:
available_trains = r.json()['data']['result']
我们运行这个脚本,它将以字典的形式返回所有车站和它的大写字母代号, 我们将结果重定向到 stations.py 中,
$ python3 parse_station.py > stations.py
我们为这个字典加名字,stations, 最终,stations.py文件是这样的:
现在,用户输入车站的中文名,我们就可以直接从这个字典中获取它的字母代码了:
class TrainsCollection:header = '车次 车站 时间 历时 一等 二等 高级软卧 软卧 硬卧 硬座 无座'.split()def __init__(self, available_trains,available_place, options):"""查询的火车班次集合:param available_trains: 一个列表, 包含可获得的火车班次, 每个火车班次是一个字典:param options: 查询的选项, 如高铁, 动车, etc..."""self.available_trains = available_trainsself.available_place = available_placeself.options = options@propertydef trains(self):for raw_train in self.available_trains:raw_train_list = raw_train.split('|')train_no = raw_train_list[3]initial = train_no[0].lower()duration = raw_train_list[10]if not self.options or initial in self.options:train = [train_no,# train number'\n'.join([self.available_place[raw_train_list[6]],#始发站self.available_place[raw_train_list[7]]]),#终点站'\n'.join([raw_train_list[8],# 发车时间raw_train_list[9]]),# 到站时间duration,#时长raw_train_list[-6] if raw_train_list[-6] else '--',# 一等 raw_train_list[-7] if raw_train_list[-7] else '--',# 二等 raw_train_list[-15] if raw_train_list[-15] else '--',# 高级软卧raw_train_list[-8] if raw_train_list[-8] else '--',# 软卧raw_train_list[-14] if raw_train_list[-14] else '--',#硬卧raw_train_list[-11] if raw_train_list[-11] else '--',#硬座raw_train_list[-9] if raw_train_list[-9] else '--',#无座]yield traindef pretty_print(self):pt = PrettyTable()pt._set_field_names(self.header)for train in self.trains:pt.add_row(train)print(pt)
万事俱备,下面我们来请求这个URL获取数据吧!这里我们使用 requests 这个库, 它提供了非常简单易用的接口,
...import requestsdef cli():...# 添加verify=False参数不验证证书r = requests.get(url, verify=False)print(r.json())</pre>
我们已经知道该请求返回的是JSON数据, 使用 requests 提供的 r.json() 可以将 JSON 数据转化为 Python 字典,上面我们打印了这个字典,运行程序,我们看到:
佷明显,查询结果中与列车时刻相关的信息都位于一个名为 result 的数组中:
...class TrainCollection:......def cli():"""command-line interface"""arguments = docopt(__doc__)from_station = stations.get(arguments['<from>'])to_station = stations.get(arguments['<to>'])date = arguments['<date>']url = ('/otn/leftTicket/queryO?''leftTicketDTO.train_date={}&''leftTicketDTO.from_station={}&leftTicketDTO.to_station={}&purpose_codes=ADULT').format(date, from_station, to_station)r = requests.get(url, verify=False)available_trains = r.json()['data']['result']available_place = r.json()['data']['map']options = ''.join([key for key, value in arguments.items() if value is True])TrainsCollection(available_trains,available_place, options).pretty_print()
result 中的每个元素都是包含了列车信息的字符串,并以 | 分隔。所以可以先用 split 将字符串分解成列表,然后再读取感兴趣的数据。
3.3 解析数据
我们封装一个简单的类来解析数据:
...class TrainCollection:......def cli():"""command-line interface"""arguments = docopt(__doc__)from_station = stations.get(arguments['<from>'])to_station = stations.get(arguments['<to>'])date = arguments['<date>']url = ('/otn/leftTicket/queryO?''leftTicketDTO.train_date={}&''leftTicketDTO.from_station={}&leftTicketDTO.to_station={}&purpose_codes=ADULT').format(date, from_station, to_station)r = requests.get(url, verify=False)available_trains = r.json()['data']['result']available_place = r.json()['data']['map']options = ''.join([key for key, value in arguments.items() if value is True])TrainsCollection(available_trains,available_place, options).pretty_print()
3.4 显示结果
最后,我们将上述过程进行汇总并将结果输出到屏幕上:
...class TrainCollection:......def cli():"""command-line interface"""arguments = docopt(__doc__)from_station = stations.get(arguments['<from>'])to_station = stations.get(arguments['<to>'])date = arguments['<date>']url = ('/otn/leftTicket/queryO?''leftTicketDTO.train_date={}&''leftTicketDTO.from_station={}&leftTicketDTO.to_station={}&purpose_codes=ADULT').format(date, from_station, to_station)r = requests.get(url, verify=False)available_trains = r.json()['data']['result']available_place = r.json()['data']['map']options = ''.join([key for key, value in arguments.items() if value is True])TrainsCollection(available_trains,available_place, options).pretty_print()
运行下程序看看效果吧:
3.5 着色
至此, 程序的主体已经完成了, 但是上面打印出的结果是全是黑白的,很是乏味, 我们来给它添加点颜色吧! 这里我们使用 colorama 这个命令行着色工具:
from colorama import init, Foreinit()
修改一下程序,将出发车站与出发时间显示为绿色,到达车站与到达时间显示为红色:
...'\n'.join([Fore.GREEN + raw_train['from_station_name'] + Fore.RESET,Fore.RED + raw_train['to_station_name'] + Fore.RESET]),'\n'.join([Fore.GREEN + raw_train['start_time'] + Fore.RESET,Fore.RED + raw_train['arrive_time'] + Fore.RESET]),...
现在再运行程序就可以像文章开始的效果图一样了!
四、Setup
上面的程序中我们运行程序的方式是这样的:
python3 tickets.py from to date
我们当然可以将脚本改成可执行的,然后这样执行:
./tickets.py from to date
但这也不是理想的方案,因为我们必须在脚本的目录下才能运行。我们想要的是在命令行的任何地方都可以这样运行:
ticktes from to date
这是可以实现的,我们需要借助 Python 的 SETUP 工具。写一个简单的 setup 脚本:
from setuptools import setupsetup(name='tickets',py_modules=['tickets', 'stations'],install_requires=['requests', 'docopt', 'prettytable', 'colorama'],entry_points={'console_scripts': ['tickets=tickets:cli']})
在命令行运行一下:
python3 setup.py install
现在我们可以愉快的查询了:
五、总结
本课程使用 Python3 抓取 12306 网站信息提供一个命令行的火车票查询工具。通过该项目的实现,可以学习并实践 Python3 基础及网络编程,以及 docopt,requests,prettytable,colorama 等库的使用。
感兴趣的同学可以实现更多拓展功能:
有票时,邮箱提醒显示商务坐, 是否有无座位添加参数支持,用户可以指定火车类型支持更多的时间格式,如:1010
本项目的完整代码及demo,可在实验楼课程《Python3 实现火车票查询功能》查看并在线完成。