Added a preliminary pylintrc to the project.

and started to fix linting errors.

plugin/UltiSnips.vim

@@ -153,7 +153,7 @@ endfunction
 
 function! UltiSnips_SnippetsInCurrentScope()
     let g:current_ulti_dict = {}
-    exec g:_uspy "UltiSnips_Manager.list_snippets_dict()"
+    exec g:_uspy "UltiSnips_Manager.snippets_in_current_scope()"
     return g:current_ulti_dict
 endfunction
 
@@ -286,10 +286,11 @@ exec g:_uspy "import vim, os, sys"
 exec g:_uspy "new_path = vim.eval('expand(\"<sfile>:h\")')"
 exec g:_uspy "vim.command(\"let g:UltiSnipsPythonPath = '%s'\" % new_path)"
 exec g:_uspy "sys.path.append(new_path)"
-exec g:_uspy "from UltiSnips import UltiSnips_Manager"
+exec g:_uspy "from UltiSnips import SnippetManager"
-exec g:_uspy "UltiSnips_Manager.expand_trigger = vim.eval('g:UltiSnipsExpandTrigger')"
+exec g:_uspy "UltiSnips_Manager = SnippetManager(
-exec g:_uspy "UltiSnips_Manager.forward_trigger = vim.eval('g:UltiSnipsJumpForwardTrigger')"
+    \ vim.eval('g:UltiSnipsExpandTrigger'),
-exec g:_uspy "UltiSnips_Manager.backward_trigger = vim.eval('g:UltiSnipsJumpBackwardTrigger')"
+    \ vim.eval('g:UltiSnipsJumpForwardTrigger'),
+    \ vim.eval('g:UltiSnipsJumpBackwardTrigger'))"
 
 au CursorMovedI * call UltiSnips_CursorMoved()
 au CursorMoved * call UltiSnips_CursorMoved()

plugin/UltiSnips/__init__.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # encoding: utf-8
 
+"""Contains the SnippetManager facade used by all Vim Functions."""
+
 from collections import defaultdict
 from functools import wraps
 import glob
@@ -22,7 +24,8 @@ def _ask_snippets(snippets):
     """ Given a list of snippets, ask the user which one they
     want to use, and return it.
     """
-    display = [ as_unicode("%i: %s") % (i+1,s.description) for i,s in enumerate(snippets)]
+    display = [as_unicode("%i: %s") % (i+1, s.description) for
+            i, s in enumerate(snippets)]
     try:
         rv = _vim.eval("inputlist(%s)" % _vim.escape(display))
         if rv is None or rv == '0':
@@ -31,7 +34,7 @@ def _ask_snippets(snippets):
         if rv > len(snippets):
             rv = len(snippets)
         return snippets[rv-1]
-    except _vim.error as e:
+    except _vim.error:
         # Likely "invalid expression", but might be translated. We have no way
         # of knowing the exact error, therefore, we ignore all errors silently.
         return None
@@ -53,7 +56,8 @@ def _base_snippet_files_for(ft, default=True):
         snippet_dirs = _vim.eval("b:UltiSnipsSnippetDirectories")
     else:
         snippet_dirs = _vim.eval("g:UltiSnipsSnippetDirectories")
-    base_snippets = os.path.realpath(os.path.join(__file__, "../../../UltiSnips"))
+    base_snippets = os.path.realpath(os.path.join(
+        __file__, "../../../UltiSnips"))
     ret = []
 
     paths = _vim.eval("&runtimepath").split(',')
@@ -63,9 +67,9 @@ def _base_snippet_files_for(ft, default=True):
 
     for rtp in paths:
         for snippet_dir in snippet_dirs:
-            pth = os.path.realpath(os.path.expanduser(os.path.join(rtp, snippet_dir)))
+            pth = os.path.realpath(os.path.expanduser(
-
+                os.path.join(rtp, snippet_dir)))
-            patterns = ["%s.snippets", "%s_*.snippets", os.path.join("%s","*")]
+            patterns = ["%s.snippets", "%s_*.snippets", os.path.join("%s", "*")]
             if not default and pth == base_snippets:
                 patterns.remove("%s.snippets")
 
@@ -82,28 +86,31 @@ def _plugin_dir():
     current file being 3 levels deep from the plugin directory, so it needs to
     be updated if the code moves.
     """
-    d = __file__
+    directory = __file__
-    for i in range(10):
+    for _ in range(10):
-        d = os.path.dirname(d)
+        directory = os.path.dirname(directory)
-        if os.path.isdir(os.path.join(d, "plugin")) and os.path.isdir(os.path.join(d, "doc")):
+        if (os.path.isdir(os.path.join(directory, "plugin")) and
-            return d
+            os.path.isdir(os.path.join(directory, "doc"))):
+            return directory
     raise Exception("Unable to find the plugin directory.")
 
 def _snippets_dir_is_before_plugin_dir():
     """ Returns True if the snippets directory comes before the plugin
     directory in Vim's runtime path. False otherwise.
     """
-    paths = [ os.path.realpath(os.path.expanduser(p)).rstrip(os.path.sep)
+    paths = [os.path.realpath(os.path.expanduser(p)).rstrip(os.path.sep)
-        for p in _vim.eval("&runtimepath").split(',') ]
+        for p in _vim.eval("&runtimepath").split(',')]
     home = _vim.eval("$HOME")
     def vim_path_index(suffix):
+        """Returns index of 'suffix' in 'paths' or -1 if it is not found."""
         path = os.path.realpath(os.path.join(home, suffix)).rstrip(os.path.sep)
         try:
             return paths.index(path)
         except ValueError:
             return -1
     try:
-        real_vim_path_index = max(vim_path_index(".vim"), vim_path_index("vimfiles"))
+        real_vim_path_index = max(
+                vim_path_index(".vim"), vim_path_index("vimfiles"))
         plugin_path_index = paths.index(_plugin_dir())
         return plugin_path_index < real_vim_path_index
     except ValueError:
@@ -116,40 +123,44 @@ def _should_reverse_search_path():
     False.
     """
     if _vim.eval("exists('g:UltiSnipsDontReverseSearchPath')") != "0":
-       return _vim.eval("g:UltiSnipsDontReverseSearchPath") != "0"
+        return _vim.eval("g:UltiSnipsDontReverseSearchPath") != "0"
     return not _snippets_dir_is_before_plugin_dir()
 
-def err_to_scratch_buffer(f):
+def err_to_scratch_buffer(func):
-    @wraps(f)
+    """Decorator that will catch any Exception that 'func' throws and displays
+    it in a new Vim scratch buffer."""
+    @wraps(func)
     def wrapper(self, *args, **kwds):
         try:
-            return f(self, *args, **kwds)
+            return func(self, *args, **kwds)
-        except:
+        except: # pylint: disable=bare-except
-            s = \
+            msg = \
 """An error occured. This is either a bug in UltiSnips or a bug in a
 snippet definition. If you think this is a bug, please report it to
 https://bugs.launchpad.net/ultisnips/+filebug.
 
 Following is the full stack trace:
 """
-            s += traceback.format_exc()
+            msg += traceback.format_exc()
             self.leaving_buffer() # Vim sends no WinLeave msg here.
-            _vim.new_scratch_buffer(s)
+            _vim.new_scratch_buffer(msg)
     return wrapper
 
 class SnippetManager(object):
-    def __init__(self):
+    def __init__(self, expand_trigger, forward_trigger, backward_trigger):
+        """The main entry point for all UltiSnips functionality. All Vim
+        functions call methods in this class."""
+        self.expand_trigger = expand_trigger
+        self.forward_trigger = forward_trigger
+        self.backward_trigger = backward_trigger
         self._supertab_keys = None
         self._csnippets = []
 
-        # needed to retain the unnamed register at all times
-        self._unnamed_reg_cached = False
-        self._last_placeholder = None
-
         self.reset()
 
     @err_to_scratch_buffer
     def reset(self, test_error=False):
+        """Reset the class to the state it had directly after creation."""
         self._vstate = VimState()
         self._test_error = test_error
         self._snippets = {}
@@ -159,10 +170,15 @@ class SnippetManager(object):
         while len(self._csnippets):
             self._current_snippet_is_done()
 
+        # needed to retain the unnamed register at all times
+        self._unnamed_reg_cached = False
+        self._last_placeholder = None
+
         self._reinit()
 
     @err_to_scratch_buffer
     def jump_forwards(self):
+        """Jumps to the next tabstop."""
         _vim.command("let g:ulti_jump_forwards_res = 1")
         if not self._jump():
             _vim.command("let g:ulti_jump_forwards_res = 0")
@@ -170,6 +186,7 @@ class SnippetManager(object):
 
     @err_to_scratch_buffer
     def jump_backwards(self):
+        """Jumps to the previous tabstop."""
         _vim.command("let g:ulti_jump_backwards_res = 1")
         if not self._jump(True):
             _vim.command("let g:ulti_jump_backwards_res = 0")
@@ -177,14 +194,17 @@ class SnippetManager(object):
 
     @err_to_scratch_buffer
     def expand(self):
+        """Trie to expand a snippet at the current position."""
         _vim.command("let g:ulti_expand_res = 1")
         if not self._try_expand():
             _vim.command("let g:ulti_expand_res = 0")
             self._handle_failure(self.expand_trigger)
 
     @err_to_scratch_buffer
-    def list_snippets_dict(self):
+    def snippets_in_current_scope(self):
-        before, after = _vim.buf.current_line_splitted
+        """Returns the snippets that could be expanded to Vim as a global
+        variable."""
+        before, _ = _vim.buf.current_line_splitted
         snippets = self._snips(before, True)
 
         # Sort snippets alphabetically
@@ -198,14 +218,19 @@ class SnippetManager(object):
 
             #remove surrounding "" or '' in snippet description if it exists
             if len(description) > 2:
-              if description[0] == description[-1] and description[0] in ['"', "'"]:
+                if (description[0] == description[-1] and
-                description = description[1:-1]
+                        description[0] in "'\""):
+                    description = description[1:-1]
 
-            _vim.command(as_unicode("let g:current_ulti_dict['{key}'] = '{val}'").format(
+            _vim.command(as_unicode(
-              key=key.replace("'", "''"), val=description.replace("'", "''")))
+                "let g:current_ulti_dict['{key}'] = '{val}'").format(
+                    key=key.replace("'", "''"),
+                    val=description.replace("'", "''")))
 
     @err_to_scratch_buffer
     def list_snippets(self):
+        """Shows the snippets that could be expanded to the User and let her
+        select one."""
         before, after = _vim.buf.current_line_splitted
         snippets = self._snips(before, True)
 
@@ -252,13 +277,16 @@ class SnippetManager(object):
         """
         self._visual_content.conserve()
 
+    # TODO(sirver): replace through defaultdict
     def snippet_dict(self, ft):
+        """Makes sure that ft is in self._snippets."""
         if ft not in self._snippets:
             self._snippets[ft] = SnippetDictionary()
         return self._snippets[ft]
 
     @err_to_scratch_buffer
-    def add_snippet(self, trigger, value, descr, options, ft = "all", globals = None, fn=None):
+    def add_snippet(self, trigger, value, descr, options, ft="all", globals=None, fn=None):
+        """Add a snippet to the list of known snippets of the given 'ft'."""
         l = self.snippet_dict(ft).add_snippet(
             Snippet(trigger, value, descr, options, globals or {}), fn
         )
@@ -412,8 +440,8 @@ class SnippetManager(object):
                         m = re.match(r'(.*?)\s+$', before)
                         if m:
                             lineno = _vim.buf.cursor.line
-                            _vim.text_to_vim(Position(lineno,0), Position(
+                            _vim.text_to_vim(Position(lineno, 0), Position(
-                                lineno,len(before)+len(after)), m.group(1))
+                                lineno, len(before)+len(after)), m.group(1))
                 _vim.select(self._ctab.start, self._ctab.end)
                 jumped = True
                 if self._ctab.no == 0:
@@ -461,7 +489,7 @@ class SnippetManager(object):
                     _vim.eval("g:SuperTabMappingBackward"),
                 )
             else:
-                self._supertab_keys = [ '', '' ]
+                self._supertab_keys = ['', '']
 
         for idx, sttrig in enumerate(self._supertab_keys):
             if trigger.lower() == sttrig.lower():
@@ -537,7 +565,8 @@ class SnippetManager(object):
         else:
             start = Position(_vim.buf.cursor.line, len(text_before))
             end = Position(_vim.buf.cursor.line, len(before))
-            si = snippet.launch(text_before, self._visual_content, None, start, end)
+            si = snippet.launch(text_before, self._visual_content,
+                                None, start, end)
 
         self._visual_content.reset()
         self._csnippets.append(si)
@@ -602,8 +631,10 @@ class SnippetManager(object):
             edit = existing[-1] # last sourced/highest priority
         else:
             home = _vim.eval("$HOME")
-            rtp = [ os.path.realpath(os.path.expanduser(p)) for p in _vim.eval("&rtp").split(",") ]
+            rtp = [os.path.realpath(os.path.expanduser(p))
-            snippet_dirs = ["UltiSnips"] + _vim.eval("g:UltiSnipsSnippetDirectories")
+                    for p in _vim.eval("&rtp").split(",")]
+            snippet_dirs = ["UltiSnips"] + \
+                    _vim.eval("g:UltiSnipsSnippetDirectories")
             us = snippet_dirs[-1]
 
             path = os.path.join(home, ".vim", us)
@@ -623,9 +654,9 @@ class SnippetManager(object):
         for fn in _base_snippet_files_for(ft):
             self._parse_snippets(ft, fn)
         # Now load for the parents
-        for p in self._snippets[ft].extends:
+        for parent_ft in self._snippets[ft].extends:
-            if p not in self._snippets:
+            if parent_ft not in self._snippets:
-                self._load_snippets_for(p)
+                self._load_snippets_for(parent_ft)
 
     def _needs_update(self, ft):
         do_hash = _vim.eval('exists("g:UltiSnipsDoHash")') == "0" \
@@ -689,20 +720,17 @@ class SnippetManager(object):
         potentially - also returns snippets that could potentially match; that
                       is which triggers start with the current trigger
         """
-        snips = self._snippets.get(ft,None)
+        snips = self._snippets.get(ft, None)
         if not snips:
             return []
         if not seen:
             seen = []
         seen.append(ft)
         parent_results = []
-        for p in snips.extends:
+        for parent_ft in snips.extends:
-            if p not in seen:
+            if parent_ft not in seen:
-                seen.append(p)
+                seen.append(parent_ft)
-                parent_results += self._find_snippets(p, trigger,
+                parent_results += self._find_snippets(parent_ft, trigger,
                         potentially, seen)
         return parent_results + snips.get_matching_snippets(
             trigger, potentially)
-
-
-UltiSnips_Manager = SnippetManager()

plugin/UltiSnips/compatibility.py

@@ -83,4 +83,3 @@ else:
 
     def as_vimencoding(s):
         return _vim_enc(s)
-

plugin/UltiSnips/compatibility_py3.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 # encoding: utf-8
 
-
 """
 This file contains code that is invalid in python2 and must therefore never be
 seen by the interpretor

pylintrc

@@ -0,0 +1,258 @@
+[MASTER]
+
+msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}"
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+init-hook='import sys; sys.path.append("plugin/")'
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS,compatibility_py3
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# 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. See also the "--disable" option for examples.
+#enable=
+
+# 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=too-many-public-methods, 
+   too-many-instance-attributes, 
+   attribute-defined-outside-init
+
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. 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
+
+
+[BASIC]
+
+# Required attributes for module, separated by a comma
+required-attributes=
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,input
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Regular expression which should only match correct class names
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+# Regular expression which should only match correct function names
+function-rgx=_?[a-z_][a-z0-9_]{2,50}$
+
+# Regular expression which should only match correct method names
+method-rgx=[a-z_][a-z0-9_]{2,50}$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=[a-z_][a-z0-9_]{2,50}$
+
+# Regular expression which should only match correct argument names
+argument-rgx=[a-z_][a-z0-9_]{1,50}$
+
+# Regular expression which should only match correct variable names
+variable-rgx=[a-z_][a-z0-9_]{1,50}$
+
+# Regular expression which should only match correct attribute names in class
+# bodies
+class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,ex,Run,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=foo,bar,baz,toto,tutu,tata
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=(__.*__|wrapper)
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=80
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# 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
+
+# List of optional constructs for which whitespace checking is disabled
+no-space-check=trailing-comma,dict-separator
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[TYPECHECK]
+
+# 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
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed. Python regular
+# expressions are accepted.
+generated-members=REQUEST,acl_users,aq_parent
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=_$|dummy
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+[CLASSES]
+
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+# 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
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branches=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,TERMIOS,Bastion,rexec
+
+# 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 external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception