polyglot-piranha 0.3.25__cp310-cp310-manylinux_2_28_x86_64.whl → 0.3.27__cp310-cp310-manylinux_2_28_x86_64.whl

polyglot_piranha/__init__.pyi

@@ -13,7 +13,7 @@ from __future__ import annotations
 from typing import List, Optional, Literal
 
 # Languages that Piranha supports (see ./src/models/language.rs)
-PiranhaLanguage = Literal["java", "kt", "kotlin", "go", "py", "swift", "ts", "tsx", "thrift", "strings", "scm", "scala", "rb"]
+PiranhaLanguage = Literal["java", "kt", "kotlin", "go", "python", "swift", "typescript", "tsx", "thrift", "strings", "scm", "scala", "ruby", "yaml", "yml"]
 
 
 def execute_piranha(piranha_argument: PiranhaArguments) -> list[PiranhaOutputSummary]:

polyglot_piranha-0.3.27.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.3
+Name: polyglot_piranha
+Version: 0.3.27
+License-File: LICENSE
+License-File: NOTICE
+Summary: Polyglot Piranha is a library for performing structural find and replace with deep cleanup.
+Keywords: refactoring,code update,structural find-replace,structural search and replace,structural search
+Author: Uber Technologies Inc.
+License: Apache-2.0
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: homepage, https://github.com/uber/piranha
+Project-URL: documentation, https://github.com/uber/piranha
+Project-URL: repository, https://github.com/uber/piranha
+
+# PolyglotPiranha
+
+PolyglotPiranha is a lightweight code transformation toolset for automating large scale changes. At Uber, it is mostly used to clean up stale feature flags.
+
+
+## Installation
+
+To install Polyglot Piranha, you can use it as a Python library or as a command-line tool.
+
+### Python API
+
+To install the Python API, run the following command:
+
+```bash
+pip install polyglot-piranha
+```
+
+### Command-line Interface
+
+To install the command-line interface, follow these steps:
+
+1. Install [Rust](https://www.rust-lang.org/tools/install)
+2. Clone the repository: `git clone https://github.com/uber/piranha.git`
+3. Navigate to the cloned directory: `cd piranha`
+4. Build the project: `cargo build --release` (or `cargo build --release --no-default-features` for macOS)
+5. The binary will be generated under `target/release`
+
+## Example Usage
+
+```python
+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)
+```
+
+
+## Documentation
+
+For more examples and explanations of the toolset, please check our demos and extended [POLYGLOT_README.md](POLYGLOT_README.md) file.
+
+
+## Feature Flags
+
+
+Feature flags are commonly used to enable gradual rollout or experiment with new features. In a few cases, even after the purpose of the flag is accomplished, the code pertaining to the feature flag is not removed. We refer to such flags as stale flags. The presence of code pertaining to stale flags can have the following drawbacks: 
+- Unnecessary code clutter increases the overall complexity w.r.t maintenance resulting in reduced developer productivity 
+- The flags can interfere with other experimental flags (e.g., due to nesting under a flag that is always false)
+- Presence of unused code in the source as well as the binary 
+- Stale flags can also cause bugs 
+
+PolyglotPiranha is a tool that can automatically refactor code related to stale flags. At a higher level, the input to the tool is the name of the flag and the expected behavior, after specifying a list of APIs related to flags in a properties file. Piranha will use these inputs to automatically refactor the code according to the expected behavior.
+
+PolyglotPiranha (as of May 2022) is a common refactoring tool to support multiple languages and feature flag APIs.
+For legacy language-specific implementations please check following [tag](https://github.com/uber/piranha/releases/tag/last-version-having-legacy-piranha).
+
+
+
+A few additional links on Piranha: 
+
+- Research paper published at [PLDI 2024](https://dl.acm.org/doi/10.1145/3656429) on PolyglotPiranha.
+- A technical [report](report.pdf) detailing our experiences with using Piranha at Uber.
+- A [blogpost](https://eng.uber.com/piranha/) presenting more information on Piranha. 
+- 6 minute [video](https://www.youtube.com/watch?v=V5XirDs6LX8&feature=emb_logo) overview of Piranha.
+
+## Support
+
+If you have any questions on how to use Piranha or find any bugs, please [open a GitHub issue](https://github.com/uber/piranha/issues).
+
+## Contributors
+
+We'd love for you to contribute to Piranha!  Please note that once
+you create a pull request, you will be asked to sign our [Uber Contributor License Agreement](https://cla-assistant.io/uber/piranha).
+
+We are also looking for contributions to extend Piranha to other languages (C++, C#, Kotlin). 
+
+## License
+Piranha is licensed under the Apache 2.0 license.  See the LICENSE file for more information.
+

polyglot_piranha-0.3.27.dist-info/RECORD

@@ -0,0 +1,9 @@
+polyglot_piranha-0.3.27.dist-info/METADATA,sha256=xaMhc9-KuRghoxYZ5QXExwaOpFjxi6uYDQ64gdPStrc,4928
+polyglot_piranha-0.3.27.dist-info/WHEEL,sha256=frJ0jFhrxtt2pGDBONvx9540ZW9xkmTZYKaVKqF4ZeY,108
+polyglot_piranha-0.3.27.dist-info/licenses/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
+polyglot_piranha-0.3.27.dist-info/licenses/NOTICE,sha256=9bEJKCdL0MABjEknpMHXbYBZSkGVGRXYcSxSXS293X0,147
+polyglot_piranha/__init__.py,sha256=pghVgChf0-NgAG_zd7CzKtvFuBDxg5Wh-GcHx2PoTzg,147
+polyglot_piranha/__init__.pyi,sha256=RLo1rlEFdaCy_gX_xY59KSLp-WiZ4Ddyg731pimUc2M,10504
+polyglot_piranha/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+polyglot_piranha/polyglot_piranha.cpython-310-x86_64-linux-gnu.so,sha256=2w0Ks7UJYWZHDq54NXqhrRvTEW4vUJFKdJO2nnXz2lk,80842512
+polyglot_piranha-0.3.27.dist-info/RECORD,,

{polyglot_piranha-0.3.25.dist-info → polyglot_piranha-0.3.27.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.7.0)
+Generator: maturin (1.7.1)
 Root-Is-Purelib: false
 Tag: cp310-cp310-manylinux_2_28_x86_64

polyglot_piranha-0.3.25.dist-info/METADATA

@@ -1,57 +0,0 @@
-Metadata-Version: 2.3
-Name: polyglot_piranha
-Version: 0.3.25
-License-File: LICENSE
-License-File: NOTICE
-Summary: Polyglot Piranha is a library for performing structural find and replace with deep cleanup.
-Keywords: refactoring,code update,structural find-replace,structural search and replace,structural search
-Author: Uber Technologies Inc.
-License: Apache-2.0
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: homepage, https://github.com/uber/piranha
-Project-URL: documentation, https://github.com/uber/piranha
-Project-URL: repository, https://github.com/uber/piranha
-
-# Piranha
-
-[![Join the chat at https://gitter.im/uber/piranha](https://badges.gitter.im/uber/piranha.svg)](https://gitter.im/uber/piranha?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-Feature flags are commonly used to enable gradual rollout or experiment with new features. In a few cases, even after the purpose of the flag is accomplished, the code pertaining to the feature flag is not removed. We refer to such flags as stale flags. The presence of code pertaining to stale flags can have the following drawbacks: 
-- Unnecessary code clutter increases the overall complexity w.r.t maintenance resulting in reduced developer productivity 
-- The flags can interfere with other experimental flags (e.g., due to nesting under a flag that is always false)
-- Presence of unused code in the source as well as the binary 
-- Stale flags can also cause bugs 
-
-Piranha is a tool to automatically refactor code related to stale flags. At a higher level, the input to the tool is the name of the flag and the expected behavior, after specifying a list of APIs related to flags in a properties file. Piranha will use these inputs to automatically refactor the code according to the expected behavior. 
-
-This repository contains four independent versions of Piranha, one for each of the four supported languages: Java, JavaScript, Objective-C and Swift. **It also contains a redesigned variant of Piranha (as of May 2022) that is a common refactoring tool to support multiple languages and feature flag APIs. If interested in this polyglot variant, goto [Polyglot Piranha](POLYGLOT_README.md)**.
-
-To use/build each version, look under the corresponding [lang]/ directory and follow instructions in the corresponding [lang]/README.md file. Make sure to cd into that directory to build any related code following the instructions in the README. 
-
-- [PiranhaJava](legacy/java/README.md)
-- [PiranhaJS](legacy/javascript/README.md)
-- [PiranhaObjC](legacy/objc/README.md)
-- [PiranhaSwift](legacy/swift/README.md)
-
-A few additional links on Piranha: 
-
-- Research paper published at [PLDI 2024](https://dl.acm.org/doi/10.1145/3656429) on PolyglotPiranha.
-- A technical [report](report.pdf) detailing our experiences with using Piranha at Uber.
-- A [blogpost](https://eng.uber.com/piranha/) presenting more information on Piranha. 
-- 6 minute [video](https://www.youtube.com/watch?v=V5XirDs6LX8&feature=emb_logo) overview of Piranha.
-
-## Support
-
-If you have any questions on how to use Piranha, please feel free to reach out to us on the [gitter channel](https://gitter.im/uber/piranha?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge). For bugs and enhancement requests, [open a GitHub issue](https://github.com/uber/piranha/issues).
-
-## Contributors
-
-We'd love for you to contribute to Piranha!  Please note that once
-you create a pull request, you will be asked to sign our [Uber Contributor License Agreement](https://cla-assistant.io/uber/piranha).
-
-We are also looking for contributions to extend Piranha to other languages (C++, C#, Kotlin). 
-
-## License
-Piranha is licensed under the Apache 2.0 license.  See the LICENSE file for more information.
-

polyglot_piranha-0.3.25.dist-info/RECORD

@@ -1,9 +0,0 @@
-polyglot_piranha-0.3.25.dist-info/METADATA,sha256=sPaY71g745SmD4LbGrHOlb1ngGLtpjN7LfsrQtBYcIc,3820
-polyglot_piranha-0.3.25.dist-info/WHEEL,sha256=o2a7w7pwJaHwz9eJC7NBuokOzmoVNgOcn76t9UzkJbA,108
-polyglot_piranha-0.3.25.dist-info/license_files/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
-polyglot_piranha-0.3.25.dist-info/license_files/NOTICE,sha256=9bEJKCdL0MABjEknpMHXbYBZSkGVGRXYcSxSXS293X0,147
-polyglot_piranha/__init__.py,sha256=pghVgChf0-NgAG_zd7CzKtvFuBDxg5Wh-GcHx2PoTzg,147
-polyglot_piranha/__init__.pyi,sha256=NCT9ACz8M9CJqQGEisGT5AybulsHfl-_z_I-QQ6iMQw,10475
-polyglot_piranha/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polyglot_piranha/polyglot_piranha.cpython-310-x86_64-linux-gnu.so,sha256=I6ykl2-eSXIN_-gAPctPjSDlBBsqft-C_JMjDdnK-jg,80646024
-polyglot_piranha-0.3.25.dist-info/RECORD,,