Add regexp matching

Author: chrisjsewell

doc/conf.py

@@ -38,7 +38,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx_copybutton"]
+extensions = ["sphinx_copybutton", "IPython.sphinxext.ipython_directive"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -98,7 +98,8 @@
 # html_sidebars = {}
 
 # CopyButton configuration
-copybutton_prompt_text = ">>> "
+copybutton_prompt_text = ">>> |\\\\$ |\\[\\d*\\]: |\\.\\.\\.: "
+copybutton_prompt_is_regexp = True
 # Switches for testing but shouldn't be activated in the live docs
 # copybutton_only_copy_prompt_lines = False
 # copybutton_remove_prompts = False

doc/index.rst

@@ -135,6 +135,34 @@ use the following configuration:
 
     copybutton_prompt_text = ">>> "
 
+Using regexp prompt identifiers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If your prompts are more complex than a single string, then you can use a regexp to match with.
+
+.. code-block:: python
+
+   copybutton_prompt_text = "\\[\\d*\\]: |\\.\\.\\.: "
+   copybutton_prompt_is_regexp = True
+
+For example when using ipython prompts with continuations:
+
+.. code-block:: restructuredtext
+
+   .. code-block:: ipython
+
+      [1]: first
+      ...: continuation
+      output
+      [2]: second
+
+.. code-block:: ipython
+
+   [1]: first
+   ...: continuation
+   output
+   [2]: second
+
 Configure whether *only* lines with prompts are copied
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -265,7 +293,7 @@ Then run the docs build:
 
 .. code-block:: console
 
-   $ cd docs
+   $ cd doc
    $ make html
 
 .. toctree::

doc/requirements.txt

@@ -1,4 +1,5 @@
 sphinx
+ipython
 
 # Install ourselves
 .

sphinx_copybutton/__init__.py

@@ -18,6 +18,9 @@ def add_to_context(app, config):
     config.html_context.update(
         {"copybutton_prompt_text": config.copybutton_prompt_text}
     )
+    config.html_context.update(
+        {"copybutton_prompt_is_regexp": config.copybutton_prompt_is_regexp}
+    )
     config.html_context.update(
         {"copybutton_only_copy_prompt_lines": config.copybutton_only_copy_prompt_lines}
     )
@@ -37,12 +40,14 @@ def add_to_context(app, config):
 
 
 def setup(app):
+
     logger.verbose("Adding copy buttons to code blocks...")
     # Add our static path
     app.connect("builder-inited", scb_static_path)
 
     # configuration for this tool
     app.add_config_value("copybutton_prompt_text", "", "html")
+    app.add_config_value("copybutton_prompt_is_regexp", False, "html")
     app.add_config_value("copybutton_only_copy_prompt_lines", True, "html")
     app.add_config_value("copybutton_remove_prompts", True, "html")
     app.add_config_value("copybutton_image_path", "copy-button.svg", "html")

sphinx_copybutton/_static/copybutton.js_t

@@ -84,9 +84,9 @@ const addCopyButtonToCodeCells = () => {
 
 {{ copybutton_format_func }}
 
-var copyTargetText = (target) => {
+var copyTargetText = (trigger) => {
   var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
-  return formatCopyText(target.innerText, '{{ copybutton_prompt_text }}', {{ copybutton_only_copy_prompt_lines | lower }},  {{ copybutton_remove_prompts | lower }})
+  return formatCopyText(target.innerText, '{{ copybutton_prompt_text }}', {{ copybutton_prompt_is_regexp | lower }}, {{ copybutton_only_copy_prompt_lines | lower }},  {{ copybutton_remove_prompts | lower }})
 }
 
   // Initialize with a callback so we can modify the text before copy

sphinx_copybutton/_static/copybutton_funcs.js

@@ -1,31 +1,44 @@
+function escapeRegExp(string) {
+    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+
 // Callback when a copy button is clicked. Will be passed the node that was clicked
 // should then grab the text and replace pieces of text that shouldn't be used in output
-export function formatCopyText(textContent, copybuttonPromptText, onlyCopyPromptLines=true, removePrompts=true) {
-    textContent = textContent.split('\n');
-    // Text content line filtering based on prompts (if a prompt text is given)
-    if (copybuttonPromptText.length > 0) {
-        // If only copying prompt lines, remove all lines that don't start w/ prompt
-        if (onlyCopyPromptLines) {
-            var linesWithPrompt = textContent.filter((line) => {
-                return line.startsWith(copybuttonPromptText) || (line.length == 0); // Keep newlines
-            });
-            // Check to make sure we have at least one non-empty line
-            var nonEmptyLines = linesWithPrompt.filter((line) => { return line.length > 0 });
-            // If we detected lines w/ prompt, then overwrite textContent w/ those lines
-            if ((linesWithPrompt.length > 0) && (nonEmptyLines.length > 0)) {
-                textContent = linesWithPrompt;
+export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true) {
+
+    var regexp;
+    var match;
+
+    // create regexp to capture prompt and remaining line
+    if (isRegexp) {
+        regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
+    } else {
+        regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
+    }
+
+    const outputLines = [];
+    var promptFound = false;
+    for (const line of textContent.split('\n')) {
+        match = line.match(regexp)
+        if (match) {
+            promptFound = true
+            if (removePrompts) {
+                outputLines.push(match[2])
+            } else {
+                outputLines.push(line)
+            }
+        } else {
+            if (!onlyCopyPromptLines) {
+                outputLines.push(line)
             }
         }
-        // Remove the starting prompt from any remaining lines
-        if (removePrompts) {
-            textContent.forEach((line, index) => {
-                if (line.startsWith(copybuttonPromptText)) {
-                    textContent[index] = line.slice(copybuttonPromptText.length);
-                }
-            });
-        }
     }
-    textContent = textContent.join('\n');
+
+    // If no lines with the prompt were found then just use original lines
+    if (promptFound) {
+        textContent = outputLines.join('\n');
+    }
+
     // Remove a trailing newline to avoid auto-running when pasting
     if (textContent.endsWith("\n")) {
         textContent = textContent.slice(0, -1)

sphinx_copybutton/_static/test.js

@@ -3,22 +3,138 @@ import { formatCopyText } from "./copybutton_funcs";
 
 const parameters = [
 	{
-		description: 'no prompt',
+		description: 'empty prompt',
 		text: 'hallo',
 		prompt: '',
+		isRegexp: false,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
 		expected: 'hallo'
 	},
 	{
-		description: 'with prompt',
-		text: '>>> hallo',
+		description: 'no prompt in text',
+		text: 'hallo',
 		prompt: '>>> ',
+		isRegexp: false,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
 		expected: 'hallo'
+	},
+	{
+		description: 'with non-regexp python prompt',
+		text: `
+>>> first
+output
+>>> second`,
+		prompt: '>>> ',
+		isRegexp: false,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
+		expected: 'first\nsecond'
+	},
+	{
+		description: 'with non-regexp console prompt',
+		text: `
+$ first
+output
+$ second`,
+		prompt: '$ ',
+		isRegexp: false,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
+		expected: 'first\nsecond'
+	},
+	{
+		description: 'with non-regexp prompt, keep prompt',
+		text: `
+>>> first
+output
+>>> second`,
+		prompt: '>>> ',
+		isRegexp: false,
+		onlyCopyPromptLines: true,
+		removePrompts: false,
+		expected: '>>> first\n>>> second'
+	},
+	{
+		description: 'with non-regexp prompt, keep lines',
+		text: `
+>>> first
+output
+>>> second`,
+		prompt: '>>> ',
+		isRegexp: false,
+		onlyCopyPromptLines: false,
+		removePrompts: true,
+		expected: '\nfirst\noutput\nsecond'
+	},
+	{
+		description: 'with non-regexp prompt, keep all',
+		text: `
+>>> first
+output
+>>> second`,
+		prompt: '>>> ',
+		isRegexp: false,
+		onlyCopyPromptLines: false,
+		removePrompts: false,
+		expected: '\n>>> first\noutput\n>>> second'
+	},
+	{
+		description: 'with regexp python prompt',
+		text: `
+>>> first
+output
+>>> second`,
+		prompt: '>>> ',
+		isRegexp: true,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
+		expected: 'first\nsecond'
+	},
+	{
+		description: 'with regexp console prompt',
+		text: `
+$ first
+output
+$ second`,
+		prompt: '\\$ ',
+		isRegexp: true,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
+		expected: 'first\nsecond'
+	},
+	{
+		description: 'with ipython prompt regexp',
+		text: `
+[1]: first
+...: continuation
+output
+[2]: second`,
+		prompt: '[\d*]: |\.\.\.: ',
+		isRegexp: true,
+		onlyCopyPromptLines: true,
+		removePrompts: true,
+		expected: 'first\ncontinuation\nsecond'
+	},
+	{
+		description: 'with ipython prompt regexp, keep prompts',
+		text: `
+[1]: first
+...: continuation
+output
+[2]: second`,
+		prompt: '[\d*]: |\.\.\.: ',
+		isRegexp: true,
+		onlyCopyPromptLines: true,
+		removePrompts: false,
+		expected: '[1]: first\n...: continuation\n[2]: second'
 	}
 ]
 
-parameters.forEach((parameter) => {
-	test(parameter.description, t => {
-		const text = formatCopyText(parameter.text, parameter.prompt);
-		t.is(text, parameter.expected)
+parameters.forEach((p) => {
+	test(p.description, t => {
+		const text = formatCopyText(p.text, p.prompt, p.isRegexp, p.onlyCopyPromptLines, p.removePrompts);
+		t.is(text, p.expected)
 	});
 })