update to make this a proper package, some minor updates and cleanup, fixes bug where triple quotes tracking was not cleaned up between modules.

Author: edaniszewski

README.md

@@ -70,7 +70,7 @@ pip install pylint-quotes
 ## Usage
 To use pylint-quotes, it must loaded in as a plugin when running pylint
 ```
-pylint --load-plugins pylint-quotes <file>
+pylint --load-plugins pylint_quotes <module-or-package>
 ```
 
 ## Checks

pylint_quotes/__init__.py

@@ -0,0 +1,7 @@
+"""pylint-quotes module"""
+from __future__ import absolute_import
+from pylint_quotes import plugin
+
+__version__ = '0.1.3'
+
+register = plugin.register

pylint_quotes.py pylint_quotes/checker.pypylint_quotes.py renamed to pylint_quotes/checker.py

@@ -1,12 +1,14 @@
 """Pylint plugin for checking quote type on strings.
 """
+
 from __future__ import absolute_import
 
 import tokenize
 
 from pylint.interfaces import ITokenChecker, IAstroidChecker
 from pylint.checkers import BaseTokenChecker
 
+
 CONFIG_OPTS = ('single', 'double')
 
 QUOTES = ('\'', '"')
@@ -99,6 +101,20 @@ def visit_module(self, node):
         """
         self._process_for_docstring(node, 'module')
 
+    # pylint: disable=unused-argument
+    def leave_module(self, node):
+        """Leave module and check remaining triple quotes.
+
+        Args:
+            node: the module node we are leaving.
+        """
+        for triple_quote in self._tokenized_triple_quotes.values():
+            self._check_triple_quotes(triple_quote)
+
+        # after we are done checking these, clear out the triple-quote
+        # tracking collection so nothing is left over for the next module.
+        self._tokenized_triple_quotes = {}
+
     def visit_classdef(self, node):
         """Visit class and check for docstring quote consistency.
 
@@ -146,16 +162,6 @@ def _process_for_docstring(self, node, node_type):
                 self._check_docstring_quotes(quote_record)
                 del self._tokenized_triple_quotes[doc_row]
 
-    # pylint: disable=unused-argument
-    def leave_module(self, node):
-        """Leave module and check remaining triple quotes.
-
-        Args:
-            node: the module node we are leaving.
-        """
-        for triple_quote in self._tokenized_triple_quotes.values():
-            self._check_triple_quotes(triple_quote)
-
     def process_tokens(self, tokens):
         """Process the token stream.
 
@@ -254,12 +260,3 @@ def _invalid_docstring_quote(self, quote, row):
             line=row,
             args=(quote, TRIPLE_QUOTE_OPTS.get(self.config.docstring_quote))
         )
-
-
-def register(linter):
-    """Required method to auto register this checker.
-
-    Args:
-        linter: Main interface object for Pylint plugins.
-    """
-    linter.register_checker(StringQuoteChecker(linter))

pylint_quotes/plugin.py

@@ -0,0 +1,14 @@
+"""Module which defines the required register method
+for Pylint plugins.
+"""
+
+from pylint_quotes.checker import StringQuoteChecker
+
+
+def register(linter):
+    """Required method to auto register this checker.
+
+    Args:
+        linter: Main interface object for Pylint plugins.
+    """
+    linter.register_checker(StringQuoteChecker(linter))

setup.py

@@ -1,23 +1,24 @@
 """Setup for the pylint-quotes package.
 """
-from setuptools import setup
+
+from setuptools import setup, find_packages
+
+from pylint_quotes import __version__
 
 
 setup(
     name='pylint-quotes',
     description='Quote consistency checker for Pylint',
     long_description=open('README.md').read(),
     license='MIT',
-    version='0.1.0',
+    version=__version__,
     author='Erick Daniszewski',
     author_email='edaniszewski@gmail.com',
     url='https://github.com/edaniszewski/pylint-quotes',
     install_requires=[
         'pylint',
     ],
-    packages=[
-        '',
-    ],
+    packages=find_packages(),
     classifiers=[
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',