1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
|
import types
import sys
import py
import py._apipkg as apipkg
import subprocess
import types
ModuleType = types.ModuleType
#
# test support for importing modules
#
class TestRealModule:
def setup_class(cls):
cls.tmpdir = py.test.ensuretemp('test_apipkg')
sys.path = [str(cls.tmpdir)] + sys.path
pkgdir = cls.tmpdir.ensure('realtest', dir=1)
tfile = pkgdir.join('__init__.py')
tfile.write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, {
'x': {
'module': {
'__doc__': '_xyz.testmodule:__doc__',
'mytest0': '_xyz.testmodule:mytest0',
'mytest1': '_xyz.testmodule:mytest1',
'MyTest': '_xyz.testmodule:MyTest',
}
}
}
)
"""))
ipkgdir = cls.tmpdir.ensure("_xyz", dir=1)
tfile = ipkgdir.join('testmodule.py')
ipkgdir.ensure("__init__.py")
tfile.write(py.code.Source("""
'test module'
from _xyz.othermodule import MyTest
#__all__ = ['mytest0', 'mytest1', 'MyTest']
def mytest0():
pass
def mytest1():
pass
"""))
ipkgdir.join("othermodule.py").write("class MyTest: pass")
def setup_method(self, *args):
# Unload the test modules before each test.
module_names = ['realtest', 'realtest.x', 'realtest.x.module']
for modname in module_names:
if modname in sys.modules:
del sys.modules[modname]
def test_realmodule(self):
import realtest.x
assert 'realtest.x.module' in sys.modules
assert getattr(realtest.x.module, 'mytest0')
def test_realmodule_repr(self):
import realtest.x
assert "<ApiModule 'realtest.x'>" == repr(realtest.x)
def test_realmodule_from(self):
from realtest.x import module
assert getattr(module, 'mytest1')
def test_realmodule__all__(self):
import realtest.x.module
assert realtest.x.__all__ == ['module']
assert len(realtest.x.module.__all__) == 4
def test_realmodule_dict_import(self):
"Test verifying that accessing the __dict__ invokes the import"
import realtest.x.module
moddict = realtest.x.module.__dict__
assert 'mytest0' in moddict
assert 'mytest1' in moddict
assert 'MyTest' in moddict
def test_realmodule___doc__(self):
"""test whether the __doc__ attribute is set properly from initpkg"""
import realtest.x.module
print (realtest.x.module.__map__)
assert realtest.x.module.__doc__ == 'test module'
class TestScenarios:
def test_relative_import(self, monkeypatch, tmpdir):
pkgdir = tmpdir.mkdir("mymodule")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'__doc__': '.submod:maindoc',
'x': '.submod:x',
'y': {
'z': '.submod:x'
},
})
"""))
pkgdir.join('submod.py').write("x=3\nmaindoc='hello'")
monkeypatch.syspath_prepend(tmpdir)
import mymodule
assert isinstance(mymodule, apipkg.ApiModule)
assert mymodule.x == 3
assert mymodule.__doc__ == 'hello'
assert mymodule.y.z == 3
def test_recursive_import(self, monkeypatch, tmpdir):
pkgdir = tmpdir.mkdir("recmodule")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'some': '.submod:someclass',
})
"""))
pkgdir.join('submod.py').write(py.code.Source("""
import recmodule
class someclass: pass
print (recmodule.__dict__)
"""))
monkeypatch.syspath_prepend(tmpdir)
import recmodule
assert isinstance(recmodule, apipkg.ApiModule)
assert recmodule.some.__name__ == "someclass"
def test_module_alias_import(self, monkeypatch, tmpdir):
pkgdir = tmpdir.mkdir("aliasimport")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'some': 'os.path',
})
"""))
monkeypatch.syspath_prepend(tmpdir)
import aliasimport
for k, v in py.std.os.path.__dict__.items():
assert getattr(aliasimport.some, k) == v
def test_from_module_alias_import(self, monkeypatch, tmpdir):
pkgdir = tmpdir.mkdir("fromaliasimport")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'some': 'os.path',
})
"""))
monkeypatch.syspath_prepend(tmpdir)
from fromaliasimport.some import join
assert join is py.std.os.path.join
def xtest_nested_absolute_imports():
import email
api_email = apipkg.ApiModule('email',{
'message2': {
'Message': 'email.message:Message',
},
})
# nesting is supposed to put nested items into sys.modules
assert 'email.message2' in sys.modules
# alternate ideas for specifying package + preliminary code
#
def test_parsenamespace():
spec = """
path.local __.path.local::LocalPath
path.svnwc __.path.svnwc::WCCommandPath
test.raises __.test.outcome::raises
"""
d = parsenamespace(spec)
print (d)
assert d == {'test': {'raises': '__.test.outcome::raises'},
'path': {'svnwc': '__.path.svnwc::WCCommandPath',
'local': '__.path.local::LocalPath'}
}
def xtest_parsenamespace_errors():
py.test.raises(ValueError, """
parsenamespace('path.local xyz')
""")
py.test.raises(ValueError, """
parsenamespace('x y z')
""")
def parsenamespace(spec):
ns = {}
for line in spec.split("\n"):
line = line.strip()
if not line or line[0] == "#":
continue
parts = [x.strip() for x in line.split()]
if len(parts) != 2:
raise ValueError("Wrong format: %r" %(line,))
apiname, spec = parts
if not spec.startswith("__"):
raise ValueError("%r does not start with __" %(spec,))
apinames = apiname.split(".")
cur = ns
for name in apinames[:-1]:
cur.setdefault(name, {})
cur = cur[name]
cur[apinames[-1]] = spec
return ns
def test_initpkg_replaces_sysmodules(monkeypatch):
mod = ModuleType('hello')
monkeypatch.setitem(sys.modules, 'hello', mod)
apipkg.initpkg('hello', {'x': 'os.path:abspath'})
newmod = sys.modules['hello']
assert newmod != mod
assert newmod.x == py.std.os.path.abspath
def test_initpkg_transfers_attrs(monkeypatch):
mod = ModuleType('hello')
mod.__version__ = 10
mod.__file__ = "hello.py"
mod.__loader__ = "loader"
mod.__doc__ = "this is the documentation"
monkeypatch.setitem(sys.modules, 'hello', mod)
apipkg.initpkg('hello', {})
newmod = sys.modules['hello']
assert newmod != mod
assert newmod.__file__ == py.path.local(mod.__file__)
assert newmod.__version__ == mod.__version__
assert newmod.__loader__ == mod.__loader__
assert newmod.__doc__ == mod.__doc__
def test_initpkg_nodoc(monkeypatch):
mod = ModuleType('hello')
mod.__file__ = "hello.py"
monkeypatch.setitem(sys.modules, 'hello', mod)
apipkg.initpkg('hello', {})
newmod = sys.modules['hello']
assert not newmod.__doc__
def test_initpkg_overwrite_doc(monkeypatch):
hello = ModuleType('hello')
hello.__doc__ = "this is the documentation"
monkeypatch.setitem(sys.modules, 'hello', hello)
apipkg.initpkg('hello', {"__doc__": "sys:__doc__"})
newhello = sys.modules['hello']
assert newhello != hello
assert newhello.__doc__ == sys.__doc__
def test_initpkg_not_transfers_not_existing_attrs(monkeypatch):
mod = ModuleType('hello')
mod.__file__ = "hello.py"
monkeypatch.setitem(sys.modules, 'hello', mod)
apipkg.initpkg('hello', {})
newmod = sys.modules['hello']
assert newmod != mod
assert newmod.__file__ == py.path.local(mod.__file__)
assert not hasattr(newmod, '__loader__')
assert not hasattr(newmod, '__path__')
def test_initpkg_defaults(monkeypatch):
mod = ModuleType('hello')
monkeypatch.setitem(sys.modules, 'hello', mod)
apipkg.initpkg('hello', {})
newmod = sys.modules['hello']
assert newmod.__file__ == None
assert not hasattr(newmod, '__version__')
def test_name_attribute():
api = apipkg.ApiModule('name_test', {
'subpkg': {},
})
assert api.__name__ == 'name_test'
assert api.subpkg.__name__ == 'name_test.subpkg'
def test_error_loading_one_element(monkeypatch, tmpdir):
pkgdir = tmpdir.mkdir("errorloading1")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'x': '.notexists:x',
'y': '.submod:y'
},
)
"""))
pkgdir.join('submod.py').write("y=0")
monkeypatch.syspath_prepend(tmpdir)
import errorloading1
assert isinstance(errorloading1, apipkg.ApiModule)
assert errorloading1.y == 0
py.test.raises(ImportError, 'errorloading1.x')
py.test.raises(ImportError, 'errorloading1.x')
def test_onfirstaccess(tmpdir, monkeypatch):
pkgdir = tmpdir.mkdir("firstaccess")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'__onfirstaccess__': '.submod:init',
'l': '.submod:l',
},
)
"""))
pkgdir.join('submod.py').write(py.code.Source("""
l = []
def init():
l.append(1)
"""))
monkeypatch.syspath_prepend(tmpdir)
import firstaccess
assert isinstance(firstaccess, apipkg.ApiModule)
assert len(firstaccess.l) == 1
assert len(firstaccess.l) == 1
assert '__onfirstaccess__' not in firstaccess.__all__
@py.test.mark.multi(mode=['attr', 'dict', 'onfirst'])
def test_onfirstaccess_setsnewattr(tmpdir, monkeypatch, mode):
pkgname = tmpdir.basename.replace("-", "")
pkgdir = tmpdir.mkdir(pkgname)
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, exportdefs={
'__onfirstaccess__': '.submod:init',
},
)
"""))
pkgdir.join('submod.py').write(py.code.Source("""
def init():
import %s as pkg
pkg.newattr = 42
""" % pkgname))
monkeypatch.syspath_prepend(tmpdir)
mod = __import__(pkgname)
assert isinstance(mod, apipkg.ApiModule)
if mode == 'attr':
assert mod.newattr == 42
elif mode == "dict":
print (list(mod.__dict__.keys()))
assert 'newattr' in mod.__dict__
elif mode == "onfirst":
assert not hasattr(mod, '__onfirstaccess__')
assert not hasattr(mod, '__onfirstaccess__')
assert '__onfirstaccess__' not in vars(mod)
def test_bpython_getattr_override(tmpdir, monkeypatch):
def patchgetattr(self, name):
raise AttributeError(name)
monkeypatch.setattr(apipkg.ApiModule, '__getattr__', patchgetattr)
api = apipkg.ApiModule('bpy', {
'abspath': 'os.path:abspath',
})
d = api.__dict__
assert 'abspath' in d
def test_chdir_with_relative_imports_shouldnt_break_lazy_loading(tmpdir):
tmpdir.join('apipkg.py').write(py.code.Source(apipkg))
pkg = tmpdir.mkdir('pkg')
messy = tmpdir.mkdir('messy')
pkg.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, {
'test': '.sub:test',
})
"""))
pkg.join('sub.py').write('def test(): pass')
tmpdir.join('main.py').write(py.code.Source("""
import os
import sys
sys.path.insert(0, '')
import pkg
import py
print(py.__file__)
py.builtin.print_(pkg.__path__, file=sys.stderr)
py.builtin.print_(pkg.__file__, file=sys.stderr)
py.builtin.print_(pkg, file=sys.stderr)
os.chdir('messy')
pkg.test()
assert os.path.isabs(pkg.sub.__file__), pkg.sub.__file__
"""))
res = subprocess.call(
[py.std.sys.executable, 'main.py'],
cwd=str(tmpdir),
)
assert res == 0
def test_dotted_name_lookup(tmpdir, monkeypatch):
pkgdir = tmpdir.mkdir("dotted_name_lookup")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, dict(abs='os:path.abspath'))
"""))
monkeypatch.syspath_prepend(tmpdir)
import dotted_name_lookup
assert dotted_name_lookup.abs == py.std.os.path.abspath
def test_extra_attributes(tmpdir, monkeypatch):
pkgdir = tmpdir.mkdir("extra_attributes")
pkgdir.join('__init__.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, dict(abs='os:path.abspath'), dict(foo='bar'))
"""))
monkeypatch.syspath_prepend(tmpdir)
import extra_attributes
assert extra_attributes.foo == 'bar'
def test_aliasmodule_repr():
am = apipkg.AliasModule("mymod", "sys")
r = repr(am)
assert "<AliasModule 'mymod' for 'sys'>" == r
am.version
assert repr(am) == r
def test_aliasmodule_proxy_methods(tmpdir, monkeypatch):
pkgdir = tmpdir
pkgdir.join('aliasmodule_proxy.py').write(py.code.Source("""
def doit():
return 42
"""))
pkgdir.join('my_aliasmodule_proxy.py').write(py.code.Source("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, dict(proxy='aliasmodule_proxy'))
def doit():
return 42
"""))
monkeypatch.syspath_prepend(tmpdir)
import aliasmodule_proxy as orig
from my_aliasmodule_proxy import proxy
doit = proxy.doit
assert doit is orig.doit
del proxy.doit
py.test.raises(AttributeError, "orig.doit")
proxy.doit = doit
assert orig.doit is doit
def test_aliasmodule_nested_import_with_from(tmpdir, monkeypatch):
import os
pkgdir = tmpdir.mkdir("api1")
pkgdir.ensure("__init__.py").write(py.std.textwrap.dedent("""
import py._apipkg as apipkg
apipkg.initpkg(__name__, {
'os2': 'api2',
'os2.path': 'api2.path2',
})
"""))
tmpdir.join("api2.py").write(py.std.textwrap.dedent("""
import os, sys
from os import path
sys.modules['api2.path2'] = path
x = 3
"""))
monkeypatch.syspath_prepend(tmpdir)
from api1 import os2
from api1.os2.path import abspath
assert abspath == os.path.abspath
# check that api1.os2 mirrors os.*
assert os2.x == 3
import api1
assert 'os2.path' not in api1.__dict__
def test_initpkg_without_old_module():
apipkg.initpkg("initpkg_without_old_module",
dict(modules="sys:modules"))
from initpkg_without_old_module import modules
assert modules is sys.modules
|