Redacts excessive newline (#283)

* Redacts trailing line in recipe files to conform with community preferences * Removes trailing newlines from test files * Updates hashes used in unit tests
conda-incubator · Jan 6, 2025 · 78f6534 · 78f6534
1 parent 3e75998
commit 78f6534
Show file tree

Hide file tree

Showing 107 changed files with 118 additions and 114 deletions.
diff --git a/conda_recipe_manager/parser/recipe_reader.py b/conda_recipe_manager/parser/recipe_reader.py
@@ -715,6 +715,10 @@ def render(self) -> str:
         # implied.
         RecipeReader._render_tree(self._root, -1, lines)
 
+        # If present, redact a trailing blank line as it is preferred by some communities. See Issue #279
+        if lines and lines[-1] == "":
+            lines = lines[:-1]
+
         return "\n".join(lines)
 
     @no_type_check

diff --git a/tests/parser/test_recipe_reader.py b/tests/parser/test_recipe_reader.py
@@ -1427,11 +1427,11 @@ def test_search() -> None:
 @pytest.mark.parametrize(
     "file,expected",
     [
-        ("simple-recipe.yaml", "359215c5ac3460d07470f2e3f524ed24154ff2eb7d274feb98149e6949c2ddbe"),
-        ("v1_format/v1_simple-recipe.yaml", "68c0b7fd829c17715b5b9941c882eda3bb70cb1dcef8cc08a55a9ee2b959fb7f"),
-        ("types-toml.yaml", "e117d210da9ea6507fdea856ee96407265aec40cbc58432aa6e1c7e31998a686"),
-        ("v1_format/v1_types-toml.yaml", "3474ed870eea9c8efbd248d24de8bdf54ad8651a7aed06d240f118272d8a3fd1"),
-        ("v1_format/v1_boto.yaml", "b42349254d020ffeda77f3068e8ad8804a92d1c7b89eb0f3d45632b38fc0a3bc"),
+        ("simple-recipe.yaml", "ffb3eba5cdbd950def9301bd7283c68ce002ab6f40de26d4d3c26f93eafd1e26"),
+        ("v1_format/v1_simple-recipe.yaml", "7a4c09fb7c7161a3d11f635e8ed74154dbfb4e28bd83aa7e03ad9d57d22810ab"),
+        ("types-toml.yaml", "d4c2fd9b24793a890e67dc58f5182981b4dd34c50967a8358de10eade8b2e415"),
+        ("v1_format/v1_types-toml.yaml", "9781d24867bc7e3b6e35aca84824c3139f64546b0792af59a361f20dc97a92fe"),
+        ("v1_format/v1_boto.yaml", "9b0f1ca532f4e94346fb69490ee69fb8505e6f76e317466f3b241c334fb4ff5c"),
     ],
 )
 def test_calc_sha256(file: str, expected: str) -> None:

diff --git a/tests/test_aux_files/boto.yaml b/tests/test_aux_files/boto.yaml
@@ -38,4 +38,4 @@ about:
     general use.
   doc_url: http://docs.pythonboto.org/en/latest/
   doc_source_url: https://github.com/boto/boto/blob/develop/docs/source/index.rst
-  dev_url: https://github.com/boto/boto/
+  dev_url: https://github.com/boto/boto/
diff --git a/tests/test_aux_files/bump_recipe/boto_build_num_1.yaml b/tests/test_aux_files/bump_recipe/boto_build_num_1.yaml
@@ -38,4 +38,4 @@ about:
     general use.
   doc_url: http://docs.pythonboto.org/en/latest/
   doc_source_url: https://github.com/boto/boto/blob/develop/docs/source/index.rst
-  dev_url: https://github.com/boto/boto/
+  dev_url: https://github.com/boto/boto/
diff --git a/tests/test_aux_files/bump_recipe/boto_version_bump.yaml b/tests/test_aux_files/bump_recipe/boto_version_bump.yaml
@@ -38,4 +38,4 @@ about:
     general use.
   doc_url: http://docs.pythonboto.org/en/latest/
   doc_source_url: https://github.com/boto/boto/blob/develop/docs/source/index.rst
-  dev_url: https://github.com/boto/boto/
+  dev_url: https://github.com/boto/boto/
diff --git a/tests/test_aux_files/bump_recipe/build_num_-1.yaml b/tests/test_aux_files/bump_recipe/build_num_-1.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/build_num_1.yaml b/tests/test_aux_files/bump_recipe/build_num_1.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/build_num_2.yaml b/tests/test_aux_files/bump_recipe/build_num_2.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/build_num_42.yaml b/tests/test_aux_files/bump_recipe/build_num_42.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/build_num_43.yaml b/tests/test_aux_files/bump_recipe/build_num_43.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/build_num_added.yaml b/tests/test_aux_files/bump_recipe/build_num_added.yaml
@@ -50,4 +50,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/curl_build_num_1.yaml b/tests/test_aux_files/bump_recipe/curl_build_num_1.yaml
@@ -128,4 +128,4 @@ extra:
     - jakirkham
     - ocefpaf
     - mingwandroid
-    - xylar
+    - xylar
diff --git a/tests/test_aux_files/bump_recipe/curl_version_bump.yaml b/tests/test_aux_files/bump_recipe/curl_version_bump.yaml
@@ -128,4 +128,4 @@ extra:
     - jakirkham
     - ocefpaf
     - mingwandroid
-    - xylar
+    - xylar
diff --git a/tests/test_aux_files/bump_recipe/google-cloud-cpp_build_num_2.yaml b/tests/test_aux_files/bump_recipe/google-cloud-cpp_build_num_2.yaml
@@ -184,4 +184,4 @@ extra:
     - davidbrochart
     - dbolduc
     - h-vetinari
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/bump_recipe/google-cloud-cpp_version_bump.yaml b/tests/test_aux_files/bump_recipe/google-cloud-cpp_version_bump.yaml
@@ -184,4 +184,4 @@ extra:
     - davidbrochart
     - dbolduc
     - h-vetinari
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/bump_recipe/gsm-amzn2-aarch64_build_num_6.yaml b/tests/test_aux_files/bump_recipe/gsm-amzn2-aarch64_build_num_6.yaml
@@ -47,4 +47,4 @@ about:
   summary: (CDT) Shared libraries for GSM speech compressor
 
 extras:
-  rpm_name: gsm
+  rpm_name: gsm
diff --git a/tests/test_aux_files/bump_recipe/gsm-amzn2-aarch64_version_bump.yaml b/tests/test_aux_files/bump_recipe/gsm-amzn2-aarch64_version_bump.yaml
@@ -47,4 +47,4 @@ about:
   summary: (CDT) Shared libraries for GSM speech compressor
 
 extras:
-  rpm_name: gsm
+  rpm_name: gsm
diff --git a/tests/test_aux_files/bump_recipe/huggingface_hub_build_num_1.yaml b/tests/test_aux_files/bump_recipe/huggingface_hub_build_num_1.yaml
@@ -69,4 +69,4 @@ extra:
   recipe-maintainers:
     - BastianZim
   skip-lints:
-    - python_build_tool_in_run
+    - python_build_tool_in_run
diff --git a/tests/test_aux_files/bump_recipe/huggingface_hub_version_bump.yaml b/tests/test_aux_files/bump_recipe/huggingface_hub_version_bump.yaml
@@ -69,4 +69,4 @@ extra:
   recipe-maintainers:
     - BastianZim
   skip-lints:
-    - python_build_tool_in_run
+    - python_build_tool_in_run
diff --git a/tests/test_aux_files/bump_recipe/libprotobuf_build_num_1.yaml b/tests/test_aux_files/bump_recipe/libprotobuf_build_num_1.yaml
@@ -125,4 +125,4 @@ extra:
     - ocefpaf
     - wesm
     - hajapy
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/bump_recipe/libprotobuf_version_bump.yaml b/tests/test_aux_files/bump_recipe/libprotobuf_version_bump.yaml
@@ -125,4 +125,4 @@ extra:
     - ocefpaf
     - wesm
     - hajapy
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/bump_recipe/no_build_num.yaml b/tests/test_aux_files/bump_recipe/no_build_num.yaml
@@ -49,4 +49,4 @@ test_var_usage:
     - {{ zz_non_alpha_first }}
     - blah
     - This {{ name }} is silly
-    - last
+    - last
diff --git a/tests/test_aux_files/bump_recipe/pytest-pep8_build_num_2.yaml b/tests/test_aux_files/bump_recipe/pytest-pep8_build_num_2.yaml
@@ -45,4 +45,4 @@ about:
 extra:
   recipe-maintainers:
     - bjodah
-    - nicoddemus
+    - nicoddemus
diff --git a/tests/test_aux_files/bump_recipe/pytest-pep8_version_bump.yaml b/tests/test_aux_files/bump_recipe/pytest-pep8_version_bump.yaml
@@ -45,4 +45,4 @@ about:
 extra:
   recipe-maintainers:
     - bjodah
-    - nicoddemus
+    - nicoddemus
diff --git a/tests/test_aux_files/bump_recipe/types-toml_bad_url.yaml b/tests/test_aux_files/bump_recipe/types-toml_bad_url.yaml
@@ -48,4 +48,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_bad_url_hash_var.yaml b/tests/test_aux_files/bump_recipe/types-toml_bad_url_hash_var.yaml
@@ -50,4 +50,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_bad_url_multi_source.yaml b/tests/test_aux_files/bump_recipe/types-toml_bad_url_multi_source.yaml
@@ -50,4 +50,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_bad_url_partial_save.yaml b/tests/test_aux_files/bump_recipe/types-toml_bad_url_partial_save.yaml
@@ -48,4 +48,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_build_num_1.yaml b/tests/test_aux_files/bump_recipe/types-toml_build_num_1.yaml
@@ -48,4 +48,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_hash_type_build_num_1.yaml b/tests/test_aux_files/bump_recipe/types-toml_hash_type_build_num_1.yaml
@@ -49,4 +49,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_hash_type_version_bump.yaml b/tests/test_aux_files/bump_recipe/types-toml_hash_type_version_bump.yaml
@@ -49,4 +49,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/types-toml_version_bump.yaml b/tests/test_aux_files/bump_recipe/types-toml_version_bump.yaml
@@ -48,4 +48,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/bump_recipe/x264_build_num_1.yaml b/tests/test_aux_files/bump_recipe/x264_build_num_1.yaml
@@ -50,4 +50,4 @@ extra:
     - jakirkham
     - 183amir
     - carlodri
-    - sdvillal
+    - sdvillal
diff --git a/tests/test_aux_files/bump_recipe/x264_version_bump.yaml b/tests/test_aux_files/bump_recipe/x264_version_bump.yaml
@@ -50,4 +50,4 @@ extra:
     - jakirkham
     - 183amir
     - carlodri
-    - sdvillal
+    - sdvillal
diff --git a/tests/test_aux_files/cbc_files/anaconda_cbc_01.yaml b/tests/test_aux_files/cbc_files/anaconda_cbc_01.yaml
@@ -229,4 +229,4 @@ zip_keys:
     - python
     - numpy
 zstd:
-  - 1.5.2
+  - 1.5.2
diff --git a/tests/test_aux_files/cctools-ld64.yaml b/tests/test_aux_files/cctools-ld64.yaml
@@ -128,4 +128,4 @@ outputs:
       license: Apple Public Source License 2.0
       license_family: Other
       license_file: cctools/ld64/APPLE_LICENSE
-      summary: Darwin Mach-O linker
+      summary: Darwin Mach-O linker
diff --git a/tests/test_aux_files/curl.yaml b/tests/test_aux_files/curl.yaml
@@ -128,4 +128,4 @@ extra:
     - jakirkham
     - ocefpaf
     - mingwandroid
-    - xylar
+    - xylar
diff --git a/tests/test_aux_files/dot_function_replacement.yaml b/tests/test_aux_files/dot_function_replacement.yaml
@@ -26,4 +26,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/dynamic-linking.yaml b/tests/test_aux_files/dynamic-linking.yaml
@@ -42,4 +42,4 @@ about:
   license_file: LICENSE
   license_family: OTHER
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/environ_get.yaml b/tests/test_aux_files/environ_get.yaml
@@ -3,4 +3,4 @@
 
 package:
   name: abc
-  version: 0
+  version: 0
diff --git a/tests/test_aux_files/fake_source.yaml b/tests/test_aux_files/fake_source.yaml
@@ -46,4 +46,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/git-src.yaml b/tests/test_aux_files/git-src.yaml
@@ -30,4 +30,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/google-cloud-cpp.yaml b/tests/test_aux_files/google-cloud-cpp.yaml
@@ -184,4 +184,4 @@ extra:
     - davidbrochart
     - dbolduc
     - h-vetinari
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/gsm-amzn2-aarch64.yaml b/tests/test_aux_files/gsm-amzn2-aarch64.yaml
@@ -47,4 +47,4 @@ about:
   summary: (CDT) Shared libraries for GSM speech compressor
 
 extras:
-  rpm_name: gsm
+  rpm_name: gsm
diff --git a/tests/test_aux_files/h5py.yaml b/tests/test_aux_files/h5py.yaml
@@ -66,4 +66,4 @@ extra:
     - tacaswell
     - ocefpaf
     - minrk
-    - scopatz
+    - scopatz
diff --git a/tests/test_aux_files/hash_type_replacement.yaml b/tests/test_aux_files/hash_type_replacement.yaml
@@ -33,4 +33,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/huggingface_hub.yaml b/tests/test_aux_files/huggingface_hub.yaml
@@ -69,4 +69,4 @@ extra:
   recipe-maintainers:
     - BastianZim
   skip-lints:
-    - python_build_tool_in_run
+    - python_build_tool_in_run
diff --git a/tests/test_aux_files/libprotobuf.yaml b/tests/test_aux_files/libprotobuf.yaml
@@ -126,4 +126,4 @@ extra:
     - ocefpaf
     - wesm
     - hajapy
-    - xhochy
+    - xhochy
diff --git a/tests/test_aux_files/multi-output.yaml b/tests/test_aux_files/multi-output.yaml
@@ -22,4 +22,4 @@ outputs:
         - foo
     test:
       commands:
-        - db_archive -m hello
+        - db_archive -m hello
diff --git a/tests/test_aux_files/non_marked_multiline_summary.yaml b/tests/test_aux_files/non_marked_multiline_summary.yaml
@@ -29,4 +29,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/pip_check_only.yaml b/tests/test_aux_files/pip_check_only.yaml
@@ -43,4 +43,4 @@ about:
 extra:
   recipe-maintainers:
     - fhoehle
-    - conda-forge/mypy
+    - conda-forge/mypy
diff --git a/tests/test_aux_files/pre_processor/pp_dot_function_replacement.yaml b/tests/test_aux_files/pre_processor/pp_dot_function_replacement.yaml
@@ -26,4 +26,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/pre_processor/pp_environ_get.yaml b/tests/test_aux_files/pre_processor/pp_environ_get.yaml
@@ -3,4 +3,4 @@
 
 package:
   name: abc
-  version: 0
+  version: 0
diff --git a/tests/test_aux_files/pre_processor/pp_hash_type_replacement.yaml b/tests/test_aux_files/pre_processor/pp_hash_type_replacement.yaml
@@ -30,4 +30,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
diff --git a/tests/test_aux_files/pre_processor/pp_quoted_multiline_str.yaml b/tests/test_aux_files/pre_processor/pp_quoted_multiline_str.yaml
@@ -28,4 +28,4 @@ about:
   license: MIT
   license_file: LICENSE
   dev_url: https://github.com/python/typeshed
-  doc_url: https://pypi.org/project/types-toml/
+  doc_url: https://pypi.org/project/types-toml/
-Original file line number
+Diff line change
@@ Expand Up / @@ -50,4 +50,4 @@ test_var_usage: @@
         - {{ zz_non_alpha_first }}
         - blah
         - This {{ name }} is silly
-        - last
+        - last