everything2everything.core 模块文档

核心类

TypeConverter 类

TypeConverter 是库的核心类，提供了第三方库类型之间的互转功能，以及标准类型的转换方法。

类定义

class TypeConverter:
    """类型转换兼容层
    
    A comprehensive type conversion compatibility layer that supports bidirectional
    conversion between all standard Python data types and third-party library types.
    """

主要方法

convert(obj, target_type)

通用类型转换方法，支持将任意类型转换为指定的目标类型。

from everything2everything import TypeConverter
import numpy as np

# 将numpy数组转换为torch张量
arr = np.array([1, 2, 3])
tensor = TypeConverter.convert(arr, 'torch')
print(type(tensor))  # 输出: <class 'torch.Tensor'>

# 将torch张量转换为tensorflow张量
tensor = TypeConverter.convert(tensor, 'tensorflow')
print(type(tensor))  # 输出: <class 'tensorflow.Tensor'>

numpy_to_xarray(obj)

将numpy数组转换为xarray DataArray，自动生成维度和坐标。

xarray_to_numpy(obj)

将xarray DataArray或Dataset转换为numpy数组。

torch_to_numpy(obj)

将torch Tensor转换为numpy数组，必要时从计算图中分离。

numpy_to_torch(obj)

将numpy数组转换为torch Tensor。

jax_to_numpy(obj)

将jax数组转换为numpy数组。

numpy_to_jax(obj)

将numpy数组转换为jax数组。

tensorflow_to_numpy(obj)

将tensorflow Tensor转换为numpy数组。

numpy_to_tensorflow(obj)

将numpy数组转换为tensorflow Tensor。

pandas_to_numpy(obj)

将pandas DataFrame或Series转换为numpy数组。

numpy_to_pandas(obj)

将numpy数组转换为pandas Series或DataFrame。

标准类型转换方法

TypeConverter 类还提供了一系列标准类型的转换方法，这些方法都使用了 @conversion_cache 装饰器，以提升性能。

to_list(obj)

将任意对象转换为列表。

to_str(obj)

将任意对象转换为字符串。

to_int(obj)

将任意对象转换为整数。

to_float(obj)

将任意对象转换为浮点数。

to_dict(obj)

将任意对象转换为字典。

to_set(obj)

将任意对象转换为集合。

to_tuple(obj)

将任意对象转换为元组。

转换函数

模块提供了一系列与Python内置函数兼容的转换函数，这些函数是对 TypeConverter 类方法的封装，使用更加方便。

e2e_list(obj=None)

将任意对象转换为列表，默认为空列表。

from everything2everything import e2e_list

# 基本类型转换
e2e_list(123)  # 输出: [123]
e2e_list(None)  # 输出: []
e2e_list("hello")  # 输出: ['h', 'e', 'l', 'l', 'o']

# 容器类型转换
e2e_list({"a": 1, "b": 2})  # 输出: [("a", 1), ("b", 2)]

# 第三方库类型转换
import numpy as np
e2e_list(np.array([1, 2, 3]))  # 输出: [1, 2, 3]

e2e_str(obj="")

将任意对象转换为字符串，默认为空字符串。

e2e_int(obj=0)

将任意对象转换为整数，默认为0。

e2e_float(obj=0.0)

将任意对象转换为浮点数，默认为0.0。

e2e_dict(obj=None)

将任意对象转换为字典，默认为空字典。

e2e_set(obj=None)

将任意对象转换为集合，默认为空集合。

e2e_tuple(obj=())

将任意对象转换为元组，默认为空元组。

辅助函数

conversion_cache(func)

缓存转换结果的装饰器，用于提升转换性能，避免重复转换。

类型转换规则

标准类型转换

第三方库类型转换

模块支持以下第三方库类型之间的互转：

• numpy
• cupy
• scipy
• pandas
• torch
• xarray
• jax
• tensorflow

性能优化

使用示例

基本使用

from everything2everything import (
    e2e_list, e2e_str, e2e_int, e2e_float, e2e_dict, e2e_set, e2e_tuple
)

# 示例 1：基本类型转换
print(e2e_list(123))  # 输出: [123]
print(e2e_str(None))  # 输出: ""
print(e2e_int("123"))  # 输出: 123
print(e2e_float(True))  # 输出: 1.0

# 示例 2：容器类型转换
print(e2e_list({"a": 1, "b": 2}))  # 输出: [("a", 1), ("b", 2)]
print(e2e_dict([1, 2, 3]))  # 输出: {0: 1, 1: 2, 2: 3}
print(e2e_set("hello"))  # 输出: {'h', 'e', 'l', 'o'}

# 示例 3：双向转换
print(e2e_list(e2e_tuple([1, 2, 3])))  # 输出: [1, 2, 3]
print(e2e_dict(e2e_list({"a": 1, "b": 2})))  # 输出: {0: ("a", 1), 1: ("b", 2)}

第三方库类型转换

from everything2everything import TypeConverter
import numpy as np
import torch

# 示例 1：numpy 与 torch 互转
arr = np.array([1, 2, 3])
tensor = TypeConverter.numpy_to_torch(arr)
print(type(tensor))  # 输出: <class 'torch.Tensor'>

arr2 = TypeConverter.torch_to_numpy(tensor)
print(type(arr2))  # 输出: <class 'numpy.ndarray'>

# 示例 2：使用通用转换方法
result = TypeConverter.convert(arr, 'torch')  # 转换为torch张量
print(type(result))  # 输出: <class 'torch.Tensor'>

# 示例 3：numpy 与 pandas 互转
import pandas as pd
series = TypeConverter.numpy_to_pandas(arr)
print(type(series))  # 输出: <class 'pandas.Series'>

arr3 = TypeConverter.pandas_to_numpy(series)
print(type(arr3))  # 输出: <class 'numpy.ndarray'>

总结

everything2everything.core 模块是一个功能强大、设计优雅的类型转换兼容层，它解决了Python中类型转换的各种问题，特别是在处理第三方库类型时的复杂性。

主要优势包括：

• 全面的类型支持：支持所有Python标准数据类型和主流第三方库类型
• 双向转换：提供任意类型之间的双向转换能力
• 类型安全：提供明确的错误提示和类型检查
• 高性能：内置缓存机制，避免重复转换
• 无缝集成：与Python内置函数兼容，可直接替换使用
• 智能处理：自动处理不同库之间的转换细节

这个模块为Python开发者提供了一个统一、简洁的类型转换接口，大大简化了代码编写，提高了开发效率。