[Lint] Add PyLint support and cleanup code with basic changes

* Include a pylintrc config file
 * This commit provides a basic error-only pylint config as a starting
   point with a view to adding more checks incrementally to keep the volume
   of changes low and the code able to pass pylint at each stage.

deluge/config.py

@@ -525,7 +525,7 @@ what is currently in the config and it could not convert the value
         return self.__config_file
 
     @prop
-    def config():
+    def config():  # pylint: disable=E0211
         """The config dictionary"""
         def fget(self):
             return self.__config

deluge/tests/test_client.py

@@ -68,19 +68,15 @@ class ClientTestCase(BaseTestCase):
 
     def set_up(self):
         self.listen_port = 58846
-        tries = 10
+        for dummy in range(10):
-        error = None
-        while tries > 0:
             try:
                 self.core = common.start_core(listen_port=self.listen_port)
             except CannotListenError as ex:
                 error = ex
                 self.listen_port += 1
-                tries -= 1
             else:
-                error = None
                 break
-        if error:
+        else:
             raise error
 
     def tear_down(self):

deluge/tests/test_core.py

@@ -78,22 +78,17 @@ class CoreTestCase(BaseTestCase):
         return component.start().addCallback(self.start_web_server)
 
     def start_web_server(self, result):
-        self.website = Site(TopLevelResource())
+        website = Site(TopLevelResource())
-        tries = 10
+        for dummy in range(10):
-        error = None
-        while tries > 0:
             try:
-                self.webserver = reactor.listenTCP(self.listen_port, self.website)
+                self.webserver = reactor.listenTCP(self.listen_port, website)
             except CannotListenError as ex:
                 error = ex
                 self.listen_port += 1
-                tries -= 1
             else:
-                error = None
+                return result
-                break
+        else:
-        if error:
             raise error
-        return result
 
     def tear_down(self):
 

deluge/tests/test_httpdownloader.py

@@ -93,21 +93,17 @@ class DownloadFileTestCase(unittest.TestCase):
 
     def setUp(self):  # NOQA
         setup_logger("warning", fname("log_file"))
-        self.website = Site(TopLevelResource())
+        website = Site(TopLevelResource())
         self.listen_port = 51242
-        tries = 10
+        for dummy in range(10):
-        error = None
-        while tries > 0:
             try:
-                self.webserver = reactor.listenTCP(self.listen_port, self.website)
+                self.webserver = reactor.listenTCP(self.listen_port, website)
             except CannotListenError as ex:
                 error = ex
                 self.listen_port += 1
-                tries -= 1
             else:
-                error = None
                 break
-        if error:
+        else:
             raise error
 
     def tearDown(self):  # NOQA

deluge/ui/gtkui/common.py

@@ -166,7 +166,7 @@ def associate_magnet_links(overwrite=False):
 
         try:
             hkey = _winreg.OpenKey(_winreg.HKEY_CLASSES_ROOT, "Magnet")
-        except WindowsError:
+        except WindowsError:  # pylint: disable=E0602
             overwrite = True
         else:
             _winreg.CloseKey(hkey)
@@ -175,7 +175,7 @@ def associate_magnet_links(overwrite=False):
             deluge_exe = os.path.join(os.path.dirname(sys.executable), "deluge.exe")
             try:
                 magnet_key = _winreg.CreateKey(_winreg.HKEY_CLASSES_ROOT, "Magnet")
-            except WindowsError:
+            except WindowsError:  # pylint: disable=E0602
                 # Could not create for all users, falling back to current user
                 magnet_key = _winreg.CreateKey(_winreg.HKEY_CURRENT_USER, "Software\\Classes\\Magnet")
 

deluge/ui/gtkui/createtorrentdialog.py

@@ -310,7 +310,7 @@ class CreateTorrentDialog:
                 self._on_create_torrent_progress(piece_count, num_pieces)
                 if piece_count == num_pieces:
                     from twisted.internet import reactor
-                    reactor.callLater(0.5, torrent_created)  # pylint: disable-msg=E1101
+                    reactor.callLater(0.5, torrent_created)  # pylint: disable=E1101
 
             client.register_event_handler("CreateTorrentProgressEvent", on_create_torrent_progress_event)
 

deluge/ui/gtkui/files_tab.py

@@ -307,7 +307,7 @@ class FilesTab(Tab):
         self.torrent_id = None
 
     def _on_row_activated(self, tree, path, view_column):
-        self._on_menuitem_open_file_activate()
+        self._on_menuitem_open_file_activate(None)
 
     def get_file_path(self, row, path=""):
         if not row:

deluge/ui/gtkui/gtkui.py

@@ -57,7 +57,7 @@ gobject.set_prgname("deluge")
 log = logging.getLogger(__name__)
 
 try:
-    from setproctitle import setproctitle, getproctitle
+    from setproctitle import setproctitle, getproctitle  # pylint: disable=E0611
 except ImportError:
     def setproctitle(title):
         return
@@ -167,7 +167,13 @@ class GtkUI(object):
 
             def on_die(*args):
                 reactor.stop()
-            self.gnome_client.connect("die", on_die)
+
+            if deluge.common.osx_check() and gtk.gdk.WINDOWING == "quartz":
+                import gtkosx_application
+                self.osxapp = gtkosx_application.gtkosx_application_get()
+                self.osxapp.connect("NSApplicationWillTerminate", on_die)
+            else:
+                self.gnome_client.connect("die", on_die)
             log.debug("GNOME session 'die' handler registered!")
         except Exception as ex:
             log.warning("Unable to register a 'die' handler with the GNOME session manager: %s", ex)
@@ -184,14 +190,6 @@ class GtkUI(object):
                     return 1
             SetConsoleCtrlHandler(win_handler)
 
-        if deluge.common.osx_check() and gtk.gdk.WINDOWING == "quartz":
-            import gtkosx_application
-            self.osxapp = gtkosx_application.gtkosx_application_get()
-
-            def on_die(*args):
-                reactor.stop()
-            self.osxapp.connect("NSApplicationWillTerminate", on_die)
-
         # Set process name again to fix gtk issue
         setproctitle(getproctitle())
 

deluge/ui/gtkui/status_tab.py

@@ -71,11 +71,7 @@ class StatusTab(Tab):
         self._child_widget = builder.get_object("status_tab")
         self._tab_label = builder.get_object("status_tab_label")
         self.config = ConfigManager("gtkui.conf")
-        self.config.register_set_function(
+
-            "show_piecesbar",
-            self.on_show_pieces_bar_config_changed,
-            apply_now=True
-        )
         self.label_widgets = [
             (builder.get_object("summary_availability"), fratio, ("distributed_copies",)),
             (builder.get_object("summary_total_downloaded"), fpeer_sized, ("all_time_download",
@@ -97,6 +93,9 @@ class StatusTab(Tab):
 
         self.status_keys = [status for widget in self.label_widgets for status in widget[2]]
 
+        self.piecesbar = None
+        self.config.register_set_function("show_piecesbar", self.on_show_piecesbar_config_changed, apply_now=True)
+
     def update(self):
         # Get the first selected torrent
         selected = component.get("TorrentView").get_selected_torrents()
@@ -145,24 +144,24 @@ class StatusTab(Tab):
             if self.progressbar.get_fraction() != fraction:
                 self.progressbar.set_fraction(fraction)
 
-    def on_show_pieces_bar_config_changed(self, key, show):
+    def on_show_piecesbar_config_changed(self, key, show):
-        self.show_pieces_bar(show)
+        if show:
-
+            self.show_piecesbar()
-    def show_pieces_bar(self, show):
-        if hasattr(self, 'piecesbar'):
-            if show:
-                self.piecesbar.show()
-                self.progressbar.hide()
-            else:
-                self.piecesbar.hide()
-                self.progressbar.show()
         else:
-            if show:
+            self.hide_piecesbar()
-                self.piecesbar = PiecesBar()
+
-                self.builder.get_object("status_progress_vbox").pack_start(
+    def show_piecesbar(self):
-                    self.piecesbar, False, False, 0
+        if self.piecesbar is None:
-                )
+            self.piecesbar = PiecesBar()
-                self.progressbar.hide()
+            self.builder.get_object("status_progress_vbox").pack_start(self.piecesbar, False, False, 0)
+        self.piecesbar.show()
+        self.progressbar.hide()
+
+    def hide_piecesbar(self):
+        self.progressbar.show()
+        if self.piecesbar:
+            self.piecesbar.hide()
+            self.piecesbar = None
 
     def clear(self):
         for widget in self.label_widgets:

pylintrc

@@ -0,0 +1,386 @@
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Profiled execution.
+profile=no
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Use multiple processes to speed up Pylint.
+jobs=1
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+# 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=libtorrent,gtk,gobject,gnome,twisted,wnck
+
+# Allow optimization of some AST trees. This will activate a peephole AST
+# optimizer, which will apply various small optimizations. For instance, it can
+# be used to obtain the result of joining multiple strings with the addition
+# operator. Joining a lot of strings can lead to a maximum recursion error in
+# Pylint and this flag can prevent that. It has one side effect, the resulting
+# AST will be different than the one from reality.
+optimize-ast=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# 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=all
+#disable=E1608,W1627,E1601,E1603,E1602,E1605,E1604,E1607,E1606,W1621,W1620,W1623,W1622,W1625,
+# W1624,W1609,W1608,W1607,W1606,W1605,W1604,W1603,W1602,W1601,W1639,W1640,I0021,W1638,I0020,
+# W1618,W1619,W1630,W1626,W1637,W1634,W1635,W1610,W1611,W1612,W1613,W1614,W1615,W1616,W1617,
+# W1632,W1633,W0704,W1628,W1629,W1636
+disable=E1101,E1102,no-name-in-module,W,C,R,locally-disabled,
+
+[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=parseable
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# 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)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (RP0004).
+comment=no
+
+# 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=
+
+
+[SPELLING]
+
+# 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
+
+
+[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,input
+
+# 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
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Include a hint for the correct naming format with invalid-name
+include-naming-hint=no
+
+# Regular expression matching correct function names
+function-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Naming hint for function names
+function-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression matching correct variable names
+variable-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Naming hint for variable names
+variable-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression matching correct constant names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Naming hint for constant names
+const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Regular expression matching correct attribute names
+attr-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Naming hint for attribute names
+attr-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression matching correct argument names
+argument-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Naming hint for argument names
+argument-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression matching correct class attribute names
+class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+
+# Naming hint for class attribute names
+class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+
+# Regular expression matching correct inline iteration names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Naming hint for inline iteration names
+inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
+
+# Regular expression matching correct class names
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+# Naming hint for class names
+class-name-hint=[A-Z_][a-zA-Z0-9]+$
+
+# Regular expression matching correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Naming hint for module names
+module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression matching correct method names
+method-rgx=[a-z_][a-z0-9_]{2,40}$
+
+# Naming hint for method names
+method-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=__.*__
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# 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=1500
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the name of dummy variables (i.e. expectedly
+# 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=_,__request__
+
+# 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
+
+
+[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 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
+ignored-modules=
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject,twisted.internet.reactor
+
+# 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
+
+
+[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
+
+
+[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=
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=7
+
+# 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
+
+
+[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
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,_fields,_replace,_source,_make
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception