Patchwork [3,of,3,V3] demandimport: allow extensions to import own modules by absolute name

login
register
mail settings
Submitter Katsunori FUJIWARA
Date Sept. 7, 2013, 6:22 p.m.
Message ID <8d7850556f3a4e473b11.1378578173@feefifofum>
Download mbox | patch
Permalink /patch/2402/
State Superseded
Commit 621a26eb3a99a8a31f71ccafba7ef587af88fec8
Headers show

Comments

Katsunori FUJIWARA - Sept. 7, 2013, 6:22 p.m.
# HG changeset patch
# User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
# Date 1378572147 -32400
#      Sun Sep 08 01:42:27 2013 +0900
# Node ID 8d7850556f3a4e473b117f8e80c40f9fba6241ae
# Parent  13017746a8ec1cce88260292178fe50a77cd0aa0
demandimport: allow extensions to import own modules by absolute name

Before this patch, python modules of each extensions can't import
another one in own extension by absolute name, because root modules of
each extensions are loaded with "hgext_" prefix.

For example, "import extroot.bar" in "extroot/foo.py" of "extroot"
extension fails, even though "import bar" in it succeeds.

Installing extensions into site-packages of python library path can
avoid this problem, but this solution is not reasonable in some cases:
using binary package of Mercurial on Windows, for example.

This patch retries to import with "hgext_" prefix after ImportError,
if the module in the extension may try to import another one in own
extension.

This patch doesn't change some "_import()"/"_origimport()" invocations
below, because ordinary extensions shouldn't cause such invocations.

    - invocation of "_import()" when root module imports sub-module by
      absolute path without "fromlist"

      for example, "import a.b" in "a.__init__.py".

      extensions can't import in this way without explicit "hgext_"
      prefix, because they are loaded with such prefix.

    - invocation of "_origimport()" when "level != -1" with "fromlist"

      for example, importing after "from __future__ import
      absolute_import" (level == 0), or "from . import b" or "from .a
      import b" (0 < level),

      for portability between python versions and environments,
      extensions shouldn't cause "level != -1".

Patch

diff --git a/mercurial/demandimport.py b/mercurial/demandimport.py
--- a/mercurial/demandimport.py
+++ b/mercurial/demandimport.py
@@ -38,6 +38,21 @@ 
 else:
     _import = _origimport
 
+def _hgextimport(importfunc, name, globals, *args):
+    try:
+        return importfunc(name, globals, *args)
+    except ImportError:
+        if not globals:
+            raise
+        # extensions are loaded with "hgext_" prefix
+        hgextname = 'hgext_%s' % name
+        nameroot = hgextname.split('.', 1)[0]
+        contextroot = globals.get('__name__', '').split('.', 1)[0]
+        if nameroot != contextroot:
+            raise
+        # retry to import with "hgext_" prefix
+        return importfunc(hgextname, globals, *args)
+
 class _demandmod(object):
     """module demand-loader and proxy"""
     def __init__(self, name, globals, locals, level=-1):
@@ -56,7 +71,7 @@ 
     def _load(self):
         if not self._module:
             head, globals, locals, after, level = self._data
-            mod = _import(head, globals, locals, None, level)
+            mod = _hgextimport(_import, head, globals, locals, None, level)
             # load submodules
             def subload(mod, p):
                 h, t = p, None
@@ -93,7 +108,7 @@ 
 def _demandimport(name, globals=None, locals=None, fromlist=None, level=-1):
     if not locals or name in ignore or fromlist == ('*',):
         # these cases we can't really delay
-        return _import(name, globals, locals, fromlist, level)
+        return _hgextimport(_import, name, globals, locals, fromlist, level)
     elif not fromlist:
         # import a [as b]
         if '.' in name: # a.b
@@ -112,7 +127,7 @@ 
             # from . import b,c,d or from .a import b,c,d
             return _origimport(name, globals, locals, fromlist, level)
         # from a import b,c,d
-        mod = _origimport(name, globals, locals)
+        mod = _hgextimport(_origimport, name, globals, locals)
         # recurse down the module chain
         for comp in name.split('.')[1:]:
             if getattr(mod, comp, nothing) is nothing:
diff --git a/tests/test-extension.t b/tests/test-extension.t
--- a/tests/test-extension.t
+++ b/tests/test-extension.t
@@ -159,6 +159,73 @@ 
   c24b9ac61126
 #endif
 
+Check absolute/relative import of extension specific modules
+
+  $ mkdir $TESTTMP/extroot
+  $ cat > $TESTTMP/extroot/__init__.py <<EOF
+  > extrootstr = 'this is extroot.extrootstr'
+  > import foo
+  > def extsetup(ui):
+  >     ui.write('(extroot) ', foo.func(), '\n')
+  > EOF
+  $ cat > $TESTTMP/extroot/foo.py <<EOF
+  > buf = []
+  > def func():
+  >     # "not locals" case
+  >     import bar         # relative
+  >     buf.append('import bar in func(): %s' % bar.barstr)
+  >     import extroot.bar # absolute
+  >     buf.append('import extroot.bar in func(): %s' % extroot.bar.barstr)
+  > 
+  >     return '\n(extroot) '.join(buf)
+  > 
+  > # "fromlist == ('*',)" case
+  > from bar import *         # relative
+  > buf.append('from bar import *: %s' % barstr)
+  > from extroot.bar import * # absolute
+  > buf.append('from extroot.bar import *: %s' % barstr)
+  > 
+  > # "not fromlist" and "if '.' in name" case
+  > import sub1.baz         # relative
+  > buf.append('import sub1.baz: %s' % sub1.baz.bazstr)
+  > import extroot.sub1.baz # absolute
+  > buf.append('import extroot.sub1.baz: %s' % extroot.sub1.baz.bazstr)
+  > 
+  > # "not fromlist" and NOT "if '.' in name" case
+  > import sub1    # relative
+  > buf.append('import sub1: %s' % sub1.sub1str)
+  > import extroot # absolute
+  > buf.append('import extroot: %s' % extroot.extrootstr)
+  > 
+  > # NOT "not fromlist" and NOT "level != -1" case
+  > from bar import barstr         # relative
+  > buf.append('from bar import barstr: %s' % barstr)
+  > from extroot.bar import barstr # absolute
+  > buf.append('from extroot.bar import barstr: %s' % barstr)
+  > EOF
+  $ cat > $TESTTMP/extroot/bar.py <<EOF
+  > barstr = 'this is extroot.bar.barstr'
+  > EOF
+  $ mkdir $TESTTMP/extroot/sub1
+  $ cat > $TESTTMP/extroot/sub1/__init__.py <<EOF
+  > sub1str = 'this is extroot.sub1.sub1str'
+  > EOF
+  $ cat > $TESTTMP/extroot/sub1/baz.py <<EOF
+  > bazstr = 'this is extroot.sub1.baz.bazstr'
+  > EOF
+  $ hg --config extensions.extroot=$TESTTMP/extroot id --id
+  (extroot) from bar import *: this is extroot.bar.barstr
+  (extroot) from extroot.bar import *: this is extroot.bar.barstr
+  (extroot) import sub1.baz: this is extroot.sub1.baz.bazstr
+  (extroot) import extroot.sub1.baz: this is extroot.sub1.baz.bazstr
+  (extroot) import sub1: this is extroot.sub1.sub1str
+  (extroot) import extroot: this is extroot.extrootstr
+  (extroot) from bar import barstr: this is extroot.bar.barstr
+  (extroot) from extroot.bar import barstr: this is extroot.bar.barstr
+  (extroot) import bar in func(): this is extroot.bar.barstr
+  (extroot) import extroot.bar in func(): this is extroot.bar.barstr
+  c24b9ac61126
+
   $ cd ..
 
 hide outer repo