出来搞事情了,iOS项目中嵌入Python解释器

前言

想必大家都知道 Python 是一个最近几年火到爆炸的语言。大数据、机器学习、爬虫、自动化运维balabala一大堆应用。良好的可读性,对于上手难度也不会门槛太高。
之前公司项目中有做导航App,我带搜索小组。功能交互啥玩意的都基本上定好了,但是有一些国外商业化数据太贵也不够全面,数据可新等级也不咋地,没米下锅啊。负责做数据分析的大哥就pa了上亿条 POI 数据,🐂上天。(当然还是要遵纪守法)

今天本文仅是在项目中嵌入Python编译环境,然后调用 Python 中的方法,并解析返回值。另鉴于本人 Python 菜鸡选手,如果错误还请大佬不吝指教。

Python 之初印象

  1. Python 是面向对象的编程语言。它的类支持多态、多重继承等等高级 OOP 概念。当然像 C++ 一样,Python 支持面向对象编程,也支持面向过程编程的模式。
  2. Python 是一种解释型语言。目前Python的标准实现方式是将源代码的语句转为字节码格式,通过解释器解释。Python 没有将代码编译成二进制代码,所以相较于 C 和 C++ 等编译型语言,Python的执行速度会有数量级上的差异。
  3. Python 提供了完备的基础代码库,有网络、正则、多线程、GUI、数据库、等等等。当然了,除了内置的库外,Python 还有大量的第三方轮子,供你享用。
  4. Python 可被嵌入到其他语言开发的程序中。Python 解析器能很方便地执行代码和 debug,可作为一个编程接口嵌入一个应用程序中。而且Python解释器负责管理Python的内存管理。

以上几点中第4点就是本文主要实践和探索的:
在 OC 项目中调用 Python 方法,并处理返回值。你问我有啥意义?搞事情啊

  1. 内嵌 Python 解释器后,N多轮子供你使用。

  2. 脚本可以动态化,就像游戏开发时候很多用 lua 来进行动态化。
    好了,开干。

项目配置

Python解释器

github 上有大佬写了个Python Apple Support

配置项目编译环境

新建 Xcode 项目(本文是iOS 15 SDK)
本文项目中使用的是Python-3.8-iOS-support.b7


然后在 Link Binary With Libraries 中加入缺失的依赖库 libsqlite3.tbd、libz.tbd。具体的步骤不再赘述,可以参考demo

具体实践

设置 PythonPath、PythonHome 然后初始化

    //设置python环境变量(包含项目资源文件目录、其他Python文件目录)
    NSString *resourcePath = [[NSBundle mainBundle] pathForResource:@"Python_script" ofType:@"bundle"];
    
    NSArray *pythonPathArr = [NSArray arrayWithObjects:resourcePath,
                                [resourcePath stringByAppendingPathComponent:@" "],
                                [resourcePath stringByAppendingPathComponent:@"Python"],
                                nil];

    int setenvRes = setenv("PYTHONPATH", [[pythonPathArr componentsJoinedByString:@":"] UTF8String], 1);

    //这里的路径结合可我demo中去理解
    NSString *pythonHome = [NSString stringWithFormat:@"%@/Python3.8.bundle/Resources", [[NSBundle mainBundle] resourcePath], nil];
       
    wchar_t *wPythonHome = Py_DecodeLocale([pythonHome UTF8String], NULL);
    
    Py_SetPythonHome(wPythonHome);
    
    //解初始化Python解析器
    Py_Initialize();
    //检测是否初始化成功
    if (!Py_IsInitialized()) {
        return -1;
    }

run一个简单的python脚本

    PyRun_SimpleString("print('oc project calls python methods')");

run一个简单的Python文件

    NSString *path = [[NSBundle mainBundle] pathForResource:@"XX" ofType:@"py"];
    
    FILE *file = fopen([path UTF8String], "r");
   
    PyRun_SimpleFile(mainfileFile, (char *)[[scriptPath lastPathComponent] UTF8String]);

对于 run 完后,我们要释放,需要调用Py_Finalize()

OC传参调用Python方法,然后解析Python返回值

这个操作的流程,基本就是找到 Python 文件,找到 Python 的 class,然后找到对应的方法,转换参数,填入参数。然后解析返回值 callback。

    //导入模块
    PyObject *pModule = PyImport_ImportModule(fileName);
    
    //根据类名获得类
    PyObject *pyClass = PyObject_GetAttrString(pModule, [className UTF8String]);
    
    //创建实例
    PyObject *pyInstance = PyInstanceMethod_New(pyClass);
    
    //参数序列化
    NSError *error = nil;
    
    NSData *jsonData = [NSJSONSerialization dataWithJSONObject:parameter options:NSJSONWritingPrettyPrinted error:&error];
    
    NSString *paramterJsonStr = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
    
    //调用Python方法
    PyObject *result = PyObject_CallMethod(pyInstance, [methodName UTF8String], "(N,s)", [paramterStr UTF8String]);
    
    char *cStr = NULL;
    //把Python方法的返回值解析为char
    PyArg_Parse(result, "s", &cStr);

怎么样,简单吧。看到这,何不如亲自动手试试?

一些补充

  1. 有两个宏 Py_INCREF(pObj)Py_DECREF(pObj) 被用于增和减引用计数 reference counts。当引用计数为0时,释放对象。一般调用Py_Something的函数需要去调用下 Py_DECREF()。有兴趣再多了解的可搜 Python 的引用计数。
  2. 本文demo中引入的 Python 以及需要的编译依赖资源过大。不像 OC 项目嵌入 lua 解释器只需要非常少的空间即可。
  3. 之前也有看到过用 Python 开发 iOS 项目,感兴趣的可以去google上搜Build a Mobile Application with Python或者直接搜索 kivy 这个 Python 开发框架。
  4. 解析返回值PyObject *results,单个返回值:PyArg_Parse(),多返回值:PyArg_ParseTuple()
  5. 本文用到的 libPython.a 因为太大,上传 github 时候提示超过100MB上传失败。所以后来用了 Git LFS。Git LFS的简单介绍

本文Demo

THPythonExecutor

其他

C++调用Python脚本
Embedding Python in Another Application

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容