piranha

Polyllotpiranha

Polylotpiranha是一种轻巧的代码转换工具集，用于自动化大规模更改。在Uber，它主要用于清理过时的功能标志。

我们仅支持Uber使用的语言。我们可能无法在此存储库中添加新语言。有许多叉子（请参阅https://github.com/uber/piranha/forks以获取完整列表），可能会提供其他功能。

安装

要安装Polyglot Piranha，您可以将其用作Python库或命令行工具。

Python API

要安装Python API，请运行以下命令：

pip install polyglot-piranha

命令行接口

要安装命令行接口，请按照以下步骤：

1. 安装生锈
2. 克隆存储库： git clone https://github.com/uber/piranha.git
3. 导航到克隆目录： cd piranha
4. 构建项目： cargo build --release （或cargo build --release --no-default-features ）
5. 二进制将在target/release下生成

示例用法

 from polyglot_piranha import execute_piranha , PiranhaArguments , Rule , RuleGraph , OutgoingEdges

# Original code snippet
code = """
if (obj.isLocEnabled() || x > 0) {
    // do something
} else {
    // do something else!
}
"""

# Define the rule to replace the method call
r1 = Rule (
    name = "replace_method" ,
    query = "cs :[x].isLocEnabled()" , # cs indicates we are using concrete syntax
    replace_node = "*" ,
    replace = "true" ,
    is_seed_rule = True
)

# Define the edges for the rule graph. 
# In this case, boolean_literal_cleanup is already defined for java [see src/cleanup_rules]
edge = OutgoingEdges ( "replace_method" , to = [ "boolean_literal_cleanup" ], scope = "parent" )

# Create Piranha arguments
piranha_arguments = PiranhaArguments (
    code_snippet = code ,
    language = "java" ,
    rule_graph = RuleGraph ( rules = [ r1 ], edges = [ edge ])
)

# Execute Piranha and print the transformed code
piranha_summary = execute_piranha ( piranha_arguments )
print ( piranha_summary [ 0 ]. content )

文档

有关工具集的更多示例和说明，请检查我们的演示和扩展polyglot_readme.md文件。

功能标志

特征标志通常用于逐步推出或实验新功能。在少数情况下，即使完成标志的目的，与功能标志有关的代码也不会删除。我们将这样的标志称为陈旧的旗帜。与陈旧标志有关的代码的存在可能具有以下缺点：

• 不必要的代码混乱增加了整体复杂性WRT维护，从而降低了开发人员的生产率
• 标志可以干扰其他实验标志（例如，由于始终为false的标志下的嵌套）
• 在源以及二进制中存在未使用的代码
• 陈旧的标志也可能导致错误

polylotpiranha是一种可以自动重构与陈旧标志相关的重构代码的工具。在更高级别上，该工具的输入是标志的名称和预期行为，在指定了属性文件中与标志相关的API列表之后。 Piranha将使用这些输入来根据预期行为自动重构代码。

Polylotpiranha（截至2022年5月）是支持多种语言和功能标志API的常见重构工具。对于特定于语言的实现，请检查以下标签。

关于Piranha的其他一些链接：

• 研究论文发表在PLDI 2024上的Polyllotpiranha。
• 一份技术报告详细介绍了我们在Uber使用Piranha的经验。
• 一个博客文章，介绍有关Piranha的更多信息。
• Piranha的6分钟视频概述。

支持

如果您对如何使用Piranha或找到任何错误有任何疑问，请打开GitHub问题。

执照

Piranha已获得Apache 2.0许可证的许可。有关更多信息，请参见许可证文件。

笔记

这不是Uber官方产品，并且原样提供。