Merge pull request #97 from anaconda-distribution/v0.1.5

v0.1.5, adds new function

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 Note: version releases in the 0.x.y range may introduce breaking changes.
 
+## 0.1.5
+- Adds `get_read_only_parser()` function.
+- Fixes some comments.
+
 ## 0.1.4
 - Adds 4 new functions to the `percy` parser
   - 2 of these make it easier to work with dependencies

percy/parser/recipe_parser.py

@@ -722,9 +722,8 @@ def _scan_requirements(path_prefix: str = "") -> None:
                 for i in range(len(dependencies)):
                     paths.append(f"{section_path}/{i}")
 
-        # Scan for both multi-output and non-multi-output recipes. We won't scan empty defaulted lists, making scanning
-        # for both about as computationally complex as running `is_multi_output()` while also covering a theoretical
-        # recipe format that has both sections, even if it shouldn't exist.
+        # Scan for both multi-output and non-multi-output recipes. Here is an example of a recipe that has both:
+        #   https://github.com/AnacondaRecipes/curl-feedstock/blob/master/recipe/meta.yaml
         outputs = cast(list[JsonType], self.get_value("/outputs", []))
         for i in range(len(outputs)):
             _scan_requirements(f"/outputs/{i}")

percy/render/recipe.py

@@ -624,18 +624,14 @@ def contains(self, path: str, value: str, default: Any = KeyError) -> bool:
 
     def patch_with_parser(self, callback: Callable[[RecipeParser], None]) -> bool:
         """
-        By providing a callback, this function allows calling code to utilize
-        the new parse-tree/percy recipe parser in a way that is backwards
-        compatible with the `Recipe` class.
+        By providing a callback, this function allows calling code to utilize the new parse-tree/percy recipe parser
+        in a way that is backwards compatible with the `Recipe` class.
 
-        NOTE: Expect this function to be eventually deprecated. It is provided
-              as a stop-gap as we experiment and potentially transition to
-              primarily use the `RecipeParser`/parse tree implementation.
+        NOTE: Expect this function to be eventually deprecated. It is provided as a stop-gap as we experiment and
+              potentially transition to primarily use the `RecipeParser`/parse tree implementation.
 
-        In general, prefer using the `patch()` function in the `PARSE_TREE`
-        operating mode for most recipe-patching needs. This mechanism is
-        provided to allow callers access to some of the newest features and
-        capabilities.
+        In general, prefer using the `patch()` function in the `PARSE_TREE` operating mode for most recipe-patching
+        needs. This mechanism is provided to allow callers access to some of the newest features and capabilities.
 
         :param callback: Callback that provides a `RecipeParser` instance that can make modifications that will be
             reflected in the `Recipe` class.
@@ -659,6 +655,25 @@ def patch_with_parser(self, callback: Callable[[RecipeParser], None]) -> bool:
         self.render()
         return parser.is_modified()
 
+    def get_read_only_parser(self) -> RecipeParser:
+        """
+        This function returns a read-only parser that is incapable of committing changes to the original recipe file.
+
+        To put another way, any writes to this parser will only cause changes in memory AND NOT to the underlying recipe
+        file.
+
+        It is incredibly important to understand the implications of calling this function from a security and thread
+        safety perspective. This function exists so that we can use the the `RecipeParser` class in the `check_*()`
+        functions in `anaconda-linter`
+
+        NOTE: Expect this function to be eventually deprecated. It is provided as a stop-gap as we experiment and
+              potentially transition to primarily use the `RecipeParser`/parse tree implementation.
+        :returns: An instance of the `RecipeParser` class containing the state of the recipe file at time of call.
+        """
+        # TODO Future: Consider constructing this with an optional flag that disables writes further or throws when
+        # a write is attempted(?)
+        return RecipeParser("\n".join(self.meta_yaml))
+
     def patch(
         self,
         operations: list[JsonPatchType],

pyproject.toml

@@ -10,7 +10,7 @@ namespaces = false
 
 [project]
 name = "percy"
-version = "0.1.4"
+version = "0.1.5"
 authors = [
   { name="Anaconda, Inc.", email="distribution_team@anaconda.com" },
 ]