xy0v0's Blog

Back

原代码痛点#

在项目开发中需要实现代码的重构,原先嵌入模型使用 API / 本地的方法放在一个类中实现,通过 self.mode 进行控制切换。为了方便后续维护,需要对本地和 API 的类分离

class EmbeddingService:
	def __init__(self):
		...
		self.mode = 'api' # 'api' or 'local'

	def _get_embedding_cache(self):
		if(self.model == 'api'):
			# api
		else:
			# local
plaintext

重构方案#

我们首先定义基类 BaseEmbeddingService :

from abc import ABC, abstractmethod

class BaseEmbeddingService(ABC):
	pass
plaintext

在基类之中,可使用 abstractmethod 修饰器包裹子类继承时需要重写的方法,也就是表示这是一个抽象方法。

{{< notice info >}} 抽象方法无法被实例化,实例化将会直接报错。 {{< /notice >}}

为什么需要使用ABC?#

对比其他方案:

方案扩展成本类型安全代码复用可维护性
原始if-else模式高无低差
策略模式中部分中一般
ABC抽象基类低强高优秀

当子类为实现抽象方法时将会立即报错,安全性高。可统一所有实现的方法签名

Python 中 ABC (抽象基类) 的使用

https://www.xy0v0.top/blog/1740289221
Author xy0v0 Published at Copyright CC BY-NC-SA 4.0