TEST: Add pylint

.pylintrc

@@ -0,0 +1,471 @@
+[MASTER]
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code
+extension-pkg-whitelist=
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=.git,
+       .venv,
+
+# Add files or directories matching the regex patterns to the blacklist. The
+# regex matches against base names, not paths.
+ignore-patterns=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint.
+jobs=1
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# Specify a configuration file.
+#rcfile=
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+disable=bad-whitespace,
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=c-extension-no-member
+
+
+[REPORTS]
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details
+#msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio).You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=optparse.Values,sys.exit
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+      XXX,
+      TODO
+
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+          _cb
+
+# A regular expression matching the name of dummy variables (i.e. expectedly
+# not used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,io,builtins
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging  or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=trailing-comma,
+               dict-separator
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[BASIC]
+
+# Naming style matching correct argument names
+argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style
+#argument-rgx=
+
+# Naming style matching correct attribute names
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=foo,
+          bar,
+          baz,
+          toto,
+          tutu,
+          tata
+
+# Naming style matching correct class attribute names
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style
+#class-attribute-rgx=
+
+# Naming style matching correct class names
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-style
+#class-rgx=
+
+# Naming style matching correct constant names
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,
+           j,
+           k,
+           f,
+           ex,
+           _
+
+# Include a hint for the correct naming format with invalid-name
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style
+#inlinevar-rgx=
+
+# Naming style matching correct method names
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style
+#method-rgx=
+
+# Naming style matching correct module names
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+property-classes=abc.abstractproperty
+
+# Naming style matching correct variable names
+variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style
+#variable-rgx=
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in a if statement
+max-bool-expr=5
+
+# Maximum number of branch for function / method body
+max-branches=12
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+                  _fields,
+                  _replace,
+                  _source,
+                  _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[IMPORTS]
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=yes
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,
+                   TERMIOS,
+                   Bastion,
+                   rexec
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception

mopidy_pummeluff/__init__.py

@@ -7,13 +7,22 @@ from __future__ import absolute_import, unicode_literals
 
 import os
 
-from mopidy import config, ext
+import mopidy
 
 from .frontend import PummeluffFrontend
 from .web import LatestHandler, RegistryHandler, RegisterHandler, TypesHandler
 
 
-def app_factory(config, core):
+def app_factory(config, core):  # pylint: disable=unused-argument
+    '''
+    App factory for the web apps.
+
+    :param mopidy.config config: The mopidy config
+    :param mopidy.core.Core: The mopidy core
+
+    :return: The registered app request handlers
+    :rtype: list
+    '''
     return [
         ('/latest/', LatestHandler, {'core': core}),
         ('/registry/', RegistryHandler, {'core': core}),
@@ -22,7 +31,7 @@ def app_factory(config, core):
     ]
 
 
-class Extension(ext.Extension):
+class Extension(mopidy.ext.Extension):
     '''
     Mopidy Pummeluff extension.
     '''
@@ -30,16 +39,20 @@ class Extension(ext.Extension):
     dist_name = 'Mopidy-Pummeluff'
     ext_name = 'pummeluff'
 
-    def get_default_config(self):
+    def get_default_config(self):  # pylint: disable=no-self-use
         '''
         Return the default config.
+
+        :return: The default config
         '''
         conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf')
-        return config.read(conf_file)
+        return mopidy.config.read(conf_file)
 
     def get_config_schema(self):
         '''
         Return the config schema.
+
+        :return: The config schema
         '''
         schema = super(Extension, self).get_config_schema()
         return schema
@@ -47,6 +60,8 @@ class Extension(ext.Extension):
     def setup(self, registry):
         '''
         Setup the extension.
+
+        :param mopidy.ext.Registry: The mopidy registry
         '''
         registry.add('frontend', PummeluffFrontend)
 

mopidy_pummeluff/cards.py

@@ -127,7 +127,8 @@ class Card(object):
 
         if real_cls == Card:
             error = 'Registering cards without explicit types are not allowed. ' \
-                'Set card_type argument on Card.register() or use register() method of explicit card classes.'
+                'Set card_type argument on Card.register() ' \
+                'or use register() method of explicit card classes.'
             raise InvalidCardType(error)
 
         if hasattr(real_cls, 'validate_parameter'):
@@ -149,7 +150,7 @@ class Card(object):
         :return: The dict version of this card
         :rtype: dict
         '''
-        d = {
+        card_dict = {
             'uid': self.uid,
             'alias': self.alias,
             'type': self.get_type(),
@@ -157,9 +158,9 @@ class Card(object):
         }
 
         if hasattr(self, 'scanned'):
-            d['scanned'] = self.scanned
+            card_dict['scanned'] = self.scanned
 
-        return d
+        return card_dict
 
 
 class TracklistCard(Card):
@@ -218,7 +219,7 @@ class StopCard(Card):
     Stops the playback.
     '''
 
-    def action(self, mopidy_core):
+    def action(self, mopidy_core):  # pylint: disable=no-self-use
         '''
         Stop playback.
         '''
@@ -231,7 +232,7 @@ class PauseCard(Card):
     Pauses or resumes the playback, based on the current state.
     '''
 
-    def action(self, mopidy_core):
+    def action(self, mopidy_core):  # pylint: disable=no-self-use
         '''
         Pause or resume the playback.
         '''

mopidy_pummeluff/frontend.py

@@ -10,7 +10,7 @@ from time import time
 from logging import getLogger
 
 import pykka
-from mopidy import core
+from mopidy import core as mopidy_core
 
 from .rfid_reader import RFIDReader, ReadError
 from .cards import Card
@@ -81,12 +81,12 @@ class CardReader(Thread):
         CardReader.latest = card
 
 
-class PummeluffFrontend(pykka.ThreadingActor, core.CoreListener):
+class PummeluffFrontend(pykka.ThreadingActor, mopidy_core.CoreListener):
     '''
     Pummeluff frontend which basically reads cards from the RFID reader.
     '''
 
-    def __init__(self, config, core):
+    def __init__(self, config, core):  # pylint: disable=unused-argument
         super(PummeluffFrontend, self).__init__()
         self.core        = core
         self.stop_event  = Event()

mopidy_pummeluff/registry.py

@@ -27,6 +27,8 @@ class RegistryDict(dict):
     registry_path = '/etc/mopidy/pummeluff_cards.json'
 
     def __init__(self):
+        super(RegistryDict, self).__init__(self)
+
         if os.path.exists(self.registry_path):
             self.read()
         else:

mopidy_pummeluff/rfid_reader.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # -*- coding: utf8 -*-
 '''
 Python card reader module.
@@ -22,6 +21,13 @@ class RFIDReader(RFID):
     :py:class:`pirc522.RFID` class.
     '''
 
+    @staticmethod
+    def cleanup():
+        '''
+        Cleanup GPIO ports.
+        '''
+        cleanup()
+
     @property
     def uid(self):
         '''
@@ -30,7 +36,7 @@ class RFIDReader(RFID):
         :return: The hex UID
         :rtype: string
         '''
-        error, data = self.request()
+        error, data = self.request()  # pylint: disable=unused-variable
         if error:
             raise ReadError('Could not read tag')
 
@@ -40,9 +46,3 @@ class RFIDReader(RFID):
 
         uid = '{0[0]:02X}{0[1]:02X}{0[2]:02X}{0[3]:02X}'.format(uid_chunks)
         return uid
-
-    def cleanup(self):
-        '''
-        Cleanup GPIO ports.
-        '''
-        cleanup()

mopidy_pummeluff/web.py

@@ -16,8 +16,8 @@ from logging import getLogger
 
 from tornado.web import RequestHandler
 
+from . import cards
 from .frontend import CardReader
-from .cards import *
 
 LOGGER = getLogger(__name__)
 
@@ -27,7 +27,7 @@ class LatestHandler(RequestHandler):
     Request handler which returns the latest scanned card.
     '''
 
-    def initialize(self, core):
+    def initialize(self, core):  # pylint: disable=arguments-differ
         '''
         Initialize request handler with Mopidy core.
 
@@ -35,7 +35,7 @@ class LatestHandler(RequestHandler):
         '''
         self.core = core
 
-    def get(self):
+    def get(self, *args, **kwargs):
         '''
         Handle GET request.
         '''
@@ -66,7 +66,7 @@ class RegistryHandler(RequestHandler):
     Request handler which returns all registered cards.
     '''
 
-    def initialize(self, core):
+    def initialize(self, core):  # pylint: disable=arguments-differ
         '''
         Initialize request handler with Mopidy core.
 
@@ -74,19 +74,19 @@ class RegistryHandler(RequestHandler):
         '''
         self.core = core
 
-    def get(self):
+    def get(self, *args, **kwargs):
         '''
         Handle GET request.
         '''
-        cards = []
+        cards_list = []
 
-        for uid, card in Card.all().items():
-            cards.append(card.dict)
+        for card in cards.Card.all().values():
+            cards_list.append(card.dict)
 
         data = {
             'success': True,
             'message': 'Registry successfully read',
-            'cards': cards
+            'cards': cards_list
         }
 
         self.set_header('Content-type', 'application/json')
@@ -98,7 +98,7 @@ class RegisterHandler(RequestHandler):
     Request handler which registers an RFID card in the registry.
     '''
 
-    def initialize(self, core):
+    def initialize(self, core):  # pylint: disable=arguments-differ
         '''
         Initialize request handler with Mopidy core.
 
@@ -106,12 +106,12 @@ class RegisterHandler(RequestHandler):
         '''
         self.core = core
 
-    def post(self):
+    def post(self, *args, **kwargs):
         '''
         Handle POST request.
         '''
         try:
-            card = Card.register(
+            card = cards.Card.register(
                 uid=self.get_argument('uid'),
                 alias=self.get_argument('alias', None),
                 parameter=self.get_argument('parameter'),
@@ -135,7 +135,7 @@ class RegisterHandler(RequestHandler):
         self.set_header('Content-type', 'application/json')
         self.write(dumps(data))
 
-    def put(self):
+    def put(self, *args, **kwargs):
         '''
         Handle PUT request.
         '''
@@ -147,7 +147,7 @@ class TypesHandler(RequestHandler):
     Request handler which returns all card types.
     '''
 
-    def initialize(self, core):
+    def initialize(self, core):  # pylint: disable=arguments-differ
         '''
         Initialize request handler with Mopidy core.
 
@@ -155,18 +155,16 @@ class TypesHandler(RequestHandler):
         '''
         self.core = core
 
-    def get(self):
+    def get(self, *args, **kwargs):
         '''
         Handle GET request.
         '''
-        from .cards import __all__ as card_classes
-
         types = {}
 
-        for cls_name in card_classes:
-            card_cls = globals()[cls_name]
-            if card_cls is not Card:
-                card_type        = Card.get_type(card_cls)
+        for cls_name in cards.__all__:
+            card_cls = getattr(cards, cls_name)
+            if card_cls is not cards.Card:
+                card_type        = cards.Card.get_type(card_cls)
                 card_doc         = card_cls.__doc__.strip().split('.')[0]
                 types[card_type] = card_doc