【AI Study】第五天，Matplotlib（9）- 最佳实践-CSDN博客

本文链接：https://blog.csdn.net/tearofthemyth/article/details/148791483

文章概要

本文详细介绍 Matplotlib 的最佳实践，包括：

代码组织
性能优化
错误处理
文档规范

代码组织

模块化设计

# plot_utils.py
import matplotlib.pyplot as plt
import numpy as np

def create_figure(size=(8, 6)):
    """创建基础图形"""
    return plt.subplots(figsize=size)

def set_style(style='seaborn'):
    """设置绘图样式"""
    plt.style.use(style)

def save_figure(fig, filename, **kwargs):
    """保存图形"""
    fig.savefig(filename, **kwargs)
    plt.close(fig)

# main.py
from plot_utils import create_figure, set_style, save_figure

def main():
    # 设置样式
    set_style()
    
    # 创建图形
    fig, ax = create_figure()
    
    # 绘制数据
    x = np.linspace(0, 10, 100)
    ax.plot(x, np.sin(x))
    
    # 保存图形
    save_figure(fig, 'sine_wave.png', dpi=300)

if __name__ == '__main__':
    main()

函数封装

def plot_time_series(data, title, xlabel, ylabel, **kwargs):
    """
    绘制时间序列数据
    
    参数:
        data: 时间序列数据
        title: 图表标题
        xlabel: x轴标签
        ylabel: y轴标签
        **kwargs: 其他绘图参数
    """
    fig, ax = plt.subplots(figsize=kwargs.get('figsize', (10, 6)))
    
    # 绘制数据
    ax.plot(data.index, data.values, **kwargs)
    
    # 设置标签
    ax.set_title(title)
    ax.set_xlabel(xlabel)
    ax.set_ylabel(ylabel)
    
    # 设置网格
    if kwargs.get('grid', True):
        ax.grid(True, alpha=0.3)
    
    return fig, ax

# 使用示例
import pandas as pd
dates = pd.date_range('2023-01-01', periods=100)
data = pd.Series(np.sin(np.linspace(0, 10, 100)), index=dates)
fig, ax = plot_time_series(data, 'Sine Wave', 'Date', 'Value')
plt.show()

类设计

class PlotManager:
    """图形管理器类"""
    
    def __init__(self, style='seaborn'):
        self.style = style
        plt.style.use(style)
        self.figures = {}
    
    def create_plot(self, name, size=(8, 6)):
        """创建新图形"""
        fig, ax = plt.subplots(figsize=size)
        self.figures[name] = {'fig': fig, 'ax': ax}
        return fig, ax
    
    def get_plot(self, name):
        """获取已存在的图形"""
        return self.figures.get(name)
    
    def save_all(self, prefix='figure'):
        """保存所有图形"""
        for name, plot_dict in self.figures.items():
            filename = f'{prefix}_{name}.png'
            plot_dict['fig'].savefig(filename, dpi=300)
            plt.close(plot_dict['fig'])
    
    def close_all(self):
        """关闭所有图形"""
        for plot_dict in self.figures.values():
            plt.close(plot_dict['fig'])
        self.figures.clear()

# 使用示例
manager = PlotManager()
fig1, ax1 = manager.create_plot('sine')
ax1.plot(np.linspace(0, 10, 100), np.sin(np.linspace(0, 10, 100)))
manager.save_all()

性能优化

减少重绘

def efficient_plotting():
    """高效绘图示例"""
    fig, ax = plt.subplots(figsize=(8, 6))
    
    # 关闭自动重绘
    plt.ion()
    
    # 批量更新数据
    x = np.linspace(0, 10, 100)
    line, = ax.plot(x, np.sin(x))
    
    # 更新数据而不重绘
    for i in range(100):
        line.set_ydata(np.sin(x + i/10))
        fig.canvas.draw_idle()
        fig.canvas.flush_events()
    
    plt.ioff()
    plt.show()

# 使用 blit 优化动画
def optimized_animation():
    fig, ax = plt.subplots(figsize=(8, 6))
    x = np.linspace(0, 10, 100)
    line, = ax.plot(x, np.sin(x))
    
    def update(frame):
        line.set_ydata(np.sin(x + frame/10))
        return line,
    
    anim = FuncAnimation(fig, update, frames=100,
                        interval=50, blit=True)
    plt.show()

优化数据结构

def optimize_data_structures():
    """优化数据结构示例"""
    # 使用 NumPy 数组而不是列表
    x = np.linspace(0, 10, 1000)
    y = np.sin(x)
    
    # 使用 Pandas 处理大型数据集
    df = pd.DataFrame({'x': x, 'y': y})
    
    # 使用适当的数据类型
    df = df.astype({'x': 'float32', 'y': 'float32'})
    
    return df

# 使用生成器处理大数据
def process_large_data(data_generator):
    """处理大数据集"""
    for chunk in data_generator:
        # 处理数据块
        yield process_chunk(chunk)

使用适当的方法

def efficient_methods():
    """使用高效方法示例"""
    # 使用向量化操作
    x = np.linspace(0, 10, 1000)
    y = np.sin(x)
    
    # 使用适当的绘图方法
    fig, ax = plt.subplots(figsize=(8, 6))
    
    # 对于大量数据点，使用 scatter 而不是 plot
    ax.scatter(x, y, s=1, alpha=0.5)
    
    # 使用适当的颜色映射
    im = ax.imshow(np.random.rand(100, 100),
                   cmap='viridis',
                   interpolation='nearest')
    
    return fig, ax

错误处理

异常捕获

def safe_plotting(data, **kwargs):
    """安全的绘图函数"""
    try:
        # 验证数据
        if not isinstance(data, (np.ndarray, pd.Series, pd.DataFrame)):
            raise TypeError("数据必须是 NumPy 数组或 Pandas 对象")
        
        # 创建图形
        fig, ax = plt.subplots(figsize=kwargs.get('figsize', (8, 6)))
        
        # 绘制数据
        ax.plot(data, **kwargs)
        
        return fig, ax
        
    except Exception as e:
        print(f"绘图错误: {str(e)}")
        return None, None
    finally:
        # 清理资源
        plt.close('all')

数据验证

def validate_data(data):
    """数据验证函数"""
    # 检查数据类型
    if not isinstance(data, (np.ndarray, pd.Series, pd.DataFrame)):
        raise TypeError("数据必须是 NumPy 数组或 Pandas 对象")
    
    # 检查数据是否为空
    if len(data) == 0:
        raise ValueError("数据不能为空")
    
    # 检查数据是否包含 NaN
    if isinstance(data, pd.Series) and data.isna().any():
        raise ValueError("数据包含 NaN 值")
    
    # 检查数据范围
    if isinstance(data, pd.Series):
        if data.min() < -1e10 or data.max() > 1e10:
            raise ValueError("数据范围异常")
    
    return True

日志记录

import logging

# 配置日志
logging.basicConfig(
    level=logging.INFO,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    filename='matplotlib.log'
)

def plot_with_logging(data, **kwargs):
    """带日志记录的绘图函数"""
    logger = logging.getLogger('matplotlib')
    
    try:
        logger.info("开始绘图")
        
        # 验证数据
        validate_data(data)
        logger.info("数据验证通过")
        
        # 创建图形
        fig, ax = plt.subplots(figsize=kwargs.get('figsize', (8, 6)))
        logger.info("图形创建成功")
        
        # 绘制数据
        ax.plot(data, **kwargs)
        logger.info("数据绘制完成")
        
        return fig, ax
        
    except Exception as e:
        logger.error(f"绘图错误: {str(e)}")
        raise

文档规范

代码注释

def plot_histogram(data, bins=10, **kwargs):
    """
    绘制直方图
    
    参数:
        data: 输入数据，可以是 NumPy 数组或 Pandas 对象
        bins: 直方图的箱数，默认为 10
        **kwargs: 其他绘图参数
        
    返回:
        fig: 图形对象
        ax: 坐标轴对象
        
    异常:
        TypeError: 当输入数据类型不正确时
        ValueError: 当数据为空或包含无效值时
    """
    # 验证数据
    validate_data(data)
    
    # 创建图形
    fig, ax = plt.subplots(figsize=kwargs.get('figsize', (8, 6)))
    
    # 绘制直方图
    ax.hist(data, bins=bins, **kwargs)
    
    return fig, ax

函数文档

class Plotter:
    """
    绘图器类
    
    用于创建和管理 Matplotlib 图形。
    
    属性:
        style (str): 绘图样式
        figures (dict): 存储创建的图形
        
    方法:
        create_plot(): 创建新图形
        save_plot(): 保存图形
        close_plot(): 关闭图形
    """
    
    def __init__(self, style='seaborn'):
        """
        初始化绘图器
        
        参数:
            style (str): 绘图样式名称
        """
        self.style = style
        self.figures = {}
        plt.style.use(style)
    
    def create_plot(self, name, size=(8, 6)):
        """
        创建新图形
        
        参数:
            name (str): 图形名称
            size (tuple): 图形大小
            
        返回:
            tuple: (fig, ax) 图形和坐标轴对象
        """
        fig, ax = plt.subplots(figsize=size)
        self.figures[name] = {'fig': fig, 'ax': ax}
        return fig, ax

示例说明

def example_usage():
    """
    使用示例
    
    示例 1: 基本绘图
    >>> plotter = Plotter()
    >>> fig, ax = plotter.create_plot('basic')
    >>> ax.plot([1, 2, 3], [1, 2, 3])
    >>> plt.show()
    
    示例 2: 自定义样式
    >>> plotter = Plotter(style='dark_background')
    >>> fig, ax = plotter.create_plot('custom')
    >>> ax.plot([1, 2, 3], [1, 2, 3], color='red')
    >>> plt.show()
    
    示例 3: 保存图形
    >>> plotter = Plotter()
    >>> fig, ax = plotter.create_plot('save')
    >>> ax.plot([1, 2, 3], [1, 2, 3])
    >>> plotter.save_plot('save', 'figure.png')
    """
    pass