refactor: removed special handling of qmd cell options, since # | are supported

Author: hguturu

nbqa/replace_source.py

@@ -28,45 +28,6 @@
 SEPARATOR = {True: MARKDOWN_SEPARATOR, False: CODE_SEPARATOR}
 
 
-def _restore_quarto_cell_options(og_lines: list[str], lines: list[str]) -> list[str]:
-    """
-    Restore the cell option comments #| at the start of the cell.
-
-    This comment like is typically changed to '# |' by third party tools.
-
-    This is for the cell options in quarto format as described at
-    https://quarto.org/docs/reference/cells/cells-jupyter.html.
-
-    Parameters
-    ----------
-    og_lines
-        Original input lines.
-    lines
-        Lines after all formatting and magics restored.
-
-    Returns
-    -------
-    list[str]
-        Lines with leading '# |' restored to '#|'.
-    """
-    restored_lines = []
-    i = 0
-    # iteration logic should be safe since all cell options are at the start
-    # and single lines so shouldn't suffer multi-line formatting before
-    # breaking out
-    for i, line in enumerate(lines):
-        if not line.startswith("# |") or not og_lines[i].startswith("#|"):
-            # only leading '#|' are cell options
-            # if we encounter a line without, then all following are not
-            # we also skip if the formatting tool hasn't changed '#|' to '# |'
-            # since that means the formatter is handling qmd lines properly
-            restored_lines.append(line)
-            break
-        restored_lines.append("#|" + line[3:])
-    restored_lines.extend(lines[i + 1 :])
-    return restored_lines
-
-
 def _restore_semicolon(
     source: str,
     cell_number: int,
@@ -317,8 +278,6 @@ def mutate(  # pylint: disable=too-many-locals,too-many-arguments
         )
         if not new_source:
             cells_to_remove.append(cell_number)
-        if notebook.endswith(".qmd"):
-            new_source = _restore_quarto_cell_options(cell["source"], new_source)
         cell["source"] = new_source
 
     if original_notebook_json == notebook_json:
@@ -418,8 +377,6 @@ def diff(  # pylint: disable=too-many-arguments
             newlinesbefore[python_file],
             newlinesafter[python_file],
         )
-        if notebook.endswith(".qmd"):
-            new_source = _restore_quarto_cell_options(cell["source"], new_source)
         cell["source"][-1] += "\n"
         if new_source:
             new_source[-1] += "\n"

tests/data/notebook_for_testing.qmd

@@ -18,20 +18,20 @@ jupyter:
 
 ```{python}
 #| label: fig-polar
-#| fig-cap: A line plot on a polar axis
-#   Should not be changed back to #|
-# This is a comment
-# | Looks like a cell option, but treat like
-# comment since not at top
+# | fig-cap: A line plot on a polar axis
+#|  Additional content
+# This is a comment that stops cell options
+#| fig-subcap: A line plot on a polar axis
+# |  Additional content
 
 import numpy as np
-import matplotlib.pyplot as    plt
+import matplotlib.pyplot as plt
 
-r = np.arange(0,2,0.01)
-theta = 2*np.pi*r
-fig, ax = plt.subplots(subplot_kw={'projection': 'polar'})
+r = np.arange(0, 2, 0.01)
+theta = 2 * np.pi * r
+fig, ax = plt.subplots(subplot_kw={"projection": "polar"})
 ax.plot(theta, r)
-ax.set_rticks([0.5,1,1.5,2])
+ax.set_rticks([0.5, 1, 1.5, 2])
 ax.grid(True)
 plt.show()
 ```

tests/test_jupytext.py

@@ -234,11 +234,12 @@ def test_qmd(tmp_test_data: Path) -> None:
         """\n"""
         """```{python}\n"""
         """#| label: fig-polar\n"""
-        """#| fig-cap: A line plot on a polar axis\n"""
-        """#   Should not be changed back to #|\n"""
-        """# This is a comment\n"""
-        """# | Looks like a cell option, but treat like\n"""
-        """# comment since not at top\n"""
+        """#| fig-cap: |-\n"""
+        """#|   A line plot on a polar axis\n"""
+        """#|   Additional content\n"""
+        """# This is a comment that stops cell options\n"""
+        """# | fig-subcap: A line plot on a polar axis\n"""
+        """# |  Additional content\n"""
         """\n"""
         """import numpy as np\n"""
         """import matplotlib.pyplot as plt\n"""