Commit 48d6deba authored by Jérome Perrin's avatar Jérome Perrin

patchs/pylint: update for python3 support

this works with astroid 3.2.0 and pylint 3.2.0
parent aca9c72d
......@@ -159,14 +159,13 @@ class ComponentTool(BaseTool):
erp5.component.filesystem_import_dict = None
erp5.component.ref_manager.gc()
# Clear pylint cache
try:
# Clear astroid (pylint) cache
if six.PY2:
from astroid.builder import MANAGER
except ImportError:
pass
else:
from astroid.astroid_manager import MANAGER
astroid_cache = MANAGER.astroid_cache
for k in astroid_cache.keys():
for k in list(astroid_cache.keys()):
if k.startswith('erp5.component.') and k not in component_package_list:
del astroid_cache[k]
......
......@@ -419,15 +419,11 @@ def fill_args_from_request(*optional_args):
return decorator
_pylint_message_re = re.compile(
'^(?P<type>[CRWEF]):\s*(?P<row>\d+),\s*(?P<column>\d+):\s*(?P<message>.*)$')
r'^(?P<type>[CRWEF]):\s*(?P<row>\d+),\s*(?P<column>\d+):\s*(?P<message>.*)$')
def checkPythonSourceCode(source_code_str, portal_type=None):
"""
Check source code with pylint or compile() builtin if not available.
TODO-arnau: Get rid of NamedTemporaryFile (require a patch on pylint to
allow passing a string) and this should probably return a proper
ERP5 object rather than a dict...
"""
if not source_code_str:
return []
......@@ -462,8 +458,11 @@ def checkPythonSourceCode(source_code_str, portal_type=None):
message_list = []
output_file = StringIO()
try:
with tempfile.NamedTemporaryFile(prefix='checkPythonSourceCode',
suffix='.py') as input_file:
with tempfile.NamedTemporaryFile(
prefix='checkPythonSourceCode',
suffix='.py',
mode='w',
) as input_file:
input_file.write(source_code_str)
input_file.flush()
......@@ -493,6 +492,8 @@ def checkPythonSourceCode(source_code_str, portal_type=None):
# TODO-arnau: Enable it properly would require inspection API
# '%s %r has no %r member'
'--disable=E1101,E1103',
# XXX duplicate-bases causes too many false positives
'--disable=duplicate-bases',
# map and filter should not be considered bad as in some cases
# map is faster than its recommended replacement (list
# comprehension)
......@@ -508,7 +509,26 @@ def checkPythonSourceCode(source_code_str, portal_type=None):
# unused variables
'--dummy-variables-rgx=_$|dummy|__traceback_info__|__traceback_supplement__',
]
if six.PY3:
args.extend(
(
"--msg-template='{C}: {line},{column}: {msg} ({symbol})'",
'--load-plugins=pylint.extensions.bad_builtin',
# BBB until we drop compatibility with PY2
'--disable=redundant-u-string-prefix,raise-missing-from,keyword-arg-before-vararg',
# XXX acceptable to ignore in the context of ERP5
'--disable=unspecified-encoding',
# XXX to many errors for now
'--disable=arguments-differ,arguments-renamed',
'--disable=duplicate-bases,inconsistent-mro',
)
)
else:
args.extend(
(
'--load-plugins=Products.ERP5Type.patches.pylint_compatibility_disable',
)
)
if portal_type == 'Interface Component':
# __init__ method from base class %r is not called
args.append('--disable=W0231')
......@@ -521,19 +541,18 @@ def checkPythonSourceCode(source_code_str, portal_type=None):
# Method should have "self" as first argument (no-self-argument)
args.append('--disable=E0213')
try:
from pylint.extensions.bad_builtin import __name__ as ext
args.append('--load-plugins=' + ext)
except ImportError:
pass
try:
# Note that we don't run pylint as a subprocess, but directly from
# ERP5 process, so that pylint can access the code from ERP5Type
# dynamic modules from ZODB.
Run(args, reporter=TextReporter(output_file), exit=False)
finally:
if six.PY2:
from astroid.builder import MANAGER
MANAGER.astroid_cache.pop(
else:
from astroid.astroid_manager import MANAGER
astroid_cache = MANAGER.astroid_cache
astroid_cache.pop(
os.path.splitext(os.path.basename(input_file.name))[0],
None)
......
......@@ -39,8 +39,7 @@ if getZopeVersion()[0] == 2: # BBB Zope2
else:
IS_ZOPE2 = False
import six
if six.PY2:
from .patches import pylint
from .patches import pylint
from zLOG import LOG, INFO
DISPLAY_BOOT_PROCESS = False
......
......@@ -19,9 +19,11 @@
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
from __future__ import absolute_import
import importlib
import six
import sys
import types
import warnings
import six
from Products.ERP5Type import IS_ZOPE2
# TODO: make sure that trying to use it does not import isort, because the
......@@ -32,21 +34,21 @@ sys.modules.setdefault('isort', None)
## All arguments are passed as arguments and this needlessly outputs a 'No
## config file found, using default configuration' message on stderr.
try:
if six.PY2:
from logilab.common.configuration import OptionsManagerMixIn
except ImportError:
# pylint 2.x (python3)
from pylint.config import OptionsManagerMixIn
OptionsManagerMixIn.read_config_file = lambda *args, **kw: None
OptionsManagerMixIn.read_config_file = lambda *args, **kw: None
## Pylint transforms and plugin to generate AST for ZODB Components
from astroid.builder import AstroidBuilder
from astroid.exceptions import AstroidBuildingException
from astroid import MANAGER, node_classes
if six.PY2:
from astroid.exceptions import AstroidBuildingException as AstroidBuildingError
else:
from astroid.exceptions import AstroidBuildingError
from astroid import node_classes
from astroid import MANAGER
try:
if six.PY2:
from astroid.builder import _guess_encoding
except ImportError:
# XXX: With python3, tokenize.detect_encoding() is used instead. This
# should do the same instead of copying/pasting legacy code...
import re
......@@ -61,7 +63,7 @@ except ImportError:
match = _ENCODING_RGX.match(line)
if match is not None:
return match.group(1)
def string_build(self, data, modname='', path=None):
def string_build(self, data, modname='', path=None):
"""
build astroid from source code string and return rebuilded astroid
......@@ -95,11 +97,11 @@ def string_build(self, data, modname='', path=None):
LOG("Products.ERP5Type.patches.pylint", WARNING,
"%s: Considered as not importable: Wrong encoding? (%r)" %
(modname, exc))
raise AstroidBuildingException(exc)
raise AstroidBuildingError(exc)
module = self._data_build(data, modname, path)
module.file_bytes = data
return self._post_build(module, encoding)
AstroidBuilder.string_build = string_build
AstroidBuilder.string_build = string_build
# patch node_classes.const_factory not to fail on LazyModules that e.g.
# pygolang installs for pytest and ipython into sys.modules dict:
......@@ -154,17 +156,17 @@ def _buildAstroidModuleFromComponentModuleName(modname):
obj = getattr(component_tool,
component_id.replace('_version', '', 1))
except AttributeError:
raise AstroidBuildingException()
raise AstroidBuildingError()
if obj.getValidationState() in ('modified', 'validated'):
component_obj = obj
else:
raise AstroidBuildingException()
raise AstroidBuildingError()
else:
try:
package, reference = component_id.split('.', 1)
except ValueError:
raise AstroidBuildingException()
raise AstroidBuildingError()
for version in portal.getVersionPriorityNameList():
try:
obj = getattr(component_tool,
......@@ -183,11 +185,12 @@ def _buildAstroidModuleFromComponentModuleName(modname):
return module
if component_obj is None:
raise AstroidBuildingException()
raise AstroidBuildingError()
if six.PY3:
return AstroidBuilder(MANAGER).module_build(
importlib.import_module(modname))
# module_build() could also be used but this requires importing
# the ZODB Component and also monkey-patch it to support PEP-302
# for __file__ starting with '<'
module = AstroidBuilder(MANAGER).string_build(
component_obj.getTextContent(validated_only=True),
modname)
......@@ -195,7 +198,7 @@ def _buildAstroidModuleFromComponentModuleName(modname):
def fail_hook_erp5_component(modname):
if not modname.startswith('erp5.'):
raise AstroidBuildingException()
raise AstroidBuildingError()
if (modname in ('erp5.portal_type',
'erp5.component',
......@@ -223,8 +226,11 @@ MANAGER.register_failed_import_hook(fail_hook_erp5_component)
## transforms but this would require either checking dynamically which
## attributes has been added (much more complex than the current approach)
## or listing them statically (inconvenient).
from astroid.exceptions import NotFoundError
from astroid.scoped_nodes import Module
from astroid.exceptions import AstroidError, NotFoundError
if six.PY2:
from astroid.scoped_nodes import Module
else:
from astroid.nodes import Module
Module_getattr = Module.getattr
def _getattr(self, name, *args, **kw):
try:
......@@ -232,8 +238,22 @@ def _getattr(self, name, *args, **kw):
except NotFoundError as e:
if self.name.startswith('erp5.'):
raise
real_module = __import__(self.name, fromlist=[self.name], level=0)
if six.PY3 and (
# astroid/pylint on py3 have built-in support for numpy
self.name == 'numpy'
or self.name.startswith('numpy.')
# SOAPPy.Types contains "from SOAPPy.Types import *" which confuses
# this patch
or self.name == 'SOAPpy.Types'
# pysvn also confuses pylint
or self.name == 'pysvn'
# XXX actually maybe we don't need this branch at all on py3
):
raise
real_module = __import__(
self.name,
fromlist=[self.name] if six.PY2 else [name],
level=0)
try:
attr = getattr(real_module, name)
except AttributeError:
......@@ -249,13 +269,21 @@ def _getattr(self, name, *args, **kw):
except AttributeError:
from astroid import nodes
if isinstance(attr, dict):
if six.PY2:
ast = nodes.Dict(attr)
else:
ast = nodes.Dict(attr, 0, None, end_lineno=0, end_col_offset=0)
elif isinstance(attr, list):
ast = nodes.List(attr)
elif isinstance(attr, tuple):
ast = nodes.Tuple(attr)
elif isinstance(attr, set):
if six.PY2:
ast = nodes.Set(attr)
else:
ast = nodes.Set(attr, 0, None, end_lineno=0, end_col_offset=0)
elif isinstance(attr, types.ModuleType):
ast = MANAGER.ast_from_module(attr)
else:
try:
ast = nodes.Const(attr)
......@@ -266,16 +294,29 @@ def _getattr(self, name, *args, **kw):
raise
# ast_from_class() actually works for any attribute of a Module
# (on py2 at least), but it raises some AssertionError when the class
# is defined dynamically, for example with zope.hookable.hookable,
# which (in version 6.0) is defined as:
#
# if _PURE_PYTHON or _c_hookable is None:
# hookable = _py_hookable
# else: # pragma: no cover
# hookable = _c_hookable
try:
ast = MANAGER.ast_from_class(attr)
except AstroidBuildingException:
except (AstroidError, AssertionError):
if six.PY2:
raise e
try:
ast = next(MANAGER.infer_ast_from_something(attr))
except AstroidError:
raise e
self.locals[name] = [ast]
return [ast]
Module.getattr = _getattr
if sys.version_info < (2, 8):
if six.PY2:
from astroid.node_classes import From
def _absolute_import_activated(self):
if (self.name.startswith('checkPythonSourceCode') or
......@@ -292,25 +333,25 @@ from astroid import register_module_extender
def AccessControl_PermissionRole_transform():
return AstroidBuilder(MANAGER).string_build('''
def rolesForPermissionOn(perm, object, default=_default_roles, n=None):
return None
return tuple()
class PermissionRole(object):
def __init__(self, name, default=('Manager',)):
return None
def __of__(self, parent):
return None
return imPermissionRole(self)
def rolesForPermissionOn(self, value):
return None
return self.rolesForPermissionOn(None, self)
class imPermissionRole(object):
def __of__(self, value):
return None
return self.rolesForPermissionOn(None, self)
def rolesForPermissionOn(self, value):
return None
return rolesForPermissionOn(None, self)
def __getitem__(self, i):
return None
def __len__(self):
return None
return 0
_what_not_even_god_should_do = []
''')
......@@ -338,14 +379,14 @@ def build_stub(parent, identifier_re=r'^[A-Za-z_]\w*$'):
constants = {}
methods = {}
for name in dir(parent):
if name.startswith("__"):
if name in dir(object):
continue
# Check if this is a valid name in python
if not re.match(identifier_re, name):
continue
try:
obj = getattr(parent, name)
except:
except AttributeError:
continue
if inspect.isclass(obj):
classes[name] = obj
......@@ -422,7 +463,7 @@ _inspected_modules = {}
def fail_hook_BTrees(modname):
# Only consider BTrees.OOBTree pattern
if not modname.startswith('BTrees.') or len(modname.split('.')) != 2:
raise AstroidBuildingException()
raise AstroidBuildingError()
if modname not in _inspected_modules:
try:
modcode = build_stub(
......@@ -438,7 +479,7 @@ def fail_hook_BTrees(modname):
else:
astng = _inspected_modules[modname]
if astng is None:
raise AstroidBuildingException('Failed to import module %r' % modname)
raise AstroidBuildingError('Failed to import module %r' % modname)
return astng
MANAGER.register_failed_import_hook(fail_hook_BTrees)
......@@ -484,12 +525,20 @@ def register_xpkg(pkgname):
except ImportError:
pass
else:
if six.PY2:
def xpkg_transform(node):
m = AstroidBuilder(MANAGER).string_build('__path__ = %r' % pkg.__path__)
m.package = True
m.name = pkgname
return m
MANAGER.register_transform(Module, xpkg_transform, lambda node: node.name == pkgname)
else:
import importlib
def fail_hook_xpkg(modname):
if modname.split('.')[0] == pkgname:
return MANAGER.ast_from_module(importlib.import_module(modname))
raise AstroidBuildingError()
MANAGER.register_failed_import_hook(fail_hook_xpkg)
register_xpkg('wendelin')
register_xpkg('xlte')
......
"""A dummy checker to register messages from pylint3, to be able to
disable the messages on python2 without causing bad-option-value
"""
from __future__ import absolute_import
from pylint import checkers, interfaces
class CompatibilityDisableChecker(checkers.BaseChecker):
name = "compatibility-disable"
msgs = {
"E9999": (
"not-an-iterable",
"not-an-iterable",
"",
),
"E9998": (
"misplaced-bare-raise",
"misplaced-bare-raise",
"",
),
"E9997": (
"unused-private-member",
"unused-private-member",
"",
),
"E9996": (
"using-constant-test",
"using-constant-test",
""
),
"E9995": (
"modified-iterating-list",
"modified-iterating-list",
"",
),
"E9994": (
"unsubscriptable-object",
"unsubscriptable-object",
"",
),
"E9993": (
"invalid-unary-operand-type",
"invalid-unary-operand-type",
"",
),
"E9992": (
"unbalanced-dict-unpacking",
"unbalanced-dict-unpacking",
"",
),
"E9991": (
"self-cls-assignment",
"self-cls-assignment",
"",
),
"E9990": (
"deprecated-class",
"deprecated-class",
"",
),
"E9989": (
"possibly-used-before-assignment",
"possibly-used-before-assignment",
""
)
}
def register(linter):
linter.register_checker(CompatibilityDisableChecker(linter))
......@@ -1903,11 +1903,18 @@ class TestZodbModuleComponent(SecurityTestCase):
component.setTextContent("""import unexistent_module
""" + valid_code)
self.tic()
if six.PY2:
self.assertEqual(
[m.getMessage().translate() for m in component.checkConsistency()],
["Error in Source Code: F: 1, 0: Unable to import 'unexistent_module' (import-error)"])
self.assertEqual(component.getTextContentErrorMessageList(),
["F: 1, 0: Unable to import 'unexistent_module' (import-error)"])
else:
self.assertEqual(
[m.getMessage().translate() for m in component.checkConsistency()],
["Error in Source Code: E: 1, 0: Unable to import 'unexistent_module' (import-error)"])
self.assertEqual(component.getTextContentErrorMessageList(),
["E: 1, 0: Unable to import 'unexistent_module' (import-error)"])
self.assertEqual(component.getTextContentWarningMessageList(),
["W: 1, 0: Unused import unexistent_module (unused-import)"])
......@@ -1939,11 +1946,10 @@ class TestZodbModuleComponent(SecurityTestCase):
[ComponentMixin._message_text_content_not_set],
[],
[]),
("""def foobar(*args, **kwargs)
return 42
("""None()
""" + valid_code,
["Error in Source Code: E: 1, 0: invalid syntax (syntax-error)"],
["E: 1, 0: invalid syntax (syntax-error)"],
["Error in Source Code: E: 1, 0: None is not callable (not-callable)"],
["E: 1, 0: None is not callable (not-callable)"],
[]),
# Make sure that foobar NameError is at the end to make sure that after
# defining foobar function, it is not available at all
......@@ -2213,7 +2219,10 @@ def function_foo(*args, **kwargs):
def _assertAstroidCacheContent(self,
must_be_in_cache_set,
must_not_be_in_cache_set):
if six.PY2:
from astroid.builder import MANAGER
else:
from astroid.astroid_manager import MANAGER
should_not_be_in_cache_list = []
for modname in MANAGER.astroid_cache:
if (modname.startswith('checkPythonSourceCode') or
......@@ -2269,10 +2278,10 @@ def hoge():
"""# -*- coding: utf-8 -*-
# Source code with non-ASCII character should not fail: éàホゲ
from %(namespace)s import %(reference1)s
from %(namespace)s.erp5_version import %(reference1)s
from %(namespace)s.erp5_version import %(reference1)s # pylint:disable=reimported
from %(module2)s import hoge
from %(module2_with_version)s import hoge
from %(module2_with_version)s import hoge # pylint:disable=reimported
import %(module2)s
import %(module2_with_version)s
......@@ -2297,7 +2306,8 @@ from AccessControl.PermissionRole import rolesForPermissionOn, PermissionRole, i
# Monkey patch of astroid 1.3.8: it raised 'no-name-in-module' because
# Shared.DC was not considered a namespace package
from Shared.DC.ZRDB.Results import Results # pylint: disable=unused-import
from Shared.DC.ZRDB.Results import Results
_ = Results
import lxml.etree
lxml.etree.Element('test')
......@@ -2344,17 +2354,21 @@ _ = ZBigArray
module2_with_version=imported_module2_with_version)) +
component.getTextContent())
must_be_in_cache_set = set()
if six.PY2:
must_be_in_cache_set.add(namespace)
self._assertAstroidCacheContent(
must_be_in_cache_set={'%s' % namespace},
must_be_in_cache_set=must_be_in_cache_set,
must_not_be_in_cache_set={'%s.erp5_version' % namespace,
imported_module1,
imported_module1_with_version,
imported_module2,
imported_module2_with_version})
component.checkSourceCode()
if six.PY2:
must_be_in_cache_set.add('%s.erp5_version' % namespace)
self._assertAstroidCacheContent(
must_be_in_cache_set={'%s' % namespace,
'%s.erp5_version' % namespace},
must_be_in_cache_set=must_be_in_cache_set,
must_not_be_in_cache_set={imported_module1,
imported_module1_with_version,
imported_module2,
......@@ -2362,9 +2376,11 @@ _ = ZBigArray
self.tic()
self.assertEqual(component.getValidationState(), 'modified')
if six.PY2:
self.assertEqual(
component.getTextContentErrorMessageList(),
["E: 3, 0: No name '%s' in module '%s' (no-name-in-module)" %
[
"E: 3, 0: No name '%s' in module '%s' (no-name-in-module)" %
(imported_reference1, namespace),
"E: 4, 0: No name '%s' in module '%s.erp5_version' (no-name-in-module)" %
(imported_reference1, namespace),
......@@ -2388,9 +2404,41 @@ _ = ZBigArray
"E: 10, 0: No name '%s' in module '%s.erp5_version' (no-name-in-module)" %
(imported_reference2, namespace),
"F: 10, 0: Unable to import '%s' (import-error)" %
imported_module2_with_version])
imported_module2_with_version,
],
)
else:
self.assertEqual(
component.getTextContentErrorMessageList(),
[
"E: 3, 0: No name '%s' in module '%s' (no-name-in-module)" %
(imported_reference1, namespace),
"E: 4, 0: No name '%s' in module '%s.erp5_version' (no-name-in-module)" %
(imported_reference1, namespace),
"E: 6, 0: Unable to import '%s.%s' (import-error)" %
(namespace, imported_reference2),
# Spurious message but same as filesystem modules: 2 errors raised
# (no-name-in-module and import-error)
"E: 6, 0: No name '%s' in module '%s' (no-name-in-module)" %
(imported_reference2, namespace),
"E: 7, 0: Unable to import '%s' (import-error)" %
imported_module2_with_version,
# Spurious message (see above comment)
"E: 7, 0: No name '%s' in module '%s.erp5_version' (no-name-in-module)" %
(imported_reference2, namespace),
"E: 9, 0: Unable to import '%s.%s' (import-error)" %
(namespace, imported_reference2),
# Spurious message (see above comment)
"E: 9, 0: No name '%s' in module '%s' (no-name-in-module)" %
(imported_reference2, namespace),
"E: 10, 0: Unable to import '%s' (import-error)" %
imported_module2_with_version,
# Spurious message (see above comment)
"E: 10, 0: No name '%s' in module '%s.erp5_version' (no-name-in-module)" %
(imported_reference2, namespace),
],
)
self.assertEqual(component.getTextContentWarningMessageList(), [])
## Simulate user:
# 1) First check and validate 'imported' Components
self.portal.portal_workflow.doActionFor(imported_component1, 'validate_action')
......@@ -2401,20 +2449,29 @@ _ = ZBigArray
message_list = component.checkSourceCode()
self.assertEqual(message_list, [])
self._assertAstroidCacheContent(
must_be_in_cache_set={'%s' % namespace,
'%s.erp5_version' % namespace,
must_be_in_cache_set = {
imported_module1,
imported_module1_with_version,
imported_module2,
imported_module2_with_version},
imported_module2_with_version,
}
if six.PY2:
must_be_in_cache_set.update({
'%s' % namespace,
'%s.erp5_version' % namespace,
})
self._assertAstroidCacheContent(
must_be_in_cache_set=must_be_in_cache_set,
must_not_be_in_cache_set=set())
# 2) Then modify the main one so that it automatically 'validate'
component.setTextContent(component.getTextContent() + '\n')
self.tic()
must_be_in_cache_set = set()
if six.PY2:
must_be_in_cache_set.add(namespace)
self._assertAstroidCacheContent(
must_be_in_cache_set={'%s' % namespace},
must_be_in_cache_set=must_be_in_cache_set,
must_not_be_in_cache_set={'%s.erp5_version' % namespace,
imported_module1,
imported_module1_with_version,
......@@ -2427,10 +2484,11 @@ _ = ZBigArray
component.setTextContent(
"""# -*- coding: utf-8 -*-
from %(module)s import undefined
from %(module_with_version)s import undefined
from %(module_with_version)s import undefined2
# To avoid 'unused-import' warning...
undefined()
undefined2()
""" % (dict(module=imported_module2,
module_with_version=imported_module2_with_version)) +
......@@ -2441,7 +2499,7 @@ undefined()
component.getTextContentErrorMessageList(),
["E: 2, 0: No name 'undefined' in module '%s' (no-name-in-module)" %
imported_module2_with_version,
"E: 3, 0: No name 'undefined' in module '%s' (no-name-in-module)" %
"E: 3, 0: No name 'undefined2' in module '%s' (no-name-in-module)" %
imported_module2_with_version])
self.assertEqual(component.getTextContentWarningMessageList(), [])
......@@ -2477,8 +2535,8 @@ def hoge():
component = self._newComponent(reference)
component.setTextContent(component.getTextContent() + """
from %(namespace)s import %(reference)s
from %(namespace)s.bar_version import %(reference)s
from %(namespace)s.erp5_version import %(reference)s
from %(namespace)s.bar_version import %(reference)s # pylint:disable=reimported
from %(namespace)s.erp5_version import %(reference)s # pylint:disable=reimported
# To avoid 'unused-import' warning...
%(reference)s.hoge()
......@@ -2486,7 +2544,10 @@ from %(namespace)s.erp5_version import %(reference)s
reference=imported_reference))
component.checkSourceCode()
if six.PY2:
from astroid.builder import MANAGER
else:
from astroid.astroid_manager import MANAGER
imported_module = self._getComponentFullModuleName(imported_reference)
self.assertEqual(
MANAGER.astroid_cache[self._getComponentFullModuleName(imported_reference, version='bar')],
......
Markdown is supported
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