Rely on backports.entry_points_selectable for forward compatibility with importlib.metadata.

This commit is contained in:
Jason R. Coombs 2021-03-30 17:17:58 -04:00
parent 1d5dd156ab
commit 3d253e07f3
4 changed files with 23 additions and 25 deletions

View file

@ -48,7 +48,8 @@ install_requires=
typing; python_version<"3.5" typing; python_version<"3.5"
configparser; python_version<"3.2" configparser; python_version<"3.2"
functools32; python_version<"3.2" functools32; python_version<"3.2"
importlib-metadata; python_version<"3.8" importlib_metadata; python_version<"3.8"
backports.entry_points_selectable >= 1.0.2
python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.* python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*

View file

@ -2,6 +2,8 @@
import logging import logging
from typing import Any, Dict, List, Optional, Set from typing import Any, Dict, List, Optional, Set
from backports.entry_points_selectable import entry_points
from flake8 import exceptions from flake8 import exceptions
from flake8 import utils from flake8 import utils
from flake8._compat import importlib_metadata from flake8._compat import importlib_metadata
@ -251,7 +253,7 @@ class PluginManager(object): # pylint: disable=too-few-public-methods
def _load_entrypoint_plugins(self): def _load_entrypoint_plugins(self):
LOG.info('Loading entry-points for "%s".', self.namespace) LOG.info('Loading entry-points for "%s".', self.namespace)
eps = importlib_metadata.entry_points().get(self.namespace, ()) eps = entry_points(group=self.namespace)
# python2.7 occasionally gives duplicate results due to redundant # python2.7 occasionally gives duplicate results due to redundant
# `local/lib` -> `../lib` symlink on linux in virtualenvs so we # `local/lib` -> `../lib` symlink on linux in virtualenvs so we
# eliminate duplicates here # eliminate duplicates here

View file

@ -3,7 +3,6 @@ import mock
import pytest import pytest
from flake8 import checker from flake8 import checker
from flake8._compat import importlib_metadata
from flake8.plugins import manager from flake8.plugins import manager
from flake8.processor import FileProcessor from flake8.processor import FileProcessor
@ -104,9 +103,9 @@ def mock_file_checker_with_plugin(plugin_target):
# Load the checker plugins using the entry point mock # Load the checker plugins using the entry point mock
with mock.patch.object( with mock.patch.object(
importlib_metadata, manager,
'entry_points', 'entry_points',
return_value={'flake8.extension': [entry_point]}, return_value=[entry_point],
): ):
checks = manager.Checkers() checks = manager.Checkers()

View file

@ -5,51 +5,47 @@ from flake8._compat import importlib_metadata
from flake8.plugins import manager from flake8.plugins import manager
@mock.patch.object(importlib_metadata, 'entry_points') @mock.patch.object(manager, 'entry_points')
def test_calls_entrypoints_on_instantiation(entry_points_mck): def test_calls_entrypoints_on_instantiation(entry_points_mck):
"""Verify that we call entry_points() when we create a manager.""" """Verify that we call entry_points() when we create a manager."""
entry_points_mck.return_value = {} entry_points_mck.return_value = []
manager.PluginManager(namespace='testing.entrypoints') manager.PluginManager(namespace='testing.entrypoints')
entry_points_mck.assert_called_once_with() entry_points_mck.assert_called_once_with(group='testing.entrypoints')
@mock.patch.object(importlib_metadata, 'entry_points') @mock.patch.object(manager, 'entry_points')
def test_calls_entrypoints_creates_plugins_automaticaly(entry_points_mck): def test_calls_entrypoints_creates_plugins_automaticaly(entry_points_mck):
"""Verify that we create Plugins on instantiation.""" """Verify that we create Plugins on instantiation."""
entry_points_mck.return_value = { entry_points_mck.return_value = [
'testing.entrypoints': [ importlib_metadata.EntryPoint('T100', '', None),
importlib_metadata.EntryPoint('T100', '', None), importlib_metadata.EntryPoint('T200', '', None),
importlib_metadata.EntryPoint('T200', '', None), ]
],
}
plugin_mgr = manager.PluginManager(namespace='testing.entrypoints') plugin_mgr = manager.PluginManager(namespace='testing.entrypoints')
entry_points_mck.assert_called_once_with() entry_points_mck.assert_called_once_with(group='testing.entrypoints')
assert 'T100' in plugin_mgr.plugins assert 'T100' in plugin_mgr.plugins
assert 'T200' in plugin_mgr.plugins assert 'T200' in plugin_mgr.plugins
assert isinstance(plugin_mgr.plugins['T100'], manager.Plugin) assert isinstance(plugin_mgr.plugins['T100'], manager.Plugin)
assert isinstance(plugin_mgr.plugins['T200'], manager.Plugin) assert isinstance(plugin_mgr.plugins['T200'], manager.Plugin)
@mock.patch.object(importlib_metadata, 'entry_points') @mock.patch.object(manager, 'entry_points')
def test_handles_mapping_functions_across_plugins(entry_points_mck): def test_handles_mapping_functions_across_plugins(entry_points_mck):
"""Verify we can use the PluginManager call functions on all plugins.""" """Verify we can use the PluginManager call functions on all plugins."""
entry_points_mck.return_value = { entry_points_mck.return_value = [
'testing.entrypoints': [ importlib_metadata.EntryPoint('T100', '', None),
importlib_metadata.EntryPoint('T100', '', None), importlib_metadata.EntryPoint('T200', '', None),
importlib_metadata.EntryPoint('T200', '', None), ]
],
}
plugin_mgr = manager.PluginManager(namespace='testing.entrypoints') plugin_mgr = manager.PluginManager(namespace='testing.entrypoints')
plugins = [plugin_mgr.plugins[name] for name in plugin_mgr.names] plugins = [plugin_mgr.plugins[name] for name in plugin_mgr.names]
assert list(plugin_mgr.map(lambda x: x)) == plugins assert list(plugin_mgr.map(lambda x: x)) == plugins
@mock.patch.object(importlib_metadata, 'entry_points') @mock.patch.object(manager, 'entry_points')
def test_local_plugins(entry_points_mck): def test_local_plugins(entry_points_mck):
"""Verify PluginManager can load given local plugins.""" """Verify PluginManager can load given local plugins."""
entry_points_mck.return_value = {} entry_points_mck.return_value = []
plugin_mgr = manager.PluginManager( plugin_mgr = manager.PluginManager(
namespace='testing.entrypoints', namespace='testing.entrypoints',
local_plugins=['X = path.to:Plugin'] local_plugins=['X = path.to:Plugin']