如何优雅地为 Python 类批量添加采样方法:装饰器与描述符的高级实践

星敏酱_3202

星敏酱_3202

2026-11-01

874人浏览

原创

如何优雅地为 Python 类批量添加采样方法:装饰器与描述符的高级实践

本文介绍一种符合 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 UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
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 元编程解决真实工程问题的典型范例——它不追求炫技,而以最小侵入性换取最大可维护性。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1851

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4964

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1789

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

29777

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3547

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3567

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2763

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习