summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-12-17 00:07:28 +0100
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-12-17 00:10:34 +0100
commit7185265b683002486dcedb5cbf737cf1cc92e53d (patch)
treec02ace7ebd7bf739e1bbbf4532ba764436198969
parentef1fc5e8a09f0fff841e48eb4d89cc157e6c50c3 (diff)
downloadpylint-git-burst-pylint-checker-classes.tar.gz
[refactor] Create a file for the ClassChecker in pylint.classesburst-pylint-checker-classes
-rw-r--r--pylint/checkers/classes/__init__.py2049
-rw-r--r--pylint/checkers/classes/class_checker.py2052
2 files changed, 2053 insertions, 2048 deletions
diff --git a/pylint/checkers/classes/__init__.py b/pylint/checkers/classes/__init__.py
index 15c9cdb6c..e46eb583d 100644
--- a/pylint/checkers/classes/__init__.py
+++ b/pylint/checkers/classes/__init__.py
@@ -1,2056 +1,9 @@
-# Copyright (c) 2006-2016 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
-# Copyright (c) 2010 Maarten ter Huurne <maarten@treewalker.org>
-# Copyright (c) 2012-2014 Google, Inc.
-# Copyright (c) 2012 FELD Boris <lothiraldan@gmail.com>
-# Copyright (c) 2013-2020 Claudiu Popa <pcmanticore@gmail.com>
-# Copyright (c) 2014 Michal Nowikowski <godfryd@gmail.com>
-# Copyright (c) 2014 Brett Cannon <brett@python.org>
-# Copyright (c) 2014 Arun Persaud <arun@nubati.net>
-# Copyright (c) 2014 David Pursehouse <david.pursehouse@gmail.com>
-# Copyright (c) 2015 Dmitry Pribysh <dmand@yandex.ru>
-# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
-# Copyright (c) 2016-2017 Łukasz Rogalski <rogalski.91@gmail.com>
-# Copyright (c) 2016 Alexander Todorov <atodorov@otb.bg>
-# Copyright (c) 2016 Anthony Foglia <afoglia@users.noreply.github.com>
-# Copyright (c) 2016 Florian Bruhin <me@the-compiler.org>
-# Copyright (c) 2016 Moises Lopez <moylop260@vauxoo.com>
-# Copyright (c) 2016 Jakub Wilk <jwilk@jwilk.net>
-# Copyright (c) 2017, 2019-2020 hippo91 <guillaume.peillex@gmail.com>
-# Copyright (c) 2018, 2021 Ville Skyttä <ville.skytta@iki.fi>
-# Copyright (c) 2018, 2020 Anthony Sottile <asottile@umich.edu>
-# Copyright (c) 2018-2019 Nick Drozd <nicholasdrozd@gmail.com>
-# Copyright (c) 2018-2019 Ashley Whetter <ashley@awhetter.co.uk>
-# Copyright (c) 2018 Lucas Cimon <lucas.cimon@gmail.com>
-# Copyright (c) 2018 Bryce Guinta <bryce.paul.guinta@gmail.com>
-# Copyright (c) 2018 ssolanki <sushobhitsolanki@gmail.com>
-# Copyright (c) 2018 Ben Green <benhgreen@icloud.com>
-# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
-# Copyright (c) 2019 mattlbeck <17108752+mattlbeck@users.noreply.github.com>
-# Copyright (c) 2019-2020 craig-sh <craig-sh@users.noreply.github.com>
-# Copyright (c) 2019 Janne Rönkkö <jannero@users.noreply.github.com>
-# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
-# Copyright (c) 2019 Grygorii Iermolenko <gyermolenko@gmail.com>
-# Copyright (c) 2019 Andrzej Klajnert <github@aklajnert.pl>
-# Copyright (c) 2019 Pascal Corpet <pcorpet@users.noreply.github.com>
-# Copyright (c) 2020 GergelyKalmar <gergely.kalmar@logikal.jp>
-# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
-# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
-# Copyright (c) 2021 Mark Byrne <31762852+mbyrnepr2@users.noreply.github.com>
-# Copyright (c) 2021 Samuel Freilich <sfreilich@google.com>
-# Copyright (c) 2021 Nick Pesce <nickpesce22@gmail.com>
-# Copyright (c) 2021 bot <bot@noreply.github.com>
-# Copyright (c) 2021 Yu Shao, Pang <36848472+yushao2@users.noreply.github.com>
-# Copyright (c) 2021 SupImDos <62866982+SupImDos@users.noreply.github.com>
-# Copyright (c) 2021 Kayran Schmidt <59456929+yumasheta@users.noreply.github.com>
-# Copyright (c) 2021 Konstantina Saketou <56515303+ksaketou@users.noreply.github.com>
-# Copyright (c) 2021 James Sinclair <james@nurfherder.com>
-# Copyright (c) 2021 tiagohonorato <61059243+tiagohonorato@users.noreply.github.com>
-
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
-"""Classes checker for Python code"""
-import collections
-from itertools import chain, zip_longest
-from typing import List, Pattern
-
-import astroid
-from astroid import nodes
-from pylint.checkers import BaseChecker, utils
+from pylint.checkers.classes.class_checker import ClassChecker
from pylint.checkers.classes.special_methods_checker import SpecialMethodsChecker
-from pylint.checkers.utils import (
- PYMETHODS,
- check_messages,
- class_is_abstract,
- decorated_with,
- decorated_with_property,
- get_outer_class,
- has_known_bases,
- is_attr_private,
- is_attr_protected,
- is_builtin_object,
- is_comprehension,
- is_iterable,
- is_overload_stub,
- is_property_setter,
- is_property_setter_or_deleter,
- is_protocol_class,
- node_frame_class,
- overrides_a_method,
- safe_infer,
- unimplemented_abstract_methods,
- uninferable_final_decorators,
-)
-from pylint.interfaces import IAstroidChecker
-from pylint.utils import get_global_option
-
-INVALID_BASE_CLASSES = {"bool", "range", "slice", "memoryview"}
-BUILTIN_DECORATORS = {"builtins.property", "builtins.classmethod"}
-ASTROID_TYPE_COMPARATORS = {
- nodes.Const: lambda a, b: a.value == b.value,
- nodes.ClassDef: lambda a, b: a.qname == b.qname,
- nodes.Tuple: lambda a, b: a.elts == b.elts,
- nodes.List: lambda a, b: a.elts == b.elts,
- nodes.Dict: lambda a, b: a.items == b.items,
- nodes.Name: lambda a, b: set(a.infer()) == set(b.infer()),
-}
-
-# Dealing with useless override detection, with regard
-# to parameters vs arguments
-
-_CallSignature = collections.namedtuple(
- "_CallSignature", "args kws starred_args starred_kws"
-)
-_ParameterSignature = collections.namedtuple(
- "_ParameterSignature", "args kwonlyargs varargs kwargs"
-)
-
-
-def _signature_from_call(call):
- kws = {}
- args = []
- starred_kws = []
- starred_args = []
- for keyword in call.keywords or []:
- arg, value = keyword.arg, keyword.value
- if arg is None and isinstance(value, nodes.Name):
- # Starred node and we are interested only in names,
- # otherwise some transformation might occur for the parameter.
- starred_kws.append(value.name)
- elif isinstance(value, nodes.Name):
- kws[arg] = value.name
- else:
- kws[arg] = None
-
- for arg in call.args:
- if isinstance(arg, nodes.Starred) and isinstance(arg.value, nodes.Name):
- # Positional variadic and a name, otherwise some transformation
- # might have occurred.
- starred_args.append(arg.value.name)
- elif isinstance(arg, nodes.Name):
- args.append(arg.name)
- else:
- args.append(None)
-
- return _CallSignature(args, kws, starred_args, starred_kws)
-
-
-def _signature_from_arguments(arguments):
- kwarg = arguments.kwarg
- vararg = arguments.vararg
- args = [
- arg.name
- for arg in chain(arguments.posonlyargs, arguments.args)
- if arg.name != "self"
- ]
- kwonlyargs = [arg.name for arg in arguments.kwonlyargs]
- return _ParameterSignature(args, kwonlyargs, vararg, kwarg)
-
-
-def _definition_equivalent_to_call(definition, call):
- """Check if a definition signature is equivalent to a call."""
- if definition.kwargs:
- if definition.kwargs not in call.starred_kws:
- return False
- elif call.starred_kws:
- return False
- if definition.varargs:
- if definition.varargs not in call.starred_args:
- return False
- elif call.starred_args:
- return False
- if any(kw not in call.kws for kw in definition.kwonlyargs):
- return False
- if definition.args != call.args:
- return False
-
- # No extra kwargs in call.
- return all(kw in call.args or kw in definition.kwonlyargs for kw in call.kws)
-
-
-# Deal with parameters overriding in two methods.
-
-
-def _positional_parameters(method):
- positional = method.args.args
- if method.is_bound() and method.type in {"classmethod", "method"}:
- positional = positional[1:]
- return positional
-
-
-class _DefaultMissing:
- """Sentinel value for missing arg default, use _DEFAULT_MISSING."""
-
-
-_DEFAULT_MISSING = _DefaultMissing()
-
-
-def _has_different_parameters_default_value(original, overridden):
- """
- Check if original and overridden methods arguments have different default values
-
- Return True if one of the overridden arguments has a default
- value different from the default value of the original argument
- If one of the method doesn't have argument (.args is None)
- return False
- """
- if original.args is None or overridden.args is None:
- return False
-
- for param in chain(original.args, original.kwonlyargs):
- try:
- original_default = original.default_value(param.name)
- except astroid.exceptions.NoDefault:
- original_default = _DEFAULT_MISSING
- try:
- overridden_default = overridden.default_value(param.name)
- if original_default is _DEFAULT_MISSING:
- # Only the original has a default.
- return True
- except astroid.exceptions.NoDefault:
- if original_default is _DEFAULT_MISSING:
- # Both have a default, no difference
- continue
- # Only the override has a default.
- return True
-
- original_type = type(original_default)
- if not isinstance(overridden_default, original_type):
- # Two args with same name but different types
- return True
- is_same_fn = ASTROID_TYPE_COMPARATORS.get(original_type)
- if is_same_fn is None:
- # If the default value comparison is unhandled, assume the value is different
- return True
- if not is_same_fn(original_default, overridden_default):
- # Two args with same type but different values
- return True
- return False
-
-
-def _has_different_parameters(
- original: List[nodes.AssignName],
- overridden: List[nodes.AssignName],
- dummy_parameter_regex: Pattern,
-) -> List[str]:
- result = []
- zipped = zip_longest(original, overridden)
- for original_param, overridden_param in zipped:
- params = (original_param, overridden_param)
- if not all(params):
- return ["Number of parameters "]
-
- # check for the arguments' name
- names = [param.name for param in params]
- if any(dummy_parameter_regex.match(name) for name in names):
- continue
- if original_param.name != overridden_param.name:
- result.append(
- f"Parameter '{original_param.name}' has been renamed "
- f"to '{overridden_param.name}' in"
- )
-
- return result
-
-
-def _different_parameters(
- original: nodes.FunctionDef,
- overridden: nodes.FunctionDef,
- dummy_parameter_regex: Pattern,
-) -> List[str]:
- """Determine if the two methods have different parameters
-
- They are considered to have different parameters if:
-
- * they have different positional parameters, including different names
-
- * one of the methods is having variadics, while the other is not
-
- * they have different keyword only parameters.
-
- """
- output_messages = []
- original_parameters = _positional_parameters(original)
- overridden_parameters = _positional_parameters(overridden)
-
- # Copy kwonlyargs list so that we don't affect later function linting
- original_kwonlyargs = original.args.kwonlyargs
-
- # Allow positional/keyword variadic in overridden to match against any
- # positional/keyword argument in original.
- # Keep any arguments that are found separately in overridden to satisfy
- # later tests
- if overridden.args.vararg:
- overridden_names = [v.name for v in overridden_parameters]
- original_parameters = [
- v for v in original_parameters if v.name in overridden_names
- ]
-
- if overridden.args.kwarg:
- overridden_names = [v.name for v in overridden.args.kwonlyargs]
- original_kwonlyargs = [
- v for v in original.args.kwonlyargs if v.name in overridden_names
- ]
-
- different_positional = _has_different_parameters(
- original_parameters, overridden_parameters, dummy_parameter_regex
- )
- different_kwonly = _has_different_parameters(
- original_kwonlyargs, overridden.args.kwonlyargs, dummy_parameter_regex
- )
- if different_kwonly and different_positional:
- if "Number " in different_positional[0] and "Number " in different_kwonly[0]:
- output_messages.append("Number of parameters ")
- output_messages += different_positional[1:]
- output_messages += different_kwonly[1:]
- else:
- output_messages += different_positional
- output_messages += different_kwonly
- else:
- if different_positional:
- output_messages += different_positional
- if different_kwonly:
- output_messages += different_kwonly
-
- if original.name in PYMETHODS:
- # Ignore the difference for special methods. If the parameter
- # numbers are different, then that is going to be caught by
- # unexpected-special-method-signature.
- # If the names are different, it doesn't matter, since they can't
- # be used as keyword arguments anyway.
- output_messages.clear()
-
- # Arguments will only violate LSP if there are variadics in the original
- # that are then removed from the overridden
- kwarg_lost = original.args.kwarg and not overridden.args.kwarg
- vararg_lost = original.args.vararg and not overridden.args.vararg
-
- if kwarg_lost or vararg_lost:
- output_messages += ["Variadics removed in"]
-
- return output_messages
-
-
-def _is_invalid_base_class(cls):
- return cls.name in INVALID_BASE_CLASSES and is_builtin_object(cls)
-
-
-def _has_data_descriptor(cls, attr):
- attributes = cls.getattr(attr)
- for attribute in attributes:
- try:
- for inferred in attribute.infer():
- if isinstance(inferred, astroid.Instance):
- try:
- inferred.getattr("__get__")
- inferred.getattr("__set__")
- except astroid.NotFoundError:
- continue
- else:
- return True
- except astroid.InferenceError:
- # Can't infer, avoid emitting a false positive in this case.
- return True
- return False
-
-
-def _called_in_methods(func, klass, methods):
- """Check if the func was called in any of the given methods,
- belonging to the *klass*. Returns True if so, False otherwise.
- """
- if not isinstance(func, nodes.FunctionDef):
- return False
- for method in methods:
- try:
- inferred = klass.getattr(method)
- except astroid.NotFoundError:
- continue
- for infer_method in inferred:
- for call in infer_method.nodes_of_class(nodes.Call):
- try:
- bound = next(call.func.infer())
- except (astroid.InferenceError, StopIteration):
- continue
- if not isinstance(bound, astroid.BoundMethod):
- continue
- func_obj = bound._proxied
- if isinstance(func_obj, astroid.UnboundMethod):
- func_obj = func_obj._proxied
- if func_obj.name == func.name:
- return True
- return False
-
-
-def _is_attribute_property(name, klass):
- """Check if the given attribute *name* is a property in the given *klass*.
-
- It will look for `property` calls or for functions
- with the given name, decorated by `property` or `property`
- subclasses.
- Returns ``True`` if the name is a property in the given klass,
- ``False`` otherwise.
- """
-
- try:
- attributes = klass.getattr(name)
- except astroid.NotFoundError:
- return False
- property_name = "builtins.property"
- for attr in attributes:
- if attr is astroid.Uninferable:
- continue
- try:
- inferred = next(attr.infer())
- except astroid.InferenceError:
- continue
- if isinstance(inferred, nodes.FunctionDef) and decorated_with_property(
- inferred
- ):
- return True
- if inferred.pytype() != property_name:
- continue
-
- cls = node_frame_class(inferred)
- if cls == klass.declared_metaclass():
- continue
- return True
- return False
-
-
-def _has_bare_super_call(fundef_node):
- for call in fundef_node.nodes_of_class(nodes.Call):
- func = call.func
- if isinstance(func, nodes.Name) and func.name == "super" and not call.args:
- return True
- return False
-
-
-def _has_same_layout_slots(slots, assigned_value):
- inferred = next(assigned_value.infer())
- if isinstance(inferred, nodes.ClassDef):
- other_slots = inferred.slots()
- if all(
- first_slot and second_slot and first_slot.value == second_slot.value
- for (first_slot, second_slot) in zip_longest(slots, other_slots)
- ):
- return True
- return False
-
-
-MSGS = { # pylint: disable=consider-using-namedtuple-or-dataclass
- "F0202": (
- "Unable to check methods signature (%s / %s)",
- "method-check-failed",
- "Used when Pylint has been unable to check methods signature "
- "compatibility for an unexpected reason. Please report this kind "
- "if you don't make sense of it.",
- ),
- "E0202": (
- "An attribute defined in %s line %s hides this method",
- "method-hidden",
- "Used when a class defines a method which is hidden by an "
- "instance attribute from an ancestor class or set by some "
- "client code.",
- ),
- "E0203": (
- "Access to member %r before its definition line %s",
- "access-member-before-definition",
- "Used when an instance member is accessed before it's actually assigned.",
- ),
- "W0201": (
- "Attribute %r defined outside __init__",
- "attribute-defined-outside-init",
- "Used when an instance attribute is defined outside the __init__ method.",
- ),
- "W0212": (
- "Access to a protected member %s of a client class", # E0214
- "protected-access",
- "Used when a protected member (i.e. class member with a name "
- "beginning with an underscore) is access outside the class or a "
- "descendant of the class where it's defined.",
- ),
- "E0211": (
- "Method has no argument",
- "no-method-argument",
- "Used when a method which should have the bound instance as "
- "first argument has no argument defined.",
- ),
- "E0213": (
- 'Method should have "self" as first argument',
- "no-self-argument",
- 'Used when a method has an attribute different the "self" as '
- "first argument. This is considered as an error since this is "
- "a so common convention that you shouldn't break it!",
- ),
- "C0202": (
- "Class method %s should have %s as first argument",
- "bad-classmethod-argument",
- "Used when a class method has a first argument named differently "
- "than the value specified in valid-classmethod-first-arg option "
- '(default to "cls"), recommended to easily differentiate them '
- "from regular instance methods.",
- ),
- "C0203": (
- "Metaclass method %s should have %s as first argument",
- "bad-mcs-method-argument",
- "Used when a metaclass method has a first argument named "
- "differently than the value specified in valid-classmethod-first"
- '-arg option (default to "cls"), recommended to easily '
- "differentiate them from regular instance methods.",
- ),
- "C0204": (
- "Metaclass class method %s should have %s as first argument",
- "bad-mcs-classmethod-argument",
- "Used when a metaclass class method has a first argument named "
- "differently than the value specified in valid-metaclass-"
- 'classmethod-first-arg option (default to "mcs"), recommended to '
- "easily differentiate them from regular instance methods.",
- ),
- "W0211": (
- "Static method with %r as first argument",
- "bad-staticmethod-argument",
- 'Used when a static method has "self" or a value specified in '
- "valid-classmethod-first-arg option or "
- "valid-metaclass-classmethod-first-arg option as first argument.",
- ),
- "R0201": (
- "Method could be a function",
- "no-self-use",
- "Used when a method doesn't use its bound instance, and so could "
- "be written as a function.",
- ),
- "W0221": (
- "%s %s %r method",
- "arguments-differ",
- "Used when a method has a different number of arguments than in "
- "the implemented interface or in an overridden method.",
- ),
- "W0222": (
- "Signature differs from %s %r method",
- "signature-differs",
- "Used when a method signature is different than in the "
- "implemented interface or in an overridden method.",
- ),
- "W0223": (
- "Method %r is abstract in class %r but is not overridden",
- "abstract-method",
- "Used when an abstract method (i.e. raise NotImplementedError) is "
- "not overridden in concrete class.",
- ),
- "W0231": (
- "__init__ method from base class %r is not called",
- "super-init-not-called",
- "Used when an ancestor class method has an __init__ method "
- "which is not called by a derived class.",
- ),
- "W0232": (
- "Class has no __init__ method",
- "no-init",
- "Used when a class has no __init__ method, neither its parent classes.",
- ),
- "W0233": (
- "__init__ method from a non direct base class %r is called",
- "non-parent-init-called",
- "Used when an __init__ method is called on a class which is not "
- "in the direct ancestors for the analysed class.",
- ),
- "W0235": (
- "Useless super delegation in method %r",
- "useless-super-delegation",
- "Used whenever we can detect that an overridden method is useless, "
- "relying on super() delegation to do the same thing as another method "
- "from the MRO.",
- ),
- "W0236": (
- "Method %r was expected to be %r, found it instead as %r",
- "invalid-overridden-method",
- "Used when we detect that a method was overridden in a way "
- "that does not match its base class "
- "which could result in potential bugs at runtime.",
- ),
- "W0237": (
- "%s %s %r method",
- "arguments-renamed",
- "Used when a method parameter has a different name than in "
- "the implemented interface or in an overridden method.",
- ),
- "W0238": (
- "Unused private member `%s.%s`",
- "unused-private-member",
- "Emitted when a private member of a class is defined but not used.",
- ),
- "W0239": (
- "Method %r overrides a method decorated with typing.final which is defined in class %r",
- "overridden-final-method",
- "Used when a method decorated with typing.final has been overridden.",
- ),
- "W0240": (
- "Class %r is a subclass of a class decorated with typing.final: %r",
- "subclassed-final-class",
- "Used when a class decorated with typing.final has been subclassed.",
- ),
- "E0236": (
- "Invalid object %r in __slots__, must contain only non empty strings",
- "invalid-slots-object",
- "Used when an invalid (non-string) object occurs in __slots__.",
- ),
- "E0237": (
- "Assigning to attribute %r not defined in class slots",
- "assigning-non-slot",
- "Used when assigning to an attribute not defined in the class slots.",
- ),
- "E0238": (
- "Invalid __slots__ object",
- "invalid-slots",
- "Used when an invalid __slots__ is found in class. "
- "Only a string, an iterable or a sequence is permitted.",
- ),
- "E0239": (
- "Inheriting %r, which is not a class.",
- "inherit-non-class",
- "Used when a class inherits from something which is not a class.",
- ),
- "E0240": (
- "Inconsistent method resolution order for class %r",
- "inconsistent-mro",
- "Used when a class has an inconsistent method resolution order.",
- ),
- "E0241": (
- "Duplicate bases for class %r",
- "duplicate-bases",
- "Used when a class has duplicate bases.",
- ),
- "E0242": (
- "Value %r in slots conflicts with class variable",
- "class-variable-slots-conflict",
- "Used when a value in __slots__ conflicts with a class variable, property or method.",
- ),
- "E0243": (
- "Invalid __class__ object",
- "invalid-class-object",
- "Used when an invalid object is assigned to a __class__ property. "
- "Only a class is permitted.",
- ),
- "R0202": (
- "Consider using a decorator instead of calling classmethod",
- "no-classmethod-decorator",
- "Used when a class method is defined without using the decorator syntax.",
- ),
- "R0203": (
- "Consider using a decorator instead of calling staticmethod",
- "no-staticmethod-decorator",
- "Used when a static method is defined without using the decorator syntax.",
- ),
- "C0205": (
- "Class __slots__ should be a non-string iterable",
- "single-string-used-for-slots",
- "Used when a class __slots__ is a simple string, rather than an iterable.",
- ),
- "R0205": (
- "Class %r inherits from object, can be safely removed from bases in python3",
- "useless-object-inheritance",
- "Used when a class inherit from object, which under python3 is implicit, "
- "hence can be safely removed from bases.",
- ),
- "R0206": (
- "Cannot have defined parameters for properties",
- "property-with-parameters",
- "Used when we detect that a property also has parameters, which are useless, "
- "given that properties cannot be called with additional arguments.",
- ),
-}
-
-
-def _scope_default():
- return collections.defaultdict(list)
-
-
-class ScopeAccessMap:
- """Store the accessed variables per scope."""
-
- def __init__(self):
- self._scopes = collections.defaultdict(_scope_default)
-
- def set_accessed(self, node):
- """Set the given node as accessed."""
-
- frame = node_frame_class(node)
- if frame is None:
- # The node does not live in a class.
- return
- self._scopes[frame][node.attrname].append(node)
-
- def accessed(self, scope):
- """Get the accessed variables for the given scope."""
- return self._scopes.get(scope, {})
-
-
-class ClassChecker(BaseChecker):
- """checks for :
- * methods without self as first argument
- * overridden methods signature
- * access only to existent members via self
- * attributes not defined in the __init__ method
- * unreachable code
- """
-
- __implements__ = (IAstroidChecker,)
-
- # configuration section name
- name = "classes"
- # messages
- msgs = MSGS
- priority = -2
- # configuration options
- options = (
- (
- "defining-attr-methods",
- {
- "default": ("__init__", "__new__", "setUp", "__post_init__"),
- "type": "csv",
- "metavar": "<method names>",
- "help": "List of method names used to declare (i.e. assign) \
-instance attributes.",
- },
- ),
- (
- "valid-classmethod-first-arg",
- {
- "default": ("cls",),
- "type": "csv",
- "metavar": "<argument names>",
- "help": "List of valid names for the first argument in \
-a class method.",
- },
- ),
- (
- "valid-metaclass-classmethod-first-arg",
- {
- "default": ("cls",),
- "type": "csv",
- "metavar": "<argument names>",
- "help": "List of valid names for the first argument in \
-a metaclass class method.",
- },
- ),
- (
- "exclude-protected",
- {
- "default": (
- # namedtuple public API.
- "_asdict",
- "_fields",
- "_replace",
- "_source",
- "_make",
- ),
- "type": "csv",
- "metavar": "<protected access exclusions>",
- "help": (
- "List of member names, which should be excluded "
- "from the protected access warning."
- ),
- },
- ),
- (
- "check-protected-access-in-special-methods",
- {
- "default": False,
- "type": "yn",
- "metavar": "<y or n>",
- "help": "Warn about protected attribute access inside special methods",
- },
- ),
- )
-
- def __init__(self, linter=None):
- super().__init__(linter)
- self._accessed = ScopeAccessMap()
- self._first_attrs = []
- self._meth_could_be_func = None
-
- def open(self) -> None:
- self._mixin_class_rgx = get_global_option(self, "mixin-class-rgx")
- py_version = get_global_option(self, "py-version")
- self._py38_plus = py_version >= (3, 8)
-
- @astroid.decorators.cachedproperty
- def _dummy_rgx(self):
- return get_global_option(self, "dummy-variables-rgx", default=None)
-
- @astroid.decorators.cachedproperty
- def _ignore_mixin(self):
- return get_global_option(self, "ignore-mixin-members", default=True)
-
- @check_messages(
- "abstract-method",
- "no-init",
- "invalid-slots",
- "single-string-used-for-slots",
- "invalid-slots-object",
- "class-variable-slots-conflict",
- "inherit-non-class",
- "useless-object-inheritance",
- "inconsistent-mro",
- "duplicate-bases",
- )
- def visit_classdef(self, node: nodes.ClassDef) -> None:
- """init visit variable _accessed"""
- self._check_bases_classes(node)
- # if not an exception or a metaclass
- if node.type == "class" and has_known_bases(node):
- try:
- node.local_attr("__init__")
- except astroid.NotFoundError:
- self.add_message("no-init", args=node, node=node)
- self._check_slots(node)
- self._check_proper_bases(node)
- self._check_typing_final(node)
- self._check_consistent_mro(node)
-
- def _check_consistent_mro(self, node):
- """Detect that a class has a consistent mro or duplicate bases."""
- try:
- node.mro()
- except astroid.InconsistentMroError:
- self.add_message("inconsistent-mro", args=node.name, node=node)
- except astroid.DuplicateBasesError:
- self.add_message("duplicate-bases", args=node.name, node=node)
- except NotImplementedError:
- # Old style class, there's no mro so don't do anything.
- pass
-
- def _check_proper_bases(self, node):
- """
- Detect that a class inherits something which is not
- a class or a type.
- """
- for base in node.bases:
- ancestor = safe_infer(base)
- if not ancestor:
- continue
- if isinstance(ancestor, astroid.Instance) and ancestor.is_subtype_of(
- "builtins.type"
- ):
- continue
-
- if not isinstance(ancestor, nodes.ClassDef) or _is_invalid_base_class(
- ancestor
- ):
- self.add_message("inherit-non-class", args=base.as_string(), node=node)
-
- if ancestor.name == object.__name__:
- self.add_message(
- "useless-object-inheritance", args=node.name, node=node
- )
-
- def _check_typing_final(self, node: nodes.ClassDef) -> None:
- """Detect that a class does not subclass a class decorated with `typing.final`"""
- if not self._py38_plus:
- return
- for base in node.bases:
- ancestor = safe_infer(base)
- if not ancestor:
- continue
-
- if isinstance(ancestor, nodes.ClassDef) and (
- decorated_with(ancestor, ["typing.final"])
- or uninferable_final_decorators(ancestor.decorators)
- ):
- self.add_message(
- "subclassed-final-class",
- args=(node.name, ancestor.name),
- node=node,
- )
-
- @check_messages("unused-private-member", "attribute-defined-outside-init")
- def leave_classdef(self, node: nodes.ClassDef) -> None:
- """close a class node:
- check that instance attributes are defined in __init__ and check
- access to existent members
- """
- self._check_unused_private_functions(node)
- self._check_unused_private_variables(node)
- self._check_unused_private_attributes(node)
- self._check_attribute_defined_outside_init(node)
-
- def _check_unused_private_functions(self, node: nodes.ClassDef) -> None:
- for function_def in node.nodes_of_class(nodes.FunctionDef):
- if not is_attr_private(function_def.name):
- continue
- parent_scope = function_def.parent.scope()
- if isinstance(parent_scope, nodes.FunctionDef):
- # Handle nested functions
- if function_def.name in (
- n.name for n in parent_scope.nodes_of_class(nodes.Name)
- ):
- continue
- for attribute in node.nodes_of_class(nodes.Attribute):
- if (
- attribute.attrname != function_def.name
- or attribute.scope() == function_def # We ignore recursive calls
- ):
- continue
- if isinstance(attribute.expr, nodes.Name) and attribute.expr.name in (
- "self",
- "cls",
- node.name,
- ):
- # self.__attrname
- # cls.__attrname
- # node_name.__attrname
- break
- if isinstance(attribute.expr, nodes.Call):
- # type(self).__attrname
- inferred = safe_infer(attribute.expr)
- if (
- isinstance(inferred, nodes.ClassDef)
- and inferred.name == node.name
- ):
- break
- else:
- name_stack = []
- curr = parent_scope
- # Generate proper names for nested functions
- while curr != node:
- name_stack.append(curr.name)
- curr = curr.parent.scope()
-
- outer_level_names = f"{'.'.join(reversed(name_stack))}"
- function_repr = f"{outer_level_names}.{function_def.name}({function_def.args.as_string()})"
- self.add_message(
- "unused-private-member",
- node=function_def,
- args=(node.name, function_repr.lstrip(".")),
- )
-
- def _check_unused_private_variables(self, node: nodes.ClassDef) -> None:
- """Check if private variables are never used within a class"""
- for assign_name in node.nodes_of_class(nodes.AssignName):
- if isinstance(assign_name.parent, nodes.Arguments):
- continue # Ignore function arguments
- if not is_attr_private(assign_name.name):
- continue
- for child in node.nodes_of_class((nodes.Name, nodes.Attribute)):
- if isinstance(child, nodes.Name) and child.name == assign_name.name:
- break
- if isinstance(child, nodes.Attribute):
- if not isinstance(child.expr, nodes.Name):
- break
- if child.attrname == assign_name.name and child.expr.name in (
- "self",
- "cls",
- node.name,
- ):
- break
- else:
- args = (node.name, assign_name.name)
- self.add_message("unused-private-member", node=assign_name, args=args)
-
- def _check_unused_private_attributes(self, node: nodes.ClassDef) -> None:
- for assign_attr in node.nodes_of_class(nodes.AssignAttr):
- if not is_attr_private(assign_attr.attrname) or not isinstance(
- assign_attr.expr, nodes.Name
- ):
- continue
-
- # Logic for checking false positive when using __new__,
- # Get the returned object names of the __new__ magic function
- # Then check if the attribute was consumed in other instance methods
- acceptable_obj_names: List[str] = ["self"]
- scope = assign_attr.scope()
- if isinstance(scope, nodes.FunctionDef) and scope.name == "__new__":
- acceptable_obj_names.extend(
- [
- return_node.value.name
- for return_node in scope.nodes_of_class(nodes.Return)
- if isinstance(return_node.value, nodes.Name)
- ]
- )
-
- for attribute in node.nodes_of_class(nodes.Attribute):
- if attribute.attrname != assign_attr.attrname:
- continue
-
- if (
- assign_attr.expr.name
- in {
- "cls",
- node.name,
- }
- and attribute.expr.name in {"cls", "self", node.name}
- ):
- # If assigned to cls or class name, can be accessed by cls/self/class name
- break
-
- if (
- assign_attr.expr.name in acceptable_obj_names
- and attribute.expr.name == "self"
- ):
- # If assigned to self.attrib, can only be accessed by self
- # Or if __new__ was used, the returned object names are acceptable
- break
-
- if assign_attr.expr.name == attribute.expr.name == node.name:
- # Recognise attributes which are accessed via the class name
- break
-
- else:
- args = (node.name, assign_attr.attrname)
- self.add_message("unused-private-member", node=assign_attr, args=args)
-
- def _check_attribute_defined_outside_init(self, cnode: nodes.ClassDef) -> None:
- # check access to existent members on non metaclass classes
- if self._ignore_mixin and self._mixin_class_rgx.match(cnode.name):
- # We are in a mixin class. No need to try to figure out if
- # something is missing, since it is most likely that it will
- # miss.
- return
-
- accessed = self._accessed.accessed(cnode)
- if cnode.type != "metaclass":
- self._check_accessed_members(cnode, accessed)
- # checks attributes are defined in an allowed method such as __init__
- if not self.linter.is_message_enabled("attribute-defined-outside-init"):
- return
- defining_methods = self.config.defining_attr_methods
- current_module = cnode.root()
- for attr, nodes_lst in cnode.instance_attrs.items():
- # Exclude `__dict__` as it is already defined.
- if attr == "__dict__":
- continue
-
- # Skip nodes which are not in the current module and it may screw up
- # the output, while it's not worth it
- nodes_lst = [
- n
- for n in nodes_lst
- if not isinstance(
- n.statement(future=True), (nodes.Delete, nodes.AugAssign)
- )
- and n.root() is current_module
- ]
- if not nodes_lst:
- continue # error detected by typechecking
-
- # Check if any method attr is defined in is a defining method
- # or if we have the attribute defined in a setter.
- frames = (node.frame() for node in nodes_lst)
- if any(
- frame.name in defining_methods or is_property_setter(frame)
- for frame in frames
- ):
- continue
-
- # check attribute is defined in a parent's __init__
- for parent in cnode.instance_attr_ancestors(attr):
- attr_defined = False
- # check if any parent method attr is defined in is a defining method
- for node in parent.instance_attrs[attr]:
- if node.frame().name in defining_methods:
- attr_defined = True
- if attr_defined:
- # we're done :)
- break
- else:
- # check attribute is defined as a class attribute
- try:
- cnode.local_attr(attr)
- except astroid.NotFoundError:
- for node in nodes_lst:
- if node.frame().name not in defining_methods:
- # If the attribute was set by a call in any
- # of the defining methods, then don't emit
- # the warning.
- if _called_in_methods(
- node.frame(), cnode, defining_methods
- ):
- continue
- self.add_message(
- "attribute-defined-outside-init", args=attr, node=node
- )
-
- def visit_functiondef(self, node: nodes.FunctionDef) -> None:
- """check method arguments, overriding"""
- # ignore actual functions
- if not node.is_method():
- return
-
- self._check_useless_super_delegation(node)
- self._check_property_with_parameters(node)
-
- klass = node.parent.frame()
- self._meth_could_be_func = True
- # check first argument is self if this is actually a method
- self._check_first_arg_for_type(node, klass.type == "metaclass")
- if node.name == "__init__":
- self._check_init(node)
- return
- # check signature if the method overloads inherited method
- for overridden in klass.local_attr_ancestors(node.name):
- # get astroid for the searched method
- try:
- parent_function = overridden[node.name]
- except KeyError:
- # we have found the method but it's not in the local
- # dictionary.
- # This may happen with astroid build from living objects
- continue
- if not isinstance(parent_function, nodes.FunctionDef):
- continue
- self._check_signature(node, parent_function, "overridden", klass)
- self._check_invalid_overridden_method(node, parent_function)
- break
-
- if node.decorators:
- for decorator in node.decorators.nodes:
- if isinstance(decorator, nodes.Attribute) and decorator.attrname in {
- "getter",
- "setter",
- "deleter",
- }:
- # attribute affectation will call this method, not hiding it
- return
- if isinstance(decorator, nodes.Name):
- if decorator.name == "property":
- # attribute affectation will either call a setter or raise
- # an attribute error, anyway not hiding the function
- return
-
- # Infer the decorator and see if it returns something useful
- inferred = safe_infer(decorator)
- if not inferred:
- return
- if isinstance(inferred, nodes.FunctionDef):
- # Okay, it's a decorator, let's see what it can infer.
- try:
- inferred = next(inferred.infer_call_result(inferred))
- except astroid.InferenceError:
- return
- try:
- if (
- isinstance(inferred, (astroid.Instance, nodes.ClassDef))
- and inferred.getattr("__get__")
- and inferred.getattr("__set__")
- ):
- return
- except astroid.AttributeInferenceError:
- pass
-
- # check if the method is hidden by an attribute
- try:
- overridden = klass.instance_attr(node.name)[0]
- overridden_frame = overridden.frame()
- if (
- isinstance(overridden_frame, nodes.FunctionDef)
- and overridden_frame.type == "method"
- ):
- overridden_frame = overridden_frame.parent.frame()
- if not (
- isinstance(overridden_frame, nodes.ClassDef)
- and klass.is_subtype_of(overridden_frame.qname())
- ):
- return
-
- # If a subclass defined the method then it's not our fault.
- for ancestor in klass.ancestors():
- if node.name in ancestor.instance_attrs and is_attr_private(node.name):
- return
- for obj in ancestor.lookup(node.name)[1]:
- if isinstance(obj, nodes.FunctionDef):
- return
- args = (overridden.root().name, overridden.fromlineno)
- self.add_message("method-hidden", args=args, node=node)
- except astroid.NotFoundError:
- pass
-
- visit_asyncfunctiondef = visit_functiondef
-
- def _check_useless_super_delegation(self, function):
- """Check if the given function node is an useless method override
-
- We consider it *useless* if it uses the super() builtin, but having
- nothing additional whatsoever than not implementing the method at all.
- If the method uses super() to delegate an operation to the rest of the MRO,
- and if the method called is the same as the current one, the arguments
- passed to super() are the same as the parameters that were passed to
- this method, then the method could be removed altogether, by letting
- other implementation to take precedence.
- """
-
- if (
- not function.is_method()
- # With decorators is a change of use
- or function.decorators
- ):
- return
-
- body = function.body
- if len(body) != 1:
- # Multiple statements, which means this overridden method
- # could do multiple things we are not aware of.
- return
-
- statement = body[0]
- if not isinstance(statement, (nodes.Expr, nodes.Return)):
- # Doing something else than what we are interested into.
- return
-
- call = statement.value
- if (
- not isinstance(call, nodes.Call)
- # Not a super() attribute access.
- or not isinstance(call.func, nodes.Attribute)
- ):
- return
-
- # Should be a super call.
- try:
- super_call = next(call.func.expr.infer())
- except astroid.InferenceError:
- return
- else:
- if not isinstance(super_call, astroid.objects.Super):
- return
-
- # The name should be the same.
- if call.func.attrname != function.name:
- return
-
- # Should be a super call with the MRO pointer being the
- # current class and the type being the current instance.
- current_scope = function.parent.scope()
- if (
- super_call.mro_pointer != current_scope
- or not isinstance(super_call.type, astroid.Instance)
- or super_call.type.name != current_scope.name
- ):
- return
-
- # Check values of default args
- klass = function.parent.frame()
- meth_node = None
- for overridden in klass.local_attr_ancestors(function.name):
- # get astroid for the searched method
- try:
- meth_node = overridden[function.name]
- except KeyError:
- # we have found the method but it's not in the local
- # dictionary.
- # This may happen with astroid build from living objects
- continue
- if (
- not isinstance(meth_node, nodes.FunctionDef)
- # If the method have an ancestor which is not a
- # function then it is legitimate to redefine it
- or _has_different_parameters_default_value(
- meth_node.args, function.args
- )
- ):
- return
- break
-
- # Detect if the parameters are the same as the call's arguments.
- params = _signature_from_arguments(function.args)
- args = _signature_from_call(call)
-
- if meth_node is not None:
-
- def form_annotations(arguments):
- annotations = chain(
- (arguments.posonlyargs_annotations or []), arguments.annotations
- )
- return [ann.as_string() for ann in annotations if ann is not None]
-
- called_annotations = form_annotations(function.args)
- overridden_annotations = form_annotations(meth_node.args)
- if called_annotations and overridden_annotations:
- if called_annotations != overridden_annotations:
- return
-
- if _definition_equivalent_to_call(params, args):
- self.add_message(
- "useless-super-delegation", node=function, args=(function.name,)
- )
-
- def _check_property_with_parameters(self, node):
- if (
- node.args.args
- and len(node.args.args) > 1
- and decorated_with_property(node)
- and not is_property_setter(node)
- ):
- self.add_message("property-with-parameters", node=node)
-
- def _check_invalid_overridden_method(self, function_node, parent_function_node):
- parent_is_property = decorated_with_property(
- parent_function_node
- ) or is_property_setter_or_deleter(parent_function_node)
- current_is_property = decorated_with_property(
- function_node
- ) or is_property_setter_or_deleter(function_node)
- if parent_is_property and not current_is_property:
- self.add_message(
- "invalid-overridden-method",
- args=(function_node.name, "property", function_node.type),
- node=function_node,
- )
- elif not parent_is_property and current_is_property:
- self.add_message(
- "invalid-overridden-method",
- args=(function_node.name, "method", "property"),
- node=function_node,
- )
-
- parent_is_async = isinstance(parent_function_node, nodes.AsyncFunctionDef)
- current_is_async = isinstance(function_node, nodes.AsyncFunctionDef)
-
- if parent_is_async and not current_is_async:
- self.add_message(
- "invalid-overridden-method",
- args=(function_node.name, "async", "non-async"),
- node=function_node,
- )
-
- elif not parent_is_async and current_is_async:
- self.add_message(
- "invalid-overridden-method",
- args=(function_node.name, "non-async", "async"),
- node=function_node,
- )
- if (
- decorated_with(parent_function_node, ["typing.final"])
- or uninferable_final_decorators(parent_function_node.decorators)
- ) and self._py38_plus:
- self.add_message(
- "overridden-final-method",
- args=(function_node.name, parent_function_node.parent.name),
- node=function_node,
- )
-
- def _check_slots(self, node):
- if "__slots__" not in node.locals:
- return
- for slots in node.igetattr("__slots__"):
- # check if __slots__ is a valid type
- if slots is astroid.Uninferable:
- continue
- if not is_iterable(slots) and not is_comprehension(slots):
- self.add_message("invalid-slots", node=node)
- continue
-
- if isinstance(slots, nodes.Const):
- # a string, ignore the following checks
- self.add_message("single-string-used-for-slots", node=node)
- continue
- if not hasattr(slots, "itered"):
- # we can't obtain the values, maybe a .deque?
- continue
-
- if isinstance(slots, nodes.Dict):
- values = [item[0] for item in slots.items]
- else:
- values = slots.itered()
- if values is astroid.Uninferable:
- return
- for elt in values:
- try:
- self._check_slots_elt(elt, node)
- except astroid.InferenceError:
- continue
-
- def _check_slots_elt(self, elt, node):
- for inferred in elt.infer():
- if inferred is astroid.Uninferable:
- continue
- if not isinstance(inferred, nodes.Const) or not isinstance(
- inferred.value, str
- ):
- self.add_message(
- "invalid-slots-object", args=inferred.as_string(), node=elt
- )
- continue
- if not inferred.value:
- self.add_message(
- "invalid-slots-object", args=inferred.as_string(), node=elt
- )
-
- # Check if we have a conflict with a class variable.
- class_variable = node.locals.get(inferred.value)
- if class_variable:
- # Skip annotated assignments which don't conflict at all with slots.
- if len(class_variable) == 1:
- parent = class_variable[0].parent
- if isinstance(parent, nodes.AnnAssign) and parent.value is None:
- return
- self.add_message(
- "class-variable-slots-conflict", args=(inferred.value,), node=elt
- )
-
- def leave_functiondef(self, node: nodes.FunctionDef) -> None:
- """on method node, check if this method couldn't be a function
-
- ignore class, static and abstract methods, initializer,
- methods overridden from a parent class.
- """
- if node.is_method():
- if node.args.args is not None:
- self._first_attrs.pop()
- if not self.linter.is_message_enabled("no-self-use"):
- return
- class_node = node.parent.frame()
- if (
- self._meth_could_be_func
- and node.type == "method"
- and node.name not in PYMETHODS
- and not (
- node.is_abstract()
- or overrides_a_method(class_node, node.name)
- or decorated_with_property(node)
- or _has_bare_super_call(node)
- or is_protocol_class(class_node)
- or is_overload_stub(node)
- )
- ):
- self.add_message("no-self-use", node=node)
-
- leave_asyncfunctiondef = leave_functiondef
-
- def visit_attribute(self, node: nodes.Attribute) -> None:
- """check if the getattr is an access to a class member
- if so, register it. Also check for access to protected
- class member from outside its class (but ignore __special__
- methods)
- """
- # Check self
- if self._uses_mandatory_method_param(node):
- self._accessed.set_accessed(node)
- return
- if not self.linter.is_message_enabled("protected-access"):
- return
-
- self._check_protected_attribute_access(node)
-
- @check_messages("assigning-non-slot", "invalid-class-object")
- def visit_assignattr(self, node: nodes.AssignAttr) -> None:
- if isinstance(
- node.assign_type(), nodes.AugAssign
- ) and self._uses_mandatory_method_param(node):
- self._accessed.set_accessed(node)
- self._check_in_slots(node)
- self._check_invalid_class_object(node)
-
- def _check_invalid_class_object(self, node: nodes.AssignAttr) -> None:
- if not node.attrname == "__class__":
- return
- inferred = safe_infer(node.parent.value)
- if isinstance(inferred, nodes.ClassDef) or inferred is astroid.Uninferable:
- # If is uninferrable, we allow it to prevent false positives
- return
- self.add_message("invalid-class-object", node=node)
-
- def _check_in_slots(self, node):
- """Check that the given AssignAttr node
- is defined in the class slots.
- """
- inferred = safe_infer(node.expr)
- if not isinstance(inferred, astroid.Instance):
- return
-
- klass = inferred._proxied
- if not has_known_bases(klass):
- return
- if "__slots__" not in klass.locals or not klass.newstyle:
- return
- # If `__setattr__` is defined on the class, then we can't reason about
- # what will happen when assigning to an attribute.
- if any(
- base.locals.get("__setattr__")
- for base in klass.mro()
- if base.qname() != "builtins.object"
- ):
- return
-
- # If 'typing.Generic' is a base of bases of klass, the cached version
- # of 'slots()' might have been evaluated incorrectly, thus deleted cache entry.
- if any(base.qname() == "typing.Generic" for base in klass.mro()):
- cache = getattr(klass, "__cache", None)
- if cache and cache.get(klass.slots) is not None:
- del cache[klass.slots]
-
- slots = klass.slots()
- if slots is None:
- return
- # If any ancestor doesn't use slots, the slots
- # defined for this class are superfluous.
- if any(
- "__slots__" not in ancestor.locals and ancestor.name != "object"
- for ancestor in klass.ancestors()
- ):
- return
-
- if not any(slot.value == node.attrname for slot in slots):
- # If we have a '__dict__' in slots, then
- # assigning any name is valid.
- if not any(slot.value == "__dict__" for slot in slots):
- if _is_attribute_property(node.attrname, klass):
- # Properties circumvent the slots mechanism,
- # so we should not emit a warning for them.
- return
- if node.attrname in klass.locals and _has_data_descriptor(
- klass, node.attrname
- ):
- # Descriptors circumvent the slots mechanism as well.
- return
- if node.attrname == "__class__" and _has_same_layout_slots(
- slots, node.parent.value
- ):
- return
- self.add_message("assigning-non-slot", args=(node.attrname,), node=node)
-
- @check_messages(
- "protected-access", "no-classmethod-decorator", "no-staticmethod-decorator"
- )
- def visit_assign(self, assign_node: nodes.Assign) -> None:
- self._check_classmethod_declaration(assign_node)
- node = assign_node.targets[0]
- if not isinstance(node, nodes.AssignAttr):
- return
-
- if self._uses_mandatory_method_param(node):
- return
- self._check_protected_attribute_access(node)
-
- def _check_classmethod_declaration(self, node):
- """Checks for uses of classmethod() or staticmethod()
-
- When a @classmethod or @staticmethod decorator should be used instead.
- A message will be emitted only if the assignment is at a class scope
- and only if the classmethod's argument belongs to the class where it
- is defined.
- `node` is an assign node.
- """
- if not isinstance(node.value, nodes.Call):
- return
-
- # check the function called is "classmethod" or "staticmethod"
- func = node.value.func
- if not isinstance(func, nodes.Name) or func.name not in (
- "classmethod",
- "staticmethod",
- ):
- return
-
- msg = (
- "no-classmethod-decorator"
- if func.name == "classmethod"
- else "no-staticmethod-decorator"
- )
- # assignment must be at a class scope
- parent_class = node.scope()
- if not isinstance(parent_class, nodes.ClassDef):
- return
-
- # Check if the arg passed to classmethod is a class member
- classmeth_arg = node.value.args[0]
- if not isinstance(classmeth_arg, nodes.Name):
- return
-
- method_name = classmeth_arg.name
- if any(method_name == member.name for member in parent_class.mymethods()):
- self.add_message(msg, node=node.targets[0])
-
- def _check_protected_attribute_access(self, node: nodes.Attribute):
- """Given an attribute access node (set or get), check if attribute
- access is legitimate. Call _check_first_attr with node before calling
- this method. Valid cases are:
- * self._attr in a method or cls._attr in a classmethod. Checked by
- _check_first_attr.
- * Klass._attr inside "Klass" class.
- * Klass2._attr inside "Klass" class when Klass2 is a base class of
- Klass.
- """
- attrname = node.attrname
-
- if (
- is_attr_protected(attrname)
- and attrname not in self.config.exclude_protected
- ):
-
- klass = node_frame_class(node)
-
- # In classes, check we are not getting a parent method
- # through the class object or through super
- callee = node.expr.as_string()
-
- # Typing annotations in function definitions can include protected members
- if utils.is_node_in_type_annotation_context(node):
- return
-
- # We are not in a class, no remaining valid case
- if klass is None:
- self.add_message("protected-access", node=node, args=attrname)
- return
-
- # If the expression begins with a call to super, that's ok.
- if (
- isinstance(node.expr, nodes.Call)
- and isinstance(node.expr.func, nodes.Name)
- and node.expr.func.name == "super"
- ):
- return
-
- # If the expression begins with a call to type(self), that's ok.
- if self._is_type_self_call(node.expr):
- return
-
- # Check if we are inside the scope of a class or nested inner class
- inside_klass = True
- outer_klass = klass
- parents_callee = callee.split(".")
- parents_callee.reverse()
- for callee in parents_callee:
- if not outer_klass or callee != outer_klass.name:
- inside_klass = False
- break
-
- # Move up one level within the nested classes
- outer_klass = get_outer_class(outer_klass)
-
- # We are in a class, one remaining valid cases, Klass._attr inside
- # Klass
- if not (inside_klass or callee in klass.basenames):
- # Detect property assignments in the body of the class.
- # This is acceptable:
- #
- # class A:
- # b = property(lambda: self._b)
-
- stmt = node.parent.statement(future=True)
- if (
- isinstance(stmt, nodes.Assign)
- and len(stmt.targets) == 1
- and isinstance(stmt.targets[0], nodes.AssignName)
- ):
- name = stmt.targets[0].name
- if _is_attribute_property(name, klass):
- return
-
- if (
- self._is_classmethod(node.frame())
- and self._is_inferred_instance(node.expr, klass)
- and self._is_class_attribute(attrname, klass)
- ):
- return
-
- licit_protected_member = not attrname.startswith("__")
- if (
- not self.config.check_protected_access_in_special_methods
- and licit_protected_member
- and self._is_called_inside_special_method(node)
- ):
- return
-
- self.add_message("protected-access", node=node, args=attrname)
-
- @staticmethod
- def _is_called_inside_special_method(node: nodes.NodeNG) -> bool:
- """
- Returns true if the node is located inside a special (aka dunder) method
- """
- try:
- frame_name = node.frame().name
- except AttributeError:
- return False
- return frame_name and frame_name in PYMETHODS
-
- def _is_type_self_call(self, expr):
- return (
- isinstance(expr, nodes.Call)
- and isinstance(expr.func, nodes.Name)
- and expr.func.name == "type"
- and len(expr.args) == 1
- and self._is_mandatory_method_param(expr.args[0])
- )
-
- @staticmethod
- def _is_classmethod(func):
- """Check if the given *func* node is a class method."""
-
- return isinstance(func, nodes.FunctionDef) and (
- func.type == "classmethod" or func.name == "__class_getitem__"
- )
-
- @staticmethod
- def _is_inferred_instance(expr, klass):
- """Check if the inferred value of the given *expr* is an instance of *klass*."""
-
- inferred = safe_infer(expr)
- if not isinstance(inferred, astroid.Instance):
- return False
-
- return inferred._proxied is klass
-
- @staticmethod
- def _is_class_attribute(name, klass):
- """Check if the given attribute *name* is a class or instance member of the given *klass*.
-
- Returns ``True`` if the name is a property in the given klass,
- ``False`` otherwise.
- """
-
- try:
- klass.getattr(name)
- return True
- except astroid.NotFoundError:
- pass
-
- try:
- klass.instance_attr(name)
- return True
- except astroid.NotFoundError:
- return False
-
- def visit_name(self, node: nodes.Name) -> None:
- """check if the name handle an access to a class member
- if so, register it
- """
- if self._first_attrs and (
- node.name == self._first_attrs[-1] or not self._first_attrs[-1]
- ):
- self._meth_could_be_func = False
-
- def _check_accessed_members(self, node, accessed):
- """check that accessed members are defined"""
- excs = ("AttributeError", "Exception", "BaseException")
- for attr, nodes_lst in accessed.items():
- try:
- # is it a class attribute ?
- node.local_attr(attr)
- # yes, stop here
- continue
- except astroid.NotFoundError:
- pass
- # is it an instance attribute of a parent class ?
- try:
- next(node.instance_attr_ancestors(attr))
- # yes, stop here
- continue
- except StopIteration:
- pass
- # is it an instance attribute ?
- try:
- defstmts = node.instance_attr(attr)
- except astroid.NotFoundError:
- pass
- else:
- # filter out augment assignment nodes
- defstmts = [stmt for stmt in defstmts if stmt not in nodes_lst]
- if not defstmts:
- # only augment assignment for this node, no-member should be
- # triggered by the typecheck checker
- continue
- # filter defstmts to only pick the first one when there are
- # several assignments in the same scope
- scope = defstmts[0].scope()
- defstmts = [
- stmt
- for i, stmt in enumerate(defstmts)
- if i == 0 or stmt.scope() is not scope
- ]
- # if there are still more than one, don't attempt to be smarter
- # than we can be
- if len(defstmts) == 1:
- defstmt = defstmts[0]
- # check that if the node is accessed in the same method as
- # it's defined, it's accessed after the initial assignment
- frame = defstmt.frame()
- lno = defstmt.fromlineno
- for _node in nodes_lst:
- if (
- _node.frame() is frame
- and _node.fromlineno < lno
- and not astroid.are_exclusive(
- _node.statement(future=True), defstmt, excs
- )
- ):
- self.add_message(
- "access-member-before-definition",
- node=_node,
- args=(attr, lno),
- )
-
- def _check_first_arg_for_type(self, node, metaclass=0):
- """check the name of first argument, expect:
-
- * 'self' for a regular method
- * 'cls' for a class method or a metaclass regular method (actually
- valid-classmethod-first-arg value)
- * 'mcs' for a metaclass class method (actually
- valid-metaclass-classmethod-first-arg)
- * not one of the above for a static method
- """
- # don't care about functions with unknown argument (builtins)
- if node.args.args is None:
- return
- if node.args.posonlyargs:
- first_arg = node.args.posonlyargs[0].name
- elif node.args.args:
- first_arg = node.argnames()[0]
- else:
- first_arg = None
- self._first_attrs.append(first_arg)
- first = self._first_attrs[-1]
- # static method
- if node.type == "staticmethod":
- if (
- first_arg == "self"
- or first_arg in self.config.valid_classmethod_first_arg
- or first_arg in self.config.valid_metaclass_classmethod_first_arg
- ):
- self.add_message("bad-staticmethod-argument", args=first, node=node)
- return
- self._first_attrs[-1] = None
- # class / regular method with no args
- elif not node.args.args and not node.args.posonlyargs:
- self.add_message("no-method-argument", node=node)
- # metaclass
- elif metaclass:
- # metaclass __new__ or classmethod
- if node.type == "classmethod":
- self._check_first_arg_config(
- first,
- self.config.valid_metaclass_classmethod_first_arg,
- node,
- "bad-mcs-classmethod-argument",
- node.name,
- )
- # metaclass regular method
- else:
- self._check_first_arg_config(
- first,
- self.config.valid_classmethod_first_arg,
- node,
- "bad-mcs-method-argument",
- node.name,
- )
- # regular class with class method
- elif node.type == "classmethod" or node.name == "__class_getitem__":
- self._check_first_arg_config(
- first,
- self.config.valid_classmethod_first_arg,
- node,
- "bad-classmethod-argument",
- node.name,
- )
- # regular class with regular method without self as argument
- elif first != "self":
- self.add_message("no-self-argument", node=node)
-
- def _check_first_arg_config(self, first, config, node, message, method_name):
- if first not in config:
- if len(config) == 1:
- valid = repr(config[0])
- else:
- valid = ", ".join(repr(v) for v in config[:-1])
- valid = f"{valid} or {config[-1]!r}"
- self.add_message(message, args=(method_name, valid), node=node)
-
- def _check_bases_classes(self, node):
- """check that the given class node implements abstract methods from
- base classes
- """
-
- def is_abstract(method):
- return method.is_abstract(pass_is_abstract=False)
-
- # check if this class abstract
- if class_is_abstract(node):
- return
-
- methods = sorted(
- unimplemented_abstract_methods(node, is_abstract).items(),
- key=lambda item: item[0],
- )
- for name, method in methods:
- owner = method.parent.frame()
- if owner is node:
- continue
- # owner is not this class, it must be a parent class
- # check that the ancestor's method is not abstract
- if name in node.locals:
- # it is redefined as an attribute or with a descriptor
- continue
- self.add_message("abstract-method", node=node, args=(name, owner.name))
-
- def _check_init(self, node):
- """check that the __init__ method call super or ancestors'__init__
- method (unless it is used for type hinting with `typing.overload`)
- """
- if not self.linter.is_message_enabled(
- "super-init-not-called"
- ) and not self.linter.is_message_enabled("non-parent-init-called"):
- return
- klass_node = node.parent.frame()
- to_call = _ancestors_to_call(klass_node)
- not_called_yet = dict(to_call)
- for stmt in node.nodes_of_class(nodes.Call):
- expr = stmt.func
- if not isinstance(expr, nodes.Attribute) or expr.attrname != "__init__":
- continue
- # skip the test if using super
- if (
- isinstance(expr.expr, nodes.Call)
- and isinstance(expr.expr.func, nodes.Name)
- and expr.expr.func.name == "super"
- ):
- return
- try:
- for klass in expr.expr.infer():
- if klass is astroid.Uninferable:
- continue
- # The inferred klass can be super(), which was
- # assigned to a variable and the `__init__`
- # was called later.
- #
- # base = super()
- # base.__init__(...)
-
- if (
- isinstance(klass, astroid.Instance)
- and isinstance(klass._proxied, nodes.ClassDef)
- and is_builtin_object(klass._proxied)
- and klass._proxied.name == "super"
- ):
- return
- if isinstance(klass, astroid.objects.Super):
- return
- try:
- del not_called_yet[klass]
- except KeyError:
- if klass not in to_call:
- self.add_message(
- "non-parent-init-called", node=expr, args=klass.name
- )
- except astroid.InferenceError:
- continue
- for klass, method in not_called_yet.items():
- if decorated_with(node, ["typing.overload"]):
- continue
- cls = node_frame_class(method)
- if klass.name == "object" or (cls and cls.name == "object"):
- continue
- self.add_message("super-init-not-called", args=klass.name, node=node)
-
- def _check_signature(self, method1, refmethod, class_type, cls):
- """check that the signature of the two given methods match"""
- if not (
- isinstance(method1, nodes.FunctionDef)
- and isinstance(refmethod, nodes.FunctionDef)
- ):
- self.add_message(
- "method-check-failed", args=(method1, refmethod), node=method1
- )
- return
-
- instance = cls.instantiate_class()
- method1 = astroid.scoped_nodes.function_to_method(method1, instance)
- refmethod = astroid.scoped_nodes.function_to_method(refmethod, instance)
-
- # Don't care about functions with unknown argument (builtins).
- if method1.args.args is None or refmethod.args.args is None:
- return
-
- # Ignore private to class methods.
- if is_attr_private(method1.name):
- return
- # Ignore setters, they have an implicit extra argument,
- # which shouldn't be taken in consideration.
- if is_property_setter(method1):
- return
-
- arg_differ_output = _different_parameters(
- refmethod, method1, dummy_parameter_regex=self._dummy_rgx
- )
- if len(arg_differ_output) > 0:
- for msg in arg_differ_output:
- if "Number" in msg:
- total_args_method1 = len(method1.args.args)
- if method1.args.vararg:
- total_args_method1 += 1
- if method1.args.kwarg:
- total_args_method1 += 1
- if method1.args.kwonlyargs:
- total_args_method1 += len(method1.args.kwonlyargs)
- total_args_refmethod = len(refmethod.args.args)
- if refmethod.args.vararg:
- total_args_refmethod += 1
- if refmethod.args.kwarg:
- total_args_refmethod += 1
- if refmethod.args.kwonlyargs:
- total_args_refmethod += len(refmethod.args.kwonlyargs)
- error_type = "arguments-differ"
- msg_args = (
- msg
- + f"was {total_args_refmethod} in '{refmethod.parent.name}.{refmethod.name}' and "
- f"is now {total_args_method1} in",
- class_type,
- f"{method1.parent.name}.{method1.name}",
- )
- elif "renamed" in msg:
- error_type = "arguments-renamed"
- msg_args = (
- msg,
- class_type,
- f"{method1.parent.name}.{method1.name}",
- )
- else:
- error_type = "arguments-differ"
- msg_args = (
- msg,
- class_type,
- f"{method1.parent.name}.{method1.name}",
- )
- self.add_message(error_type, args=msg_args, node=method1)
- elif (
- len(method1.args.defaults) < len(refmethod.args.defaults)
- and not method1.args.vararg
- ):
- self.add_message(
- "signature-differs", args=(class_type, method1.name), node=method1
- )
-
- def _uses_mandatory_method_param(self, node):
- """Check that attribute lookup name use first attribute variable name
-
- Name is `self` for method, `cls` for classmethod and `mcs` for metaclass.
- """
- return self._is_mandatory_method_param(node.expr)
-
- def _is_mandatory_method_param(self, node):
- """Check if nodes.Name corresponds to first attribute variable name
-
- Name is `self` for method, `cls` for classmethod and `mcs` for metaclass.
- """
- return (
- self._first_attrs
- and isinstance(node, nodes.Name)
- and node.name == self._first_attrs[-1]
- )
-
-
-def _ancestors_to_call(klass_node, method="__init__"):
- """return a dictionary where keys are the list of base classes providing
- the queried method, and so that should/may be called from the method node
- """
- to_call = {}
- for base_node in klass_node.ancestors(recurs=False):
- try:
- to_call[base_node] = next(base_node.igetattr(method))
- except astroid.InferenceError:
- continue
- return to_call
def register(linter):
diff --git a/pylint/checkers/classes/class_checker.py b/pylint/checkers/classes/class_checker.py
new file mode 100644
index 000000000..b76e10e43
--- /dev/null
+++ b/pylint/checkers/classes/class_checker.py
@@ -0,0 +1,2052 @@
+# Copyright (c) 2006-2016 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
+# Copyright (c) 2010 Maarten ter Huurne <maarten@treewalker.org>
+# Copyright (c) 2012-2014 Google, Inc.
+# Copyright (c) 2012 FELD Boris <lothiraldan@gmail.com>
+# Copyright (c) 2013-2020 Claudiu Popa <pcmanticore@gmail.com>
+# Copyright (c) 2014 Michal Nowikowski <godfryd@gmail.com>
+# Copyright (c) 2014 Brett Cannon <brett@python.org>
+# Copyright (c) 2014 Arun Persaud <arun@nubati.net>
+# Copyright (c) 2014 David Pursehouse <david.pursehouse@gmail.com>
+# Copyright (c) 2015 Dmitry Pribysh <dmand@yandex.ru>
+# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
+# Copyright (c) 2016-2017 Łukasz Rogalski <rogalski.91@gmail.com>
+# Copyright (c) 2016 Alexander Todorov <atodorov@otb.bg>
+# Copyright (c) 2016 Anthony Foglia <afoglia@users.noreply.github.com>
+# Copyright (c) 2016 Florian Bruhin <me@the-compiler.org>
+# Copyright (c) 2016 Moises Lopez <moylop260@vauxoo.com>
+# Copyright (c) 2016 Jakub Wilk <jwilk@jwilk.net>
+# Copyright (c) 2017, 2019-2020 hippo91 <guillaume.peillex@gmail.com>
+# Copyright (c) 2018, 2021 Ville Skyttä <ville.skytta@iki.fi>
+# Copyright (c) 2018, 2020 Anthony Sottile <asottile@umich.edu>
+# Copyright (c) 2018-2019 Nick Drozd <nicholasdrozd@gmail.com>
+# Copyright (c) 2018-2019 Ashley Whetter <ashley@awhetter.co.uk>
+# Copyright (c) 2018 Lucas Cimon <lucas.cimon@gmail.com>
+# Copyright (c) 2018 Bryce Guinta <bryce.paul.guinta@gmail.com>
+# Copyright (c) 2018 ssolanki <sushobhitsolanki@gmail.com>
+# Copyright (c) 2018 Ben Green <benhgreen@icloud.com>
+# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
+# Copyright (c) 2019 mattlbeck <17108752+mattlbeck@users.noreply.github.com>
+# Copyright (c) 2019-2020 craig-sh <craig-sh@users.noreply.github.com>
+# Copyright (c) 2019 Janne Rönkkö <jannero@users.noreply.github.com>
+# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
+# Copyright (c) 2019 Grygorii Iermolenko <gyermolenko@gmail.com>
+# Copyright (c) 2019 Andrzej Klajnert <github@aklajnert.pl>
+# Copyright (c) 2019 Pascal Corpet <pcorpet@users.noreply.github.com>
+# Copyright (c) 2020 GergelyKalmar <gergely.kalmar@logikal.jp>
+# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
+# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
+# Copyright (c) 2021 Mark Byrne <31762852+mbyrnepr2@users.noreply.github.com>
+# Copyright (c) 2021 Samuel Freilich <sfreilich@google.com>
+# Copyright (c) 2021 Nick Pesce <nickpesce22@gmail.com>
+# Copyright (c) 2021 bot <bot@noreply.github.com>
+# Copyright (c) 2021 Yu Shao, Pang <36848472+yushao2@users.noreply.github.com>
+# Copyright (c) 2021 SupImDos <62866982+SupImDos@users.noreply.github.com>
+# Copyright (c) 2021 Kayran Schmidt <59456929+yumasheta@users.noreply.github.com>
+# Copyright (c) 2021 Konstantina Saketou <56515303+ksaketou@users.noreply.github.com>
+# Copyright (c) 2021 James Sinclair <james@nurfherder.com>
+# Copyright (c) 2021 tiagohonorato <61059243+tiagohonorato@users.noreply.github.com>
+
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+
+"""Classes checker for Python code"""
+import collections
+from itertools import chain, zip_longest
+from typing import List, Pattern
+
+import astroid
+from astroid import nodes
+
+from pylint.checkers import BaseChecker, utils
+from pylint.checkers.utils import (
+ PYMETHODS,
+ check_messages,
+ class_is_abstract,
+ decorated_with,
+ decorated_with_property,
+ get_outer_class,
+ has_known_bases,
+ is_attr_private,
+ is_attr_protected,
+ is_builtin_object,
+ is_comprehension,
+ is_iterable,
+ is_overload_stub,
+ is_property_setter,
+ is_property_setter_or_deleter,
+ is_protocol_class,
+ node_frame_class,
+ overrides_a_method,
+ safe_infer,
+ unimplemented_abstract_methods,
+ uninferable_final_decorators,
+)
+from pylint.interfaces import IAstroidChecker
+from pylint.utils import get_global_option
+
+INVALID_BASE_CLASSES = {"bool", "range", "slice", "memoryview"}
+BUILTIN_DECORATORS = {"builtins.property", "builtins.classmethod"}
+ASTROID_TYPE_COMPARATORS = {
+ nodes.Const: lambda a, b: a.value == b.value,
+ nodes.ClassDef: lambda a, b: a.qname == b.qname,
+ nodes.Tuple: lambda a, b: a.elts == b.elts,
+ nodes.List: lambda a, b: a.elts == b.elts,
+ nodes.Dict: lambda a, b: a.items == b.items,
+ nodes.Name: lambda a, b: set(a.infer()) == set(b.infer()),
+}
+
+# Dealing with useless override detection, with regard
+# to parameters vs arguments
+
+_CallSignature = collections.namedtuple(
+ "_CallSignature", "args kws starred_args starred_kws"
+)
+_ParameterSignature = collections.namedtuple(
+ "_ParameterSignature", "args kwonlyargs varargs kwargs"
+)
+
+
+def _signature_from_call(call):
+ kws = {}
+ args = []
+ starred_kws = []
+ starred_args = []
+ for keyword in call.keywords or []:
+ arg, value = keyword.arg, keyword.value
+ if arg is None and isinstance(value, nodes.Name):
+ # Starred node and we are interested only in names,
+ # otherwise some transformation might occur for the parameter.
+ starred_kws.append(value.name)
+ elif isinstance(value, nodes.Name):
+ kws[arg] = value.name
+ else:
+ kws[arg] = None
+
+ for arg in call.args:
+ if isinstance(arg, nodes.Starred) and isinstance(arg.value, nodes.Name):
+ # Positional variadic and a name, otherwise some transformation
+ # might have occurred.
+ starred_args.append(arg.value.name)
+ elif isinstance(arg, nodes.Name):
+ args.append(arg.name)
+ else:
+ args.append(None)
+
+ return _CallSignature(args, kws, starred_args, starred_kws)
+
+
+def _signature_from_arguments(arguments):
+ kwarg = arguments.kwarg
+ vararg = arguments.vararg
+ args = [
+ arg.name
+ for arg in chain(arguments.posonlyargs, arguments.args)
+ if arg.name != "self"
+ ]
+ kwonlyargs = [arg.name for arg in arguments.kwonlyargs]
+ return _ParameterSignature(args, kwonlyargs, vararg, kwarg)
+
+
+def _definition_equivalent_to_call(definition, call):
+ """Check if a definition signature is equivalent to a call."""
+ if definition.kwargs:
+ if definition.kwargs not in call.starred_kws:
+ return False
+ elif call.starred_kws:
+ return False
+ if definition.varargs:
+ if definition.varargs not in call.starred_args:
+ return False
+ elif call.starred_args:
+ return False
+ if any(kw not in call.kws for kw in definition.kwonlyargs):
+ return False
+ if definition.args != call.args:
+ return False
+
+ # No extra kwargs in call.
+ return all(kw in call.args or kw in definition.kwonlyargs for kw in call.kws)
+
+
+# Deal with parameters overriding in two methods.
+
+
+def _positional_parameters(method):
+ positional = method.args.args
+ if method.is_bound() and method.type in {"classmethod", "method"}:
+ positional = positional[1:]
+ return positional
+
+
+class _DefaultMissing:
+ """Sentinel value for missing arg default, use _DEFAULT_MISSING."""
+
+
+_DEFAULT_MISSING = _DefaultMissing()
+
+
+def _has_different_parameters_default_value(original, overridden):
+ """
+ Check if original and overridden methods arguments have different default values
+
+ Return True if one of the overridden arguments has a default
+ value different from the default value of the original argument
+ If one of the method doesn't have argument (.args is None)
+ return False
+ """
+ if original.args is None or overridden.args is None:
+ return False
+
+ for param in chain(original.args, original.kwonlyargs):
+ try:
+ original_default = original.default_value(param.name)
+ except astroid.exceptions.NoDefault:
+ original_default = _DEFAULT_MISSING
+ try:
+ overridden_default = overridden.default_value(param.name)
+ if original_default is _DEFAULT_MISSING:
+ # Only the original has a default.
+ return True
+ except astroid.exceptions.NoDefault:
+ if original_default is _DEFAULT_MISSING:
+ # Both have a default, no difference
+ continue
+ # Only the override has a default.
+ return True
+
+ original_type = type(original_default)
+ if not isinstance(overridden_default, original_type):
+ # Two args with same name but different types
+ return True
+ is_same_fn = ASTROID_TYPE_COMPARATORS.get(original_type)
+ if is_same_fn is None:
+ # If the default value comparison is unhandled, assume the value is different
+ return True
+ if not is_same_fn(original_default, overridden_default):
+ # Two args with same type but different values
+ return True
+ return False
+
+
+def _has_different_parameters(
+ original: List[nodes.AssignName],
+ overridden: List[nodes.AssignName],
+ dummy_parameter_regex: Pattern,
+) -> List[str]:
+ result = []
+ zipped = zip_longest(original, overridden)
+ for original_param, overridden_param in zipped:
+ params = (original_param, overridden_param)
+ if not all(params):
+ return ["Number of parameters "]
+
+ # check for the arguments' name
+ names = [param.name for param in params]
+ if any(dummy_parameter_regex.match(name) for name in names):
+ continue
+ if original_param.name != overridden_param.name:
+ result.append(
+ f"Parameter '{original_param.name}' has been renamed "
+ f"to '{overridden_param.name}' in"
+ )
+
+ return result
+
+
+def _different_parameters(
+ original: nodes.FunctionDef,
+ overridden: nodes.FunctionDef,
+ dummy_parameter_regex: Pattern,
+) -> List[str]:
+ """Determine if the two methods have different parameters
+
+ They are considered to have different parameters if:
+
+ * they have different positional parameters, including different names
+
+ * one of the methods is having variadics, while the other is not
+
+ * they have different keyword only parameters.
+
+ """
+ output_messages = []
+ original_parameters = _positional_parameters(original)
+ overridden_parameters = _positional_parameters(overridden)
+
+ # Copy kwonlyargs list so that we don't affect later function linting
+ original_kwonlyargs = original.args.kwonlyargs
+
+ # Allow positional/keyword variadic in overridden to match against any
+ # positional/keyword argument in original.
+ # Keep any arguments that are found separately in overridden to satisfy
+ # later tests
+ if overridden.args.vararg:
+ overridden_names = [v.name for v in overridden_parameters]
+ original_parameters = [
+ v for v in original_parameters if v.name in overridden_names
+ ]
+
+ if overridden.args.kwarg:
+ overridden_names = [v.name for v in overridden.args.kwonlyargs]
+ original_kwonlyargs = [
+ v for v in original.args.kwonlyargs if v.name in overridden_names
+ ]
+
+ different_positional = _has_different_parameters(
+ original_parameters, overridden_parameters, dummy_parameter_regex
+ )
+ different_kwonly = _has_different_parameters(
+ original_kwonlyargs, overridden.args.kwonlyargs, dummy_parameter_regex
+ )
+ if different_kwonly and different_positional:
+ if "Number " in different_positional[0] and "Number " in different_kwonly[0]:
+ output_messages.append("Number of parameters ")
+ output_messages += different_positional[1:]
+ output_messages += different_kwonly[1:]
+ else:
+ output_messages += different_positional
+ output_messages += different_kwonly
+ else:
+ if different_positional:
+ output_messages += different_positional
+ if different_kwonly:
+ output_messages += different_kwonly
+
+ if original.name in PYMETHODS:
+ # Ignore the difference for special methods. If the parameter
+ # numbers are different, then that is going to be caught by
+ # unexpected-special-method-signature.
+ # If the names are different, it doesn't matter, since they can't
+ # be used as keyword arguments anyway.
+ output_messages.clear()
+
+ # Arguments will only violate LSP if there are variadics in the original
+ # that are then removed from the overridden
+ kwarg_lost = original.args.kwarg and not overridden.args.kwarg
+ vararg_lost = original.args.vararg and not overridden.args.vararg
+
+ if kwarg_lost or vararg_lost:
+ output_messages += ["Variadics removed in"]
+
+ return output_messages
+
+
+def _is_invalid_base_class(cls):
+ return cls.name in INVALID_BASE_CLASSES and is_builtin_object(cls)
+
+
+def _has_data_descriptor(cls, attr):
+ attributes = cls.getattr(attr)
+ for attribute in attributes:
+ try:
+ for inferred in attribute.infer():
+ if isinstance(inferred, astroid.Instance):
+ try:
+ inferred.getattr("__get__")
+ inferred.getattr("__set__")
+ except astroid.NotFoundError:
+ continue
+ else:
+ return True
+ except astroid.InferenceError:
+ # Can't infer, avoid emitting a false positive in this case.
+ return True
+ return False
+
+
+def _called_in_methods(func, klass, methods):
+ """Check if the func was called in any of the given methods,
+ belonging to the *klass*. Returns True if so, False otherwise.
+ """
+ if not isinstance(func, nodes.FunctionDef):
+ return False
+ for method in methods:
+ try:
+ inferred = klass.getattr(method)
+ except astroid.NotFoundError:
+ continue
+ for infer_method in inferred:
+ for call in infer_method.nodes_of_class(nodes.Call):
+ try:
+ bound = next(call.func.infer())
+ except (astroid.InferenceError, StopIteration):
+ continue
+ if not isinstance(bound, astroid.BoundMethod):
+ continue
+ func_obj = bound._proxied
+ if isinstance(func_obj, astroid.UnboundMethod):
+ func_obj = func_obj._proxied
+ if func_obj.name == func.name:
+ return True
+ return False
+
+
+def _is_attribute_property(name, klass):
+ """Check if the given attribute *name* is a property in the given *klass*.
+
+ It will look for `property` calls or for functions
+ with the given name, decorated by `property` or `property`
+ subclasses.
+ Returns ``True`` if the name is a property in the given klass,
+ ``False`` otherwise.
+ """
+
+ try:
+ attributes = klass.getattr(name)
+ except astroid.NotFoundError:
+ return False
+ property_name = "builtins.property"
+ for attr in attributes:
+ if attr is astroid.Uninferable:
+ continue
+ try:
+ inferred = next(attr.infer())
+ except astroid.InferenceError:
+ continue
+ if isinstance(inferred, nodes.FunctionDef) and decorated_with_property(
+ inferred
+ ):
+ return True
+ if inferred.pytype() != property_name:
+ continue
+
+ cls = node_frame_class(inferred)
+ if cls == klass.declared_metaclass():
+ continue
+ return True
+ return False
+
+
+def _has_bare_super_call(fundef_node):
+ for call in fundef_node.nodes_of_class(nodes.Call):
+ func = call.func
+ if isinstance(func, nodes.Name) and func.name == "super" and not call.args:
+ return True
+ return False
+
+
+def _has_same_layout_slots(slots, assigned_value):
+ inferred = next(assigned_value.infer())
+ if isinstance(inferred, nodes.ClassDef):
+ other_slots = inferred.slots()
+ if all(
+ first_slot and second_slot and first_slot.value == second_slot.value
+ for (first_slot, second_slot) in zip_longest(slots, other_slots)
+ ):
+ return True
+ return False
+
+
+MSGS = { # pylint: disable=consider-using-namedtuple-or-dataclass
+ "F0202": (
+ "Unable to check methods signature (%s / %s)",
+ "method-check-failed",
+ "Used when Pylint has been unable to check methods signature "
+ "compatibility for an unexpected reason. Please report this kind "
+ "if you don't make sense of it.",
+ ),
+ "E0202": (
+ "An attribute defined in %s line %s hides this method",
+ "method-hidden",
+ "Used when a class defines a method which is hidden by an "
+ "instance attribute from an ancestor class or set by some "
+ "client code.",
+ ),
+ "E0203": (
+ "Access to member %r before its definition line %s",
+ "access-member-before-definition",
+ "Used when an instance member is accessed before it's actually assigned.",
+ ),
+ "W0201": (
+ "Attribute %r defined outside __init__",
+ "attribute-defined-outside-init",
+ "Used when an instance attribute is defined outside the __init__ method.",
+ ),
+ "W0212": (
+ "Access to a protected member %s of a client class", # E0214
+ "protected-access",
+ "Used when a protected member (i.e. class member with a name "
+ "beginning with an underscore) is access outside the class or a "
+ "descendant of the class where it's defined.",
+ ),
+ "E0211": (
+ "Method has no argument",
+ "no-method-argument",
+ "Used when a method which should have the bound instance as "
+ "first argument has no argument defined.",
+ ),
+ "E0213": (
+ 'Method should have "self" as first argument',
+ "no-self-argument",
+ 'Used when a method has an attribute different the "self" as '
+ "first argument. This is considered as an error since this is "
+ "a so common convention that you shouldn't break it!",
+ ),
+ "C0202": (
+ "Class method %s should have %s as first argument",
+ "bad-classmethod-argument",
+ "Used when a class method has a first argument named differently "
+ "than the value specified in valid-classmethod-first-arg option "
+ '(default to "cls"), recommended to easily differentiate them '
+ "from regular instance methods.",
+ ),
+ "C0203": (
+ "Metaclass method %s should have %s as first argument",
+ "bad-mcs-method-argument",
+ "Used when a metaclass method has a first argument named "
+ "differently than the value specified in valid-classmethod-first"
+ '-arg option (default to "cls"), recommended to easily '
+ "differentiate them from regular instance methods.",
+ ),
+ "C0204": (
+ "Metaclass class method %s should have %s as first argument",
+ "bad-mcs-classmethod-argument",
+ "Used when a metaclass class method has a first argument named "
+ "differently than the value specified in valid-metaclass-"
+ 'classmethod-first-arg option (default to "mcs"), recommended to '
+ "easily differentiate them from regular instance methods.",
+ ),
+ "W0211": (
+ "Static method with %r as first argument",
+ "bad-staticmethod-argument",
+ 'Used when a static method has "self" or a value specified in '
+ "valid-classmethod-first-arg option or "
+ "valid-metaclass-classmethod-first-arg option as first argument.",
+ ),
+ "R0201": (
+ "Method could be a function",
+ "no-self-use",
+ "Used when a method doesn't use its bound instance, and so could "
+ "be written as a function.",
+ ),
+ "W0221": (
+ "%s %s %r method",
+ "arguments-differ",
+ "Used when a method has a different number of arguments than in "
+ "the implemented interface or in an overridden method.",
+ ),
+ "W0222": (
+ "Signature differs from %s %r method",
+ "signature-differs",
+ "Used when a method signature is different than in the "
+ "implemented interface or in an overridden method.",
+ ),
+ "W0223": (
+ "Method %r is abstract in class %r but is not overridden",
+ "abstract-method",
+ "Used when an abstract method (i.e. raise NotImplementedError) is "
+ "not overridden in concrete class.",
+ ),
+ "W0231": (
+ "__init__ method from base class %r is not called",
+ "super-init-not-called",
+ "Used when an ancestor class method has an __init__ method "
+ "which is not called by a derived class.",
+ ),
+ "W0232": (
+ "Class has no __init__ method",
+ "no-init",
+ "Used when a class has no __init__ method, neither its parent classes.",
+ ),
+ "W0233": (
+ "__init__ method from a non direct base class %r is called",
+ "non-parent-init-called",
+ "Used when an __init__ method is called on a class which is not "
+ "in the direct ancestors for the analysed class.",
+ ),
+ "W0235": (
+ "Useless super delegation in method %r",
+ "useless-super-delegation",
+ "Used whenever we can detect that an overridden method is useless, "
+ "relying on super() delegation to do the same thing as another method "
+ "from the MRO.",
+ ),
+ "W0236": (
+ "Method %r was expected to be %r, found it instead as %r",
+ "invalid-overridden-method",
+ "Used when we detect that a method was overridden in a way "
+ "that does not match its base class "
+ "which could result in potential bugs at runtime.",
+ ),
+ "W0237": (
+ "%s %s %r method",
+ "arguments-renamed",
+ "Used when a method parameter has a different name than in "
+ "the implemented interface or in an overridden method.",
+ ),
+ "W0238": (
+ "Unused private member `%s.%s`",
+ "unused-private-member",
+ "Emitted when a private member of a class is defined but not used.",
+ ),
+ "W0239": (
+ "Method %r overrides a method decorated with typing.final which is defined in class %r",
+ "overridden-final-method",
+ "Used when a method decorated with typing.final has been overridden.",
+ ),
+ "W0240": (
+ "Class %r is a subclass of a class decorated with typing.final: %r",
+ "subclassed-final-class",
+ "Used when a class decorated with typing.final has been subclassed.",
+ ),
+ "E0236": (
+ "Invalid object %r in __slots__, must contain only non empty strings",
+ "invalid-slots-object",
+ "Used when an invalid (non-string) object occurs in __slots__.",
+ ),
+ "E0237": (
+ "Assigning to attribute %r not defined in class slots",
+ "assigning-non-slot",
+ "Used when assigning to an attribute not defined in the class slots.",
+ ),
+ "E0238": (
+ "Invalid __slots__ object",
+ "invalid-slots",
+ "Used when an invalid __slots__ is found in class. "
+ "Only a string, an iterable or a sequence is permitted.",
+ ),
+ "E0239": (
+ "Inheriting %r, which is not a class.",
+ "inherit-non-class",
+ "Used when a class inherits from something which is not a class.",
+ ),
+ "E0240": (
+ "Inconsistent method resolution order for class %r",
+ "inconsistent-mro",
+ "Used when a class has an inconsistent method resolution order.",
+ ),
+ "E0241": (
+ "Duplicate bases for class %r",
+ "duplicate-bases",
+ "Used when a class has duplicate bases.",
+ ),
+ "E0242": (
+ "Value %r in slots conflicts with class variable",
+ "class-variable-slots-conflict",
+ "Used when a value in __slots__ conflicts with a class variable, property or method.",
+ ),
+ "E0243": (
+ "Invalid __class__ object",
+ "invalid-class-object",
+ "Used when an invalid object is assigned to a __class__ property. "
+ "Only a class is permitted.",
+ ),
+ "R0202": (
+ "Consider using a decorator instead of calling classmethod",
+ "no-classmethod-decorator",
+ "Used when a class method is defined without using the decorator syntax.",
+ ),
+ "R0203": (
+ "Consider using a decorator instead of calling staticmethod",
+ "no-staticmethod-decorator",
+ "Used when a static method is defined without using the decorator syntax.",
+ ),
+ "C0205": (
+ "Class __slots__ should be a non-string iterable",
+ "single-string-used-for-slots",
+ "Used when a class __slots__ is a simple string, rather than an iterable.",
+ ),
+ "R0205": (
+ "Class %r inherits from object, can be safely removed from bases in python3",
+ "useless-object-inheritance",
+ "Used when a class inherit from object, which under python3 is implicit, "
+ "hence can be safely removed from bases.",
+ ),
+ "R0206": (
+ "Cannot have defined parameters for properties",
+ "property-with-parameters",
+ "Used when we detect that a property also has parameters, which are useless, "
+ "given that properties cannot be called with additional arguments.",
+ ),
+}
+
+
+def _scope_default():
+ return collections.defaultdict(list)
+
+
+class ScopeAccessMap:
+ """Store the accessed variables per scope."""
+
+ def __init__(self):
+ self._scopes = collections.defaultdict(_scope_default)
+
+ def set_accessed(self, node):
+ """Set the given node as accessed."""
+
+ frame = node_frame_class(node)
+ if frame is None:
+ # The node does not live in a class.
+ return
+ self._scopes[frame][node.attrname].append(node)
+
+ def accessed(self, scope):
+ """Get the accessed variables for the given scope."""
+ return self._scopes.get(scope, {})
+
+
+class ClassChecker(BaseChecker):
+ """checks for :
+ * methods without self as first argument
+ * overridden methods signature
+ * access only to existent members via self
+ * attributes not defined in the __init__ method
+ * unreachable code
+ """
+
+ __implements__ = (IAstroidChecker,)
+
+ # configuration section name
+ name = "classes"
+ # messages
+ msgs = MSGS
+ priority = -2
+ # configuration options
+ options = (
+ (
+ "defining-attr-methods",
+ {
+ "default": ("__init__", "__new__", "setUp", "__post_init__"),
+ "type": "csv",
+ "metavar": "<method names>",
+ "help": "List of method names used to declare (i.e. assign) \
+instance attributes.",
+ },
+ ),
+ (
+ "valid-classmethod-first-arg",
+ {
+ "default": ("cls",),
+ "type": "csv",
+ "metavar": "<argument names>",
+ "help": "List of valid names for the first argument in \
+a class method.",
+ },
+ ),
+ (
+ "valid-metaclass-classmethod-first-arg",
+ {
+ "default": ("cls",),
+ "type": "csv",
+ "metavar": "<argument names>",
+ "help": "List of valid names for the first argument in \
+a metaclass class method.",
+ },
+ ),
+ (
+ "exclude-protected",
+ {
+ "default": (
+ # namedtuple public API.
+ "_asdict",
+ "_fields",
+ "_replace",
+ "_source",
+ "_make",
+ ),
+ "type": "csv",
+ "metavar": "<protected access exclusions>",
+ "help": (
+ "List of member names, which should be excluded "
+ "from the protected access warning."
+ ),
+ },
+ ),
+ (
+ "check-protected-access-in-special-methods",
+ {
+ "default": False,
+ "type": "yn",
+ "metavar": "<y or n>",
+ "help": "Warn about protected attribute access inside special methods",
+ },
+ ),
+ )
+
+ def __init__(self, linter=None):
+ super().__init__(linter)
+ self._accessed = ScopeAccessMap()
+ self._first_attrs = []
+ self._meth_could_be_func = None
+
+ def open(self) -> None:
+ self._mixin_class_rgx = get_global_option(self, "mixin-class-rgx")
+ py_version = get_global_option(self, "py-version")
+ self._py38_plus = py_version >= (3, 8)
+
+ @astroid.decorators.cachedproperty
+ def _dummy_rgx(self):
+ return get_global_option(self, "dummy-variables-rgx", default=None)
+
+ @astroid.decorators.cachedproperty
+ def _ignore_mixin(self):
+ return get_global_option(self, "ignore-mixin-members", default=True)
+
+ @check_messages(
+ "abstract-method",
+ "no-init",
+ "invalid-slots",
+ "single-string-used-for-slots",
+ "invalid-slots-object",
+ "class-variable-slots-conflict",
+ "inherit-non-class",
+ "useless-object-inheritance",
+ "inconsistent-mro",
+ "duplicate-bases",
+ )
+ def visit_classdef(self, node: nodes.ClassDef) -> None:
+ """init visit variable _accessed"""
+ self._check_bases_classes(node)
+ # if not an exception or a metaclass
+ if node.type == "class" and has_known_bases(node):
+ try:
+ node.local_attr("__init__")
+ except astroid.NotFoundError:
+ self.add_message("no-init", args=node, node=node)
+ self._check_slots(node)
+ self._check_proper_bases(node)
+ self._check_typing_final(node)
+ self._check_consistent_mro(node)
+
+ def _check_consistent_mro(self, node):
+ """Detect that a class has a consistent mro or duplicate bases."""
+ try:
+ node.mro()
+ except astroid.InconsistentMroError:
+ self.add_message("inconsistent-mro", args=node.name, node=node)
+ except astroid.DuplicateBasesError:
+ self.add_message("duplicate-bases", args=node.name, node=node)
+ except NotImplementedError:
+ # Old style class, there's no mro so don't do anything.
+ pass
+
+ def _check_proper_bases(self, node):
+ """
+ Detect that a class inherits something which is not
+ a class or a type.
+ """
+ for base in node.bases:
+ ancestor = safe_infer(base)
+ if not ancestor:
+ continue
+ if isinstance(ancestor, astroid.Instance) and ancestor.is_subtype_of(
+ "builtins.type"
+ ):
+ continue
+
+ if not isinstance(ancestor, nodes.ClassDef) or _is_invalid_base_class(
+ ancestor
+ ):
+ self.add_message("inherit-non-class", args=base.as_string(), node=node)
+
+ if ancestor.name == object.__name__:
+ self.add_message(
+ "useless-object-inheritance", args=node.name, node=node
+ )
+
+ def _check_typing_final(self, node: nodes.ClassDef) -> None:
+ """Detect that a class does not subclass a class decorated with `typing.final`"""
+ if not self._py38_plus:
+ return
+ for base in node.bases:
+ ancestor = safe_infer(base)
+ if not ancestor:
+ continue
+
+ if isinstance(ancestor, nodes.ClassDef) and (
+ decorated_with(ancestor, ["typing.final"])
+ or uninferable_final_decorators(ancestor.decorators)
+ ):
+ self.add_message(
+ "subclassed-final-class",
+ args=(node.name, ancestor.name),
+ node=node,
+ )
+
+ @check_messages("unused-private-member", "attribute-defined-outside-init")
+ def leave_classdef(self, node: nodes.ClassDef) -> None:
+ """close a class node:
+ check that instance attributes are defined in __init__ and check
+ access to existent members
+ """
+ self._check_unused_private_functions(node)
+ self._check_unused_private_variables(node)
+ self._check_unused_private_attributes(node)
+ self._check_attribute_defined_outside_init(node)
+
+ def _check_unused_private_functions(self, node: nodes.ClassDef) -> None:
+ for function_def in node.nodes_of_class(nodes.FunctionDef):
+ if not is_attr_private(function_def.name):
+ continue
+ parent_scope = function_def.parent.scope()
+ if isinstance(parent_scope, nodes.FunctionDef):
+ # Handle nested functions
+ if function_def.name in (
+ n.name for n in parent_scope.nodes_of_class(nodes.Name)
+ ):
+ continue
+ for attribute in node.nodes_of_class(nodes.Attribute):
+ if (
+ attribute.attrname != function_def.name
+ or attribute.scope() == function_def # We ignore recursive calls
+ ):
+ continue
+ if isinstance(attribute.expr, nodes.Name) and attribute.expr.name in (
+ "self",
+ "cls",
+ node.name,
+ ):
+ # self.__attrname
+ # cls.__attrname
+ # node_name.__attrname
+ break
+ if isinstance(attribute.expr, nodes.Call):
+ # type(self).__attrname
+ inferred = safe_infer(attribute.expr)
+ if (
+ isinstance(inferred, nodes.ClassDef)
+ and inferred.name == node.name
+ ):
+ break
+ else:
+ name_stack = []
+ curr = parent_scope
+ # Generate proper names for nested functions
+ while curr != node:
+ name_stack.append(curr.name)
+ curr = curr.parent.scope()
+
+ outer_level_names = f"{'.'.join(reversed(name_stack))}"
+ function_repr = f"{outer_level_names}.{function_def.name}({function_def.args.as_string()})"
+ self.add_message(
+ "unused-private-member",
+ node=function_def,
+ args=(node.name, function_repr.lstrip(".")),
+ )
+
+ def _check_unused_private_variables(self, node: nodes.ClassDef) -> None:
+ """Check if private variables are never used within a class"""
+ for assign_name in node.nodes_of_class(nodes.AssignName):
+ if isinstance(assign_name.parent, nodes.Arguments):
+ continue # Ignore function arguments
+ if not is_attr_private(assign_name.name):
+ continue
+ for child in node.nodes_of_class((nodes.Name, nodes.Attribute)):
+ if isinstance(child, nodes.Name) and child.name == assign_name.name:
+ break
+ if isinstance(child, nodes.Attribute):
+ if not isinstance(child.expr, nodes.Name):
+ break
+ if child.attrname == assign_name.name and child.expr.name in (
+ "self",
+ "cls",
+ node.name,
+ ):
+ break
+ else:
+ args = (node.name, assign_name.name)
+ self.add_message("unused-private-member", node=assign_name, args=args)
+
+ def _check_unused_private_attributes(self, node: nodes.ClassDef) -> None:
+ for assign_attr in node.nodes_of_class(nodes.AssignAttr):
+ if not is_attr_private(assign_attr.attrname) or not isinstance(
+ assign_attr.expr, nodes.Name
+ ):
+ continue
+
+ # Logic for checking false positive when using __new__,
+ # Get the returned object names of the __new__ magic function
+ # Then check if the attribute was consumed in other instance methods
+ acceptable_obj_names: List[str] = ["self"]
+ scope = assign_attr.scope()
+ if isinstance(scope, nodes.FunctionDef) and scope.name == "__new__":
+ acceptable_obj_names.extend(
+ [
+ return_node.value.name
+ for return_node in scope.nodes_of_class(nodes.Return)
+ if isinstance(return_node.value, nodes.Name)
+ ]
+ )
+
+ for attribute in node.nodes_of_class(nodes.Attribute):
+ if attribute.attrname != assign_attr.attrname:
+ continue
+
+ if (
+ assign_attr.expr.name
+ in {
+ "cls",
+ node.name,
+ }
+ and attribute.expr.name in {"cls", "self", node.name}
+ ):
+ # If assigned to cls or class name, can be accessed by cls/self/class name
+ break
+
+ if (
+ assign_attr.expr.name in acceptable_obj_names
+ and attribute.expr.name == "self"
+ ):
+ # If assigned to self.attrib, can only be accessed by self
+ # Or if __new__ was used, the returned object names are acceptable
+ break
+
+ if assign_attr.expr.name == attribute.expr.name == node.name:
+ # Recognise attributes which are accessed via the class name
+ break
+
+ else:
+ args = (node.name, assign_attr.attrname)
+ self.add_message("unused-private-member", node=assign_attr, args=args)
+
+ def _check_attribute_defined_outside_init(self, cnode: nodes.ClassDef) -> None:
+ # check access to existent members on non metaclass classes
+ if self._ignore_mixin and self._mixin_class_rgx.match(cnode.name):
+ # We are in a mixin class. No need to try to figure out if
+ # something is missing, since it is most likely that it will
+ # miss.
+ return
+
+ accessed = self._accessed.accessed(cnode)
+ if cnode.type != "metaclass":
+ self._check_accessed_members(cnode, accessed)
+ # checks attributes are defined in an allowed method such as __init__
+ if not self.linter.is_message_enabled("attribute-defined-outside-init"):
+ return
+ defining_methods = self.config.defining_attr_methods
+ current_module = cnode.root()
+ for attr, nodes_lst in cnode.instance_attrs.items():
+ # Exclude `__dict__` as it is already defined.
+ if attr == "__dict__":
+ continue
+
+ # Skip nodes which are not in the current module and it may screw up
+ # the output, while it's not worth it
+ nodes_lst = [
+ n
+ for n in nodes_lst
+ if not isinstance(
+ n.statement(future=True), (nodes.Delete, nodes.AugAssign)
+ )
+ and n.root() is current_module
+ ]
+ if not nodes_lst:
+ continue # error detected by typechecking
+
+ # Check if any method attr is defined in is a defining method
+ # or if we have the attribute defined in a setter.
+ frames = (node.frame() for node in nodes_lst)
+ if any(
+ frame.name in defining_methods or is_property_setter(frame)
+ for frame in frames
+ ):
+ continue
+
+ # check attribute is defined in a parent's __init__
+ for parent in cnode.instance_attr_ancestors(attr):
+ attr_defined = False
+ # check if any parent method attr is defined in is a defining method
+ for node in parent.instance_attrs[attr]:
+ if node.frame().name in defining_methods:
+ attr_defined = True
+ if attr_defined:
+ # we're done :)
+ break
+ else:
+ # check attribute is defined as a class attribute
+ try:
+ cnode.local_attr(attr)
+ except astroid.NotFoundError:
+ for node in nodes_lst:
+ if node.frame().name not in defining_methods:
+ # If the attribute was set by a call in any
+ # of the defining methods, then don't emit
+ # the warning.
+ if _called_in_methods(
+ node.frame(), cnode, defining_methods
+ ):
+ continue
+ self.add_message(
+ "attribute-defined-outside-init", args=attr, node=node
+ )
+
+ def visit_functiondef(self, node: nodes.FunctionDef) -> None:
+ """check method arguments, overriding"""
+ # ignore actual functions
+ if not node.is_method():
+ return
+
+ self._check_useless_super_delegation(node)
+ self._check_property_with_parameters(node)
+
+ klass = node.parent.frame()
+ self._meth_could_be_func = True
+ # check first argument is self if this is actually a method
+ self._check_first_arg_for_type(node, klass.type == "metaclass")
+ if node.name == "__init__":
+ self._check_init(node)
+ return
+ # check signature if the method overloads inherited method
+ for overridden in klass.local_attr_ancestors(node.name):
+ # get astroid for the searched method
+ try:
+ parent_function = overridden[node.name]
+ except KeyError:
+ # we have found the method but it's not in the local
+ # dictionary.
+ # This may happen with astroid build from living objects
+ continue
+ if not isinstance(parent_function, nodes.FunctionDef):
+ continue
+ self._check_signature(node, parent_function, "overridden", klass)
+ self._check_invalid_overridden_method(node, parent_function)
+ break
+
+ if node.decorators:
+ for decorator in node.decorators.nodes:
+ if isinstance(decorator, nodes.Attribute) and decorator.attrname in {
+ "getter",
+ "setter",
+ "deleter",
+ }:
+ # attribute affectation will call this method, not hiding it
+ return
+ if isinstance(decorator, nodes.Name):
+ if decorator.name == "property":
+ # attribute affectation will either call a setter or raise
+ # an attribute error, anyway not hiding the function
+ return
+
+ # Infer the decorator and see if it returns something useful
+ inferred = safe_infer(decorator)
+ if not inferred:
+ return
+ if isinstance(inferred, nodes.FunctionDef):
+ # Okay, it's a decorator, let's see what it can infer.
+ try:
+ inferred = next(inferred.infer_call_result(inferred))
+ except astroid.InferenceError:
+ return
+ try:
+ if (
+ isinstance(inferred, (astroid.Instance, nodes.ClassDef))
+ and inferred.getattr("__get__")
+ and inferred.getattr("__set__")
+ ):
+ return
+ except astroid.AttributeInferenceError:
+ pass
+
+ # check if the method is hidden by an attribute
+ try:
+ overridden = klass.instance_attr(node.name)[0]
+ overridden_frame = overridden.frame()
+ if (
+ isinstance(overridden_frame, nodes.FunctionDef)
+ and overridden_frame.type == "method"
+ ):
+ overridden_frame = overridden_frame.parent.frame()
+ if not (
+ isinstance(overridden_frame, nodes.ClassDef)
+ and klass.is_subtype_of(overridden_frame.qname())
+ ):
+ return
+
+ # If a subclass defined the method then it's not our fault.
+ for ancestor in klass.ancestors():
+ if node.name in ancestor.instance_attrs and is_attr_private(node.name):
+ return
+ for obj in ancestor.lookup(node.name)[1]:
+ if isinstance(obj, nodes.FunctionDef):
+ return
+ args = (overridden.root().name, overridden.fromlineno)
+ self.add_message("method-hidden", args=args, node=node)
+ except astroid.NotFoundError:
+ pass
+
+ visit_asyncfunctiondef = visit_functiondef
+
+ def _check_useless_super_delegation(self, function):
+ """Check if the given function node is an useless method override
+
+ We consider it *useless* if it uses the super() builtin, but having
+ nothing additional whatsoever than not implementing the method at all.
+ If the method uses super() to delegate an operation to the rest of the MRO,
+ and if the method called is the same as the current one, the arguments
+ passed to super() are the same as the parameters that were passed to
+ this method, then the method could be removed altogether, by letting
+ other implementation to take precedence.
+ """
+
+ if (
+ not function.is_method()
+ # With decorators is a change of use
+ or function.decorators
+ ):
+ return
+
+ body = function.body
+ if len(body) != 1:
+ # Multiple statements, which means this overridden method
+ # could do multiple things we are not aware of.
+ return
+
+ statement = body[0]
+ if not isinstance(statement, (nodes.Expr, nodes.Return)):
+ # Doing something else than what we are interested into.
+ return
+
+ call = statement.value
+ if (
+ not isinstance(call, nodes.Call)
+ # Not a super() attribute access.
+ or not isinstance(call.func, nodes.Attribute)
+ ):
+ return
+
+ # Should be a super call.
+ try:
+ super_call = next(call.func.expr.infer())
+ except astroid.InferenceError:
+ return
+ else:
+ if not isinstance(super_call, astroid.objects.Super):
+ return
+
+ # The name should be the same.
+ if call.func.attrname != function.name:
+ return
+
+ # Should be a super call with the MRO pointer being the
+ # current class and the type being the current instance.
+ current_scope = function.parent.scope()
+ if (
+ super_call.mro_pointer != current_scope
+ or not isinstance(super_call.type, astroid.Instance)
+ or super_call.type.name != current_scope.name
+ ):
+ return
+
+ # Check values of default args
+ klass = function.parent.frame()
+ meth_node = None
+ for overridden in klass.local_attr_ancestors(function.name):
+ # get astroid for the searched method
+ try:
+ meth_node = overridden[function.name]
+ except KeyError:
+ # we have found the method but it's not in the local
+ # dictionary.
+ # This may happen with astroid build from living objects
+ continue
+ if (
+ not isinstance(meth_node, nodes.FunctionDef)
+ # If the method have an ancestor which is not a
+ # function then it is legitimate to redefine it
+ or _has_different_parameters_default_value(
+ meth_node.args, function.args
+ )
+ ):
+ return
+ break
+
+ # Detect if the parameters are the same as the call's arguments.
+ params = _signature_from_arguments(function.args)
+ args = _signature_from_call(call)
+
+ if meth_node is not None:
+
+ def form_annotations(arguments):
+ annotations = chain(
+ (arguments.posonlyargs_annotations or []), arguments.annotations
+ )
+ return [ann.as_string() for ann in annotations if ann is not None]
+
+ called_annotations = form_annotations(function.args)
+ overridden_annotations = form_annotations(meth_node.args)
+ if called_annotations and overridden_annotations:
+ if called_annotations != overridden_annotations:
+ return
+
+ if _definition_equivalent_to_call(params, args):
+ self.add_message(
+ "useless-super-delegation", node=function, args=(function.name,)
+ )
+
+ def _check_property_with_parameters(self, node):
+ if (
+ node.args.args
+ and len(node.args.args) > 1
+ and decorated_with_property(node)
+ and not is_property_setter(node)
+ ):
+ self.add_message("property-with-parameters", node=node)
+
+ def _check_invalid_overridden_method(self, function_node, parent_function_node):
+ parent_is_property = decorated_with_property(
+ parent_function_node
+ ) or is_property_setter_or_deleter(parent_function_node)
+ current_is_property = decorated_with_property(
+ function_node
+ ) or is_property_setter_or_deleter(function_node)
+ if parent_is_property and not current_is_property:
+ self.add_message(
+ "invalid-overridden-method",
+ args=(function_node.name, "property", function_node.type),
+ node=function_node,
+ )
+ elif not parent_is_property and current_is_property:
+ self.add_message(
+ "invalid-overridden-method",
+ args=(function_node.name, "method", "property"),
+ node=function_node,
+ )
+
+ parent_is_async = isinstance(parent_function_node, nodes.AsyncFunctionDef)
+ current_is_async = isinstance(function_node, nodes.AsyncFunctionDef)
+
+ if parent_is_async and not current_is_async:
+ self.add_message(
+ "invalid-overridden-method",
+ args=(function_node.name, "async", "non-async"),
+ node=function_node,
+ )
+
+ elif not parent_is_async and current_is_async:
+ self.add_message(
+ "invalid-overridden-method",
+ args=(function_node.name, "non-async", "async"),
+ node=function_node,
+ )
+ if (
+ decorated_with(parent_function_node, ["typing.final"])
+ or uninferable_final_decorators(parent_function_node.decorators)
+ ) and self._py38_plus:
+ self.add_message(
+ "overridden-final-method",
+ args=(function_node.name, parent_function_node.parent.name),
+ node=function_node,
+ )
+
+ def _check_slots(self, node):
+ if "__slots__" not in node.locals:
+ return
+ for slots in node.igetattr("__slots__"):
+ # check if __slots__ is a valid type
+ if slots is astroid.Uninferable:
+ continue
+ if not is_iterable(slots) and not is_comprehension(slots):
+ self.add_message("invalid-slots", node=node)
+ continue
+
+ if isinstance(slots, nodes.Const):
+ # a string, ignore the following checks
+ self.add_message("single-string-used-for-slots", node=node)
+ continue
+ if not hasattr(slots, "itered"):
+ # we can't obtain the values, maybe a .deque?
+ continue
+
+ if isinstance(slots, nodes.Dict):
+ values = [item[0] for item in slots.items]
+ else:
+ values = slots.itered()
+ if values is astroid.Uninferable:
+ return
+ for elt in values:
+ try:
+ self._check_slots_elt(elt, node)
+ except astroid.InferenceError:
+ continue
+
+ def _check_slots_elt(self, elt, node):
+ for inferred in elt.infer():
+ if inferred is astroid.Uninferable:
+ continue
+ if not isinstance(inferred, nodes.Const) or not isinstance(
+ inferred.value, str
+ ):
+ self.add_message(
+ "invalid-slots-object", args=inferred.as_string(), node=elt
+ )
+ continue
+ if not inferred.value:
+ self.add_message(
+ "invalid-slots-object", args=inferred.as_string(), node=elt
+ )
+
+ # Check if we have a conflict with a class variable.
+ class_variable = node.locals.get(inferred.value)
+ if class_variable:
+ # Skip annotated assignments which don't conflict at all with slots.
+ if len(class_variable) == 1:
+ parent = class_variable[0].parent
+ if isinstance(parent, nodes.AnnAssign) and parent.value is None:
+ return
+ self.add_message(
+ "class-variable-slots-conflict", args=(inferred.value,), node=elt
+ )
+
+ def leave_functiondef(self, node: nodes.FunctionDef) -> None:
+ """on method node, check if this method couldn't be a function
+
+ ignore class, static and abstract methods, initializer,
+ methods overridden from a parent class.
+ """
+ if node.is_method():
+ if node.args.args is not None:
+ self._first_attrs.pop()
+ if not self.linter.is_message_enabled("no-self-use"):
+ return
+ class_node = node.parent.frame()
+ if (
+ self._meth_could_be_func
+ and node.type == "method"
+ and node.name not in PYMETHODS
+ and not (
+ node.is_abstract()
+ or overrides_a_method(class_node, node.name)
+ or decorated_with_property(node)
+ or _has_bare_super_call(node)
+ or is_protocol_class(class_node)
+ or is_overload_stub(node)
+ )
+ ):
+ self.add_message("no-self-use", node=node)
+
+ leave_asyncfunctiondef = leave_functiondef
+
+ def visit_attribute(self, node: nodes.Attribute) -> None:
+ """check if the getattr is an access to a class member
+ if so, register it. Also check for access to protected
+ class member from outside its class (but ignore __special__
+ methods)
+ """
+ # Check self
+ if self._uses_mandatory_method_param(node):
+ self._accessed.set_accessed(node)
+ return
+ if not self.linter.is_message_enabled("protected-access"):
+ return
+
+ self._check_protected_attribute_access(node)
+
+ @check_messages("assigning-non-slot", "invalid-class-object")
+ def visit_assignattr(self, node: nodes.AssignAttr) -> None:
+ if isinstance(
+ node.assign_type(), nodes.AugAssign
+ ) and self._uses_mandatory_method_param(node):
+ self._accessed.set_accessed(node)
+ self._check_in_slots(node)
+ self._check_invalid_class_object(node)
+
+ def _check_invalid_class_object(self, node: nodes.AssignAttr) -> None:
+ if not node.attrname == "__class__":
+ return
+ inferred = safe_infer(node.parent.value)
+ if isinstance(inferred, nodes.ClassDef) or inferred is astroid.Uninferable:
+ # If is uninferrable, we allow it to prevent false positives
+ return
+ self.add_message("invalid-class-object", node=node)
+
+ def _check_in_slots(self, node):
+ """Check that the given AssignAttr node
+ is defined in the class slots.
+ """
+ inferred = safe_infer(node.expr)
+ if not isinstance(inferred, astroid.Instance):
+ return
+
+ klass = inferred._proxied
+ if not has_known_bases(klass):
+ return
+ if "__slots__" not in klass.locals or not klass.newstyle:
+ return
+ # If `__setattr__` is defined on the class, then we can't reason about
+ # what will happen when assigning to an attribute.
+ if any(
+ base.locals.get("__setattr__")
+ for base in klass.mro()
+ if base.qname() != "builtins.object"
+ ):
+ return
+
+ # If 'typing.Generic' is a base of bases of klass, the cached version
+ # of 'slots()' might have been evaluated incorrectly, thus deleted cache entry.
+ if any(base.qname() == "typing.Generic" for base in klass.mro()):
+ cache = getattr(klass, "__cache", None)
+ if cache and cache.get(klass.slots) is not None:
+ del cache[klass.slots]
+
+ slots = klass.slots()
+ if slots is None:
+ return
+ # If any ancestor doesn't use slots, the slots
+ # defined for this class are superfluous.
+ if any(
+ "__slots__" not in ancestor.locals and ancestor.name != "object"
+ for ancestor in klass.ancestors()
+ ):
+ return
+
+ if not any(slot.value == node.attrname for slot in slots):
+ # If we have a '__dict__' in slots, then
+ # assigning any name is valid.
+ if not any(slot.value == "__dict__" for slot in slots):
+ if _is_attribute_property(node.attrname, klass):
+ # Properties circumvent the slots mechanism,
+ # so we should not emit a warning for them.
+ return
+ if node.attrname in klass.locals and _has_data_descriptor(
+ klass, node.attrname
+ ):
+ # Descriptors circumvent the slots mechanism as well.
+ return
+ if node.attrname == "__class__" and _has_same_layout_slots(
+ slots, node.parent.value
+ ):
+ return
+ self.add_message("assigning-non-slot", args=(node.attrname,), node=node)
+
+ @check_messages(
+ "protected-access", "no-classmethod-decorator", "no-staticmethod-decorator"
+ )
+ def visit_assign(self, assign_node: nodes.Assign) -> None:
+ self._check_classmethod_declaration(assign_node)
+ node = assign_node.targets[0]
+ if not isinstance(node, nodes.AssignAttr):
+ return
+
+ if self._uses_mandatory_method_param(node):
+ return
+ self._check_protected_attribute_access(node)
+
+ def _check_classmethod_declaration(self, node):
+ """Checks for uses of classmethod() or staticmethod()
+
+ When a @classmethod or @staticmethod decorator should be used instead.
+ A message will be emitted only if the assignment is at a class scope
+ and only if the classmethod's argument belongs to the class where it
+ is defined.
+ `node` is an assign node.
+ """
+ if not isinstance(node.value, nodes.Call):
+ return
+
+ # check the function called is "classmethod" or "staticmethod"
+ func = node.value.func
+ if not isinstance(func, nodes.Name) or func.name not in (
+ "classmethod",
+ "staticmethod",
+ ):
+ return
+
+ msg = (
+ "no-classmethod-decorator"
+ if func.name == "classmethod"
+ else "no-staticmethod-decorator"
+ )
+ # assignment must be at a class scope
+ parent_class = node.scope()
+ if not isinstance(parent_class, nodes.ClassDef):
+ return
+
+ # Check if the arg passed to classmethod is a class member
+ classmeth_arg = node.value.args[0]
+ if not isinstance(classmeth_arg, nodes.Name):
+ return
+
+ method_name = classmeth_arg.name
+ if any(method_name == member.name for member in parent_class.mymethods()):
+ self.add_message(msg, node=node.targets[0])
+
+ def _check_protected_attribute_access(self, node: nodes.Attribute):
+ """Given an attribute access node (set or get), check if attribute
+ access is legitimate. Call _check_first_attr with node before calling
+ this method. Valid cases are:
+ * self._attr in a method or cls._attr in a classmethod. Checked by
+ _check_first_attr.
+ * Klass._attr inside "Klass" class.
+ * Klass2._attr inside "Klass" class when Klass2 is a base class of
+ Klass.
+ """
+ attrname = node.attrname
+
+ if (
+ is_attr_protected(attrname)
+ and attrname not in self.config.exclude_protected
+ ):
+
+ klass = node_frame_class(node)
+
+ # In classes, check we are not getting a parent method
+ # through the class object or through super
+ callee = node.expr.as_string()
+
+ # Typing annotations in function definitions can include protected members
+ if utils.is_node_in_type_annotation_context(node):
+ return
+
+ # We are not in a class, no remaining valid case
+ if klass is None:
+ self.add_message("protected-access", node=node, args=attrname)
+ return
+
+ # If the expression begins with a call to super, that's ok.
+ if (
+ isinstance(node.expr, nodes.Call)
+ and isinstance(node.expr.func, nodes.Name)
+ and node.expr.func.name == "super"
+ ):
+ return
+
+ # If the expression begins with a call to type(self), that's ok.
+ if self._is_type_self_call(node.expr):
+ return
+
+ # Check if we are inside the scope of a class or nested inner class
+ inside_klass = True
+ outer_klass = klass
+ parents_callee = callee.split(".")
+ parents_callee.reverse()
+ for callee in parents_callee:
+ if not outer_klass or callee != outer_klass.name:
+ inside_klass = False
+ break
+
+ # Move up one level within the nested classes
+ outer_klass = get_outer_class(outer_klass)
+
+ # We are in a class, one remaining valid cases, Klass._attr inside
+ # Klass
+ if not (inside_klass or callee in klass.basenames):
+ # Detect property assignments in the body of the class.
+ # This is acceptable:
+ #
+ # class A:
+ # b = property(lambda: self._b)
+
+ stmt = node.parent.statement(future=True)
+ if (
+ isinstance(stmt, nodes.Assign)
+ and len(stmt.targets) == 1
+ and isinstance(stmt.targets[0], nodes.AssignName)
+ ):
+ name = stmt.targets[0].name
+ if _is_attribute_property(name, klass):
+ return
+
+ if (
+ self._is_classmethod(node.frame())
+ and self._is_inferred_instance(node.expr, klass)
+ and self._is_class_attribute(attrname, klass)
+ ):
+ return
+
+ licit_protected_member = not attrname.startswith("__")
+ if (
+ not self.config.check_protected_access_in_special_methods
+ and licit_protected_member
+ and self._is_called_inside_special_method(node)
+ ):
+ return
+
+ self.add_message("protected-access", node=node, args=attrname)
+
+ @staticmethod
+ def _is_called_inside_special_method(node: nodes.NodeNG) -> bool:
+ """
+ Returns true if the node is located inside a special (aka dunder) method
+ """
+ try:
+ frame_name = node.frame().name
+ except AttributeError:
+ return False
+ return frame_name and frame_name in PYMETHODS
+
+ def _is_type_self_call(self, expr):
+ return (
+ isinstance(expr, nodes.Call)
+ and isinstance(expr.func, nodes.Name)
+ and expr.func.name == "type"
+ and len(expr.args) == 1
+ and self._is_mandatory_method_param(expr.args[0])
+ )
+
+ @staticmethod
+ def _is_classmethod(func):
+ """Check if the given *func* node is a class method."""
+
+ return isinstance(func, nodes.FunctionDef) and (
+ func.type == "classmethod" or func.name == "__class_getitem__"
+ )
+
+ @staticmethod
+ def _is_inferred_instance(expr, klass):
+ """Check if the inferred value of the given *expr* is an instance of *klass*."""
+
+ inferred = safe_infer(expr)
+ if not isinstance(inferred, astroid.Instance):
+ return False
+
+ return inferred._proxied is klass
+
+ @staticmethod
+ def _is_class_attribute(name, klass):
+ """Check if the given attribute *name* is a class or instance member of the given *klass*.
+
+ Returns ``True`` if the name is a property in the given klass,
+ ``False`` otherwise.
+ """
+
+ try:
+ klass.getattr(name)
+ return True
+ except astroid.NotFoundError:
+ pass
+
+ try:
+ klass.instance_attr(name)
+ return True
+ except astroid.NotFoundError:
+ return False
+
+ def visit_name(self, node: nodes.Name) -> None:
+ """check if the name handle an access to a class member
+ if so, register it
+ """
+ if self._first_attrs and (
+ node.name == self._first_attrs[-1] or not self._first_attrs[-1]
+ ):
+ self._meth_could_be_func = False
+
+ def _check_accessed_members(self, node, accessed):
+ """check that accessed members are defined"""
+ excs = ("AttributeError", "Exception", "BaseException")
+ for attr, nodes_lst in accessed.items():
+ try:
+ # is it a class attribute ?
+ node.local_attr(attr)
+ # yes, stop here
+ continue
+ except astroid.NotFoundError:
+ pass
+ # is it an instance attribute of a parent class ?
+ try:
+ next(node.instance_attr_ancestors(attr))
+ # yes, stop here
+ continue
+ except StopIteration:
+ pass
+ # is it an instance attribute ?
+ try:
+ defstmts = node.instance_attr(attr)
+ except astroid.NotFoundError:
+ pass
+ else:
+ # filter out augment assignment nodes
+ defstmts = [stmt for stmt in defstmts if stmt not in nodes_lst]
+ if not defstmts:
+ # only augment assignment for this node, no-member should be
+ # triggered by the typecheck checker
+ continue
+ # filter defstmts to only pick the first one when there are
+ # several assignments in the same scope
+ scope = defstmts[0].scope()
+ defstmts = [
+ stmt
+ for i, stmt in enumerate(defstmts)
+ if i == 0 or stmt.scope() is not scope
+ ]
+ # if there are still more than one, don't attempt to be smarter
+ # than we can be
+ if len(defstmts) == 1:
+ defstmt = defstmts[0]
+ # check that if the node is accessed in the same method as
+ # it's defined, it's accessed after the initial assignment
+ frame = defstmt.frame()
+ lno = defstmt.fromlineno
+ for _node in nodes_lst:
+ if (
+ _node.frame() is frame
+ and _node.fromlineno < lno
+ and not astroid.are_exclusive(
+ _node.statement(future=True), defstmt, excs
+ )
+ ):
+ self.add_message(
+ "access-member-before-definition",
+ node=_node,
+ args=(attr, lno),
+ )
+
+ def _check_first_arg_for_type(self, node, metaclass=0):
+ """check the name of first argument, expect:
+
+ * 'self' for a regular method
+ * 'cls' for a class method or a metaclass regular method (actually
+ valid-classmethod-first-arg value)
+ * 'mcs' for a metaclass class method (actually
+ valid-metaclass-classmethod-first-arg)
+ * not one of the above for a static method
+ """
+ # don't care about functions with unknown argument (builtins)
+ if node.args.args is None:
+ return
+ if node.args.posonlyargs:
+ first_arg = node.args.posonlyargs[0].name
+ elif node.args.args:
+ first_arg = node.argnames()[0]
+ else:
+ first_arg = None
+ self._first_attrs.append(first_arg)
+ first = self._first_attrs[-1]
+ # static method
+ if node.type == "staticmethod":
+ if (
+ first_arg == "self"
+ or first_arg in self.config.valid_classmethod_first_arg
+ or first_arg in self.config.valid_metaclass_classmethod_first_arg
+ ):
+ self.add_message("bad-staticmethod-argument", args=first, node=node)
+ return
+ self._first_attrs[-1] = None
+ # class / regular method with no args
+ elif not node.args.args and not node.args.posonlyargs:
+ self.add_message("no-method-argument", node=node)
+ # metaclass
+ elif metaclass:
+ # metaclass __new__ or classmethod
+ if node.type == "classmethod":
+ self._check_first_arg_config(
+ first,
+ self.config.valid_metaclass_classmethod_first_arg,
+ node,
+ "bad-mcs-classmethod-argument",
+ node.name,
+ )
+ # metaclass regular method
+ else:
+ self._check_first_arg_config(
+ first,
+ self.config.valid_classmethod_first_arg,
+ node,
+ "bad-mcs-method-argument",
+ node.name,
+ )
+ # regular class with class method
+ elif node.type == "classmethod" or node.name == "__class_getitem__":
+ self._check_first_arg_config(
+ first,
+ self.config.valid_classmethod_first_arg,
+ node,
+ "bad-classmethod-argument",
+ node.name,
+ )
+ # regular class with regular method without self as argument
+ elif first != "self":
+ self.add_message("no-self-argument", node=node)
+
+ def _check_first_arg_config(self, first, config, node, message, method_name):
+ if first not in config:
+ if len(config) == 1:
+ valid = repr(config[0])
+ else:
+ valid = ", ".join(repr(v) for v in config[:-1])
+ valid = f"{valid} or {config[-1]!r}"
+ self.add_message(message, args=(method_name, valid), node=node)
+
+ def _check_bases_classes(self, node):
+ """check that the given class node implements abstract methods from
+ base classes
+ """
+
+ def is_abstract(method):
+ return method.is_abstract(pass_is_abstract=False)
+
+ # check if this class abstract
+ if class_is_abstract(node):
+ return
+
+ methods = sorted(
+ unimplemented_abstract_methods(node, is_abstract).items(),
+ key=lambda item: item[0],
+ )
+ for name, method in methods:
+ owner = method.parent.frame()
+ if owner is node:
+ continue
+ # owner is not this class, it must be a parent class
+ # check that the ancestor's method is not abstract
+ if name in node.locals:
+ # it is redefined as an attribute or with a descriptor
+ continue
+ self.add_message("abstract-method", node=node, args=(name, owner.name))
+
+ def _check_init(self, node):
+ """check that the __init__ method call super or ancestors'__init__
+ method (unless it is used for type hinting with `typing.overload`)
+ """
+ if not self.linter.is_message_enabled(
+ "super-init-not-called"
+ ) and not self.linter.is_message_enabled("non-parent-init-called"):
+ return
+ klass_node = node.parent.frame()
+ to_call = _ancestors_to_call(klass_node)
+ not_called_yet = dict(to_call)
+ for stmt in node.nodes_of_class(nodes.Call):
+ expr = stmt.func
+ if not isinstance(expr, nodes.Attribute) or expr.attrname != "__init__":
+ continue
+ # skip the test if using super
+ if (
+ isinstance(expr.expr, nodes.Call)
+ and isinstance(expr.expr.func, nodes.Name)
+ and expr.expr.func.name == "super"
+ ):
+ return
+ try:
+ for klass in expr.expr.infer():
+ if klass is astroid.Uninferable:
+ continue
+ # The inferred klass can be super(), which was
+ # assigned to a variable and the `__init__`
+ # was called later.
+ #
+ # base = super()
+ # base.__init__(...)
+
+ if (
+ isinstance(klass, astroid.Instance)
+ and isinstance(klass._proxied, nodes.ClassDef)
+ and is_builtin_object(klass._proxied)
+ and klass._proxied.name == "super"
+ ):
+ return
+ if isinstance(klass, astroid.objects.Super):
+ return
+ try:
+ del not_called_yet[klass]
+ except KeyError:
+ if klass not in to_call:
+ self.add_message(
+ "non-parent-init-called", node=expr, args=klass.name
+ )
+ except astroid.InferenceError:
+ continue
+ for klass, method in not_called_yet.items():
+ if decorated_with(node, ["typing.overload"]):
+ continue
+ cls = node_frame_class(method)
+ if klass.name == "object" or (cls and cls.name == "object"):
+ continue
+ self.add_message("super-init-not-called", args=klass.name, node=node)
+
+ def _check_signature(self, method1, refmethod, class_type, cls):
+ """check that the signature of the two given methods match"""
+ if not (
+ isinstance(method1, nodes.FunctionDef)
+ and isinstance(refmethod, nodes.FunctionDef)
+ ):
+ self.add_message(
+ "method-check-failed", args=(method1, refmethod), node=method1
+ )
+ return
+
+ instance = cls.instantiate_class()
+ method1 = astroid.scoped_nodes.function_to_method(method1, instance)
+ refmethod = astroid.scoped_nodes.function_to_method(refmethod, instance)
+
+ # Don't care about functions with unknown argument (builtins).
+ if method1.args.args is None or refmethod.args.args is None:
+ return
+
+ # Ignore private to class methods.
+ if is_attr_private(method1.name):
+ return
+ # Ignore setters, they have an implicit extra argument,
+ # which shouldn't be taken in consideration.
+ if is_property_setter(method1):
+ return
+
+ arg_differ_output = _different_parameters(
+ refmethod, method1, dummy_parameter_regex=self._dummy_rgx
+ )
+ if len(arg_differ_output) > 0:
+ for msg in arg_differ_output:
+ if "Number" in msg:
+ total_args_method1 = len(method1.args.args)
+ if method1.args.vararg:
+ total_args_method1 += 1
+ if method1.args.kwarg:
+ total_args_method1 += 1
+ if method1.args.kwonlyargs:
+ total_args_method1 += len(method1.args.kwonlyargs)
+ total_args_refmethod = len(refmethod.args.args)
+ if refmethod.args.vararg:
+ total_args_refmethod += 1
+ if refmethod.args.kwarg:
+ total_args_refmethod += 1
+ if refmethod.args.kwonlyargs:
+ total_args_refmethod += len(refmethod.args.kwonlyargs)
+ error_type = "arguments-differ"
+ msg_args = (
+ msg
+ + f"was {total_args_refmethod} in '{refmethod.parent.name}.{refmethod.name}' and "
+ f"is now {total_args_method1} in",
+ class_type,
+ f"{method1.parent.name}.{method1.name}",
+ )
+ elif "renamed" in msg:
+ error_type = "arguments-renamed"
+ msg_args = (
+ msg,
+ class_type,
+ f"{method1.parent.name}.{method1.name}",
+ )
+ else:
+ error_type = "arguments-differ"
+ msg_args = (
+ msg,
+ class_type,
+ f"{method1.parent.name}.{method1.name}",
+ )
+ self.add_message(error_type, args=msg_args, node=method1)
+ elif (
+ len(method1.args.defaults) < len(refmethod.args.defaults)
+ and not method1.args.vararg
+ ):
+ self.add_message(
+ "signature-differs", args=(class_type, method1.name), node=method1
+ )
+
+ def _uses_mandatory_method_param(self, node):
+ """Check that attribute lookup name use first attribute variable name
+
+ Name is `self` for method, `cls` for classmethod and `mcs` for metaclass.
+ """
+ return self._is_mandatory_method_param(node.expr)
+
+ def _is_mandatory_method_param(self, node):
+ """Check if nodes.Name corresponds to first attribute variable name
+
+ Name is `self` for method, `cls` for classmethod and `mcs` for metaclass.
+ """
+ return (
+ self._first_attrs
+ and isinstance(node, nodes.Name)
+ and node.name == self._first_attrs[-1]
+ )
+
+
+def _ancestors_to_call(klass_node, method="__init__"):
+ """return a dictionary where keys are the list of base classes providing
+ the queried method, and so that should/may be called from the method node
+ """
+ to_call = {}
+ for base_node in klass_node.ancestors(recurs=False):
+ try:
+ to_call[base_node] = next(base_node.igetattr(method))
+ except astroid.InferenceError:
+ continue
+ return to_call