boxx

项目介绍：Box-X

简介

Box-X 是一个高效的 Python 工具箱，旨在简化和加速 Python 的开发与调试，尤其是在科学计算和计算机视觉领域。这款工具箱中的所有工具分为两大类：普遍用途的 Python 工具和专门用于科学计算及计算机视觉的工具。

Box-X 支持 Python 2 和 3 操作系统，包括 Linux、macOS 和 Windows，以及在 CPython、IPython、Spyder 和 Notebook 等环境中使用。

安装指南

要安装 Box-X，只需在终端中运行以下命令：

pip install boxx

建议通过源码安装以确保获取最新功能：

git clone https://github.com/DIYer22/boxx
cd boxx/
python setup.py install

教程

Box-X 的使用教程采用 Jupyter Notebook 文件的形式提供，有以下几种方式可以查看或运行：

方法 1：在线交互式 Notebook

使用 Binder 在线运行教程，无需下载或安装任何东西，即可在浏览器中运行代码。

方法 2：下载并本地运行

从 GitHub 下载完整的项目并安装，然后通过 Jupyter Notebook 打开教程文件。

方法 3：静态教程

直接查看教程内容，便于快速了解。

示例展示

工具示例也分为两部分：一般 Python 工具和科学计算与计算机视觉工具。每个工具都附有图示示例，便于理解其功能和使用场景。

一般 Python 工具

• p/x：更优雅的打印方式。
• g.name = x 或 g.name/x：将变量传递到 Python 交互式控制台。
• g()：将函数中的所有变量传递到控制台，方便调试。
• with p, with g, with gg：在 "with 语句" 下作用于多个变量。

科学计算与计算机视觉工具

• loga：可视化矩阵和张量，显示数据的多种属性。
• show：轻松显示复杂结构中的图片。
• tree：以树状结构可视化复杂数据结构。

调试工具矩阵

Box-X 提供了多种便捷的调试工具：

• 单变量打印和传递：p/x、g.name/x、gg.name/x
• 多变量处理：with p:、with g:、with gg:
• 作用于所有局部变量：p()、g()、gg()
• 便捷导入使用：import boxx.p、import boxx.g、import boxx.gg

性能分析工具

• what: 展示对象的详细信息。
• timeit: 在 "with 语句" 下计时代码块。
• mapmp: 多进程版的 map，用于加速处理。
• heatmap: 显示代码的时间热图，直观表现性能。
• performance: 统计函数调用，动态可视化代码性能。

致谢

感谢以下人员的建议和支持：Xiaodong Xu、Guodong Wu、Haoqiang Fan 和 Pengfei Xiong。同时，Box-X 的开发得益于 Spyder IDE 和许多开源项目的帮助，如 SnakeViz 和 pyheat。