Python遇上Stata--IPyStata介绍

本文作者：任哲，中南财经政法大学经济学院
文字编辑：王子一
技术总编：张馨月

前言

我们都知道Python是一种胶水语言，那么自然就会有人想，能不能在Python中与Stata进行互动呢？在国外有位名叫Ties de Kok的大神不仅这么想了，而且还这么做了。Ties de Kok大神开发了神器IPyStata来帮助大家在Python环境下使用Jupyter notebook调用Stata，接下来本文将以Windows系统为例向大家介绍IPyStata。

1、IPyStata的安装

在Windows系统下，请打开命令提示符cmd ，并输入执行pip install ipystata，出现下图所示的Successfully installed ipystata-0.3.8，即表示安装成功：

image

安装成功后，要对IPyStata进行设置。首先，我们找到Stata软件的安装路径，并在命令提示符cmd的管理员模式中切换到Stata所在的目录。随后再输入“StataMP-64.exe”或者“StataMP-64.exe /Register”注册Stata。

image

接下来，打开Jupyter notebook告诉IPyStata关于Stata的路径。如果之前没有使用过Jupyter notebook，可以阅读一下之前的推文《Jupyter Notebook的使用》。

import ipystata
from ipystata.config import config_stata 
#请在此处告诉IPyStata在哪里可以找到Stata
config_stata(r'F:\Stata16\StataMP-64')

IPyStata在Windows系统中可以使用两种不同的模式与Stata进行交互：Stata Automation模式（Windows独有）和Stata Batch模式（Windows，Mac OS X和Linux皆可使用）。Windows默认使用功能更加强大的Stata Automation模式，但如果你想使用Stata Batch模式，可以通过以下方式设置。

#通过以下命令设置Stata Batch mode模式。
import ipystata
from ipystata.config import config_stata
config_stata(r'F:\Stata16\StataMP-64', force_batch=True)

如果屏幕中打印出IPyStata is loaded in batch mode.的字样，即代表设置成功。

在设置完成之后，需要重启Jupyter notebook，也即先点击菜单栏中的Kernel，再点击restart。

ps：设置只需要在首次运行IPyStata之前进行，之后除非帮Stata搬了家，否则无需再次设置。

2、IPyStata的使用

在进行完上述的准备之后，就可以在Jupyetr notebook上使用IPyStata的各种功能了。IPyStata的功能有很多，这里给大家介绍一些常用的功能。

2.1、小牛试刀--第一条命令

首先导入需要用的库：

import ipystata
import pandas as pd

之后，我们需要在每个cell的首行写上%%stata ，这样IPyStata就会把该cell里的内容翻译成Stata可识别的格式。注意与Stata无关的代码不要和%%stata放在同一个cell里哦！

下面，我们来进行一个简单的尝试：

%%stata  
display "We love Stata&Python!"

结果如下：

image

除此之外，IPyStata有以下几种常用的命令，接下来我们会一一展示：

命令	命令缩写	功能
--data	-d	将jupyter notebook中的数据传到Stata
--output	-o	将Stata中的数据传到jupyter notebook
--graph	-gr	绘制图表
--input	-i	将Python列表作为宏导入到Stata
--getmacro	-gm	将Stata定义的宏导入到Python字典之中（仅适用于Stata Automation模式）
--openstata	-os	通过Python打开Stata窗口

2.2、将Python中的数据导入Stata

格式：%%stata -d dataframe名称

我们先创建一个关于武汉和黄冈人口数据的dataframe,命名为df_test，具体如下:

#注意与Stata无关的代码不要和%%stata放在同一个代码块里
data = {'Wuhan': {2015:1060.77,2016: 1076.62, 2017: 1089.29, 2018: 1108.1,2019:1121.2}, 'Huanggang': {2015:629.1,2016: 632.1, 2017: 634.1, 2018: 633,2019:633.3}}
df_test = pd.DataFrame(data)
df_test

image

接下来，将df_test读入Stata，并利用sum2docx进行描述性分析。sum2docx命令是由爬虫俱乐部开发的外部命令，该命令可以生成描述性统计结果并将输出到指定word文档里。如果之前没有安装此命令，可以直接在当前cell里通过ssc install sum2docx进行安装。

%%stata -d df_test
 ssc install sum2docx,replace
 sum2docx Wuhan Huanggang using d:/temp1.docx, replace stats(N mean(%9.2f) sd min(%9.0g) median(%9.0g) max(%9.0g))

image

需要注意不同于Stata，这里不会直接生成word文档的超链接，不过我们可以手动找到该文档，如下：

image

2.3、将Stata中的数据导出到Python

格式：%%stata -o dataframe名称

比如，我们可以使用Stata中的cntrade命令下载长江电力的交易数据，并放入名为stock_df的dataframe中。由于IPyStata的编码问题，我们需要将stknme这一列更改为UTF-8编码。具体如下：

#把长江电力的数据导出到stock_df之中
%%stata -o stock_df
cntrade 600900
replace stknme = ustrfrom(stknme, "utf-8", 1)

在新的cell之中，查看是否导入成功:

stock_df.head()

image

2.4、利用IPyStata绘制图形

格式：%%stata -gr -d dataframe名称

平时我们在Python绘图常常用到pyecharts等外部包，但如果你不熟悉这些用法，就可以借助-gr(--graph)命令帮助我们直接调用Stata进行绘图，示例如下：

%%stata  -gr -d df_test  
graph twoway scatter Wuhan index</pre>

image

2.5、将列表作为宏导入到Stata

格式：%%stata -i list名称

例子如下：

example_list = ['wuhan', 'zhengzhou','chengdu ','changsha']

%%stata -i example_list
foreach i in `example_list' {
 dis "`i'"
}

ps:上述代码需分两个cell执行。

结果如下：

image

2.6、将Stata定义的宏导出到字典macro_dict

格式：%%stata -gm 宏的名称

例子如下：

%%stata -gm macro_1 
local macro_1 Python Stata

print(macro_dict)

ps:上述代码需分两个cell执行

在上述代码中，我们先在Stata中定义了一个名为macro_1 的宏，通过使用IPyStata，可以将这个宏添加到Python中名为macro_dict的字典中，宏的名称与内容分别对应于字典的key与value：

image

2.7、通过Python打开Stata窗口

格式：%%stata -os

在实际操作中，我们有时候会需要在Python完成一部分工作，并用Stata进行后续处理，使用%%stata -os可以大大方便我们的操作，直接打开Stata应用程序。示例如下：

%%stata --data df_test -os 
graph twoway scatter Wuhan index

执行上述代码会将df_test导入的Stata中，并弹出Stata窗口绘制散点图，之后的相关操作都可以直接在Stata中进行，结果如下：

image

3、IPyStata的缺陷

很遗憾，目前在IPyStata对中文的处理不够友好，尽管对于数据集中的中文，可以参考本文2.3的内容进行转码处理，但是IPyStata目前无法识别中文文件名，中文路径等，也是使用过程中我们需注意的地方。

以上就是IPyStata常用功能的介绍了。如果想了解更多更详细的内容，可以前往Github上的[IPyStata主页] (https://github.com/TiesdeKok/ipystata)进学习~~