see: dir for humans 技术文档

1. 安装指南

安装方式

see 是一个用于替代 Python 内置函数 dir() 的工具，适用于 Python 2.7 和 3.4+ 版本。你可以通过以下步骤安装 see：

使用 pip 安装

pip install see

从源码安装

如果你希望从源码安装，可以按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/ljcooke/see.git
   

2. 进入项目目录：

   cd see
   

3. 安装依赖并安装 see：

   pip install -r requirements.txt
   python setup.py install
   

2. 项目的使用说明

基本使用

see 的主要功能是帮助你更直观地查看对象的属性和方法。你可以通过以下方式使用 see：

示例

假设你有一个对象，想要了解它的更多信息：

from datetime import timedelta

使用 see 来查看该对象的属性和方法：

see(timedelta)

输出结果如下：

isclass             +                   -
*                   /                   //
%                   +obj                -obj
<                   <=                  ==
!=                  >                   >=
abs()               bool()              dir()
divmod()            hash()              help()
repr()              str()               .days
.max                .microseconds       .min
.resolution         .seconds            .total_seconds()

通过 see，你可以快速了解对象的以下信息：

• 该对象是一个类。
• 可以使用 + 运算符对其进行加法操作。
• 它有一个 seconds 属性。
• 它有一个 total_seconds 方法。

与 dir() 的对比

使用 dir() 查看相同对象的结果如下：

dir(timedelta)

输出结果：

['__abs__', '__add__', '__bool__', '__class__', '__delattr__', '
__dir__', '__divmod__', '__doc__', '__eq__', '__floordiv__', '__
format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '
__init__', '__init_subclass__', '__le__', '__lt__', '__mod__', '
__mul__', '__ne__', '__neg__', '__new__', '__pos__', '__radd__',
 '__rdivmod__', '__reduce__', '__reduce_ex__', '__repr__', '__rf
loordiv__', '__rmod__', '__rmul__', '__rsub__', '__rtruediv__',
'__setattr__', '__sizeof__', '__str__', '__sub__', '__subclassho
ok__', '__truediv__', 'days', 'max', 'microseconds', 'min', 'res
olution', 'seconds', 'total_seconds']

see 的输出更加简洁和易读。

过滤结果

你可以使用通配符模式或正则表达式来过滤 see 的输出结果：

示例

see(timedelta).filter('*sec*')

输出结果：

.microseconds       .seconds            .total_seconds()

see(timedelta).filter('/^d/')

输出结果：

dir()       divmod()

3. 项目API使用文档

see 函数

see 函数是 see 库的核心函数，用于查看对象的属性和方法。

参数

• obj：要查看的对象。

返回值

返回一个包含对象属性和方法的简洁列表。

示例

from see import see
from datetime import timedelta

result = see(timedelta)
print(result)

filter 方法

filter 方法用于过滤 see 的输出结果。

参数

• pattern：过滤模式，可以是通配符模式或正则表达式。

返回值

返回过滤后的属性和方法列表。

示例

result = see(timedelta).filter('*sec*')
print(result)

4. 项目安装方式

使用 pip 安装

pip install see

从源码安装

git clone https://github.com/ljcooke/see.git
cd see
pip install -r requirements.txt
python setup.py install

通过以上步骤，你可以轻松安装并使用 see 来替代 dir()，提升代码的可读性和调试效率。