Skip to content

Commit

Permalink
Improve performance by caching find_spec
Browse files Browse the repository at this point in the history
Certain checkers upstream on pylint like import-error heavily use
find_spec. This method is IO intensive as it looks for files
across several search paths to return a ModuleSpec.

Since imports across files may repeat themselves it makes sense to cache
this method in order to speed up the linting process.

Local testing shows that caching reduces the total amount of calls to
find_module methods (used by find_spec) by about 50%. Linting the test
repository in the related issue goes from 40 seconds to 37 seconds. This
was on a NVME disk and after warmup, so timing gains may be bigger on
slower file systems like the one mentioned in the referenced issue.

Closes pylint-dev/pylint#9310.
  • Loading branch information
crazybolillo committed Apr 5, 2024
1 parent 7a3b482 commit 4ccb9c4
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
14 changes: 14 additions & 0 deletions astroid/interpreter/_import/spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

from . import util

modpath_cache = {}


# The MetaPathFinder protocol comes from typeshed, which says:
# Intentionally omits one deprecated and one optional method of `importlib.abc.MetaPathFinder`
Expand Down Expand Up @@ -423,6 +425,18 @@ def _find_spec_with_path(
raise ImportError(f"No module named {'.'.join(module_parts)}")


def cache_modpath(func):
def wrapper(*args):
key = ".".join(args[0])
if key not in modpath_cache:
modpath_cache[key] = func(*args)

return modpath_cache[key]

return wrapper


@cache_modpath
def find_spec(modpath: list[str], path: Sequence[str] | None = None) -> ModuleSpec:
"""Find a spec for the given module.
Expand Down
1 change: 1 addition & 0 deletions tests/test_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class AstroidManagerTest(
):
def setUp(self) -> None:
super().setUp()
astroid.interpreter._import.spec.modpath_cache.clear()
self.manager = test_utils.brainless_manager()

def test_ast_from_file(self) -> None:
Expand Down
1 change: 1 addition & 0 deletions tests/test_modutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class ModuleFileTest(unittest.TestCase):
package = "mypypa"

def tearDown(self) -> None:
astroid.interpreter._import.spec.modpath_cache.clear()
for k in list(sys.path_importer_cache):
if "MyPyPa" in k:
del sys.path_importer_cache[k]
Expand Down

0 comments on commit 4ccb9c4

Please sign in to comment.