Implement IPython pinfo (?) and pinfo2 (??), closes #342

Author: krassowski

packages/jupyterlab-lsp/src/transclusions/ipython/overrides.spec.ts

@@ -165,6 +165,46 @@ describe('Default IPython overrides', () => {
     it('does not override != comparisons', () => {
       let override = line_magics_map.override_for('1 != None');
       expect(override).to.equal(null);
-    })
+    });
+  });
+
+  describe('IPython help line magics', () => {
+    let line_magics_map = new ReversibleOverridesMap(
+      overrides.filter(override => override.scope == 'line')
+    );
+
+    it('overrides pinfo', () => {
+      let override = line_magics_map.override_for('?int');
+      expect(override).to.equal("get_ipython().run_line_magic('pinfo', 'int')");
+
+      let reverse = line_magics_map.reverse.override_for(override);
+      expect(reverse).to.equal('?int');
+
+      override = line_magics_map.override_for('int?');
+      expect(override).to.equal(
+        "get_ipython().run_line_magic('pinfo',  'int')"
+      );
+
+      reverse = line_magics_map.reverse.override_for(override);
+      expect(reverse).to.equal('int?');
+    });
+
+    it('overrides pinfo2', () => {
+      let override = line_magics_map.override_for('??int');
+      expect(override).to.equal(
+        "get_ipython().run_line_magic('pinfo2', 'int')"
+      );
+
+      let reverse = line_magics_map.reverse.override_for(override);
+      expect(reverse).to.equal('??int');
+
+      override = line_magics_map.override_for('int??');
+      expect(override).to.equal(
+        "get_ipython().run_line_magic('pinfo2',  'int')"
+      );
+
+      reverse = line_magics_map.reverse.override_for(override);
+      expect(reverse).to.equal('int??');
+    });
   });
 });

packages/jupyterlab-lsp/src/transclusions/ipython/overrides.ts

@@ -37,7 +37,7 @@ function empty_or_escaped(x: string) {
  *    x['a = !ls'] = !ls
  * is perfectly valid IPython, but regular expressions cannot help here.
  */
-export const LINE_MAGIC_PREFIX = '^(\\s*|\\s*\\S+\\s*=\\s*)'
+export const LINE_MAGIC_PREFIX = '^(\\s*|\\s*\\S+\\s*=\\s*)';
 
 export let overrides: IScopedCodeOverride[] = [
   /**
@@ -55,6 +55,45 @@ export let overrides: IScopedCodeOverride[] = [
       scope: 'line'
     }
   },
+  {
+    // note: assignments of pinfo/pinfo2 are not supported by IPython
+    pattern: '^(\\s*)' + '(\\?{1,2})(\\S+)(\n)?',
+    replacement: (match, prefix, marks, name, line_break) => {
+      const cmd = marks == '?' ? 'pinfo' : 'pinfo2';
+      line_break = line_break || '';
+      // trick: use single quotes to distinguish
+      return `${prefix}get_ipython().run_line_magic(\'${cmd}\', \'${name}\')${line_break}`;
+    },
+    scope: 'line',
+    reverse: {
+      pattern:
+        "get_ipython\\(\\).run_line_magic\\('(pinfo2?)', '(.*?)'\\)(\n)?",
+      replacement: (match, cmd, name) => {
+        const marks = cmd == 'pinfo' ? '?' : '??';
+        return `${marks}${name}`;
+      },
+      scope: 'line'
+    }
+  },
+  {
+    pattern: '^(\\s*)' + '([^\\?\\s]+)(\\?{1,2})(\n)?',
+    replacement: (match, prefix, name, marks, line_break) => {
+      const cmd = marks == '?' ? 'pinfo' : 'pinfo2';
+      line_break = line_break || '';
+      // trick: use two spaces to distinguish pinfo using suffix (int?) from the one using prefix (?int)
+      return `${prefix}get_ipython().run_line_magic(\'${cmd}\',  \'${name}\')${line_break}`;
+    },
+    scope: 'line',
+    reverse: {
+      pattern:
+        "get_ipython\\(\\).run_line_magic\\('(pinfo2?)',  '(.*?)'\\)(\n)?",
+      replacement: (match, cmd, name) => {
+        const marks = cmd == 'pinfo' ? '?' : '??';
+        return `${name}${marks}`;
+      },
+      scope: 'line'
+    }
+  },
   {
     pattern: LINE_MAGIC_PREFIX + '%(\\S+)(.*)(\n)?',
     replacement: (match, prefix, name, args, line_break) => {