diff --git a/doc-generator/src/main/scala/codacy/pylint/Main.scala b/doc-generator/src/main/scala/codacy/pylint/Main.scala index 48bbcc0..c6aa7f3 100644 --- a/doc-generator/src/main/scala/codacy/pylint/Main.scala +++ b/doc-generator/src/main/scala/codacy/pylint/Main.scala @@ -86,7 +86,14 @@ object Main { } val rulesNamesTitlesBodiesPlainText = rulesNamesTitlesBodies.map { - case (name, title, body) => (name, title, body.text) + case (name, title, body) => + val newLines = body.text.linesIterator.toList match { + case title :: secondLine :: rest => + title.stripSuffix(".") + "." :: secondLine.capitalize :: rest + case lines => lines + } + val descriptionText = newLines.mkString(" ") + (name, title, descriptionText) } val docsPath = "../docs" diff --git a/docs/description/description.json b/docs/description/description.json index 25e832d..4ac1eec 100644 --- a/docs/description/description.json +++ b/docs/description/description.json @@ -2,732 +2,732 @@ { "patternId": "E1701", "title": "not-async-context-manager (E1701)", - "description": "Async context manager '%s' doesn't implement __aenter__ and __aexit__.\nUsed when an async context manager is used with an object that does not\nimplement the async context management protocol. This message can't be emitted\nwhen using Python < 3.5." + "description": "Async context manager '%s' doesn't implement __aenter__ and __aexit__. Used when an async context manager is used with an object that does not implement the async context management protocol. This message can't be emitted when using Python < 3.5." }, { "patternId": "E1700", "title": "yield-inside-async-function (E1700)", - "description": "Yield inside async function\nUsed when an yield or yield from statement is found inside an async\nfunction. This message can't be emitted when using Python < 3.5." + "description": "Yield inside async function. Used when an yield or yield from statement is found inside an async function. This message can't be emitted when using Python < 3.5." }, { "patternId": "E0103", "title": "not-in-loop (E0103)", - "description": "%r not properly in loop\nUsed when break or continue keywords are used outside a loop." + "description": "%r not properly in loop. Used when break or continue keywords are used outside a loop." }, { "patternId": "E0102", "title": "function-redefined (E0102)", - "description": "%s already defined line %s\nUsed when a function / class / method is redefined." + "description": "%s already defined line %s. Used when a function / class / method is redefined." }, { "patternId": "E0116", "title": "continue-in-finally (E0116)", - "description": "'continue' not supported inside 'finally' clause\nEmitted when the continue keyword is found inside a finally clause, which is\na SyntaxError." + "description": "'continue' not supported inside 'finally' clause. Emitted when the continue keyword is found inside a finally clause, which is a SyntaxError." }, { "patternId": "E0110", "title": "abstract-class-instantiated (E0110)", - "description": "Abstract class %r with abstract methods instantiated\nUsed when an abstract class with abc.ABCMeta as metaclass has abstract\nmethods and is instantiated." + "description": "Abstract class %r with abstract methods instantiated. Used when an abstract class with abc.ABCMeta as metaclass has abstract methods and is instantiated." }, { "patternId": "E0114", "title": "star-needs-assignment-target (E0114)", - "description": "Can use starred expression only in assignment target\nEmitted when a star expression is not used in an assignment target." + "description": "Can use starred expression only in assignment target. Emitted when a star expression is not used in an assignment target." }, { "patternId": "E0108", "title": "duplicate-argument-name (E0108)", - "description": "Duplicate argument name %s in function definition\nDuplicate argument names in function definitions are syntax errors." + "description": "Duplicate argument name %s in function definition. Duplicate argument names in function definitions are syntax errors." }, { "patternId": "E0101", "title": "return-in-init (E0101)", - "description": "Explicit return in __init__\nUsed when the special class method __init__ has an explicit return value." + "description": "Explicit return in __init__. Used when the special class method __init__ has an explicit return value." }, { "patternId": "E0112", "title": "too-many-star-expressions (E0112)", - "description": "More than one starred expression in assignment\nEmitted when there are more than one starred expressions (*x) in an\nassignment. This is a SyntaxError." + "description": "More than one starred expression in assignment. Emitted when there are more than one starred expressions (*x) in an assignment. This is a SyntaxError." }, { "patternId": "E0115", "title": "nonlocal-and-global (E0115)", - "description": "Name %r is nonlocal and global\nEmitted when a name is both nonlocal and global." + "description": "Name %r is nonlocal and global. Emitted when a name is both nonlocal and global." }, { "patternId": "E0118", "title": "used-prior-global-declaration (E0118)", - "description": "Name %r is used prior to global declaration\nEmitted when a name is used prior a global declaration, which results in an\nerror since Python 3.6. This message can't be emitted when using Python < 3.6." + "description": "Name %r is used prior to global declaration. Emitted when a name is used prior a global declaration, which results in an error since Python 3.6. This message can't be emitted when using Python < 3.6." }, { "patternId": "E0104", "title": "return-outside-function (E0104)", - "description": "Return outside function\nUsed when a \"return\" statement is found outside a function or method." + "description": "Return outside function. Used when a \"return\" statement is found outside a function or method." }, { "patternId": "E0106", "title": "return-arg-in-generator (E0106)", - "description": "Return with argument inside generator\nUsed when a \"return\" statement with an argument is found outside in a\ngenerator function or method (e.g. with some \"yield\" statements). This message\ncan't be emitted when using Python >= 3.3." + "description": "Return with argument inside generator. Used when a \"return\" statement with an argument is found outside in a generator function or method (e.g. with some \"yield\" statements). This message can't be emitted when using Python >= 3.3." }, { "patternId": "E0113", "title": "invalid-star-assignment-target (E0113)", - "description": "Starred assignment target must be in a list or tuple\nEmitted when a star expression is used as a starred assignment target." + "description": "Starred assignment target must be in a list or tuple. Emitted when a star expression is used as a starred assignment target." }, { "patternId": "E0111", "title": "bad-reversed-sequence (E0111)", - "description": "The first reversed() argument is not a sequence\nUsed when the first argument to reversed() builtin isn't a sequence (does not\nimplement __reversed__, nor __getitem__ and __len__" + "description": "The first reversed() argument is not a sequence. Used when the first argument to reversed() builtin isn't a sequence (does not implement __reversed__, nor __getitem__ and __len__" }, { "patternId": "E0107", "title": "nonexistent-operator (E0107)", - "description": "Use of the non-existent %s operator\nUsed when you attempt to use the C-style pre-increment or pre-decrement\noperator -- and ++, which doesn't exist in Python." + "description": "Use of the non-existent %s operator. Used when you attempt to use the C-style pre-increment or pre-decrement operator -- and ++, which doesn't exist in Python." }, { "patternId": "E0105", "title": "yield-outside-function (E0105)", - "description": "Yield outside function\nUsed when a \"yield\" statement is found outside a function or method." + "description": "Yield outside function. Used when a \"yield\" statement is found outside a function or method." }, { "patternId": "E0100", "title": "init-is-generator (E0100)", - "description": "__init__ method is a generator\nUsed when the special class method __init__ is turned into a generator by a\nyield in its body." + "description": "__init__ method is a generator. Used when the special class method __init__ is turned into a generator by a yield in its body." }, { "patternId": "E0119", "title": "misplaced-format-function (E0119)", - "description": "format function is not called on str\nEmitted when format function is not called on str object. e.g doing\nprint(\"value: {}\").format(123) instead of print(\"value: {}\".format(123)). This\nmight not be what the user intended to do." + "description": "format function is not called on str. Emitted when format function is not called on str object. e.g doing print(\"value: {}\").format(123) instead of print(\"value: {}\".format(123)). This might not be what the user intended to do." }, { "patternId": "E0117", "title": "nonlocal-without-binding (E0117)", - "description": "nonlocal name %s found without binding\nEmitted when a nonlocal variable does not have an attached name somewhere in\nthe parent scopes" + "description": "nonlocal name %s found without binding. Emitted when a nonlocal variable does not have an attached name somewhere in the parent scopes" }, { "patternId": "W0150", "title": "lost-exception (W0150)", - "description": "%s statement in finally block may swallow exception\nUsed when a break or a return statement is found inside the finally clause of\na try...finally block: the exceptions raised in the try clause will be\nsilently swallowed instead of being re-raised." + "description": "%s statement in finally block may swallow exception. Used when a break or a return statement is found inside the finally clause of a try...finally block: the exceptions raised in the try clause will be silently swallowed instead of being re-raised." }, { "patternId": "W0199", "title": "assert-on-tuple (W0199)", - "description": "Assert called on a 2-item-tuple. Did you mean 'assert x,y'?\nA call of assert on a tuple will always evaluate to true if the tuple is not\nempty, and will always evaluate to false if it is." + "description": "Assert called on a 2-item-tuple. Did you mean 'assert x,y'?. A call of assert on a tuple will always evaluate to true if the tuple is not empty, and will always evaluate to false if it is." }, { "patternId": "W0127", "title": "self-assigning-variable (W0127)", - "description": "Assigning the same variable %r to itself\nEmitted when we detect that a variable is assigned to itself" + "description": "Assigning the same variable %r to itself. Emitted when we detect that a variable is assigned to itself" }, { "patternId": "W0143", "title": "comparison-with-callable (W0143)", - "description": "Comparing against a callable, did you omit the parenthesis?\nThis message is emitted when pylint detects that a comparison with a callable\nwas made, which might suggest that some parenthesis were omitted, resulting in\npotential unwanted behaviour." + "description": "Comparing against a callable, did you omit the parenthesis?. This message is emitted when pylint detects that a comparison with a callable was made, which might suggest that some parenthesis were omitted, resulting in potential unwanted behaviour." }, { "patternId": "W0102", "title": "dangerous-default-value (W0102)", - "description": "Dangerous default value %s as argument\nUsed when a mutable value as list or dictionary is detected in a default value\nfor an argument." + "description": "Dangerous default value %s as argument. Used when a mutable value as list or dictionary is detected in a default value for an argument." }, { "patternId": "W0109", "title": "duplicate-key (W0109)", - "description": "Duplicate key %r in dictionary\nUsed when a dictionary expression binds the same key multiple times." + "description": "Duplicate key %r in dictionary. Used when a dictionary expression binds the same key multiple times." }, { "patternId": "W0120", "title": "useless-else-on-loop (W0120)", - "description": "Else clause on loop without a break statement\nLoops should only have an else clause if they can exit early with a break\nstatement, otherwise the statements under else should be on the same scope as\nthe loop itself." + "description": "Else clause on loop without a break statement. Loops should only have an else clause if they can exit early with a break statement, otherwise the statements under else should be on the same scope as the loop itself." }, { "patternId": "W0106", "title": "expression-not-assigned (W0106)", - "description": "Expression \"%s\" is assigned to nothing\nUsed when an expression that is not a function call is assigned to nothing.\nProbably something else was intended." + "description": "Expression \"%s\" is assigned to nothing. Used when an expression that is not a function call is assigned to nothing. Probably something else was intended." }, { "patternId": "W0124", "title": "confusing-with-statement (W0124)", - "description": "Following \"as\" with another context manager looks like a tuple.\nEmitted when a with statement component returns multiple values and uses\nname binding with as only for a part of those values, as in with ctx() as a,\nb. This can be misleading, since it's not clear if the context manager returns\na tuple or if the node without a name binding is another context manager." + "description": "Following \"as\" with another context manager looks like a tuple. Emitted when a with statement component returns multiple values and uses name binding with as only for a part of those values, as in with ctx() as a, b. This can be misleading, since it's not clear if the context manager returns a tuple or if the node without a name binding is another context manager." }, { "patternId": "W0108", "title": "unnecessary-lambda (W0108)", - "description": "Lambda may not be necessary\nUsed when the body of a lambda expression is a function call on the same\nargument list as the lambda itself; such lambda expressions are in all but a\nfew cases replaceable with the function being called in the body of the\nlambda." + "description": "Lambda may not be necessary. Used when the body of a lambda expression is a function call on the same argument list as the lambda itself; such lambda expressions are in all but a few cases replaceable with the function being called in the body of the lambda." }, { "patternId": "W0111", "title": "assign-to-new-keyword (W0111)", - "description": "Name %s will become a keyword in Python %s\nUsed when assignment will become invalid in future Python release due to\nintroducing new keyword." + "description": "Name %s will become a keyword in Python %s. Used when assignment will become invalid in future Python release due to introducing new keyword." }, { "patternId": "W0128", "title": "redeclared-assigned-name (W0128)", - "description": "Redeclared variable %r in assignment\nEmitted when we detect that a variable was redeclared in the same assignment." + "description": "Redeclared variable %r in assignment. Emitted when we detect that a variable was redeclared in the same assignment." }, { "patternId": "W0104", "title": "pointless-statement (W0104)", - "description": "Statement seems to have no effect\nUsed when a statement doesn't have (or at least seems to) any effect." + "description": "Statement seems to have no effect. Used when a statement doesn't have (or at least seems to) any effect." }, { "patternId": "W0105", "title": "pointless-string-statement (W0105)", - "description": "String statement has no effect\nUsed when a string is used as a statement (which of course has no effect).\nThis is a particular case of W0104 with its own message so you can easily\ndisable it if you're using those strings as documentation, instead of\ncomments." + "description": "String statement has no effect. Used when a string is used as a statement (which of course has no effect). This is a particular case of W0104 with its own message so you can easily disable it if you're using those strings as documentation, instead of comments." }, { "patternId": "W0107", "title": "unnecessary-pass (W0107)", - "description": "Unnecessary pass statement\nUsed when a \"pass\" statement that can be avoided is encountered." + "description": "Unnecessary pass statement. Used when a \"pass\" statement that can be avoided is encountered." }, { "patternId": "W0101", "title": "unreachable (W0101)", - "description": "Unreachable code\nUsed when there is some code behind a \"return\" or \"raise\" statement, which\nwill never be accessed." + "description": "Unreachable code. Used when there is some code behind a \"return\" or \"raise\" statement, which will never be accessed." }, { "patternId": "W0123", "title": "eval-used (W0123)", - "description": "Use of eval\nUsed when you use the \"eval\" function, to discourage its usage. Consider using\nast.literal_eval for safely evaluating strings containing Python expressions\nfrom untrusted sources." + "description": "Use of eval. Used when you use the \"eval\" function, to discourage its usage. Consider using ast.literal_eval for safely evaluating strings containing Python expressions from untrusted sources." }, { "patternId": "W0122", "title": "exec-used (W0122)", - "description": "Use of exec\nUsed when you use the \"exec\" statement (function for Python 3), to discourage\nits usage. That doesn't mean you cannot use it !" + "description": "Use of exec. Used when you use the \"exec\" statement (function for Python 3), to discourage its usage. That doesn't mean you cannot use it !" }, { "patternId": "W0125", "title": "using-constant-test (W0125)", - "description": "Using a conditional statement with a constant value\nEmitted when a conditional statement (If or ternary if) uses a constant value\nfor its test. This might not be what the user intended to do." + "description": "Using a conditional statement with a constant value. Emitted when a conditional statement (If or ternary if) uses a constant value for its test. This might not be what the user intended to do." }, { "patternId": "W0126", "title": "missing-parentheses-for-call-in-test (W0126)", - "description": "Using a conditional statement with potentially wrong function or method call due to missing parentheses\nEmitted when a conditional statement (If or ternary if) seems to wrongly call\na function due to missing parentheses" + "description": "Using a conditional statement with potentially wrong function or method call due to missing parentheses. Emitted when a conditional statement (If or ternary if) seems to wrongly call a function due to missing parentheses" }, { "patternId": "R0123", "title": "literal-comparison (R0123)", - "description": "Comparison to literal\nUsed when comparing an object to a literal, which is usually what you do not\nwant to do, since you can compare to a different literal than what was\nexpected altogether." + "description": "Comparison to literal. Used when comparing an object to a literal, which is usually what you do not want to do, since you can compare to a different literal than what was expected altogether." }, { "patternId": "R0124", "title": "comparison-with-itself (R0124)", - "description": "Redundant comparison - %s\nUsed when something is compared against itself." + "description": "Redundant comparison - %s. Used when something is compared against itself." }, { "patternId": "C0103", "title": "invalid-name (C0103)", - "description": "%s name \"%s\" doesn't conform to %s\nUsed when the name doesn't conform to naming rules associated to its type\n(constant, variable, class...)." + "description": "%s name \"%s\" doesn't conform to %s. Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...)." }, { "patternId": "C0102", "title": "blacklisted-name (C0102)", - "description": "Black listed name \"%s\"\nUsed when the name is listed in the black list (unauthorized names)." + "description": "Black listed name \"%s\". Used when the name is listed in the black list (unauthorized names)." }, { "patternId": "C0122", "title": "misplaced-comparison-constant (C0122)", - "description": "Comparison should be %s\nUsed when the constant is placed on the left side of a comparison. It is\nusually clearer in intent to place it in the right hand side of the\ncomparison." + "description": "Comparison should be %s. Used when the constant is placed on the left side of a comparison. It is usually clearer in intent to place it in the right hand side of the comparison." }, { "patternId": "C0121", "title": "singleton-comparison (C0121)", - "description": "Comparison to %s should be %s\nUsed when an expression is compared to singleton values like True, False or\nNone." + "description": "Comparison to %s should be %s. Used when an expression is compared to singleton values like True, False or None." }, { "patternId": "C0112", "title": "empty-docstring (C0112)", - "description": "Empty %s docstring\nUsed when a module, function, class or method has an empty docstring (it would\nbe too easy ;)." + "description": "Empty %s docstring. Used when a module, function, class or method has an empty docstring (it would be too easy ;)." }, { "patternId": "C0115", "title": "missing-class-docstring (C0115)", - "description": "Missing class docstring\nUsed when a class has no docstring.Even an empty class must have a docstring." + "description": "Missing class docstring. Used when a class has no docstring.Even an empty class must have a docstring." }, { "patternId": "C0116", "title": "missing-function-docstring (C0116)", - "description": "Missing function or method docstring\nUsed when a function or method has no docstring.Some special methods like\n__init__ do not require a docstring." + "description": "Missing function or method docstring. Used when a function or method has no docstring.Some special methods like __init__ do not require a docstring." }, { "patternId": "C0114", "title": "missing-module-docstring (C0114)", - "description": "Missing module docstring\nUsed when a module has no docstring.Empty modules do not require a docstring." + "description": "Missing module docstring. Used when a module has no docstring.Empty modules do not require a docstring." }, { "patternId": "C0123", "title": "unidiomatic-typecheck (C0123)", - "description": "Using type() instead of isinstance() for a typecheck.\nThe idiomatic way to perform an explicit typecheck in Python is to use\nisinstance(x, Y) rather than type(x) == Y, type(x) is Y. Though there are\nunusual situations where these give different results." + "description": "Using type() instead of isinstance() for a typecheck. The idiomatic way to perform an explicit typecheck in Python is to use isinstance(x, Y) rather than type(x) == Y, type(x) is Y. Though there are unusual situations where these give different results." }, { "patternId": "E0203", "title": "access-member-before-definition (E0203)", - "description": "Access to member %r before its definition line %s\nUsed when an instance member is accessed before it's actually assigned." + "description": "Access to member %r before its definition line %s. Used when an instance member is accessed before it's actually assigned." }, { "patternId": "E0202", "title": "method-hidden (E0202)", - "description": "An attribute defined in %s line %s hides this method\nUsed when a class defines a method which is hidden by an instance attribute\nfrom an ancestor class or set by some client code." + "description": "An attribute defined in %s line %s hides this method. Used when a class defines a method which is hidden by an instance attribute from an ancestor class or set by some client code." }, { "patternId": "E0237", "title": "assigning-non-slot (E0237)", - "description": "Assigning to attribute %r not defined in class slots\nUsed when assigning to an attribute not defined in the class slots." + "description": "Assigning to attribute %r not defined in class slots. Used when assigning to an attribute not defined in the class slots." }, { "patternId": "E0241", "title": "duplicate-bases (E0241)", - "description": "Duplicate bases for class %r\nUsed when a class has duplicate bases." + "description": "Duplicate bases for class %r. Used when a class has duplicate bases." }, { "patternId": "E0240", "title": "inconsistent-mro (E0240)", - "description": "Inconsistent method resolution order for class %r\nUsed when a class has an inconsistent method resolution order." + "description": "Inconsistent method resolution order for class %r. Used when a class has an inconsistent method resolution order." }, { "patternId": "E0239", "title": "inherit-non-class (E0239)", - "description": "Inheriting %r, which is not a class.\nUsed when a class inherits from something which is not a class." + "description": "Inheriting %r, which is not a class. Used when a class inherits from something which is not a class." }, { "patternId": "E0238", "title": "invalid-slots (E0238)", - "description": "Invalid __slots__ object\nUsed when an invalid __slots__ is found in class. Only a string, an iterable\nor a sequence is permitted." + "description": "Invalid __slots__ object. Used when an invalid __slots__ is found in class. Only a string, an iterable or a sequence is permitted." }, { "patternId": "E0236", "title": "invalid-slots-object (E0236)", - "description": "Invalid object %r in __slots__, must contain only non empty strings\nUsed when an invalid (non-string) object occurs in __slots__." + "description": "Invalid object %r in __slots__, must contain only non empty strings. Used when an invalid (non-string) object occurs in __slots__." }, { "patternId": "E0211", "title": "no-method-argument (E0211)", - "description": "Method has no argument\nUsed when a method which should have the bound instance as first argument has\nno argument defined." + "description": "Method has no argument. Used when a method which should have the bound instance as first argument has no argument defined." }, { "patternId": "E0213", "title": "no-self-argument (E0213)", - "description": "Method should have \"self\" as first argument\nUsed when a method has an attribute different the \"self\" as first argument.\nThis is considered as an error since this is a so common convention that you\nshouldn't break it!" + "description": "Method should have \"self\" as first 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!" }, { "patternId": "E0302", "title": "unexpected-special-method-signature (E0302)", - "description": "The special method %r expects %s param(s), %d %s given\nEmitted when a special method was defined with an invalid number of\nparameters. If it has too few or too many, it might not work at all." + "description": "The special method %r expects %s param(s), %d %s given. Emitted when a special method was defined with an invalid number of parameters. If it has too few or too many, it might not work at all." }, { "patternId": "E0242", "title": "class-variable-slots-conflict (E0242)", - "description": "Value %r in slots conflicts with class variable\nUsed when a value in __slots__ conflicts with a class variable, property or\nmethod." + "description": "Value %r in slots conflicts with class variable. Used when a value in __slots__ conflicts with a class variable, property or method." }, { "patternId": "E0301", "title": "non-iterator-returned (E0301)", - "description": "__iter__ returns non-iterator\nUsed when an __iter__ method returns something which is not an iterable (i.e.\nhas no __next__ method)" + "description": "__iter__ returns non-iterator. Used when an __iter__ method returns something which is not an iterable (i.e. has no __next__ method)" }, { "patternId": "E0303", "title": "invalid-length-returned (E0303)", - "description": "__len__ does not return non-negative integer\nUsed when a __len__ method returns something which is not a non-negative\ninteger" + "description": "__len__ does not return non-negative integer. Used when a __len__ method returns something which is not a non-negative integer" }, { "patternId": "W0212", "title": "protected-access (W0212)", - "description": "Access to a protected member %s of a client class\nUsed when a protected member (i.e. class member with a name beginning with an\nunderscore) is access outside the class or a descendant of the class where\nit's defined." + "description": "Access to a protected member %s of a client class. 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." }, { "patternId": "W0201", "title": "attribute-defined-outside-init (W0201)", - "description": "Attribute %r defined outside __init__\nUsed when an instance attribute is defined outside the __init__ method." + "description": "Attribute %r defined outside __init__. Used when an instance attribute is defined outside the __init__ method." }, { "patternId": "W0232", "title": "no-init (W0232)", - "description": "Class has no __init__ method\nUsed when a class has no __init__ method, neither its parent classes." + "description": "Class has no __init__ method. Used when a class has no __init__ method, neither its parent classes." }, { "patternId": "W0223", "title": "abstract-method (W0223)", - "description": "Method %r is abstract in class %r but is not overridden\nUsed when an abstract method (i.e. raise NotImplementedError) is not\noverridden in concrete class." + "description": "Method %r is abstract in class %r but is not overridden. Used when an abstract method (i.e. raise NotImplementedError) is not overridden in concrete class." }, { "patternId": "W0236", "title": "invalid-overridden-method (W0236)", - "description": "Method %r was expected to be %r, found it instead as %r\nUsed when we detect that a method was overridden as a property or the other\nway around, which could result in potential bugs at runtime." + "description": "Method %r was expected to be %r, found it instead as %r. Used when we detect that a method was overridden as a property or the other way around, which could result in potential bugs at runtime." }, { "patternId": "W0221", "title": "arguments-differ (W0221)", - "description": "Parameters differ from %s %r method\nUsed when a method has a different number of arguments than in the implemented\ninterface or in an overridden method." + "description": "Parameters differ from %s %r method. Used when a method has a different number of arguments than in the implemented interface or in an overridden method." }, { "patternId": "W0222", "title": "signature-differs (W0222)", - "description": "Signature differs from %s %r method\nUsed when a method signature is different than in the implemented interface or\nin an overridden method." + "description": "Signature differs from %s %r method. Used when a method signature is different than in the implemented interface or in an overridden method." }, { "patternId": "W0211", "title": "bad-staticmethod-argument (W0211)", - "description": "Static method with %r as first argument\nUsed when a static method has \"self\" or a value specified in valid-\nclassmethod-first-arg option or valid-metaclass-classmethod-first-arg option\nas first argument." + "description": "Static method with %r as first 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." }, { "patternId": "W0235", "title": "useless-super-delegation (W0235)", - "description": "Useless super delegation in method %r\nUsed whenever we can detect that an overridden method is useless, relying on\nsuper() delegation to do the same thing as another method from the MRO." + "description": "Useless super delegation in method %r. 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." }, { "patternId": "W0233", "title": "non-parent-init-called (W0233)", - "description": "__init__ method from a non direct base class %r is called\nUsed when an __init__ method is called on a class which is not in the direct\nancestors for the analysed class." + "description": "__init__ method from a non direct base class %r is called. Used when an __init__ method is called on a class which is not in the direct ancestors for the analysed class." }, { "patternId": "W0231", "title": "super-init-not-called (W0231)", - "description": "__init__ method from base class %r is not called\nUsed when an ancestor class method has an __init__ method which is not called\nby a derived class." + "description": "__init__ method from base class %r is not called. Used when an ancestor class method has an __init__ method which is not called by a derived class." }, { "patternId": "R0206", "title": "property-with-parameters (R0206)", - "description": "Cannot have defined parameters for properties\nUsed when we detect that a property also has parameters, which are useless,\ngiven that properties cannot be called with additional arguments." + "description": "Cannot have defined parameters for properties. Used when we detect that a property also has parameters, which are useless, given that properties cannot be called with additional arguments." }, { "patternId": "R0205", "title": "useless-object-inheritance (R0205)", - "description": "Class %r inherits from object, can be safely removed from bases in python3\nUsed when a class inherit from object, which under python3 is implicit, hence\ncan be safely removed from bases." + "description": "Class %r inherits from object, can be safely removed from bases in python3. Used when a class inherit from object, which under python3 is implicit, hence can be safely removed from bases." }, { "patternId": "R0202", "title": "no-classmethod-decorator (R0202)", - "description": "Consider using a decorator instead of calling classmethod\nUsed when a class method is defined without using the decorator syntax." + "description": "Consider using a decorator instead of calling classmethod. Used when a class method is defined without using the decorator syntax." }, { "patternId": "R0203", "title": "no-staticmethod-decorator (R0203)", - "description": "Consider using a decorator instead of calling staticmethod\nUsed when a static method is defined without using the decorator syntax." + "description": "Consider using a decorator instead of calling staticmethod. Used when a static method is defined without using the decorator syntax." }, { "patternId": "R0201", "title": "no-self-use (R0201)", - "description": "Method could be a function\nUsed when a method doesn't use its bound instance, and so could be written as\na function." + "description": "Method could be a function. Used when a method doesn't use its bound instance, and so could be written as a function." }, { "patternId": "C0205", "title": "single-string-used-for-slots (C0205)", - "description": "Class __slots__ should be a non-string iterable\nUsed when a class __slots__ is a simple string, rather than an iterable." + "description": "Class __slots__ should be a non-string iterable. Used when a class __slots__ is a simple string, rather than an iterable." }, { "patternId": "C0202", "title": "bad-classmethod-argument (C0202)", - "description": "Class method %s should have %s as first argument\nUsed when a class method has a first argument named differently than the value\nspecified in valid-classmethod-first-arg option (default to \"cls\"),\nrecommended to easily differentiate them from regular instance methods." + "description": "Class method %s should have %s as first 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." }, { "patternId": "C0204", "title": "bad-mcs-classmethod-argument (C0204)", - "description": "Metaclass class method %s should have %s as first argument\nUsed when a metaclass class method has a first argument named differently than\nthe value specified in valid-metaclass-classmethod-first-arg option (default\nto \"mcs\"), recommended to easily differentiate them from regular instance\nmethods." + "description": "Metaclass class method %s should have %s as first 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." }, { "patternId": "C0203", "title": "bad-mcs-method-argument (C0203)", - "description": "Metaclass method %s should have %s as first argument\nUsed when a metaclass method has a first argument named differently than the\nvalue specified in valid-classmethod-first-arg option (default to \"cls\"),\nrecommended to easily differentiate them from regular instance methods." + "description": "Metaclass method %s should have %s as first 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." }, { "patternId": "F0202", "title": "method-check-failed (F0202)", - "description": "Unable to check methods signature (%s / %s)\nUsed when Pylint has been unable to check methods signature compatibility for\nan unexpected reason. Please report this kind if you don't make sense of it." + "description": "Unable to check methods signature (%s / %s). 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." }, { "patternId": "R0903", "title": "too-few-public-methods (R0903)", - "description": "Too few public methods (%s/%s)\nUsed when class has too few public methods, so be sure it's really worth it." + "description": "Too few public methods (%s/%s). Used when class has too few public methods, so be sure it's really worth it." }, { "patternId": "R0901", "title": "too-many-ancestors (R0901)", - "description": "Too many ancestors (%s/%s)\nUsed when class has too many parent classes, try to reduce this to get a\nsimpler (and so easier to use) class." + "description": "Too many ancestors (%s/%s). Used when class has too many parent classes, try to reduce this to get a simpler (and so easier to use) class." }, { "patternId": "R0913", "title": "too-many-arguments (R0913)", - "description": "Too many arguments (%s/%s)\nUsed when a function or method takes too many arguments." + "description": "Too many arguments (%s/%s). Used when a function or method takes too many arguments." }, { "patternId": "R0916", "title": "too-many-boolean-expressions (R0916)", - "description": "Too many boolean expressions in if statement (%s/%s)\nUsed when an if statement contains too many boolean expressions." + "description": "Too many boolean expressions in if statement (%s/%s). Used when an if statement contains too many boolean expressions." }, { "patternId": "R0912", "title": "too-many-branches (R0912)", - "description": "Too many branches (%s/%s)\nUsed when a function or method has too many branches, making it hard to\nfollow." + "description": "Too many branches (%s/%s). Used when a function or method has too many branches, making it hard to follow." }, { "patternId": "R0902", "title": "too-many-instance-attributes (R0902)", - "description": "Too many instance attributes (%s/%s)\nUsed when class has too many instance attributes, try to reduce this to get a\nsimpler (and so easier to use) class." + "description": "Too many instance attributes (%s/%s). Used when class has too many instance attributes, try to reduce this to get a simpler (and so easier to use) class." }, { "patternId": "R0914", "title": "too-many-locals (R0914)", - "description": "Too many local variables (%s/%s)\nUsed when a function or method has too many local variables." + "description": "Too many local variables (%s/%s). Used when a function or method has too many local variables." }, { "patternId": "R0904", "title": "too-many-public-methods (R0904)", - "description": "Too many public methods (%s/%s)\nUsed when class has too many public methods, try to reduce this to get a\nsimpler (and so easier to use) class." + "description": "Too many public methods (%s/%s). Used when class has too many public methods, try to reduce this to get a simpler (and so easier to use) class." }, { "patternId": "R0911", "title": "too-many-return-statements (R0911)", - "description": "Too many return statements (%s/%s)\nUsed when a function or method has too many return statement, making it hard\nto follow." + "description": "Too many return statements (%s/%s). Used when a function or method has too many return statement, making it hard to follow." }, { "patternId": "R0915", "title": "too-many-statements (R0915)", - "description": "Too many statements (%s/%s)\nUsed when a function or method has too many statements. You should then split\nit in smaller functions / methods." + "description": "Too many statements (%s/%s). Used when a function or method has too many statements. You should then split it in smaller functions / methods." }, { "patternId": "E0701", "title": "bad-except-order (E0701)", - "description": "Bad except clauses order (%s)\nUsed when except clauses are not in the correct order (from the more specific\nto the more generic). If you don't fix the order, some exceptions may not be\ncaught by the most specific handler." + "description": "Bad except clauses order (%s). Used when except clauses are not in the correct order (from the more specific to the more generic). If you don't fix the order, some exceptions may not be caught by the most specific handler." }, { "patternId": "E0712", "title": "catching-non-exception (E0712)", - "description": "Catching an exception which doesn't inherit from Exception: %s\nUsed when a class which doesn't inherit from Exception is used as an exception\nin an except clause." + "description": "Catching an exception which doesn't inherit from Exception: %s. Used when a class which doesn't inherit from Exception is used as an exception in an except clause." }, { "patternId": "E0703", "title": "bad-exception-context (E0703)", - "description": "Exception context set to something which is not an exception, nor None\nUsed when using the syntax \"raise ... from ...\", where the exception context\nis not an exception, nor None." + "description": "Exception context set to something which is not an exception, nor None. Used when using the syntax \"raise ... from ...\", where the exception context is not an exception, nor None." }, { "patternId": "E0711", "title": "notimplemented-raised (E0711)", - "description": "NotImplemented raised - should raise NotImplementedError\nUsed when NotImplemented is raised instead of NotImplementedError" + "description": "NotImplemented raised - should raise NotImplementedError. Used when NotImplemented is raised instead of NotImplementedError" }, { "patternId": "E0702", "title": "raising-bad-type (E0702)", - "description": "Raising %s while only classes or instances are allowed\nUsed when something which is neither a class, an instance or a string is\nraised (i.e. a TypeError will be raised)." + "description": "Raising %s while only classes or instances are allowed. Used when something which is neither a class, an instance or a string is raised (i.e. a TypeError will be raised)." }, { "patternId": "E0710", "title": "raising-non-exception (E0710)", - "description": "Raising a new style class which doesn't inherit from BaseException\nUsed when a new style class which doesn't inherit from BaseException is\nraised." + "description": "Raising a new style class which doesn't inherit from BaseException. Used when a new style class which doesn't inherit from BaseException is raised." }, { "patternId": "E0704", "title": "misplaced-bare-raise (E0704)", - "description": "The raise statement is not inside an except clause\nUsed when a bare raise is not used inside an except clause. This generates an\nerror, since there are no active exceptions to be reraised. An exception to\nthis rule is represented by a bare raise inside a finally clause, which might\nwork, as long as an exception is raised inside the try block, but it is\nnevertheless a code smell that must not be relied upon." + "description": "The raise statement is not inside an except clause. Used when a bare raise is not used inside an except clause. This generates an error, since there are no active exceptions to be reraised. An exception to this rule is represented by a bare raise inside a finally clause, which might work, as long as an exception is raised inside the try block, but it is nevertheless a code smell that must not be relied upon." }, { "patternId": "W0705", "title": "duplicate-except (W0705)", - "description": "Catching previously caught exception type %s\nUsed when an except catches a type that was already caught by a previous\nhandler." + "description": "Catching previously caught exception type %s. Used when an except catches a type that was already caught by a previous handler." }, { "patternId": "W0703", "title": "broad-except (W0703)", - "description": "Catching too general exception %s\nUsed when an except catches a too general exception, possibly burying\nunrelated errors." + "description": "Catching too general exception %s. Used when an except catches a too general exception, possibly burying unrelated errors." }, { "patternId": "W0715", "title": "raising-format-tuple (W0715)", - "description": "Exception arguments suggest string formatting might be intended\nUsed when passing multiple arguments to an exception constructor, the first of\nthem a string literal containing what appears to be placeholders intended for\nformatting" + "description": "Exception arguments suggest string formatting might be intended. Used when passing multiple arguments to an exception constructor, the first of them a string literal containing what appears to be placeholders intended for formatting" }, { "patternId": "W0711", "title": "binary-op-exception (W0711)", - "description": "Exception to catch is the result of a binary \"%s\" operation\nUsed when the exception to catch is of the form \"except A or B:\". If intending\nto catch multiple, rewrite as \"except (A, B):\"" + "description": "Exception to catch is the result of a binary \"%s\" operation. Used when the exception to catch is of the form \"except A or B:\". If intending to catch multiple, rewrite as \"except (A, B):\"" }, { "patternId": "W0716", "title": "wrong-exception-operation (W0716)", - "description": "Invalid exception operation. %s\nUsed when an operation is done against an exception, but the operation is not\nvalid for the exception in question. Usually emitted when having binary\noperations between exceptions in except handlers." + "description": "Invalid exception operation. %s. Used when an operation is done against an exception, but the operation is not valid for the exception in question. Usually emitted when having binary operations between exceptions in except handlers." }, { "patternId": "W0702", "title": "bare-except (W0702)", - "description": "No exception type(s) specified\nUsed when an except clause doesn't specify exceptions type to catch." + "description": "No exception type(s) specified. Used when an except clause doesn't specify exceptions type to catch." }, { "patternId": "W0706", "title": "try-except-raise (W0706)", - "description": "The except handler raises immediately\nUsed when an except handler uses raise as its first or only operator. This is\nuseless because it raises back the exception immediately. Remove the raise\noperator or the entire try-except-raise block!" + "description": "The except handler raises immediately. Used when an except handler uses raise as its first or only operator. This is useless because it raises back the exception immediately. Remove the raise operator or the entire try-except-raise block!" }, { "patternId": "W0311", "title": "bad-indentation (W0311)", - "description": "Bad indentation. Found %s %s, expected %s\nUsed when an unexpected number of indentation's tabulations or spaces has been\nfound." + "description": "Bad indentation. Found %s %s, expected %s. Used when an unexpected number of indentation's tabulations or spaces has been found." }, { "patternId": "W0312", "title": "mixed-indentation (W0312)", - "description": "Found indentation with %ss instead of %ss\nUsed when there are some mixed tabs and spaces in a module." + "description": "Found indentation with %ss instead of %ss. Used when there are some mixed tabs and spaces in a module." }, { "patternId": "W0301", "title": "unnecessary-semicolon (W0301)", - "description": "Unnecessary semicolon\nUsed when a statement is ended by a semi-colon (\";\"), which isn't necessary\n(that's python, not C ;)." + "description": "Unnecessary semicolon. Used when a statement is ended by a semi-colon (\";\"), which isn't necessary (that's python, not C ;)." }, { "patternId": "C0326", "title": "bad-whitespace (C0326)", - "description": "%s space %s %s %s\nUsed when a wrong number of spaces is used around an operator, bracket or\nblock opener." + "description": "%s space %s %s %s. Used when a wrong number of spaces is used around an operator, bracket or block opener." }, { "patternId": "C0304", "title": "missing-final-newline (C0304)", - "description": "Final newline missing\nUsed when the last line in a file is missing a newline." + "description": "Final newline missing. Used when the last line in a file is missing a newline." }, { "patternId": "C0301", "title": "line-too-long (C0301)", - "description": "Line too long (%s/%s)\nUsed when a line is longer than a given number of characters." + "description": "Line too long (%s/%s). Used when a line is longer than a given number of characters." }, { "patternId": "C0327", "title": "mixed-line-endings (C0327)", - "description": "Mixed line endings LF and CRLF\nUsed when there are mixed (LF and CRLF) newline signs in a file." + "description": "Mixed line endings LF and CRLF. Used when there are mixed (LF and CRLF) newline signs in a file." }, { "patternId": "C0321", "title": "multiple-statements (C0321)", - "description": "More than one statement on a single line\nUsed when more than on statement are found on the same line." + "description": "More than one statement on a single line. Used when more than on statement are found on the same line." }, { "patternId": "C0302", "title": "too-many-lines (C0302)", - "description": "Too many lines in module (%s/%s)\nUsed when a module has too many lines, reducing its readability." + "description": "Too many lines in module (%s/%s). Used when a module has too many lines, reducing its readability." }, { "patternId": "C0305", "title": "trailing-newlines (C0305)", - "description": "Trailing newlines\nUsed when there are trailing blank lines in a file." + "description": "Trailing newlines. Used when there are trailing blank lines in a file." }, { "patternId": "C0303", "title": "trailing-whitespace (C0303)", - "description": "Trailing whitespace\nUsed when there is whitespace between the end of a line and the newline." + "description": "Trailing whitespace. Used when there is whitespace between the end of a line and the newline." }, { "patternId": "C0328", "title": "unexpected-line-ending-format (C0328)", - "description": "Unexpected line ending format. There is '%s' while it should be '%s'.\nUsed when there is different newline than expected." + "description": "Unexpected line ending format. There is '%s' while it should be '%s'. Used when there is different newline than expected." }, { "patternId": "C0325", "title": "superfluous-parens (C0325)", - "description": "Unnecessary parens after %r keyword\nUsed when a single item in parentheses follows an if, for, or other keyword." + "description": "Unnecessary parens after %r keyword. Used when a single item in parentheses follows an if, for, or other keyword." }, { "patternId": "C0330", "title": "bad-continuation (C0330)", - "description": "Wrong %s indentation%s%s.\nTODO" + "description": "Wrong %s indentation%s%s. TODO" }, { "patternId": "E0402", "title": "relative-beyond-top-level (E0402)", - "description": "Attempted relative import beyond top-level package\nUsed when a relative import tries to access too many levels in the current\npackage." + "description": "Attempted relative import beyond top-level package. Used when a relative import tries to access too many levels in the current package." }, { "patternId": "E0401", "title": "import-error (E0401)", - "description": "Unable to import %s\nUsed when pylint has been unable to import a module." + "description": "Unable to import %s. Used when pylint has been unable to import a module." }, { "patternId": "W0406", "title": "import-self (W0406)", - "description": "Module import itself\nUsed when a module is importing itself." + "description": "Module import itself. Used when a module is importing itself." }, { "patternId": "W0407", "title": "preferred-module (W0407)", - "description": "Prefer importing %r instead of %r\nUsed when a module imported has a preferred replacement module." + "description": "Prefer importing %r instead of %r. Used when a module imported has a preferred replacement module." }, { "patternId": "W0404", "title": "reimported (W0404)", - "description": "Reimport %r (imported line %s)\nUsed when a module is reimported multiple times." + "description": "Reimport %r (imported line %s). Used when a module is reimported multiple times." }, { "patternId": "W0402", "title": "deprecated-module (W0402)", - "description": "Uses of a deprecated module %r\nUsed a module marked as deprecated is imported." + "description": "Uses of a deprecated module %r. Used a module marked as deprecated is imported." }, { "patternId": "W0401", "title": "wildcard-import (W0401)", - "description": "Wildcard import %s\nUsed when from module import * is detected." + "description": "Wildcard import %s. Used when from module import * is detected." }, { "patternId": "W0410", "title": "misplaced-future (W0410)", - "description": "__future__ import is not the first non docstring statement\nPython 2.5 and greater require __future__ import to be the first non docstring\nstatement in the module." + "description": "__future__ import is not the first non docstring statement. Python 2.5 and greater require __future__ import to be the first non docstring statement in the module." }, { "patternId": "R0401", "title": "cyclic-import (R0401)", - "description": "Cyclic import (%s)\nUsed when a cyclic import between two or more modules is detected." + "description": "Cyclic import (%s). Used when a cyclic import between two or more modules is detected." }, { "patternId": "C0411", "title": "wrong-import-order (C0411)", - "description": "%s should be placed before %s\nUsed when PEP8 import order is not respected (standard imports first, then\nthird-party libraries, then local imports)" + "description": "%s should be placed before %s. Used when PEP8 import order is not respected (standard imports first, then third-party libraries, then local imports)" }, { "patternId": "C0413", "title": "wrong-import-position (C0413)", - "description": "Import \"%s\" should be placed at the top of the module\nUsed when code and imports are mixed" + "description": "Import \"%s\" should be placed at the top of the module. Used when code and imports are mixed" }, { "patternId": "C0414", "title": "useless-import-alias (C0414)", - "description": "Import alias does not rename original package\nUsed when an import alias is same as original package.e.g using import numpy\nas numpy instead of import numpy as np" + "description": "Import alias does not rename original package. Used when an import alias is same as original package.e.g using import numpy as numpy instead of import numpy as np" }, { "patternId": "C0415", "title": "import-outside-toplevel (C0415)", - "description": "Import outside toplevel (%s)\nUsed when an import statement is used anywhere other than the module toplevel.\nMove this import to the top of the file." + "description": "Import outside toplevel (%s). Used when an import statement is used anywhere other than the module toplevel. Move this import to the top of the file." }, { "patternId": "C0412", "title": "ungrouped-imports (C0412)", - "description": "Imports from package %s are not grouped\nUsed when imports are not grouped by packages" + "description": "Imports from package %s are not grouped. Used when imports are not grouped by packages" }, { "patternId": "C0410", "title": "multiple-imports (C0410)", - "description": "Multiple imports on one line (%s)\nUsed when import statement importing multiple modules is detected." + "description": "Multiple imports on one line (%s). Used when import statement importing multiple modules is detected." }, { "patternId": "E1201", "title": "logging-format-truncated (E1201)", - "description": "Logging format string ends in middle of conversion specifier\nUsed when a logging statement format string terminates before the end of a\nconversion specifier." + "description": "Logging format string ends in middle of conversion specifier. Used when a logging statement format string terminates before the end of a conversion specifier." }, { "patternId": "E1206", "title": "logging-too-few-args (E1206)", - "description": "Not enough arguments for logging format string\nUsed when a logging format string is given too few arguments." + "description": "Not enough arguments for logging format string. Used when a logging format string is given too few arguments." }, { "patternId": "E1205", "title": "logging-too-many-args (E1205)", - "description": "Too many arguments for logging format string\nUsed when a logging format string is given too many arguments." + "description": "Too many arguments for logging format string. Used when a logging format string is given too many arguments." }, { "patternId": "E1200", "title": "logging-unsupported-format (E1200)", - "description": "Unsupported logging format character %r (%#02x) at index %d\nUsed when an unsupported format character is used in a logging statement\nformat string." + "description": "Unsupported logging format character %r (%#02x) at index %d. Used when an unsupported format character is used in a logging statement format string." }, { "patternId": "W1201", "title": "logging-not-lazy (W1201)", - "description": "Specify string format arguments as logging function parameters\nUsed when a logging statement has a call form of \"logging.(format_string % (format_args...))\". Such calls should leave string\ninterpolation to the logging method itself and be written \"logging.(format_string, format_args...)\" so that the program may avoid\nincurring the cost of the interpolation in those cases in which no message\nwill be logged. For more, see http://www.python.org/dev/peps/pep-0282/." + "description": "Specify string format arguments as logging function parameters. Used when a logging statement has a call form of \"logging.(format_string % (format_args...))\". Such calls should leave string interpolation to the logging method itself and be written \"logging.(format_string, format_args...)\" so that the program may avoid incurring the cost of the interpolation in those cases in which no message will be logged. For more, see http://www.python.org/dev/peps/pep-0282/." }, { "patternId": "W1202", "title": "logging-format-interpolation (W1202)", - "description": "Use %s formatting in logging functions%s\nUsed when a logging statement has a call form of \"logging.()\". with invalid string formatting. Use another way\nfor format the string instead." + "description": "Use %s formatting in logging functions%s. Used when a logging statement has a call form of \"logging.()\". with invalid string formatting. Use another way for format the string instead." }, { "patternId": "W0511", @@ -742,921 +742,921 @@ { "patternId": "E1003", "title": "bad-super-call (E1003)", - "description": "Bad first argument %r given to super()\nUsed when another argument than the current class is given as first argument\nof the super builtin." + "description": "Bad first argument %r given to super(). Used when another argument than the current class is given as first argument of the super builtin." }, { "patternId": "E1603", "title": "unpacking-in-except (E1603)", - "description": "Implicit unpacking of exceptions is not supported in Python 3\nPython3 will not allow implicit unpacking of exceptions in except clauses. See\nhttp://www.python.org/dev/peps/pep-3110/" + "description": "Implicit unpacking of exceptions is not supported in Python 3. Python3 will not allow implicit unpacking of exceptions in except clauses. See http://www.python.org/dev/peps/pep-3110/" }, { "patternId": "E1609", "title": "import-star-module-level (E1609)", - "description": "Import * only allowed at module level\nUsed when the import star syntax is used somewhere else than the module level.\nThis message can't be emitted when using Python >= 3.0." + "description": "Import * only allowed at module level. Used when the import star syntax is used somewhere else than the module level. This message can't be emitted when using Python >= 3.0." }, { "patternId": "E1610", "title": "non-ascii-bytes-literal (E1610)", - "description": "Non-ascii bytes literals not supported in 3.x\nUsed when non-ascii bytes literals are found in a program. They are no longer\nsupported in Python 3. This message can't be emitted when using Python >= 3.0." + "description": "Non-ascii bytes literals not supported in 3.x. Used when non-ascii bytes literals are found in a program. They are no longer supported in Python 3. This message can't be emitted when using Python >= 3.0." }, { "patternId": "E1602", "title": "parameter-unpacking (E1602)", - "description": "Parameter unpacking specified\nUsed when parameter unpacking is specified for a function(Python 3 doesn't\nallow it)" + "description": "Parameter unpacking specified. Used when parameter unpacking is specified for a function(Python 3 doesn't allow it)" }, { "patternId": "E1606", "title": "long-suffix (E1606)", - "description": "Use of long suffix\nUsed when \"l\" or \"L\" is used to mark a long integer. This will not work in\nPython 3, since int and long types have merged. This message can't be\nemitted when using Python >= 3.0." + "description": "Use of long suffix. Used when \"l\" or \"L\" is used to mark a long integer. This will not work in Python 3, since int and long types have merged. This message can't be emitted when using Python >= 3.0." }, { "patternId": "E1608", "title": "old-octal-literal (E1608)", - "description": "Use of old octal literal\nUsed when encountering the old octal syntax, removed in Python 3. To use the\nnew syntax, prepend 0o on the number. This message can't be emitted when using\nPython >= 3.0." + "description": "Use of old octal literal. Used when encountering the old octal syntax, removed in Python 3. To use the new syntax, prepend 0o on the number. This message can't be emitted when using Python >= 3.0." }, { "patternId": "E1607", "title": "old-ne-operator (E1607)", - "description": "Use of the <> operator\nUsed when the deprecated \"<>\" operator is used instead of \"!=\". This is\nremoved in Python 3. This message can't be emitted when using Python >= 3.0." + "description": "Use of the <> operator. Used when the deprecated \"<>\" operator is used instead of \"!=\". This is removed in Python 3. This message can't be emitted when using Python >= 3.0." }, { "patternId": "E1605", "title": "backtick (E1605)", - "description": "Use of the `` operator\nUsed when the deprecated \"``\" (backtick) operator is used instead of the str()\nfunction." + "description": "Use of the `` operator. Used when the deprecated \"``\" (backtick) operator is used instead of the str() function." }, { "patternId": "E1604", "title": "old-raise-syntax (E1604)", - "description": "Use raise ErrorClass(args) instead of raise ErrorClass, args.\nUsed when the alternate raise syntax 'raise foo, bar' is used instead of\n'raise foo(bar)'." + "description": "Use raise ErrorClass(args) instead of raise ErrorClass, args. Used when the alternate raise syntax 'raise foo, bar' is used instead of 'raise foo(bar)'." }, { "patternId": "E1601", "title": "print-statement (E1601)", - "description": "print statement used\nUsed when a print statement is used (print is a function in Python 3)" + "description": "print statement used. Used when a print statement is used (print is a function in Python 3)" }, { "patternId": "W1652", "title": "deprecated-types-field (W1652)", - "description": "Accessing a deprecated fields on the types module\nUsed when accessing a field on types that has been removed in Python 3." + "description": "Accessing a deprecated fields on the types module. Used when accessing a field on types that has been removed in Python 3." }, { "patternId": "W1651", "title": "deprecated-itertools-function (W1651)", - "description": "Accessing a deprecated function on the itertools module\nUsed when accessing a function on itertools that has been removed in Python 3." + "description": "Accessing a deprecated function on the itertools module. Used when accessing a function on itertools that has been removed in Python 3." }, { "patternId": "W1649", "title": "deprecated-string-function (W1649)", - "description": "Accessing a deprecated function on the string module\nUsed when accessing a string function that has been deprecated in Python 3." + "description": "Accessing a deprecated function on the string module. Used when accessing a string function that has been deprecated in Python 3." }, { "patternId": "W1657", "title": "deprecated-operator-function (W1657)", - "description": "Accessing a removed attribute on the operator module\nUsed when accessing a field on operator module that has been removed in Python\n3." + "description": "Accessing a removed attribute on the operator module. Used when accessing a field on operator module that has been removed in Python 3." }, { "patternId": "W1660", "title": "deprecated-sys-function (W1660)", - "description": "Accessing a removed attribute on the sys module\nUsed when accessing a field on sys module that has been removed in Python 3." + "description": "Accessing a removed attribute on the sys module. Used when accessing a field on sys module that has been removed in Python 3." }, { "patternId": "W1658", "title": "deprecated-urllib-function (W1658)", - "description": "Accessing a removed attribute on the urllib module\nUsed when accessing a field on urllib module that has been removed or moved in\nPython 3." + "description": "Accessing a removed attribute on the urllib module. Used when accessing a field on urllib module that has been removed or moved in Python 3." }, { "patternId": "W1659", "title": "xreadlines-attribute (W1659)", - "description": "Accessing a removed xreadlines attribute\nUsed when accessing the xreadlines() function on a file stream, removed in\nPython 3." + "description": "Accessing a removed xreadlines attribute. Used when accessing the xreadlines() function on a file stream, removed in Python 3." }, { "patternId": "W1623", "title": "metaclass-assignment (W1623)", - "description": "Assigning to a class's __metaclass__ attribute\nUsed when a metaclass is specified by assigning to __metaclass__ (Python 3\nspecifies the metaclass as a class statement argument)" + "description": "Assigning to a class's __metaclass__ attribute. Used when a metaclass is specified by assigning to __metaclass__ (Python 3 specifies the metaclass as a class statement argument)" }, { "patternId": "W1622", "title": "next-method-called (W1622)", - "description": "Called a next() method on an object\nUsed when an object's next() method is called (Python 3 uses the next() built-\nin function)" + "description": "Called a next() method on an object. Used when an object's next() method is called (Python 3 uses the next() built- in function)" }, { "patternId": "W1620", "title": "dict-iter-method (W1620)", - "description": "Calling a dict.iter*() method\nUsed for calls to dict.iterkeys(), itervalues() or iteritems() (Python 3 lacks\nthese methods)" + "description": "Calling a dict.iter*() method. Used for calls to dict.iterkeys(), itervalues() or iteritems() (Python 3 lacks these methods)" }, { "patternId": "W1621", "title": "dict-view-method (W1621)", - "description": "Calling a dict.view*() method\nUsed for calls to dict.viewkeys(), viewvalues() or viewitems() (Python 3 lacks\nthese methods)" + "description": "Calling a dict.view*() method. Used for calls to dict.viewkeys(), viewvalues() or viewitems() (Python 3 lacks these methods)" }, { "patternId": "W1645", "title": "exception-message-attribute (W1645)", - "description": "Exception.message removed in Python 3\nUsed when the message attribute is accessed on an Exception. Use\nstr(exception) instead." + "description": "Exception.message removed in Python 3. Used when the message attribute is accessed on an Exception. Use str(exception) instead." }, { "patternId": "W1641", "title": "eq-without-hash (W1641)", - "description": "Implementing __eq__ without also implementing __hash__\nUsed when a class implements __eq__ but not __hash__. In Python 2, objects get\nobject.__hash__ as the default implementation, in Python 3 objects get None as\ntheir default __hash__ implementation if they also implement __eq__." + "description": "Implementing __eq__ without also implementing __hash__. Used when a class implements __eq__ but not __hash__. In Python 2, objects get object.__hash__ as the default implementation, in Python 3 objects get None as their default __hash__ implementation if they also implement __eq__." }, { "patternId": "W1624", "title": "indexing-exception (W1624)", - "description": "Indexing exceptions will not work on Python 3\nIndexing exceptions will not work on Python 3. Use exception.args[index]\ninstead." + "description": "Indexing exceptions will not work on Python 3. Indexing exceptions will not work on Python 3. Use exception.args[index] instead." }, { "patternId": "W1648", "title": "bad-python3-import (W1648)", - "description": "Module moved in Python 3\nUsed when importing a module that no longer exists in Python 3." + "description": "Module moved in Python 3. Used when importing a module that no longer exists in Python 3." }, { "patternId": "W1625", "title": "raising-string (W1625)", - "description": "Raising a string exception\nUsed when a string exception is raised. This will not work on Python 3." + "description": "Raising a string exception. Used when a string exception is raised. This will not work on Python 3." }, { "patternId": "W1611", "title": "standarderror-builtin (W1611)", - "description": "StandardError built-in referenced\nUsed when the StandardError built-in function is referenced (missing from\nPython 3)" + "description": "StandardError built-in referenced. Used when the StandardError built-in function is referenced (missing from Python 3)" }, { "patternId": "W1662", "title": "comprehension-escape (W1662)", - "description": "Using a variable that was bound inside a comprehension\nEmitted when using a variable, that was bound in a comprehension handler,\noutside of the comprehension itself. On Python 3 these variables will be\ndeleted outside of the comprehension." + "description": "Using a variable that was bound inside a comprehension. Emitted when using a variable, that was bound in a comprehension handler, outside of the comprehension itself. On Python 3 these variables will be deleted outside of the comprehension." }, { "patternId": "W1661", "title": "exception-escape (W1661)", - "description": "Using an exception object that was bound by an except handler\nEmitted when using an exception, that was bound in an except handler, outside\nof the except handler. On Python 3 these exceptions will be deleted once they\nget out of the except handler." + "description": "Using an exception object that was bound by an except handler. Emitted when using an exception, that was bound in an except handler, outside of the except handler. On Python 3 these exceptions will be deleted once they get out of the except handler." }, { "patternId": "W1650", "title": "deprecated-str-translate-call (W1650)", - "description": "Using str.translate with deprecated deletechars parameters\nUsed when using the deprecated deletechars parameters from str.translate. Use\nre.sub to remove the desired characters" + "description": "Using str.translate with deprecated deletechars parameters. Used when using the deprecated deletechars parameters from str.translate. Use re.sub to remove the desired characters" }, { "patternId": "W1640", "title": "using-cmp-argument (W1640)", - "description": "Using the cmp argument for list.sort / sorted\nUsing the cmp argument for list.sort or the sorted builtin should be avoided,\nsince it was removed in Python 3. Using either key or functools.cmp_to_key\nshould be preferred." + "description": "Using the cmp argument for list.sort / sorted. Using the cmp argument for list.sort or the sorted builtin should be avoided, since it was removed in Python 3. Using either key or functools.cmp_to_key should be preferred." }, { "patternId": "W1630", "title": "cmp-method (W1630)", - "description": "__cmp__ method defined\nUsed when a __cmp__ method is defined (method is not used by Python 3)" + "description": "__cmp__ method defined. Used when a __cmp__ method is defined (method is not used by Python 3)" }, { "patternId": "W1614", "title": "coerce-method (W1614)", - "description": "__coerce__ method defined\nUsed when a __coerce__ method is defined (method is not used by Python 3)" + "description": "__coerce__ method defined. Used when a __coerce__ method is defined (method is not used by Python 3)" }, { "patternId": "W1615", "title": "delslice-method (W1615)", - "description": "__delslice__ method defined\nUsed when a __delslice__ method is defined (method is not used by Python 3)" + "description": "__delslice__ method defined. Used when a __delslice__ method is defined (method is not used by Python 3)" }, { "patternId": "W1642", "title": "div-method (W1642)", - "description": "__div__ method defined\nUsed when a __div__ method is defined. Using __truediv__ and setting__div__\n= __truediv__ should be preferred.(method is not used by Python 3)" + "description": "__div__ method defined. Used when a __div__ method is defined. Using __truediv__ and setting__div__ = __truediv__ should be preferred.(method is not used by Python 3)" }, { "patternId": "W1616", "title": "getslice-method (W1616)", - "description": "__getslice__ method defined\nUsed when a __getslice__ method is defined (method is not used by Python 3)" + "description": "__getslice__ method defined. Used when a __getslice__ method is defined (method is not used by Python 3)" }, { "patternId": "W1628", "title": "hex-method (W1628)", - "description": "__hex__ method defined\nUsed when a __hex__ method is defined (method is not used by Python 3)" + "description": "__hex__ method defined. Used when a __hex__ method is defined (method is not used by Python 3)" }, { "patternId": "W1643", "title": "idiv-method (W1643)", - "description": "__idiv__ method defined\nUsed when an __idiv__ method is defined. Using __itruediv__ and\nsetting__idiv__ = __itruediv__ should be preferred.(method is not used by\nPython 3)" + "description": "__idiv__ method defined. Used when an __idiv__ method is defined. Using __itruediv__ and setting__idiv__ = __itruediv__ should be preferred.(method is not used by Python 3)" }, { "patternId": "W1629", "title": "nonzero-method (W1629)", - "description": "__nonzero__ method defined\nUsed when a __nonzero__ method is defined (method is not used by Python 3)" + "description": "__nonzero__ method defined. Used when a __nonzero__ method is defined (method is not used by Python 3)" }, { "patternId": "W1627", "title": "oct-method (W1627)", - "description": "__oct__ method defined\nUsed when an __oct__ method is defined (method is not used by Python 3)" + "description": "__oct__ method defined. Used when an __oct__ method is defined (method is not used by Python 3)" }, { "patternId": "W1644", "title": "rdiv-method (W1644)", - "description": "__rdiv__ method defined\nUsed when a __rdiv__ method is defined. Using __rtruediv__ and\nsetting__rdiv__ = __rtruediv__ should be preferred.(method is not used by\nPython 3)" + "description": "__rdiv__ method defined. Used when a __rdiv__ method is defined. Using __rtruediv__ and setting__rdiv__ = __rtruediv__ should be preferred.(method is not used by Python 3)" }, { "patternId": "W1617", "title": "setslice-method (W1617)", - "description": "__setslice__ method defined\nUsed when a __setslice__ method is defined (method is not used by Python 3)" + "description": "__setslice__ method defined. Used when a __setslice__ method is defined (method is not used by Python 3)" }, { "patternId": "W1601", "title": "apply-builtin (W1601)", - "description": "apply built-in referenced\nUsed when the apply built-in function is referenced (missing from Python 3)" + "description": "apply built-in referenced. Used when the apply built-in function is referenced (missing from Python 3)" }, { "patternId": "W1602", "title": "basestring-builtin (W1602)", - "description": "basestring built-in referenced\nUsed when the basestring built-in function is referenced (missing from Python\n3)" + "description": "basestring built-in referenced. Used when the basestring built-in function is referenced (missing from Python 3)" }, { "patternId": "W1603", "title": "buffer-builtin (W1603)", - "description": "buffer built-in referenced\nUsed when the buffer built-in function is referenced (missing from Python 3)" + "description": "buffer built-in referenced. Used when the buffer built-in function is referenced (missing from Python 3)" }, { "patternId": "W1604", "title": "cmp-builtin (W1604)", - "description": "cmp built-in referenced\nUsed when the cmp built-in function is referenced (missing from Python 3)" + "description": "cmp built-in referenced. Used when the cmp built-in function is referenced (missing from Python 3)" }, { "patternId": "W1605", "title": "coerce-builtin (W1605)", - "description": "coerce built-in referenced\nUsed when the coerce built-in function is referenced (missing from Python 3)" + "description": "coerce built-in referenced. Used when the coerce built-in function is referenced (missing from Python 3)" }, { "patternId": "W1654", "title": "dict-items-not-iterating (W1654)", - "description": "dict.items referenced when not iterating\nUsed when dict.items is referenced in a non-iterating context (returns an\niterator in Python 3)" + "description": "dict.items referenced when not iterating. Used when dict.items is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "W1655", "title": "dict-keys-not-iterating (W1655)", - "description": "dict.keys referenced when not iterating\nUsed when dict.keys is referenced in a non-iterating context (returns an\niterator in Python 3)" + "description": "dict.keys referenced when not iterating. Used when dict.keys is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "W1656", "title": "dict-values-not-iterating (W1656)", - "description": "dict.values referenced when not iterating\nUsed when dict.values is referenced in a non-iterating context (returns an\niterator in Python 3)" + "description": "dict.values referenced when not iterating. Used when dict.values is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "W1619", "title": "old-division (W1619)", - "description": "division w/o __future__ statement\nUsed for non-floor division w/o a float literal or from __future__ import\ndivision (Python 3 returns a float for int division unconditionally)" + "description": "division w/o __future__ statement. Used for non-floor division w/o a float literal or from __future__ import division (Python 3 returns a float for int division unconditionally)" }, { "patternId": "W1606", "title": "execfile-builtin (W1606)", - "description": "execfile built-in referenced\nUsed when the execfile built-in function is referenced (missing from Python 3)" + "description": "execfile built-in referenced. Used when the execfile built-in function is referenced (missing from Python 3)" }, { "patternId": "W1607", "title": "file-builtin (W1607)", - "description": "file built-in referenced\nUsed when the file built-in function is referenced (missing from Python 3)" + "description": "file built-in referenced. Used when the file built-in function is referenced (missing from Python 3)" }, { "patternId": "W1639", "title": "filter-builtin-not-iterating (W1639)", - "description": "filter built-in referenced when not iterating\nUsed when the filter built-in is referenced in a non-iterating context\n(returns an iterator in Python 3)" + "description": "filter built-in referenced when not iterating. Used when the filter built-in is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "W1618", "title": "no-absolute-import (W1618)", - "description": "import missing `from __future__ import absolute_import`\nUsed when an import is not accompanied by from __future__ import\nabsolute_import (default behaviour in Python 3)" + "description": "import missing `from __future__ import absolute_import`. Used when an import is not accompanied by from __future__ import absolute_import (default behaviour in Python 3)" }, { "patternId": "W1632", "title": "input-builtin (W1632)", - "description": "input built-in referenced\nUsed when the input built-in is referenced (backwards-incompatible semantics\nin Python 3)" + "description": "input built-in referenced. Used when the input built-in is referenced (backwards-incompatible semantics in Python 3)" }, { "patternId": "W1634", "title": "intern-builtin (W1634)", - "description": "intern built-in referenced\nUsed when the intern built-in is referenced (Moved to sys.intern in Python 3)" + "description": "intern built-in referenced. Used when the intern built-in is referenced (Moved to sys.intern in Python 3)" }, { "patternId": "W1608", "title": "long-builtin (W1608)", - "description": "long built-in referenced\nUsed when the long built-in function is referenced (missing from Python 3)" + "description": "long built-in referenced. Used when the long built-in function is referenced (missing from Python 3)" }, { "patternId": "W1636", "title": "map-builtin-not-iterating (W1636)", - "description": "map built-in referenced when not iterating\nUsed when the map built-in is referenced in a non-iterating context (returns\nan iterator in Python 3)" + "description": "map built-in referenced when not iterating. Used when the map built-in is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "W1653", "title": "next-method-defined (W1653)", - "description": "next method defined\nUsed when a next method is defined that would be an iterator in Python 2 but\nis treated as a normal function in Python 3." + "description": "next method defined. Used when a next method is defined that would be an iterator in Python 2 but is treated as a normal function in Python 3." }, { "patternId": "W1646", "title": "invalid-str-codec (W1646)", - "description": "non-text encoding used in str.decode\nUsed when using str.encode or str.decode with a non-text encoding. Use codecs\nmodule to handle arbitrary codecs." + "description": "non-text encoding used in str.decode. Used when using str.encode or str.decode with a non-text encoding. Use codecs module to handle arbitrary codecs." }, { "patternId": "W1638", "title": "range-builtin-not-iterating (W1638)", - "description": "range built-in referenced when not iterating\nUsed when the range built-in is referenced in a non-iterating context (returns\na range in Python 3)" + "description": "range built-in referenced when not iterating. Used when the range built-in is referenced in a non-iterating context (returns a range in Python 3)" }, { "patternId": "W1609", "title": "raw_input-builtin (W1609)", - "description": "raw_input built-in referenced\nUsed when the raw_input built-in function is referenced (missing from Python\n3)" + "description": "raw_input built-in referenced. Used when the raw_input built-in function is referenced (missing from Python 3)" }, { "patternId": "W1610", "title": "reduce-builtin (W1610)", - "description": "reduce built-in referenced\nUsed when the reduce built-in function is referenced (missing from Python 3)" + "description": "reduce built-in referenced. Used when the reduce built-in function is referenced (missing from Python 3)" }, { "patternId": "W1626", "title": "reload-builtin (W1626)", - "description": "reload built-in referenced\nUsed when the reload built-in function is referenced (missing from Python 3).\nYou can use instead imp.reload or importlib.reload." + "description": "reload built-in referenced. Used when the reload built-in function is referenced (missing from Python 3). You can use instead imp.reload or importlib.reload." }, { "patternId": "W1633", "title": "round-builtin (W1633)", - "description": "round built-in referenced\nUsed when the round built-in is referenced (backwards-incompatible semantics\nin Python 3)" + "description": "round built-in referenced. Used when the round built-in is referenced (backwards-incompatible semantics in Python 3)" }, { "patternId": "W1647", "title": "sys-max-int (W1647)", - "description": "sys.maxint removed in Python 3\nUsed when accessing sys.maxint. Use sys.maxsize instead." + "description": "sys.maxint removed in Python 3. Used when accessing sys.maxint. Use sys.maxsize instead." }, { "patternId": "W1635", "title": "unichr-builtin (W1635)", - "description": "unichr built-in referenced\nUsed when the unichr built-in is referenced (Use chr in Python 3)" + "description": "unichr built-in referenced. Used when the unichr built-in is referenced (Use chr in Python 3)" }, { "patternId": "W1612", "title": "unicode-builtin (W1612)", - "description": "unicode built-in referenced\nUsed when the unicode built-in function is referenced (missing from Python 3)" + "description": "unicode built-in referenced. Used when the unicode built-in function is referenced (missing from Python 3)" }, { "patternId": "W1613", "title": "xrange-builtin (W1613)", - "description": "xrange built-in referenced\nUsed when the xrange built-in function is referenced (missing from Python 3)" + "description": "xrange built-in referenced. Used when the xrange built-in function is referenced (missing from Python 3)" }, { "patternId": "W1637", "title": "zip-builtin-not-iterating (W1637)", - "description": "zip built-in referenced when not iterating\nUsed when the zip built-in is referenced in a non-iterating context (returns\nan iterator in Python 3)" + "description": "zip built-in referenced when not iterating. Used when the zip built-in is referenced in a non-iterating context (returns an iterator in Python 3)" }, { "patternId": "R1709", "title": "simplify-boolean-expression (R1709)", - "description": "Boolean expression may be simplified to %s\nEmitted when redundant pre-python 2.5 ternary syntax is used." + "description": "Boolean expression may be simplified to %s. Emitted when redundant pre-python 2.5 ternary syntax is used." }, { "patternId": "R1714", "title": "consider-using-in (R1714)", - "description": "Consider merging these comparisons with \"in\" to %r\nTo check if a variable is equal to one of many values,combine the values into\na tuple and check if the variable is contained \"in\" it instead of checking for\nequality against each of the values.This is faster and less verbose." + "description": "Consider merging these comparisons with \"in\" to %r. To check if a variable is equal to one of many values,combine the values into a tuple and check if the variable is contained \"in\" it instead of checking for equality against each of the values.This is faster and less verbose." }, { "patternId": "R1701", "title": "consider-merging-isinstance (R1701)", - "description": "Consider merging these isinstance calls to isinstance(%s, (%s))\nUsed when multiple consecutive isinstance calls can be merged into one." + "description": "Consider merging these isinstance calls to isinstance(%s, (%s)). Used when multiple consecutive isinstance calls can be merged into one." }, { "patternId": "R1717", "title": "consider-using-dict-comprehension (R1717)", - "description": "Consider using a dictionary comprehension\nEmitted when we detect the creation of a dictionary using the dict() callable\nand a transient list. Although there is nothing syntactically wrong with this\ncode, it is hard to read and can be simplified to a dict comprehension.Also it\nis faster since you don't need to create another transient list" + "description": "Consider using a dictionary comprehension. Emitted when we detect the creation of a dictionary using the dict() callable and a transient list. Although there is nothing syntactically wrong with this code, it is hard to read and can be simplified to a dict comprehension.Also it is faster since you don't need to create another transient list" }, { "patternId": "R1718", "title": "consider-using-set-comprehension (R1718)", - "description": "Consider using a set comprehension\nAlthough there is nothing syntactically wrong with this code, it is hard to\nread and can be simplified to a set comprehension.Also it is faster since you\ndon't need to create another transient list" + "description": "Consider using a set comprehension. Although there is nothing syntactically wrong with this code, it is hard to read and can be simplified to a set comprehension.Also it is faster since you don't need to create another transient list" }, { "patternId": "R1715", "title": "consider-using-get (R1715)", - "description": "Consider using dict.get for getting values from a dict if a key is present or a default if not\nUsing the builtin dict.get for getting a value from a dictionary if a key is\npresent or a default if not, is simpler and considered more idiomatic,\nalthough sometimes a bit slower" + "description": "Consider using dict.get for getting values from a dict if a key is present or a default if not. Using the builtin dict.get for getting a value from a dictionary if a key is present or a default if not, is simpler and considered more idiomatic, although sometimes a bit slower" }, { "patternId": "R1713", "title": "consider-using-join (R1713)", - "description": "Consider using str.join(sequence) for concatenating strings from an iterable\nUsing str.join(sequence) is faster, uses less memory and increases readability\ncompared to for-loop iteration." + "description": "Consider using str.join(sequence) for concatenating strings from an iterable. Using str.join(sequence) is faster, uses less memory and increases readability compared to for-loop iteration." }, { "patternId": "R1722", "title": "consider-using-sys-exit (R1722)", - "description": "Consider using sys.exit()\nInstead of using exit() or quit(), consider using the sys.exit()." + "description": "Consider using sys.exit(). Instead of using exit() or quit(), consider using the sys.exit()." }, { "patternId": "R1706", "title": "consider-using-ternary (R1706)", - "description": "Consider using ternary (%s)\nUsed when one of known pre-python 2.5 ternary syntax is used." + "description": "Consider using ternary (%s). Used when one of known pre-python 2.5 ternary syntax is used." }, { "patternId": "R1712", "title": "consider-swap-variables (R1712)", - "description": "Consider using tuple unpacking for swapping variables\nYou do not have to use a temporary variable in order to swap variables. Using\n\"tuple unpacking\" to directly swap variables makes the intention more clear." + "description": "Consider using tuple unpacking for swapping variables. You do not have to use a temporary variable in order to swap variables. Using \"tuple unpacking\" to directly swap variables makes the intention more clear." }, { "patternId": "R1707", "title": "trailing-comma-tuple (R1707)", - "description": "Disallow trailing comma tuple\nIn Python, a tuple is actually created by the comma symbol, not by the\nparentheses. Unfortunately, one can actually create a tuple by misplacing a\ntrailing comma, which can lead to potential weird bugs in your code. You\nshould always use parentheses explicitly for creating a tuple." + "description": "Disallow trailing comma tuple. In Python, a tuple is actually created by the comma symbol, not by the parentheses. Unfortunately, one can actually create a tuple by misplacing a trailing comma, which can lead to potential weird bugs in your code. You should always use parentheses explicitly for creating a tuple." }, { "patternId": "R1708", "title": "stop-iteration-return (R1708)", - "description": "Do not raise StopIteration in generator, use return statement instead\nAccording to PEP479, the raise of StopIteration to end the loop of a generator\nmay lead to hard to find bugs. This PEP specify that raise StopIteration has\nto be replaced by a simple return statement" + "description": "Do not raise StopIteration in generator, use return statement instead. According to PEP479, the raise of StopIteration to end the loop of a generator may lead to hard to find bugs. This PEP specify that raise StopIteration has to be replaced by a simple return statement" }, { "patternId": "R1710", "title": "inconsistent-return-statements (R1710)", - "description": "Either all return statements in a function should return an expression, or none of them should.\nAccording to PEP8, if any return statement returns an expression, any return\nstatements where no value is returned should explicitly state this as return\nNone, and an explicit return statement should be present at the end of the\nfunction (if reachable)" + "description": "Either all return statements in a function should return an expression, or none of them should. According to PEP8, if any return statement returns an expression, any return statements where no value is returned should explicitly state this as return None, and an explicit return statement should be present at the end of the function (if reachable)" }, { "patternId": "R1704", "title": "redefined-argument-from-local (R1704)", - "description": "Redefining argument with the local name %r\nUsed when a local name is redefining an argument, which might suggest a\npotential error. This is taken in account only for a handful of name binding\noperations, such as for iteration, with statement assignment and exception\nhandler assignment." + "description": "Redefining argument with the local name %r. Used when a local name is redefining an argument, which might suggest a potential error. This is taken in account only for a handful of name binding operations, such as for iteration, with statement assignment and exception handler assignment." }, { "patternId": "R1716", "title": "chained-comparison (R1716)", - "description": "Simplify chained comparison between the operands\nThis message is emitted when pylint encounters boolean operation like\"a < b\nand b < c\", suggesting instead to refactor it to \"a < b < c\"" + "description": "Simplify chained comparison between the operands. This message is emitted when pylint encounters boolean operation like\"a < b and b < c\", suggesting instead to refactor it to \"a < b < c\"" }, { "patternId": "R1719", "title": "simplifiable-if-expression (R1719)", - "description": "The if expression can be replaced with %s\nUsed when an if expression can be replaced with 'bool(test)'." + "description": "The if expression can be replaced with %s. Used when an if expression can be replaced with 'bool(test)'." }, { "patternId": "R1703", "title": "simplifiable-if-statement (R1703)", - "description": "The if statement can be replaced with %s\nUsed when an if statement can be replaced with 'bool(test)'." + "description": "The if statement can be replaced with %s. Used when an if statement can be replaced with 'bool(test)'." }, { "patternId": "R1702", "title": "too-many-nested-blocks (R1702)", - "description": "Too many nested blocks (%s/%s)\nUsed when a function or a method has too many nested blocks. This makes the\ncode less understandable and maintainable." + "description": "Too many nested blocks (%s/%s). Used when a function or a method has too many nested blocks. This makes the code less understandable and maintainable." }, { "patternId": "R1723", "title": "no-else-break (R1723)", - "description": "Unnecessary \"%s\" after \"break\"\nUsed in order to highlight an unnecessary block of code following an if\ncontaining a break statement. As such, it will warn when it encounters an else\nfollowing a chain of ifs, all of them containing a break statement." + "description": "Unnecessary \"%s\" after \"break\". Used in order to highlight an unnecessary block of code following an if containing a break statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a break statement." }, { "patternId": "R1724", "title": "no-else-continue (R1724)", - "description": "Unnecessary \"%s\" after \"continue\"\nUsed in order to highlight an unnecessary block of code following an if\ncontaining a continue statement. As such, it will warn when it encounters an\nelse following a chain of ifs, all of them containing a continue statement." + "description": "Unnecessary \"%s\" after \"continue\". Used in order to highlight an unnecessary block of code following an if containing a continue statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a continue statement." }, { "patternId": "R1720", "title": "no-else-raise (R1720)", - "description": "Unnecessary \"%s\" after \"raise\"\nUsed in order to highlight an unnecessary block of code following an if\ncontaining a raise statement. As such, it will warn when it encounters an else\nfollowing a chain of ifs, all of them containing a raise statement." + "description": "Unnecessary \"%s\" after \"raise\". Used in order to highlight an unnecessary block of code following an if containing a raise statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a raise statement." }, { "patternId": "R1705", "title": "no-else-return (R1705)", - "description": "Unnecessary \"%s\" after \"return\"\nUsed in order to highlight an unnecessary block of code following an if\ncontaining a return statement. As such, it will warn when it encounters an\nelse following a chain of ifs, all of them containing a return statement." + "description": "Unnecessary \"%s\" after \"return\". Used in order to highlight an unnecessary block of code following an if containing a return statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a return statement." }, { "patternId": "R1721", "title": "unnecessary-comprehension (R1721)", - "description": "Unnecessary use of a comprehension\nInstead of using an identitiy comprehension, consider using the list, dict or\nset constructor. It is faster and simpler." + "description": "Unnecessary use of a comprehension. Instead of using an identitiy comprehension, consider using the list, dict or set constructor. It is faster and simpler." }, { "patternId": "R1711", "title": "useless-return (R1711)", - "description": "Useless return at end of function or method\nEmitted when a single \"return\" or \"return None\" statement is found at the end\nof function or method definition. This statement can safely be removed because\nPython will implicitly return None" + "description": "Useless return at end of function or method. Emitted when a single \"return\" or \"return None\" statement is found at the end of function or method definition. This statement can safely be removed because Python will implicitly return None" }, { "patternId": "C0113", "title": "unneeded-not (C0113)", - "description": "Consider changing \"%s\" to \"%s\"\nUsed when a boolean expression contains an unneeded negation." + "description": "Consider changing \"%s\" to \"%s\". Used when a boolean expression contains an unneeded negation." }, { "patternId": "C0201", "title": "consider-iterating-dictionary (C0201)", - "description": "Consider iterating the dictionary directly instead of calling .keys()\nEmitted when the keys of a dictionary are iterated through the .keys() method.\nIt is enough to just iterate through the dictionary itself, as in \"for key in\ndictionary\"." + "description": "Consider iterating the dictionary directly instead of calling .keys(). Emitted when the keys of a dictionary are iterated through the .keys() method. It is enough to just iterate through the dictionary itself, as in \"for key in dictionary\"." }, { "patternId": "C0200", "title": "consider-using-enumerate (C0200)", - "description": "Consider using enumerate instead of iterating with range and len\nEmitted when code that iterates with range and len is encountered. Such code\ncan be simplified by using the enumerate builtin." + "description": "Consider using enumerate instead of iterating with range and len. Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin." }, { "patternId": "C1801", "title": "len-as-condition (C1801)", - "description": "Do not use `len(SEQUENCE)` without comparison to determine if a sequence is empty\nUsed when Pylint detects that len(sequence) is being used without explicit\ncomparison inside a condition to determine if a sequence is empty. Instead of\ncoercing the length to a boolean, either rely on the fact that empty sequences\nare false or compare the length against a scalar." + "description": "Do not use `len(SEQUENCE)` without comparison to determine if a sequence is empty. Used when Pylint detects that len(sequence) is being used without explicit comparison inside a condition to determine if a sequence is empty. Instead of coercing the length to a boolean, either rely on the fact that empty sequences are false or compare the length against a scalar." }, { "patternId": "R0801", "title": "duplicate-code (R0801)", - "description": "Similar lines in %s files\nIndicates that a set of similar lines has been detected among multiple file.\nThis usually means that the code should be refactored to avoid this\nduplication." + "description": "Similar lines in %s files. Indicates that a set of similar lines has been detected among multiple file. This usually means that the code should be refactored to avoid this duplication." }, { "patternId": "C0403", "title": "invalid-characters-in-docstring (C0403)", - "description": "Invalid characters %r in a docstring\nUsed when a word in docstring cannot be checked by enchant." + "description": "Invalid characters %r in a docstring. Used when a word in docstring cannot be checked by enchant." }, { "patternId": "C0401", "title": "wrong-spelling-in-comment (C0401)", - "description": "Wrong spelling of a word '%s' in a comment:\nUsed when a word in comment is not spelled correctly." + "description": "Wrong spelling of a word '%s' in a comment:. Used when a word in comment is not spelled correctly." }, { "patternId": "C0402", "title": "wrong-spelling-in-docstring (C0402)", - "description": "Wrong spelling of a word '%s' in a docstring:\nUsed when a word in docstring is not spelled correctly." + "description": "Wrong spelling of a word '%s' in a docstring:. Used when a word in docstring is not spelled correctly." }, { "patternId": "E1507", "title": "invalid-envvar-value (E1507)", - "description": "%s does not support %s type argument\nEnv manipulation functions support only string type arguments. See\nhttps://docs.python.org/3/library/os.html#os.getenv." + "description": "%s does not support %s type argument. Env manipulation functions support only string type arguments. See https://docs.python.org/3/library/os.html#os.getenv." }, { "patternId": "W1501", "title": "bad-open-mode (W1501)", - "description": "\"%s\" is not a valid mode for open.\nPython supports: r, w, a[, x] modes with b, +, and U (only with r) options.\nSee http://docs.python.org/2/library/functions.html#open" + "description": "\"%s\" is not a valid mode for open. Python supports: r, w, a[, x] modes with b, +, and U (only with r) options. See http://docs.python.org/2/library/functions.html#open" }, { "patternId": "W1508", "title": "invalid-envvar-default (W1508)", - "description": "%s default type is %s. Expected str or None.\nEnv manipulation functions return None or str values. Supplying anything\ndifferent as a default may cause bugs. See\nhttps://docs.python.org/3/library/os.html#os.getenv." + "description": "%s default type is %s. Expected str or None. Env manipulation functions return None or str values. Supplying anything different as a default may cause bugs. See https://docs.python.org/3/library/os.html#os.getenv." }, { "patternId": "W1503", "title": "redundant-unittest-assert (W1503)", - "description": "Redundant use of %s with constant value %r\nThe first argument of assertTrue and assertFalse is a condition. If a constant\nis passed as parameter, that condition will be always true. In this case a\nwarning should be emitted." + "description": "Redundant use of %s with constant value %r. The first argument of assertTrue and assertFalse is a condition. If a constant is passed as parameter, that condition will be always true. In this case a warning should be emitted." }, { "patternId": "W1507", "title": "shallow-copy-environ (W1507)", - "description": "Using copy.copy(os.environ). Use os.environ.copy() instead.\nos.environ is not a dict object but proxy object, so shallow copy has still\neffects on original object. See https://bugs.python.org/issue15373 for\nreference." + "description": "Using copy.copy(os.environ). Use os.environ.copy() instead. Os.environ is not a dict object but proxy object, so shallow copy has still effects on original object. See https://bugs.python.org/issue15373 for reference." }, { "patternId": "W1502", "title": "boolean-datetime (W1502)", - "description": "Using datetime.time in a boolean context.\nUsing datetime.time in a boolean context can hide subtle bugs when the time\nthey represent matches midnight UTC. This behaviour was fixed in Python 3.5.\nSee http://bugs.python.org/issue13936 for reference. This message can't be\nemitted when using Python >= 3.5." + "description": "Using datetime.time in a boolean context. Using datetime.time in a boolean context can hide subtle bugs when the time they represent matches midnight UTC. This behaviour was fixed in Python 3.5. See http://bugs.python.org/issue13936 for reference. This message can't be emitted when using Python >= 3.5." }, { "patternId": "W1505", "title": "deprecated-method (W1505)", - "description": "Using deprecated method %s()\nThe method is marked as deprecated and will be removed in a future version of\nPython. Consider looking for an alternative in the documentation." + "description": "Using deprecated method %s(). The method is marked as deprecated and will be removed in a future version of Python. Consider looking for an alternative in the documentation." }, { "patternId": "W1509", "title": "subprocess-popen-preexec-fn (W1509)", - "description": "Using preexec_fn keyword which may be unsafe in the presence of threads\nThe preexec_fn parameter is not safe to use in the presence of threads in your\napplication. The child process could deadlock before exec is called. If you\nmust use it, keep it trivial! Minimize the number of libraries you call\ninto.https://docs.python.org/3/library/subprocess.html#popen-constructor" + "description": "Using preexec_fn keyword which may be unsafe in the presence of threads. The preexec_fn parameter is not safe to use in the presence of threads in your application. The child process could deadlock before exec is called. If you must use it, keep it trivial! Minimize the number of libraries you call into.https://docs.python.org/3/library/subprocess.html#popen-constructor" }, { "patternId": "W1510", "title": "subprocess-run-check (W1510)", - "description": "Using subprocess.run without explicitly set `check` is not recommended.\nThe check parameter should always be used with explicitly set check keyword\nto make clear what the error-handling behavior\nis.https://docs.python.org/3/library/subprocess.html#subprocess.runs" + "description": "Using subprocess.run without explicitly set `check` is not recommended. The check parameter should always be used with explicitly set check keyword to make clear what the error-handling behavior is.https://docs.python.org/3/library/subprocess.html#subprocess.runs" }, { "patternId": "W1506", "title": "bad-thread-instantiation (W1506)", - "description": "threading.Thread needs the target function\nThe warning is emitted when a threading.Thread class is instantiated without\nthe target function being passed. By default, the first parameter is the group\nparam, not the target param." + "description": "threading.Thread needs the target function. The warning is emitted when a threading.Thread class is instantiated without the target function being passed. By default, the first parameter is the group param, not the target param." }, { "patternId": "E1307", "title": "bad-string-format-type (E1307)", - "description": "Argument %r does not match format type %r\nUsed when a type required by format string is not suitable for actual argument\ntype" + "description": "Argument %r does not match format type %r. Used when a type required by format string is not suitable for actual argument type" }, { "patternId": "E1303", "title": "format-needs-mapping (E1303)", - "description": "Expected mapping for format string, not %s\nUsed when a format string that uses named conversion specifiers is used with\nan argument that is not a mapping." + "description": "Expected mapping for format string, not %s. Used when a format string that uses named conversion specifiers is used with an argument that is not a mapping." }, { "patternId": "E1301", "title": "truncated-format-string (E1301)", - "description": "Format string ends in middle of conversion specifier\nUsed when a format string terminates before the end of a conversion specifier." + "description": "Format string ends in middle of conversion specifier. Used when a format string terminates before the end of a conversion specifier." }, { "patternId": "E1304", "title": "missing-format-string-key (E1304)", - "description": "Missing key %r in format string dictionary\nUsed when a format string that uses named conversion specifiers is used with a\ndictionary that doesn't contain all the keys required by the format string." + "description": "Missing key %r in format string dictionary. Used when a format string that uses named conversion specifiers is used with a dictionary that doesn't contain all the keys required by the format string." }, { "patternId": "E1302", "title": "mixed-format-string (E1302)", - "description": "Mixing named and unnamed conversion specifiers in format string\nUsed when a format string contains both named (e.g. '%(foo)d') and unnamed\n(e.g. '%d') conversion specifiers. This is also used when a named conversion\nspecifier contains * for the minimum field width and/or precision." + "description": "Mixing named and unnamed conversion specifiers in format string. Used when a format string contains both named (e.g. '%(foo)d') and unnamed (e.g. '%d') conversion specifiers. This is also used when a named conversion specifier contains * for the minimum field width and/or precision." }, { "patternId": "E1306", "title": "too-few-format-args (E1306)", - "description": "Not enough arguments for format string\nUsed when a format string that uses unnamed conversion specifiers is given too\nfew arguments" + "description": "Not enough arguments for format string. Used when a format string that uses unnamed conversion specifiers is given too few arguments" }, { "patternId": "E1310", "title": "bad-str-strip-call (E1310)", - "description": "Suspicious argument in %s.%s call\nThe argument to a str.{l,r,}strip call contains a duplicate character," + "description": "Suspicious argument in %s.%s call. The argument to a str.{l,r,}strip call contains a duplicate character," }, { "patternId": "E1305", "title": "too-many-format-args (E1305)", - "description": "Too many arguments for format string\nUsed when a format string that uses unnamed conversion specifiers is given too\nmany arguments." + "description": "Too many arguments for format string. Used when a format string that uses unnamed conversion specifiers is given too many arguments." }, { "patternId": "E1300", "title": "bad-format-character (E1300)", - "description": "Unsupported format character %r (%#02x) at index %d\nUsed when an unsupported format character is used in a format string." + "description": "Unsupported format character %r (%#02x) at index %d. Used when an unsupported format character is used in a format string." }, { "patternId": "W1402", "title": "anomalous-unicode-escape-in-string (W1402)", - "description": "Anomalous Unicode escape in byte string: '%s'. String constant might be missing an r or u prefix.\nUsed when an escape like u is encountered in a byte string where it has no\neffect." + "description": "Anomalous Unicode escape in byte string: '%s'. String constant might be missing an r or u prefix. Used when an escape like u is encountered in a byte string where it has no effect." }, { "patternId": "W1401", "title": "anomalous-backslash-in-string (W1401)", - "description": "Anomalous backslash in string: '%s'. String constant might be missing an r prefix.\nUsed when a backslash is in a literal string but not as an escape." + "description": "Anomalous backslash in string: '%s'. String constant might be missing an r prefix. Used when a backslash is in a literal string but not as an escape." }, { "patternId": "W1308", "title": "duplicate-string-formatting-argument (W1308)", - "description": "Duplicate string formatting argument %r, consider passing as named argument\nUsed when we detect that a string formatting is repeating an argument instead\nof using named string arguments" + "description": "Duplicate string formatting argument %r, consider passing as named argument. Used when we detect that a string formatting is repeating an argument instead of using named string arguments" }, { "patternId": "W1305", "title": "format-combined-specification (W1305)", - "description": "Format string contains both automatic field numbering and manual field specification\nUsed when a PEP 3101 format string contains both automatic field numbering\n(e.g. '{}') and manual field specification (e.g. '{0}')." + "description": "Format string contains both automatic field numbering and manual field specification. Used when a PEP 3101 format string contains both automatic field numbering (e.g. '{}') and manual field specification (e.g. '{0}')." }, { "patternId": "W1300", "title": "bad-format-string-key (W1300)", - "description": "Format string dictionary key should be a string, not %s\nUsed when a format string that uses named conversion specifiers is used with a\ndictionary whose keys are not all strings." + "description": "Format string dictionary key should be a string, not %s. Used when a format string that uses named conversion specifiers is used with a dictionary whose keys are not all strings." }, { "patternId": "W1403", "title": "implicit-str-concat-in-sequence (W1403)", - "description": "Implicit string concatenation found in %s\nString literals are implicitly concatenated in a literal iterable definition :\nmaybe a comma is missing ?" + "description": "Implicit string concatenation found in %s. String literals are implicitly concatenated in a literal iterable definition : maybe a comma is missing ?" }, { "patternId": "W1302", "title": "bad-format-string (W1302)", - "description": "Invalid format string\nUsed when a PEP 3101 format string is invalid." + "description": "Invalid format string. Used when a PEP 3101 format string is invalid." }, { "patternId": "W1306", "title": "missing-format-attribute (W1306)", - "description": "Missing format attribute %r in format specifier %r\nUsed when a PEP 3101 format string uses an attribute specifier ({0.length}),\nbut the argument passed for formatting doesn't have that attribute." + "description": "Missing format attribute %r in format specifier %r. Used when a PEP 3101 format string uses an attribute specifier ({0.length}), but the argument passed for formatting doesn't have that attribute." }, { "patternId": "W1303", "title": "missing-format-argument-key (W1303)", - "description": "Missing keyword argument %r for format string\nUsed when a PEP 3101 format string that uses named fields doesn't receive one\nor more required keywords." + "description": "Missing keyword argument %r for format string. Used when a PEP 3101 format string that uses named fields doesn't receive one or more required keywords." }, { "patternId": "W1304", "title": "unused-format-string-argument (W1304)", - "description": "Unused format argument %r\nUsed when a PEP 3101 format string that uses named fields is used with an\nargument that is not required by the format string." + "description": "Unused format argument %r. Used when a PEP 3101 format string that uses named fields is used with an argument that is not required by the format string." }, { "patternId": "W1301", "title": "unused-format-string-key (W1301)", - "description": "Unused key %r in format string dictionary\nUsed when a format string that uses named conversion specifiers is used with a\ndictionary that contains keys not required by the format string." + "description": "Unused key %r in format string dictionary. Used when a format string that uses named conversion specifiers is used with a dictionary that contains keys not required by the format string." }, { "patternId": "W1307", "title": "invalid-format-index (W1307)", - "description": "Using invalid lookup key %r in format specifier %r\nUsed when a PEP 3101 format string uses a lookup specifier ({a[1]}), but the\nargument passed for formatting doesn't contain or doesn't have that key as an\nattribute." + "description": "Using invalid lookup key %r in format specifier %r. Used when a PEP 3101 format string uses a lookup specifier ({a[1]}), but the argument passed for formatting doesn't contain or doesn't have that key as an attribute." }, { "patternId": "E1137", "title": "unsupported-assignment-operation (E1137)", - "description": "%r does not support item assignment\nEmitted when an object does not support item assignment (i.e. doesn't define\n__setitem__ method)." + "description": "%r does not support item assignment. Emitted when an object does not support item assignment (i.e. doesn't define __setitem__ method)." }, { "patternId": "E1138", "title": "unsupported-delete-operation (E1138)", - "description": "%r does not support item deletion\nEmitted when an object does not support item deletion (i.e. doesn't define\n__delitem__ method)." + "description": "%r does not support item deletion. Emitted when an object does not support item deletion (i.e. doesn't define __delitem__ method)." }, { "patternId": "E1130", "title": "invalid-unary-operand-type (E1130)", - "description": "Emitted when a unary operand is used on an object which does not support this\ntype of operation." + "description": "Emitted when a unary operand is used on an object which does not support this. Type of operation." }, { "patternId": "E1131", "title": "unsupported-binary-operation (E1131)", - "description": "Emitted when a binary arithmetic operation between two operands is not\nsupported." + "description": "Emitted when a binary arithmetic operation between two operands is not. Supported." }, { "patternId": "E1101", "title": "no-member (E1101)", - "description": "%s %r has no %r member%s\nUsed when a variable is accessed for an unexistent member." + "description": "%s %r has no %r member%s. Used when a variable is accessed for an unexistent member." }, { "patternId": "E1102", "title": "not-callable (E1102)", - "description": "%s is not callable\nUsed when an object being called has been inferred to a non callable object." + "description": "%s is not callable. Used when an object being called has been inferred to a non callable object." }, { "patternId": "E1124", "title": "redundant-keyword-arg (E1124)", - "description": "Argument %r passed by position and keyword in %s call\nUsed when a function call would result in assigning multiple values to a\nfunction parameter, one value from a positional argument and one from a\nkeyword argument." + "description": "Argument %r passed by position and keyword in %s call. Used when a function call would result in assigning multiple values to a function parameter, one value from a positional argument and one from a keyword argument." }, { "patternId": "E1111", "title": "assignment-from-no-return (E1111)", - "description": "Assigning result of a function call, where the function has no return\nUsed when an assignment is done on a function call but the inferred function\ndoesn't return anything." + "description": "Assigning result of a function call, where the function has no return. Used when an assignment is done on a function call but the inferred function doesn't return anything." }, { "patternId": "E1128", "title": "assignment-from-none (E1128)", - "description": "Assigning result of a function call, where the function returns None\nUsed when an assignment is done on a function call but the inferred function\nreturns nothing but None." + "description": "Assigning result of a function call, where the function returns None. Used when an assignment is done on a function call but the inferred function returns nothing but None." }, { "patternId": "E1129", "title": "not-context-manager (E1129)", - "description": "Context manager '%s' doesn't implement __enter__ and __exit__.\nUsed when an instance in a with statement doesn't implement the context\nmanager protocol(__enter__/__exit__)." + "description": "Context manager '%s' doesn't implement __enter__ and __exit__. Used when an instance in a with statement doesn't implement the context manager protocol(__enter__/__exit__)." }, { "patternId": "E1140", "title": "unhashable-dict-key (E1140)", - "description": "Dict key is unhashable\nEmitted when a dict key is not hashable (i.e. doesn't define __hash__ method)." + "description": "Dict key is unhashable. Emitted when a dict key is not hashable (i.e. doesn't define __hash__ method)." }, { "patternId": "E1132", "title": "repeated-keyword (E1132)", - "description": "Got multiple values for keyword argument %r in function call\nEmitted when a function call got multiple values for a keyword." + "description": "Got multiple values for keyword argument %r in function call. Emitted when a function call got multiple values for a keyword." }, { "patternId": "E1139", "title": "invalid-metaclass (E1139)", - "description": "Invalid metaclass %r used\nEmitted whenever we can detect that a class is using, as a metaclass,\nsomething which might be invalid for using as a metaclass." + "description": "Invalid metaclass %r used. Emitted whenever we can detect that a class is using, as a metaclass, something which might be invalid for using as a metaclass." }, { "patternId": "E1125", "title": "missing-kwoa (E1125)", - "description": "Missing mandatory keyword argument %r in %s call\nUsed when a function call does not pass a mandatory keyword-only argument." + "description": "Missing mandatory keyword argument %r in %s call. Used when a function call does not pass a mandatory keyword-only argument." }, { "patternId": "E1120", "title": "no-value-for-parameter (E1120)", - "description": "No value for argument %s in %s call\nUsed when a function call passes too few arguments." + "description": "No value for argument %s in %s call. Used when a function call passes too few arguments." }, { "patternId": "E1133", "title": "not-an-iterable (E1133)", - "description": "Non-iterable value %s is used in an iterating context\nUsed when a non-iterable value is used in place where iterable is expected" + "description": "Non-iterable value %s is used in an iterating context. Used when a non-iterable value is used in place where iterable is expected" }, { "patternId": "E1134", "title": "not-a-mapping (E1134)", - "description": "Non-mapping value %s is used in a mapping context\nUsed when a non-mapping value is used in place where mapping is expected" + "description": "Non-mapping value %s is used in a mapping context. Used when a non-mapping value is used in place where mapping is expected" }, { "patternId": "E1126", "title": "invalid-sequence-index (E1126)", - "description": "Sequence index is not an int, slice, or instance with __index__\nUsed when a sequence type is indexed with an invalid type. Valid types are\nints, slices, and objects with an __index__ method." + "description": "Sequence index is not an int, slice, or instance with __index__. Used when a sequence type is indexed with an invalid type. Valid types are ints, slices, and objects with an __index__ method." }, { "patternId": "E1127", "title": "invalid-slice-index (E1127)", - "description": "Slice index is not an int, None, or instance with __index__\nUsed when a slice index is not an integer, None, or an object with an\n__index__ method." + "description": "Slice index is not an int, None, or instance with __index__. Used when a slice index is not an integer, None, or an object with an __index__ method." }, { "patternId": "E1121", "title": "too-many-function-args (E1121)", - "description": "Too many positional arguments for %s call\nUsed when a function call passes too many positional arguments." + "description": "Too many positional arguments for %s call. Used when a function call passes too many positional arguments." }, { "patternId": "E1123", "title": "unexpected-keyword-arg (E1123)", - "description": "Unexpected keyword argument %r in %s call\nUsed when a function call passes a keyword argument that doesn't correspond to\none of the function's parameter names." + "description": "Unexpected keyword argument %r in %s call. Used when a function call passes a keyword argument that doesn't correspond to one of the function's parameter names." }, { "patternId": "E1141", "title": "dict-iter-missing-items (E1141)", - "description": "Unpacking a dictionary in iteration without calling .items()\nEmitted when trying to iterate through a dict without calling .items()" + "description": "Unpacking a dictionary in iteration without calling .items(). Emitted when trying to iterate through a dict without calling .items()" }, { "patternId": "E1135", "title": "unsupported-membership-test (E1135)", - "description": "Value '%s' doesn't support membership test\nEmitted when an instance in membership test expression doesn't implement\nmembership protocol (__contains__/__iter__/__getitem__)." + "description": "Value '%s' doesn't support membership test. Emitted when an instance in membership test expression doesn't implement membership protocol (__contains__/__iter__/__getitem__)." }, { "patternId": "E1136", "title": "unsubscriptable-object (E1136)", - "description": "Value '%s' is unsubscriptable\nEmitted when a subscripted value doesn't support subscription (i.e. doesn't\ndefine __getitem__ method or __class_getitem__ for a class)." + "description": "Value '%s' is unsubscriptable. Emitted when a subscripted value doesn't support subscription (i.e. doesn't define __getitem__ method or __class_getitem__ for a class)." }, { "patternId": "W1113", "title": "keyword-arg-before-vararg (W1113)", - "description": "Keyword argument before variable positional arguments list in the definition of %s function\nWhen defining a keyword argument before variable positional arguments, one can\nend up in having multiple values passed for the aforementioned parameter in\ncase the method is called with keyword arguments." + "description": "Keyword argument before variable positional arguments list in the definition of %s function. When defining a keyword argument before variable positional arguments, one can end up in having multiple values passed for the aforementioned parameter in case the method is called with keyword arguments." }, { "patternId": "W1114", "title": "arguments-out-of-order (W1114)", - "description": "Positional arguments appear to be out of order\nEmitted when the caller's argument names fully match the parameter names in\nthe function signature but do not have the same order." + "description": "Positional arguments appear to be out of order. Emitted when the caller's argument names fully match the parameter names in the function signature but do not have the same order." }, { "patternId": "I1101", "title": "c-extension-no-member (I1101)", - "description": "%s %r has no %r member%s, but source is unavailable. Consider adding this module to extension-pkg-whitelist if you want to perform analysis based on run-time introspection of living objects.\nUsed when a variable is accessed for non-existent member of C extension. Due\nto unavailability of source static analysis is impossible, but it may be\nperformed by introspecting living objects in run-time." + "description": "%s %r has no %r member%s, but source is unavailable. Consider adding this module to extension-pkg-whitelist if you want to perform analysis based on run-time introspection of living objects. Used when a variable is accessed for non-existent member of C extension. Due to unavailability of source static analysis is impossible, but it may be performed by introspecting living objects in run-time." }, { "patternId": "E0633", "title": "unpacking-non-sequence (E0633)", - "description": "Attempting to unpack a non-sequence%s\nUsed when something which is not a sequence is used in an unpack assignment" + "description": "Attempting to unpack a non-sequence%s. Used when something which is not a sequence is used in an unpack assignment" }, { "patternId": "E0604", "title": "invalid-all-object (E0604)", - "description": "Invalid object %r in __all__, must contain only strings\nUsed when an invalid (non-string) object occurs in __all__." + "description": "Invalid object %r in __all__, must contain only strings. Used when an invalid (non-string) object occurs in __all__." }, { "patternId": "E0611", "title": "no-name-in-module (E0611)", - "description": "No name %r in module %r\nUsed when a name cannot be found in a module." + "description": "No name %r in module %r. Used when a name cannot be found in a module." }, { "patternId": "E0602", "title": "undefined-variable (E0602)", - "description": "Undefined variable %r\nUsed when an undefined variable is accessed." + "description": "Undefined variable %r. Used when an undefined variable is accessed." }, { "patternId": "E0603", "title": "undefined-all-variable (E0603)", - "description": "Undefined variable name %r in __all__\nUsed when an undefined variable name is referenced in __all__." + "description": "Undefined variable name %r in __all__. Used when an undefined variable name is referenced in __all__." }, { "patternId": "E0601", "title": "used-before-assignment (E0601)", - "description": "Using variable %r before assignment\nUsed when a local variable is accessed before its assignment." + "description": "Using variable %r before assignment. Used when a local variable is accessed before its assignment." }, { "patternId": "W0640", "title": "cell-var-from-loop (W0640)", - "description": "Cell variable %s defined in loop\nA variable used in a closure is defined in a loop. This will result in all\nclosures using the same value for the closed-over variable." + "description": "Cell variable %s defined in loop. A variable used in a closure is defined in a loop. This will result in all closures using the same value for the closed-over variable." }, { "patternId": "W0601", "title": "global-variable-undefined (W0601)", - "description": "Global variable %r undefined at the module level\nUsed when a variable is defined through the \"global\" statement but the\nvariable is not defined in the module scope." + "description": "Global variable %r undefined at the module level. Used when a variable is defined through the \"global\" statement but the variable is not defined in the module scope." }, { "patternId": "W0642", "title": "self-cls-assignment (W0642)", - "description": "Invalid assignment to %s in method\nInvalid assignment to self or cls in instance or class method respectively." + "description": "Invalid assignment to %s in method. Invalid assignment to self or cls in instance or class method respectively." }, { "patternId": "W0632", "title": "unbalanced-tuple-unpacking (W0632)", - "description": "Possible unbalanced tuple unpacking with sequence%s: left side has %d label(s), right side has %d value(s)\nUsed when there is an unbalanced tuple unpacking in assignment" + "description": "Possible unbalanced tuple unpacking with sequence%s: left side has %d label(s), right side has %d value(s). Used when there is an unbalanced tuple unpacking in assignment" }, { "patternId": "W0641", "title": "possibly-unused-variable (W0641)", - "description": "Possibly unused variable %r\nUsed when a variable is defined but might not be used. The possibility comes\nfrom the fact that locals() might be used, which could consume or not the said\nvariable" + "description": "Possibly unused variable %r. Used when a variable is defined but might not be used. The possibility comes from the fact that locals() might be used, which could consume or not the said variable" }, { "patternId": "W0622", "title": "redefined-builtin (W0622)", - "description": "Redefining built-in %r\nUsed when a variable or function override a built-in." + "description": "Redefining built-in %r. Used when a variable or function override a built-in." }, { "patternId": "W0623", "title": "redefine-in-handler (W0623)", - "description": "Redefining name %r from %s in exception handler\nUsed when an exception handler assigns the exception to an existing name" + "description": "Redefining name %r from %s in exception handler. Used when an exception handler assigns the exception to an existing name" }, { "patternId": "W0621", "title": "redefined-outer-name (W0621)", - "description": "Redefining name %r from outer scope (line %s)\nUsed when a variable's name hides a name defined in the outer scope." + "description": "Redefining name %r from outer scope (line %s). Used when a variable's name hides a name defined in the outer scope." }, { "patternId": "W0611", "title": "unused-import (W0611)", - "description": "Unused %s\nUsed when an imported module or variable is not used." + "description": "Unused %s. Used when an imported module or variable is not used." }, { "patternId": "W0613", "title": "unused-argument (W0613)", - "description": "Unused argument %r\nUsed when a function or method argument is not used." + "description": "Unused argument %r. Used when a function or method argument is not used." }, { "patternId": "W0614", "title": "unused-wildcard-import (W0614)", - "description": "Unused import %s from wildcard import\nUsed when an imported module or variable is not used from a 'from X import\n*' style import." + "description": "Unused import %s from wildcard import. Used when an imported module or variable is not used from a 'from X import *' style import." }, { "patternId": "W0612", "title": "unused-variable (W0612)", - "description": "Unused variable %r\nUsed when a variable is defined but not used." + "description": "Unused variable %r. Used when a variable is defined but not used." }, { "patternId": "W0602", "title": "global-variable-not-assigned (W0602)", - "description": "Using global for %r but no assignment is done\nUsed when a variable is defined through the \"global\" statement but no\nassignment to this variable is done." + "description": "Using global for %r but no assignment is done. Used when a variable is defined through the \"global\" statement but no assignment to this variable is done." }, { "patternId": "W0631", "title": "undefined-loop-variable (W0631)", - "description": "Using possibly undefined loop variable %r\nUsed when a loop variable (i.e. defined by a for loop or a list comprehension\nor a generator expression) is used outside the loop." + "description": "Using possibly undefined loop variable %r. Used when a loop variable (i.e. defined by a for loop or a list comprehension or a generator expression) is used outside the loop." }, { "patternId": "W0603", "title": "global-statement (W0603)", - "description": "Using the global statement\nUsed when you use the \"global\" statement to update a global variable. Pylint\njust try to discourage this usage. That doesn't mean you cannot use it !" + "description": "Using the global statement. Used when you use the \"global\" statement to update a global variable. Pylint just try to discourage this usage. That doesn't mean you cannot use it !" }, { "patternId": "W0604", "title": "global-at-module-level (W0604)", - "description": "Using the global statement at the module level\nUsed when you use the \"global\" statement at the module level since it has no\neffect" + "description": "Using the global statement at the module level. Used when you use the \"global\" statement at the module level since it has no effect" } ]