时隔一年没有更新博客,这次准备来个专题「方便的 Python」。
一个资深程序员写的代码,要能让新人看懂,一个大师级程序员写的代码,能让 CS 专业的大一学生看懂。写的代码不仅要追求性能优功能强,还有一个重要的特质——方便易懂。所以本文是「方便的 Python」的其中一个主题,拓展方便。
本文将介绍如何使用 Python 的特性把一个功能扩展的开发逐步收拢到只有一个改动点。代码的收拢点越少,出 bug 的可能性就小。这个案例并非脱离实际,而是我在项目实践中经常遇到的一个场景——策略与注册,对接多家房产客户有使用过这个方案。
背景介绍:
小朱收到一个需求,做一个新闻聚合机器人,从一些门户网站上获取新闻,发到飞书群中,并且允许用户指定某个来源。小朱经过一番思考,觉得这是一个简单的爬虫程序,于是很快写出了主体部分:
小朱特意把 get_news() 留了出来,因为新闻来源有多个,他打算应用设计模式中的「策略模式」,把每种来源作为一个单独的策略类,暴露相同的接口,他还用上了抽象类,做了一个基类出来:
接着,他通过子类做出了 HackerNews,V2EX,今日头条的策略类 HNSource,V2Source,TTSource。最后实现 get_news 方法:
注: itertools.chain() 可以拼接多个可迭代对象,依次迭代。
功能上线,领导很满意,小伙伴们现在能在 IM 里直接看新闻了。
初次尝试:
过了一礼拜,领导要加一个新闻源 Python China,小朱觉自己架子搭得很好了,于是就交给了新来的小刘去做,小刘看完代码,很快啊,就加好了功能:
在 sources/ 下面新建一个 pychina.py,实现了PyChina
在 sources/__init__.py 中新增 from sources.pychina import PyChina
在 main.py 中加上 from sources import PyChina
在 get_news() 中新增 elif source == 'pychina' 的情形
功能上线了,运行无 bug,但一天之后大家发现没有指定新闻源的时候永远看不到 Python China 的新闻。大家应该很快发现了,有处改动漏掉了:if source is None 的情况下应该加上 PyChina。复盘之后小刘接锅:新增一个策略,涉及的改动点太多了,一个不熟悉代码的人很容易漏掉。
消灭if-else:
于是小刘略加改动,创建了一个字典来保存所有策略,消灭掉了 if-else:
这下改动点减少了一个(get_news() 内部不用改动,但source_map新增一个改动点)。
动态导入+注册中心:
小刘发现这样改动点还是太多了,主要原因是这个字典需要自己维护,很浪费精力。有没有办法自动生成这个映射呢?用注册大法!首先写一个注册方法:
然后修改下各新闻源子类
这样做的好处是,进入装饰器 @register 当引入某个新闻子类就会自动注册子类到 source_map 中,所有和一个新闻源相关的参数都集中到一处了,开发者在扩展新的新闻源的时候,关注点无需在不同文件中跳来跳去。
为了避免每次新增其他新闻时还修改 expand/sources/__init__.py 中的代码,可以根据使用 Django 的经验想到,可以扫描 sources/ 目录下面的所有文件,自动导入所有新闻的子类。
导入模块的时候会隐式地更新 source_map,现在如果要新增一个新闻源,只要复制粘贴出一个新新闻类 py 文件即可,依葫芦画瓢改改就行了,小刘可以放心地把这个活交给新人,因为整个程序扩展起来非常方便简单。
本文分享自 pythonista的日常 微信公众号,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。
本文参与 腾讯云自媒体同步曝光计划 ,欢迎热爱写作的你一起参与!