Merge pull request #301 from return42/fix-lintrc

[pylint] .pylintrc - disable missing-function-docstring

.pylintrc

@@ -59,7 +59,9 @@ confidence=
 # --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, duplicate-code
+disable=bad-whitespace,
+        duplicate-code,
+        missing-function-docstring,
 
 # 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

searx/__init__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring, missing-module-docstring
+# pylint: disable=missing-module-docstring
 
 from os.path import dirname, abspath
 import logging

searx/engines/__init__.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """This module implements the engine loader.
 
 Load and initialize the ``engines``, see :py:func:`load_engines` and register

searx/engines/apkmirror.py

@@ -3,7 +3,7 @@
 """APKMirror
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 
 from urllib.parse import urlencode
 from lxml import html

searx/engines/artic.py

@@ -8,8 +8,6 @@ Explore thousands of artworks from The Art Institute of Chicago.
 
 """
 
-# pylint: disable=missing-function-docstring
-
 from json import loads
 from urllib.parse import urlencode
 

searx/engines/core.py

@@ -3,7 +3,6 @@
 """CORE (science)
 
 """
-# pylint: disable=missing-function-docstring
 
 from json import loads
 from datetime import datetime

searx/engines/deviantart.py

@@ -3,7 +3,6 @@
 """
  Deviantart (Images)
 """
-# pylint: disable=missing-function-docstring
 
 from urllib.parse import urlencode
 from lxml import html

searx/engines/digg.py

@@ -3,7 +3,6 @@
 """
  Digg (News, Social media)
 """
-# pylint: disable=missing-function-docstring
 
 from json import loads
 from urllib.parse import urlencode

searx/engines/docker_hub.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """Docker Hub (IT)
 
 """

searx/engines/duckduckgo_definitions.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """DuckDuckGo (Instant Answer API)
 
 """

searx/engines/genius.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 """Genius
 
 """

searx/engines/gigablast.py

@@ -3,7 +3,7 @@
 """
  Gigablast (Web)
 """
-# pylint: disable=missing-function-docstring, invalid-name
+# pylint: disable=invalid-name
 
 import re
 from json import loads

searx/engines/google.py

@@ -25,8 +25,6 @@ The google WEB engine itself has a special setup option:
 
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
-
 from urllib.parse import urlencode
 from lxml import html
 from searx.utils import match_language, extract_text, eval_xpath, eval_xpath_list, eval_xpath_getindex

searx/engines/google_news.py

@@ -11,7 +11,7 @@ ignores some parameters from the common :ref:`google API`:
 
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 
 import binascii
 from datetime import datetime

searx/engines/google_scholar.py

@@ -9,7 +9,7 @@ Definitions`_.
    https://developers.google.com/custom-search/docs/xml_results#WebSearch_Query_Parameter_Definitions
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 
 from urllib.parse import urlencode
 from datetime import datetime

searx/engines/google_videos.py

@@ -14,7 +14,7 @@
 
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 
 import re
 from urllib.parse import urlencode

searx/engines/mediathekviewweb.py

@@ -4,8 +4,6 @@
 
 """
 
-# pylint: disable=missing-function-docstring
-
 import datetime
 from json import loads, dumps
 

searx/engines/meilisearch.py

@@ -4,7 +4,7 @@
  Meilisearch
 """
 
-# pylint: disable=global-statement, missing-function-docstring
+# pylint: disable=global-statement
 
 from json import loads, dumps
 

searx/engines/mongodb.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """MongoDB engine (Offline)
 
 """

searx/engines/mysql_server.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """MySQL database (offline)
 
 """

searx/engines/openstreetmap.py

@@ -3,7 +3,6 @@
 """OpenStreetMap (Map)
 
 """
-# pylint: disable=missing-function-docstring
 
 import re
 from json import loads

searx/engines/postgresql.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """PostgreSQL database (offline)
 
 """

searx/engines/redis_server.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """Redis engine (offline)
 
 """

searx/engines/solidtorrents.py

@@ -4,8 +4,6 @@
 
 """
 
-# pylint: disable=missing-function-docstring
-
 from json import loads
 from urllib.parse import urlencode
 

searx/engines/solr.py

@@ -4,7 +4,7 @@
  Solr
 """
 
-# pylint: disable=global-statement, missing-function-docstring
+# pylint: disable=global-statement
 
 from json import loads
 from urllib.parse import urlencode

searx/engines/springer.py

@@ -4,8 +4,6 @@
 
 """
 
-# pylint: disable=missing-function-docstring
-
 from datetime import datetime
 from json import loads
 from urllib.parse import urlencode

searx/engines/sqlite.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 
 """SQLite database (Offline)
 

searx/engines/unsplash.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """Unsplash
 
 """

searx/engines/xpath.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """The XPath engine is a *generic* engine with which it is possible to configure
 engines in the settings.
 

searx/engines/yahoo_news.py

@@ -6,7 +6,7 @@ Yahoo News is "English only" and do not offer localized nor language queries.
 
 """
 
-# pylint: disable=invalid-name, missing-function-docstring
+# pylint: disable=invalid-name
 
 import re
 from urllib.parse import urlencode

searx/flaskfix.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring,missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 from urllib.parse import urlparse
 

searx/metrics/__init__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 import typing
 import math

searx/network/__init__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring, global-statement
+# pylint: disable=missing-module-docstring, global-statement
 
 import asyncio
 import threading

searx/network/client.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring, global-statement
+# pylint: disable=missing-module-docstring, global-statement
 
 import asyncio
 import logging

searx/network/network.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
 # pylint: disable=global-statement
-# pylint: disable=missing-module-docstring, missing-class-docstring, missing-function-docstring
+# pylint: disable=missing-module-docstring, missing-class-docstring
 
 import atexit
 import asyncio

searx/network/raise_for_httperror.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """Raise exception for an HTTP response is an error.
 
 """

searx/preferences.py

@@ -117,7 +117,7 @@ class MultipleChoiceSetting(EnumStringSetting):
         self._validate_selections(elements)
         self.value = elements
 
-    def parse_form(self, data):  # pylint: disable=missing-function-docstring
+    def parse_form(self, data):
         if self.locked:
             return
 
@@ -154,7 +154,7 @@ class SetSetting(Setting):
         for element in elements:
             self.values.add(element)
 
-    def parse_form(self, data):  # pylint: disable=missing-function-docstring
+    def parse_form(self, data):
         if self.locked:
             return
 
@@ -226,22 +226,22 @@ class SwitchableSetting(Setting):
         if not hasattr(self, 'choices'):
             raise MissingArgumentException('missing argument: choices')
 
-    def transform_form_items(self, items):  # pylint: disable=missing-function-docstring
+    def transform_form_items(self, items):
         # pylint: disable=no-self-use
         return items
 
-    def transform_values(self, values):   # pylint: disable=missing-function-docstring
+    def transform_values(self, values):
         # pylint: disable=no-self-use
         return values
 
-    def parse_cookie(self, data):   # pylint: disable=missing-function-docstring
+    def parse_cookie(self, data):
         # pylint: disable=attribute-defined-outside-init
         if data[DISABLED] != '':
             self.disabled = set(data[DISABLED].split(','))
         if data[ENABLED] != '':
             self.enabled = set(data[ENABLED].split(','))
 
-    def parse_form(self, items):   # pylint: disable=missing-function-docstring
+    def parse_form(self, items):
         if self.locked:
             return
 
@@ -262,14 +262,14 @@ class SwitchableSetting(Setting):
         resp.set_cookie('disabled_{0}'.format(self.value), ','.join(self.disabled), max_age=COOKIE_MAX_AGE)
         resp.set_cookie('enabled_{0}'.format(self.value), ','.join(self.enabled), max_age=COOKIE_MAX_AGE)
 
-    def get_disabled(self):   # pylint: disable=missing-function-docstring
+    def get_disabled(self):
         disabled = self.disabled
         for choice in self.choices:  # pylint: disable=no-member
             if not choice['default_on'] and choice['id'] not in self.enabled:
                 disabled.add(choice['id'])
         return self.transform_values(disabled)
 
-    def get_enabled(self):   # pylint: disable=missing-function-docstring
+    def get_enabled(self):
         enabled = self.enabled
         for choice in self.choices:  # pylint: disable=no-member
             if choice['default_on'] and choice['id'] not in self.disabled:
@@ -515,7 +515,7 @@ class Preferences:
             resp.set_cookie(k, v, max_age=COOKIE_MAX_AGE)
         return resp
 
-    def validate_token(self, engine):  # pylint: disable=missing-function-docstring
+    def validate_token(self, engine):
         valid = True
         if hasattr(engine, 'tokens') and engine.tokens:
             valid = False

searx/search/__init__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 import typing
 import threading

searx/search/checker/__main__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 import sys
 import io

searx/search/checker/background.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-module-docstring, missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 import json
 import random

searx/search/processors/abstract.py

@@ -19,8 +19,6 @@ from searx.utils import get_engine_from_settings
 logger = logger.getChild('searx.search.processor')
 SUSPENDED_STATUS = {}
 
-# pylint: disable=missing-function-docstring
-
 class SuspendedStatus:
     """Class to handle suspend state."""
 

searx/search/processors/online_currency.py

@@ -12,8 +12,6 @@ from .online import OnlineProcessor
 
 parser_re = re.compile('.*?(\\d+(?:\\.\\d+)?) ([^.0-9]+) (?:in|to) ([^.0-9]+)', re.I)
 
-# pylint: disable=missing-function-docstring
-
 def normalize_name(name):
     name = name.lower().replace('-', ' ').rstrip('s')
     name = re.sub(' +', ' ', name)

searx/settings_defaults.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """Implementation of the default settings.
 
 """

searx/unixthreadname.py

@@ -14,7 +14,7 @@ else:
     old_thread_init = threading.Thread.__init__
 
     def new_thread_init(self, *args, **kwargs):
-        # pylint: disable=protected-access, disable=c-extension-no-member, disable=missing-function-docstring
+        # pylint: disable=protected-access, disable=c-extension-no-member
         old_thread_init(self, *args, **kwargs)
         setproctitle.setthreadtitle(self._name)
     threading.Thread.__init__ = new_thread_init

searx/version.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring,missing-module-docstring,missing-class-docstring
+# pylint: disable=,missing-module-docstring,missing-class-docstring
 
 import re
 import os

searx/webapp.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-# pylint: disable=missing-function-docstring
 """WebbApp
 
 """