Skip to content
Snippets Groups Projects
Commit 1c11f393ed40 authored by Laurent Peuch's avatar Laurent Peuch
Browse files

refactor(modutils)!: remove all unused code by our main core projects 

modutils code is very old and hard to evolved and maintained and it also
depends of both imp and pkg_resources which are deprecated old modules that
will be removed in the future from the core python libraby.

So starting by removing everything that is not needed is a first step to get
ride of those problems.

This cleanup is based on this analysis:

List of used symbols
--------------------
* LazyObject
* load_module_from_name
* clean_sys_modules
* cleanup_sys_modules
* load_module_from_file
* modpath_from_file

Internal symbols needed by the used symbols
-------------------------------------------
LazyObject
    load_module_from_name
        load_module_from_modpath
            find_module[imp]
            load_module[imp]
            _is_namespace <- pkg_resources

load_module_from_file
    modpath_from_file (deprecated)
        _canonicalize_path
        _check_init

    load_module_from_modpath
        find_module[imp]
        load_module[imp]
        _is_namespace <- pkg_resources
parent eb74d94f728c
No related branches found
Tags 0.2.4
1 merge request!76refactor(modutils)!: remove all unused code by our main core projects
Expand all Hide whitespace changes
Inline Side-by-side
logilab/common/modutils.py
+ 20
− 487
View file @ 1c11f393
This diff is collapsed.
test/test_modutils.py
+ 1
− 212
View file @ 1c11f393
...@@ -31,5 +31,5 @@ ...@@ -31,5 +31,5 @@
from logilab.common.testlib import TestCase, unittest_main from logilab.common.testlib import TestCase, unittest_main
from logilab.common import modutils from logilab.common import modutils
from os import path, getcwd, sep from os import path, getcwd
from logilab import common from logilab import common
...@@ -35,5 +35,4 @@ ...@@ -35,5 +35,4 @@
from logilab import common from logilab import common
from logilab.common import tree
warnings.simplefilter("default", DeprecationWarning) warnings.simplefilter("default", DeprecationWarning)
sys.path.insert(0, path.dirname(__file__)) sys.path.insert(0, path.dirname(__file__))
...@@ -53,32 +52,6 @@ ...@@ -53,32 +52,6 @@
super().tearDown() super().tearDown()
class ModuleFileTC(ModutilsTestCase):
package = "mypypa"
def setUp(self):
super().setUp()
for k in list(sys.path_importer_cache.keys()):
if "MyPyPa" in k:
del sys.path_importer_cache[k]
def test_find_zipped_module(self):
mtype, mfile = modutils._module_file(
[self.package], [path.join(DATADIR, "MyPyPa-0.1.0.zip")]
)
self.assertEqual(mtype, modutils.ZIPFILE)
self.assertEqual(mfile.split(sep)[-4:], ["test", "data", "MyPyPa-0.1.0.zip", self.package])
def test_find_egg_module(self):
mtype, mfile = modutils._module_file(
[self.package], [path.join(DATADIR, "MyPyPa-0.1.0-py2.5.egg")]
)
self.assertEqual(mtype, modutils.ZIPFILE)
self.assertEqual(
mfile.split(sep)[-4:], ["test", "data", "MyPyPa-0.1.0-py2.5.egg", self.package]
)
class load_module_from_name_tc(ModutilsTestCase): class load_module_from_name_tc(ModutilsTestCase):
"""load a python module from it's name""" """load a python module from it's name"""
...@@ -92,40 +65,6 @@ ...@@ -92,40 +65,6 @@
self.assertRaises(ImportError, modutils.load_module_from_name, "os.path", use_sys=0) self.assertRaises(ImportError, modutils.load_module_from_name, "os.path", use_sys=0)
class get_module_part_tc(ModutilsTestCase):
"""given a dotted name return the module part of the name"""
def test_knownValues_get_module_part_1(self):
self.assertEqual(
modutils.get_module_part("logilab.common.modutils"), "logilab.common.modutils"
)
def test_knownValues_get_module_part_2(self):
self.assertEqual(
modutils.get_module_part("logilab.common.modutils.get_module_part"),
"logilab.common.modutils",
)
def test_knownValues_get_module_part_3(self):
"""relative import from given file"""
self.assertEqual(
modutils.get_module_part("interface.Interface", modutils.__file__), "interface"
)
def test_knownValues_get_compiled_module_part(self):
self.assertEqual(modutils.get_module_part("math.log10"), "math")
self.assertEqual(modutils.get_module_part("math.log10", __file__), "math")
def test_knownValues_get_builtin_module_part(self):
self.assertEqual(modutils.get_module_part("sys.path"), "sys")
self.assertEqual(modutils.get_module_part("sys.path", "__file__"), "sys")
def test_get_module_part_exception(self):
self.assertRaises(
ImportError, modutils.get_module_part, "unknown.module", modutils.__file__
)
class modpath_from_file_tc(ModutilsTestCase): class modpath_from_file_tc(ModutilsTestCase):
"""given an absolute file path return the python module's path as a list""" """given an absolute file path return the python module's path as a list"""
...@@ -159,131 +98,4 @@ ...@@ -159,131 +98,4 @@
del sys.just_once del sys.just_once
class file_from_modpath_tc(ModutilsTestCase):
"""given a mod path (i.e. splited module / package name), return the
corresponding file, giving priority to source file over precompiled file
if it exists"""
def test_site_packages(self):
from pytz import tzinfo
self.assertEqual(
path.realpath(modutils.file_from_modpath(["pytz", "tzinfo"])),
path.realpath(tzinfo.__file__.replace(".pyc", ".py")),
)
def test_std_lib(self):
from os import path
self.assertEqual(
path.realpath(modutils.file_from_modpath(["os", "path"]).replace(".pyc", ".py")),
path.realpath(path.__file__.replace(".pyc", ".py")),
)
def test_xmlplus(self):
try:
# don't fail if pyxml isn't installed
from xml.dom import ext
except ImportError:
pass
else:
self.assertEqual(
path.realpath(
modutils.file_from_modpath(["xml", "dom", "ext"]).replace(".pyc", ".py")
),
path.realpath(ext.__file__.replace(".pyc", ".py")),
)
def test_builtin(self):
self.assertEqual(modutils.file_from_modpath(["sys"]), None)
def test_unexisting(self):
self.assertRaises(ImportError, modutils.file_from_modpath, ["turlututu"])
class get_source_file_tc(ModutilsTestCase):
def test(self):
from os import path
self.assertEqual(
modutils.get_source_file(path.__file__), path.__file__.replace(".pyc", ".py")
)
def test_raise(self):
self.assertRaises(modutils.NoSourceFile, modutils.get_source_file, "whatever")
class is_standard_module_tc(ModutilsTestCase):
"""
return true if the module may be considered as a module from the standard
library
"""
def test_builtins(self):
self.assertEqual(modutils.is_standard_module("__builtin__"), False)
self.assertEqual(modutils.is_standard_module("builtins"), True)
def test_builtin(self):
self.assertEqual(modutils.is_standard_module("sys"), True)
def test_nonstandard(self):
self.assertEqual(modutils.is_standard_module("logilab"), False)
def test_unknown(self):
self.assertEqual(modutils.is_standard_module("unknown"), False)
def test_4(self):
self.assertEqual(modutils.is_standard_module("marshal"), True)
self.assertEqual(modutils.is_standard_module("pickle"), True)
self.assertEqual(modutils.is_standard_module("email"), True)
self.assertEqual(modutils.is_standard_module("StringIO"), sys.version_info < (3, 0))
venv_py3 = sys.version_info[0] >= 3 and hasattr(sys, "real_prefix")
if not venv_py3:
# those modules are symlinked by virtualenv (but not by python's venv)
self.assertEqual(modutils.is_standard_module("hashlib"), True)
self.assertEqual(modutils.is_standard_module("io"), True)
def test_custom_path(self):
self.assertEqual(modutils.is_standard_module("data.module", (DATADIR,)), True)
self.assertEqual(modutils.is_standard_module("data.module", (path.abspath(DATADIR),)), True)
def test_failing_border_cases(self):
# using a subpackage/submodule path as std_path argument
self.assertEqual(modutils.is_standard_module("logilab.common", common.__path__), False)
# using a module + object name as modname argument
self.assertEqual(modutils.is_standard_module("sys.path"), True)
# this is because only the first package/module is considered
self.assertEqual(modutils.is_standard_module("sys.whatever"), True)
self.assertEqual(modutils.is_standard_module("logilab.whatever", common.__path__), False)
class is_relative_tc(ModutilsTestCase):
def test_knownValues_is_relative_1(self):
self.assertEqual(modutils.is_relative("modutils", common.__path__[0]), True)
def test_knownValues_is_relative_2(self):
self.assertEqual(modutils.is_relative("modutils", tree.__file__), True)
def test_knownValues_is_relative_3(self):
self.assertEqual(modutils.is_relative("logilab.common.modutils", common.__path__[0]), False)
class get_modules_tc(ModutilsTestCase):
def test_knownValues_get_modules_1(self): # XXXFIXME: TOWRITE
"""given a directory return a list of all available python modules, even
in subdirectories
"""
import data.find_test as data
mod_path = ("data", "find_test")
modules = sorted(modutils.get_modules(path.join(*mod_path), data.__path__[0]))
self.assertSetEqual(
set(modules),
{
".".join(mod_path + (mod,))
for mod in ("module", "module2", "noendingnewline", "nonregr")
},
)
class get_modules_files_tc(ModutilsTestCase): class get_modules_files_tc(ModutilsTestCase):
...@@ -289,27 +101,4 @@ ...@@ -289,27 +101,4 @@
class get_modules_files_tc(ModutilsTestCase): class get_modules_files_tc(ModutilsTestCase):
def test_knownValues_get_module_files_1(self): # XXXFIXME: TOWRITE
"""given a directory return a list of all available python module's files, even
in subdirectories
"""
import data
modules = sorted(
modutils.get_module_files(path.join(DATADIR, "find_test"), data.__path__[0])
)
self.assertEqual(
modules,
[
path.join(DATADIR, "find_test", x)
for x in [
"__init__.py",
"module.py",
"module2.py",
"noendingnewline.py",
"nonregr.py",
]
],
)
def test_load_module_set_attribute(self): def test_load_module_set_attribute(self):
import logilab.common.fileutils import logilab.common.fileutils
import logilab import logilab
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment