
本文介绍一种符合 DRY 原则的 Python 类设计模式——通过自定义描述符(@sample)让原始方法天然支持 .sample() 调用,避免重复定义采样方法,兼顾可读性、可维护性与扩展性。
本文介绍一种符合 dry 原则的 python 类设计模式——通过自定义描述符(`@sample`)让原始方法天然支持 `.sample()` 调用,避免重复定义采样方法,兼顾可读性、可维护性与扩展性。
在科学计算或时间序列分析中,常需对原始统计方法(如 mean()、sd())提供对应的插值采样版本(如 spl_mean()、spl_sd())。若采用手动定义 + 重复装饰的方式(如 @sample 修饰 spl_mean),不仅违反 DRY 原则,还会随方法数量增长导致类体臃肿、命名冗余、维护困难。
更优雅的解法是将“采样能力”作为方法的第一等行为扩展,而非独立方法。核心思路是:利用 Python 描述符协议(__get__),使被 @sample 修饰的方法返回一个可调用对象(Samplable 实例),该对象既保留原方法调用语义(bar.mean()),又提供专属的采样接口(bar.mean.sample())。
以下是完整实现(已适配实际插值逻辑):
from scipy import interpolate
import numpy as np
class Samplable:
def __init__(self, bound_method):
self._method = bound_method # 已绑定到实例的函数
def __call__(self, *args, **kwargs):
"""直接调用原始方法"""
return self._method(*args, **kwargs)
def sample(self, n_sample=100, **interp_kwargs):
"""执行插值采样:自动使用 self.ids 和当前方法结果"""
# 动态获取实例的 ids 和数据范围(需确保实例有 ids 属性)
obj = self._method.__self__
if not hasattr(obj, 'ids'):
raise AttributeError("Instance must have 'ids' attribute for sampling.")
# 计算原始统计值
vals = self._method()
# 执行一维插值(支持 axis=0 的多维数组)
new_ids = np.linspace(obj.ids[0], obj.ids[-1], n_sample)
try:
interp_func = interpolate.interp1d(
obj.ids, vals, axis=0, bounds_error=False,
fill_value="extrapolate", **interp_kwargs
)
return interp_func(new_ids)
except Exception as e:
raise RuntimeError(f"Sampling failed: {e}") from e
class sample:
def __init__(self, func):
self.func = func
# 保留原函数元信息(如文档、名称),提升调试体验
import functools
functools.update_wrapper(self, func)
def __get__(self, obj, objtype=None):
if obj is None:
return self
# 绑定方法并包装为 Samplable 对象
bound_method = self.func.__get__(obj, objtype)
return Samplable(bound_method)
# 使用示例
class Bar:
def __init__(self, ids, data):
self.ids = np.asarray(ids)
self.data = np.asarray(data)
@sample
def mean(self):
return self.data.mean(axis=0)
@sample
def sd(self):
return self.data.std(axis=0)
@sample
def max(self):
return self.data.max(axis=0)调用方式简洁直观:
让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限
立即学习“Python免费学习笔记(深入)”;
bar = Bar(ids=np.arange(5), data=np.random.rand(12, 5))
# 原始统计
print(bar.mean()) # shape: (5,)
print(bar.sd()) # shape: (5,)
# 采样版本(无需额外方法名)
sampled_mean = bar.mean.sample(n_sample=200) # shape: (200, 5)
sampled_sd = bar.sd.sample(n_sample=200) # shape: (200, 5)
# 验证一致性(与手动插值结果一致)
manual_interp = interpolate.interp1d(
bar.ids, bar.mean(), axis=0
)(np.linspace(bar.ids[0], bar.ids[-1], 200))
assert np.allclose(sampled_mean, manual_interp)✅ 优势总结:
-
零重复定义:无需为每个统计方法编写
spl_*变体; -
语义清晰:
.sample()是方法的自然延伸,非平行方法,降低认知负荷; -
灵活配置:
sample()支持传参(如n_sample,kind,fill_value); -
强健性保障:运行时检查
ids属性,明确报错; - 完全兼容:不影响原有方法签名、文档字符串和 IDE 自动补全。
⚠️ 注意事项:
- 类实例必须提供
ids属性(一维单调数组),否则sample()抛出AttributeError; - 插值依赖
scipy.interpolate.interp1d,对非规则/含 NaN 数据需预处理; - 若需支持
@sample修饰静态方法或类方法,需扩展Samplable的构造逻辑(本文聚焦实例方法场景)。
这种基于描述符的方案,本质上将“采样”从方法维度升维为行为维度,是 Python 元编程解决真实工程问题的典型范例——它不追求炫技,而以最小侵入性换取最大可维护性。

















