polyglot-piranha 0.3.0__cp38-cp38-macosx_10_16_x86_64.whl → 0.3.4__cp38-cp38-macosx_10_16_x86_64.whl

polyglot_piranha/__init__.pyi

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Uber Technologies, Inc.
+# Copyright (c) 2023 Uber Technologies, Inc.
 #
 # <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 # except in compliance with the License. You may obtain a copy of the License at
@@ -9,7 +9,7 @@
 # express or implied. See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
+from typing import List, Optional
 
 
 def execute_piranha(piranha_argument: PiranhaArguments) -> list[PiranhaOutputSummary]:
@@ -33,19 +33,22 @@ class PiranhaArguments:
     def __init__(
         self,
         language: str,
-        substitutions: dict,
-        path_to_configurations: Optional[str],
-        rule_graph: Optional[RuleGraph]= None,
         path_to_codebase: Optional[str] = None,
+        include: Optional[List[str]] = None,
+        exclude: Optional[List[str]] = None,
+        substitutions: Optional[dict] = None,
+        path_to_configurations: Optional[str] = None,
+        rule_graph: Optional[RuleGraph]= None,
         code_snippet: Optional[str] = None,
         dry_run: Optional[bool] = None,
         cleanup_comments: Optional[bool] = None,
         cleanup_comments_buffer: Optional[int] = None,
         number_of_ancestors_in_parent_scope: Optional[int] = None,
-        delete_file_if_empty : Optional[bool] = None,
-        delete_consecutive_new_lines : Optional[bool] = None,
-        path_to_output: Optional[str] = None
- 
+        delete_consecutive_new_lines: Optional[bool] = None,
+        global_tag_prefix: Optional[str] = 'GLOBAL_TAG',
+        delete_file_if_empty: Optional[bool] = None,
+        path_to_output: Optional[str] = None,
+        allow_dirty_ast: Optional[bool] = None
     ):
         """
         Constructs `PiranhaArguments`
@@ -54,20 +57,22 @@ class PiranhaArguments:
         ------------
             language: str
                 the target language
-            substitutions: dict
-                 Substitutions to instantiate the initial set of rules
+            path_to_codebase: str
+                Path to source code folder or file
             keyword arguments: _
-                 path_to_configurations (str) : Directory containing the configuration files - `piranha_arguments.toml`, `rules.toml`, and  `edges.toml`
-                 rule_graph (RuleGraph) : The rule graph constructed via RuleGraph DSL
-                 path_to_codebase (str) : Path to source code folder or file
-                 code_snippet (str) : The input code snippet to transform
-                 dry_run (bool) : Disables in-place rewriting of code
-                 cleanup_comments (bool) : Enables deletion of associated comments
+                 substitutions (dict): Substitutions to instantiate the initial set of rules
+                 path_to_configurations (str): Directory containing the configuration files - `piranha_arguments.toml`, `rules.toml`, and  `edges.toml`
+                 rule_graph (RuleGraph): The rule graph constructed via RuleGraph DSL
+                 code_snippet (str): The input code snippet to transform
+                 dry_run (bool): Disables in-place rewriting of code
+                 cleanup_comments (bool): Enables deletion of associated comments
                  cleanup_comments_buffer (int): The number of lines to consider for cleaning up the comments
                  number_of_ancestors_in_parent_scope (int): The number of ancestors considered when PARENT rules
+                 delete_consecutive_new_lines (bool): Replaces consecutive \ns  with a \n
+                 global_tag_prefix (str): the prefix for global tags
                  delete_file_if_empty (bool): User option that determines whether an empty file will be deleted
-                 delete_consecutive_new_lines (bool) : Replaces consecutive \ns  with a \n
                  path_to_output (str): Path to the output json file
+                 allow_dirty_ast (bool): Allows syntax errors in the input source code 
         """
         ...
 
@@ -77,17 +82,20 @@ class PiranhaOutputSummary:
 
     Attributes
     ----------
-    path : path to the file
-    content : content of the file after all the rewrites
-    matches : All the occurrences of "match-only" rules
+    path: path to the file
+    content: content of the file after all the rewrites
+    matches: All the occurrences of "match-only" rules
     rewrites: All the applied edits
     """
 
     path: str
     "path to the file"
 
+    original_content: str
+    "Original content of the file before any rewrites"
+
     content: str
-    "content of the file after all the rewrites"
+    "Final content of the file after all the rewrites"
 
     matches: list[tuple[str, Match]]
     'All the occurrences of "match-only" rules'
@@ -101,9 +109,9 @@ class Edit:
 
     Attributes
     ----------
-    p_match : The match representing the target site of the edit
-    replacement_string : The string to replace the substring encompassed by the match
-    matched_rule : The rule used for creating this match-replace
+    p_match: The match representing the target site of the edit
+    replacement_string: The string to replace the substring encompassed by the match
+    matched_rule: The rule used for creating this match-replace
     """
 
     p_match: Match
@@ -121,9 +129,9 @@ class Match:
 
     Attributes
     ----------
-    matched_sting : Code snippet that matched
-    range : Range of the entire AST node captured by the match
-    matches : The mapping between tags and string representation of the AST captured
+    matched_sting: Code snippet that matched
+    range: Range of the entire AST node captured by the match
+    matches: The mapping between tags and string representation of the AST captured
     """
 
     matched_string: str
@@ -150,28 +158,37 @@ class Point:
     row: int
     column: int
 
-class Constraint:
-    """ A class to capture Constraints of a Piranha Rule
+class Filter:
+    """ A class to capture filters of a Piranha Rule
     """
-    matcher: TSQuery
-    "Scope in which the constraint query has to be applied"
-    queries: list[TSQuery]
-    "The Tree-sitter queries that need to be applied in the `matcher` scope"
-
+    enclosing_node: TSQuery
+    "AST patterns that some ancestor node of the primary match should comply"
+    not_contains: list[TSQuery]
+    "AST patterns that SHOULD NOT match any subtree of node matching `enclosing_node` pattern"
+    contains: TSQuery
+    "AST pattern that SHOULD match subtrees of `enclosing_node`. " \
+    "Number of matches should be within the range of `at_least` and `at_most`."
+    at_least: int
+    "The minimum number of times the contains query should match in the enclosing node"
+    at_most: int
+    "The maximum number of times the contains query should match in the enclosing node"
     def __init__(
         self,
-        matcher: str,
-        queries: list[str] = []
+        enclosing_node: str = '',
+        not_contains: list[str] = [],
+        contains: str = '',
+        at_least: int = 1,
+        at_most: int = 4294967295 # u32::MAX
     ):
         """
-        Constructs `Constraint`
+        Constructs `Filter`
 
         Parameters
         ------------
-            matcher: str
-                Scope in which the constraint query has to be applied
-            queries: list[str]
-                 The Tree-sitter queries that need to be applied in the `matcher` scope
+            enclosing_node: str
+                AST patterns that some ancestor node of the primary match should comply
+            not_contains: list[str]
+                 AST patterns that should not match any subtree of node matching `enclosing_node` pattern
         """
         ...
 
@@ -190,8 +207,8 @@ class Rule:
     "Group(s) to which the rule belongs"
     holes: set[str]
     "Holes that need to be filled, in order to instantiate a rule"
-    constraints: set[Constraint]
-    "Additional constraints for matching the rule"
+    filters: set[Filter]
+    "Filters to test before applying a rule"
 
     def __init__(
         self,
@@ -201,7 +218,7 @@ class Rule:
         replace: Optional[str] = None,
         groups: set[str] = set(),
         holes: set[str] = set(),
-        constraints: set[Constraint] = set(),
+        filters: set[Filter] = set(),
         is_seed_rule: bool = True,
     ):
         """
@@ -221,8 +238,8 @@ class Rule:
                 Group(s) to which the rule belongs
             holes: set[str]
                 Holes that need to be filled, in order to instantiate a rule
-            constraints: set[Constraint]
-                Additional constraints for matching the rule
+            filters: set[Filter]
+                Filters to test before applying a rule
         """
         ...
 

{polyglot_piranha-0.3.0.dist-info → polyglot_piranha-0.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyglot_piranha
-Version: 0.3.0
+Version: 0.3.4
 License-File: LICENSE
 License-File: LICENSE
 License-File: NOTICE
@@ -10,9 +10,9 @@ Author: Uber Technologies Inc.
 Author-email: Ameya Ketkar <ketkara@uber.com>, Lazaro Clapp <lazaro@uber.com>
 Requires-Python: >=3.7
 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
-Project-URL: homepage, https://github.com/uber/piranha
 
 # Piranha
 

polyglot_piranha-0.3.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+polyglot_piranha-0.3.4.dist-info/METADATA,sha256=0ibaLIqcy7Fg1mUV_0ZWFWjxyo7RlwQlizMsNYbVuWQ,3797
+polyglot_piranha-0.3.4.dist-info/WHEEL,sha256=nqll5ynhXCwomcBqYs3lJrWlr8aFscLjrHGA10xvryk,104
+polyglot_piranha-0.3.4.dist-info/license_files/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
+polyglot_piranha-0.3.4.dist-info/license_files/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
+polyglot_piranha-0.3.4.dist-info/license_files/NOTICE,sha256=9bEJKCdL0MABjEknpMHXbYBZSkGVGRXYcSxSXS293X0,147
+polyglot_piranha/__init__.py,sha256=pghVgChf0-NgAG_zd7CzKtvFuBDxg5Wh-GcHx2PoTzg,147
+polyglot_piranha/__init__.pyi,sha256=sDMJC2xnL0QPNkBARAljzgwu7D-hbccyC-79r9p0djw,9476
+polyglot_piranha/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+polyglot_piranha/polyglot_piranha.cpython-38-darwin.so,sha256=g3_ubd4UZmfKn-KhCHag4BEj2_bLifMXzQUF7eHnPSA,13625120
+polyglot_piranha-0.3.4.dist-info/RECORD,,

{polyglot_piranha-0.3.0.dist-info → polyglot_piranha-0.3.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (0.14.15)
+Generator: maturin (1.0.0)
 Root-Is-Purelib: false
 Tag: cp38-cp38-macosx_10_16_x86_64

polyglot_piranha-0.3.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-polyglot_piranha-0.3.0.dist-info/METADATA,sha256=uXFsx2SMxlQRLRkUfABg3gRfDWdyeg5etrZ_3nr8Tuo,3797
-polyglot_piranha-0.3.0.dist-info/WHEEL,sha256=R9as0yyHDf-HADVClq720BdoCu3SSus4Pahnk2I6QnQ,106
-polyglot_piranha-0.3.0.dist-info/license_files/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
-polyglot_piranha-0.3.0.dist-info/license_files/LICENSE,sha256=7qqytxojDvLpt8CphcCVvEQilegiJ0x_oDkwHJU-1z4,11359
-polyglot_piranha-0.3.0.dist-info/license_files/NOTICE,sha256=9bEJKCdL0MABjEknpMHXbYBZSkGVGRXYcSxSXS293X0,147
-polyglot_piranha/__init__.py,sha256=pghVgChf0-NgAG_zd7CzKtvFuBDxg5Wh-GcHx2PoTzg,147
-polyglot_piranha/__init__.pyi,sha256=76ufpcBsLCDOjAJucqyrFsBp8zPRVnpAnyfFQou7Srg,8480
-polyglot_piranha/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polyglot_piranha/polyglot_piranha.cpython-38-darwin.so,sha256=fokYp5cEqWVAgT5Wp6ZICt5GjTAgFLUFJnGz5J3cDjk,13094992
-polyglot_piranha-0.3.0.dist-info/RECORD,,