auto:percent becomes the default format for exporting as script

mwouts · Jan 9, 2024 · e5460f5 · e5460f5
1 parent 0606f03
commit e5460f5
Show file tree

Hide file tree

Showing 21 changed files with 117 additions and 124 deletions.
diff --git a/jupyterlab/packages/jupyterlab-jupytext-extension/src/commands.ts b/jupyterlab/packages/jupyterlab-jupytext-extension/src/commands.ts
@@ -68,9 +68,9 @@ function getSelectedFormats(notebookTracker: INotebookTracker): Array<string> {
   if (languageInfo && languageInfo.file_extension) {
     const scriptExt = languageInfo.file_extension.substring(1);
     formats = formats.map((format) => {
-      // By default use light format
+      // By default use percent format
       if (format === scriptExt) {
-        return 'auto:light';
+        return 'auto:percent';
       }
       // Replace language specific extension with auto
       return format.replace(`${scriptExt}:`, 'auto:');
@@ -102,8 +102,8 @@ function getSelectedFormats(notebookTracker: INotebookTracker): Array<string> {
       'jupytext'
     ) as IJupytextSection;
     const formatName = jupytext
-      ? jupytext?.text_representation?.formatName || 'light'
-      : 'light';
+      ? jupytext?.text_representation?.formatName || 'percent'
+      : 'percent';
     formats.push(`auto:${formatName}`);
   }
   return formats;

diff --git a/jupyterlab/packages/jupyterlab-jupytext-extension/src/tokens.ts b/jupyterlab/packages/jupyterlab-jupytext-extension/src/tokens.ts
@@ -84,17 +84,6 @@ export const JUPYTEXT_PAIR_COMMANDS_FILETYPE_DATA = new Map<
       },
     ],
   ],
-  [
-    'auto:light',
-    [
-      {
-        fileExt: 'auto:light',
-        paletteLabel: 'Pair with light script',
-        caption: 'Pair Notebook with Light Format',
-        iconName: 'ui-components:text-editor',
-      },
-    ],
-  ],
   [
     'auto:percent',
     [
@@ -107,12 +96,12 @@ export const JUPYTEXT_PAIR_COMMANDS_FILETYPE_DATA = new Map<
     ],
   ],
   [
-    'auto:hydrogen',
+    'auto:light',
     [
       {
-        fileExt: 'auto:hydrogen',
-        paletteLabel: 'Pair with hydrogen script',
-        caption: 'Pair Notebook with Hydrogen Format',
+        fileExt: 'auto:light',
+        paletteLabel: 'Pair with light script',
+        caption: 'Pair Notebook with Light Format',
         iconName: 'ui-components:text-editor',
       },
     ],
@@ -250,17 +239,6 @@ export const JUPYTEXT_CREATE_TEXT_NOTEBOOK_FILETYPE_DATA = new Map<
   string,
   IFileTypeData[]
 >([
-  [
-    'auto:light',
-    [
-      {
-        fileExt: 'auto:light',
-        paletteLabel: 'Light Format',
-        caption: 'Light Format',
-        launcherLabel: 'Light Format',
-      },
-    ],
-  ],
   [
     'auto:percent',
     [
@@ -273,13 +251,13 @@ export const JUPYTEXT_CREATE_TEXT_NOTEBOOK_FILETYPE_DATA = new Map<
     ],
   ],
   [
-    'auto:hydrogen',
+    'auto:light',
     [
       {
-        fileExt: 'auto:hydrogen',
-        paletteLabel: 'Hydrogen Format',
-        caption: 'Hydrogen Format',
-        launcherLabel: 'Hydrogen Format',
+        fileExt: 'auto:light',
+        paletteLabel: 'Light Format',
+        caption: 'Light Format',
+        launcherLabel: 'Light Format',
       },
     ],
   ],
@@ -364,7 +342,6 @@ export const TEXT_NOTEBOOKS_LAUNCHER_ICONS = JUPYTEXT_FORMATS.filter(
   (format) => {
     return ![
       'ipynb',
-      'auto:hydrogen',
       'auto:nomarker',
       'qmd',
       'custom',

diff --git a/jupyterlab/packages/jupyterlab-jupytext-extension/src/utils.ts b/jupyterlab/packages/jupyterlab-jupytext-extension/src/utils.ts
@@ -163,7 +163,7 @@ export async function getAvailableCreateTextNotebookCommands(
       fileTypes.map((fileType: IFileTypeData) => {
         // If format is auto, we need to add all currently available kernels
         // For instance if there are Python and R kernels available, format
-        // auto:light will be replaced by py:light and R:light
+        // auto:percent will be replaced by py:percent and R:percent
         if (format.startsWith('auto')) {
           const formatType = format.split(':')[1];
           let mapIndex = 0;

diff --git a/src/jupytext/cli.py b/src/jupytext/cli.py
@@ -117,11 +117,10 @@ def parse_jupytext_args(args=None):
                     }
                 )
             )
-            + "The default format for scripts is the 'light' format, "
-            "which uses few cell markers (none when possible). "
-            "Alternatively, a format compatible with many editors is the "
-            "'percent' format, which uses '# %%%%' as cell markers. "
-            "The main formats (markdown, light, percent) preserve "
+            + "The default format for scripts is the 'percent' format, "
+            "which uses '# %%%%' as cell markers and is compatible with VS Code and PyCharm. "
+            "Alternatively, you can also use the 'light' format, which uses fewer cell markers. "
+            "The main formats (MyST Markdown, Markdown, percent, light) preserve "
             "notebooks and text documents in a roundtrip. Use the "
             "--test and and --test-strict commands to test the roundtrip on your files. "
             "Read more about the available formats at "

diff --git a/src/jupytext/jupytext.py b/src/jupytext/jupytext.py
@@ -30,6 +30,7 @@
     metadata_and_cell_to_header,
 )
 from .languages import (
+    _SCRIPT_EXTENSIONS,
     default_language_from_metadata_and_ext,
     set_main_and_cell_language,
 )
@@ -476,6 +477,11 @@ def writes(notebook, fmt, version=nbformat.NO_CONVERT, config=None, **kwargs):
     if not format_name:
         format_name = format_name_for_ext(metadata, ext, explicit_default=False)
 
+    # Since Jupytext==1.17, the default format for
+    # writing a notebook to a script is the percent format
+    if not format_name and "cell_markers" not in fmt and ext in _SCRIPT_EXTENSIONS:
+        format_name = "percent"
+
     if format_name:
         fmt["format_name"] = format_name
         update_jupytext_formats_metadata(metadata, fmt)

diff --git a/tests/data/notebooks/outputs/ipynb_to_spin/R notebook with invalid cell keys.R b/tests/data/notebooks/outputs/ipynb_to_spin/R notebook with invalid cell keys.R
@@ -1,12 +1,12 @@
-# ---
-# jupyter:
-#   kernelspec:
-#     display_name: R
-#     language: R
-#     name: ir
-# ---
+#' ---
+#' jupyter:
+#'   kernelspec:
+#'     display_name: R
+#'     language: R
+#'     name: ir
+#' ---
 
-# This notebook was created with IRKernel 0.8.12, and is not completely valid, as the code cell below contains an unexpected 'source' entry. This did cause https://github.com/mwouts/jupytext/issues/234. Note that the problem is solved when one upgrades to IRKernel 1.0.0.
+#' This notebook was created with IRKernel 0.8.12, and is not completely valid, as the code cell below contains an unexpected 'source' entry. This did cause https://github.com/mwouts/jupytext/issues/234. Note that the problem is solved when one upgrades to IRKernel 1.0.0.
 
 library("ggplot2")
 ggplot(mtcars, aes(mpg)) + stat_ecdf()
diff --git a/tests/data/notebooks/outputs/ipynb_to_spin/R notebook with invalid cell keys.low.r b/tests/data/notebooks/outputs/ipynb_to_spin/R notebook with invalid cell keys.low.r
@@ -1,12 +1,12 @@
-# ---
-# jupyter:
-#   kernelspec:
-#     display_name: R
-#     language: R
-#     name: ir
-# ---
+#' ---
+#' jupyter:
+#'   kernelspec:
+#'     display_name: R
+#'     language: R
+#'     name: ir
+#' ---
 
-# This notebook was created with IRKernel 0.8.12, and is not completely valid, as the code cell below contains an unexpected 'source' entry. This did cause https://github.com/mwouts/jupytext/issues/234. Note that the problem is solved when one upgrades to IRKernel 1.0.0.
+#' This notebook was created with IRKernel 0.8.12, and is not completely valid, as the code cell below contains an unexpected 'source' entry. This did cause https://github.com/mwouts/jupytext/issues/234. Note that the problem is solved when one upgrades to IRKernel 1.0.0.
 
 library("ggplot2")
 ggplot(mtcars, aes(mpg)) + stat_ecdf()
diff --git a/tests/data/notebooks/outputs/ipynb_to_spin/ir_notebook.R b/tests/data/notebooks/outputs/ipynb_to_spin/ir_notebook.R
@@ -1,12 +1,12 @@
-# ---
-# jupyter:
-#   kernelspec:
-#     display_name: R
-#     language: R
-#     name: ir
-# ---
-
-# This is a jupyter notebook that uses the IR kernel.
+#' ---
+#' jupyter:
+#'   kernelspec:
+#'     display_name: R
+#'     language: R
+#'     name: ir
+#' ---
+
+#' This is a jupyter notebook that uses the IR kernel.
 
 sum(1:10)
 

diff --git a/tests/data/notebooks/outputs/ipynb_to_spin/ir_notebook.low.r b/tests/data/notebooks/outputs/ipynb_to_spin/ir_notebook.low.r
@@ -1,12 +1,12 @@
-# ---
-# jupyter:
-#   kernelspec:
-#     display_name: R
-#     language: R
-#     name: ir
-# ---
-
-# This is a jupyter notebook that uses the IR kernel.
+#' ---
+#' jupyter:
+#'   kernelspec:
+#'     display_name: R
+#'     language: R
+#'     name: ir
+#' ---
+
+#' This is a jupyter notebook that uses the IR kernel.
 
 sum(1:10)
 

diff --git a/tests/external/pre_commit/test_pre_commit_mode.py b/tests/external/pre_commit/test_pre_commit_mode.py
@@ -40,7 +40,7 @@ def test_ignore_unmatched_ignores(tmpdir, cwd_tmpdir):
 
     # Run jupytext
     status = jupytext(
-        ["--from", "ipynb", "--to", "py:light", "--pre-commit-mode", file]
+        ["--from", "ipynb", "--to", "py:percent", "--pre-commit-mode", file]
     )
 
     assert status == 0
@@ -90,7 +90,7 @@ def test_alert_untracked_alerts_for_modified(tmpdir, cwd_tmpdir, tmp_repo, capsy
 
     # Run jupytext
     status = jupytext(
-        ["--from", "ipynb", "--to", "py:light", "--pre-commit-mode", "test.ipynb"]
+        ["--from", "ipynb", "--to", "py:percent", "--pre-commit-mode", "test.ipynb"]
     )
 
     assert status == 1

diff --git a/tests/external/pre_commit/test_pre_commit_scripts.py b/tests/external/pre_commit/test_pre_commit_scripts.py
@@ -43,7 +43,7 @@ def test_pre_commit_hook(tmpdir):
     git = git_in_tmpdir(tmpdir)
     hook = str(tmpdir.join(".git/hooks/pre-commit"))
     with open(hook, "w") as fp:
-        fp.write("#!/bin/sh\n" "jupytext --to py:light --pre-commit\n")
+        fp.write("#!/bin/sh\n" "jupytext --to py:percent --pre-commit\n")
 
     st = os.stat(hook)
     os.chmod(hook, st.st_mode | stat.S_IEXEC)
@@ -148,7 +148,7 @@ def test_pre_commit_hook_in_subfolder(tmpdir):
     hook = str(tmpdir.join(".git/hooks/pre-commit"))
     with open(hook, "w") as fp:
         fp.write(
-            "#!/bin/sh\n" "jupytext --from ipynb --to python//py:light --pre-commit\n"
+            "#!/bin/sh\n" "jupytext --from ipynb --to python//py:percent --pre-commit\n"
         )
 
     st = os.stat(hook)
@@ -178,8 +178,8 @@ def test_pre_commit_hook_py_to_ipynb_and_md(tmpdir):
     with open(hook, "w") as fp:
         fp.write(
             "#!/bin/sh\n"
-            "jupytext --from py:light --to ipynb --pre-commit\n"
-            "jupytext --from py:light --to md --pre-commit\n"
+            "jupytext --from py:percent --to ipynb --pre-commit\n"
+            "jupytext --from py:percent --to md --pre-commit\n"
         )
 
     st = os.stat(hook)

diff --git a/tests/functional/cli/test_cli.py b/tests/functional/cli/test_cli.py
@@ -1262,7 +1262,7 @@ def test_jupytext_to_ipynb_does_not_update_timestamp_if_not_paired(
     assert "Updating the timestamp" not in capture.out
 
 
-@pytest.mark.parametrize("formats", ["ipynb,py", "py:percent", "py", None])
+@pytest.mark.parametrize("formats", ["ipynb,py", "py:percent", "py:light", None])
 def test_use_source_timestamp(tmpdir, cwd_tmpdir, python_notebook, capsys, formats):
     # Write a text notebook
     nb = python_notebook
@@ -1302,7 +1302,7 @@ def test_use_source_timestamp(tmpdir, cwd_tmpdir, python_notebook, capsys, forma
     os.utime(test_py, (src_timestamp, src_timestamp))
 
     # Then we can't open paired notebooks
-    if formats == "ipynb,py":
+    if formats == "ipynb,py:percent":
         from tornado.web import HTTPError
 
         with pytest.raises(HTTPError, match="is more recent than test.py"):