#inspector #finder #cli-tool #search #cli #python-doc

应用 jones

用于搜索和检查 Python 类的 CLI 项目

5 个版本

0.2.0 2023年8月7日
0.1.4 2021年9月30日
0.1.3 2021年9月24日
0.1.1 2021年7月13日
0.1.0 2021年7月13日

#2164 in 命令行工具

每月 28 次下载

MIT 协议

27KB
618 代码行

琼斯 CLI

pipeline-jones Crates.io

上下文

注意:🌶 这是对 Rust 编程的首次尝试。

该项目是 Python 类的路径查找器/检查器。这是一个 CLI 工具的最小实现,可以帮助您找到 Python 类。它旨在帮助您找到类而无需更改文件或视图来理解类,并在终端中非常美观地显示其方法和参数

用法

显然,为了更好地理解 jones 的功能,您始终可以输入

$ jones --help

这将显示琼斯具有的所有标志和参数

搜索/grep 类

使用 --grep 标志可以找到包含给定搜索关键词的所有 Python 类。关键词应使用大小写格式,因为 Python 类通常以驼峰式编写。例如

$ jones -g Tool

这将返回包含 Tool 词汇的所有类,并像通常的 grep 一样显示它们在哪些文件中找到

> [FOUND MATCHES]
:: class Tool: -> ~/project/src/band.py
:: class ToolMind: -> ~/project/src/golden_ratio.py

注意:这仍在开发中,应将其重命名为智能搜索。智能搜索将用于根据关键词及其使用上下文来查找类

显示类功能

要显示类方法和参数,只需使用不带任何标志的 jones。例如

$ jones Tool

这将搜索在调用琼斯的当前目录中名为 tool 的类(如果未指定目录路径)。如果指定了目录路径,则 jones 将在指定目录中搜索。例如

$ jones Tool ~/band_project

输出

# Class [Board]
-------
*docstring: Tic Tac Toe board
* inherit -> Tool

# Methods
-------
:: [__init__] -> None
  * self: None
:: [__getitem__] -> ndarray
  * self: None
  * x: int
:: [display] -> None
  * self: None
:: [mark] -> None
  * self: None
  * tag: Markers
  * x: int
  * y: int

依赖关系

~5–13MB
~146K SLoC