Merge branch 'gonzobot' into gonzobot+pytest-leaks

Author: linuxdaemon

CONTRIBUTING.md

@@ -22,12 +22,12 @@ The following guidelines for contribution should be followed if you want to subm
 
 * You need a [GitHub account](https://github.com/signup/free)
 * Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) for your issue if there is no one yet.
-  * Try to describe the issue and include steps to reproduce if it's a bug.
+    * Try to describe the issue and include steps to reproduce if it's a bug.
 * If you are able and want to fix this, fork the repository on GitHub
 
 ## Make Changes
 
-* In your forked repository, create a topic branch for your upcoming patch. (optional) 
+* In your forked repository, create a topic branch for your upcoming patch. (optional)
 * Make sure you stick to the coding style that is used already.
 * Make use of the [`.editorconfig`](http://editorconfig.org/) file.
 * Make commits that make sense and describe them properly.
@@ -38,7 +38,7 @@ The following guidelines for contribution should be followed if you want to subm
 
 * Push your changes to a topic branch in your fork of the repository.
 * Open a pull request to the original repository and choose the `python3.4` branch.
-	_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
+    _Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
 * If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
 _Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
 

cloudbot/__init__.py

@@ -12,7 +12,8 @@
 
 __version__ = "1.0.9"
 
-__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader", "logging_dir"]
+__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader",
+           "logging_dir"]
 
 
 def _setup():
@@ -23,6 +24,8 @@ def _setup():
     else:
         logging_config = {}
 
+    file_log = logging_config.get("file_log", False)
+
     global logging_dir
     logging_dir = os.path.join(os.path.abspath(os.path.curdir), "logs")
 
@@ -49,25 +52,29 @@ def _setup():
                 "formatter": "brief",
                 "level": "INFO",
                 "stream": "ext://sys.stdout"
-            },
-            "file": {
-                "class": "logging.handlers.RotatingFileHandler",
-                "maxBytes": 1000000,
-                "backupCount": 5,
-                "formatter": "full",
-                "level": "INFO",
-                "encoding": "utf-8",
-                "filename": os.path.join(logging_dir, "bot.log")
             }
         },
         "loggers": {
             "cloudbot": {
                 "level": "DEBUG",
-                "handlers": ["console", "file"]
+                "handlers": ["console"]
             }
         }
     }
 
+    if file_log:
+        dict_config["handlers"]["file"] = {
+            "class": "logging.handlers.RotatingFileHandler",
+            "maxBytes": 1000000,
+            "backupCount": 5,
+            "formatter": "full",
+            "level": "INFO",
+            "encoding": "utf-8",
+            "filename": os.path.join(logging_dir, "bot.log")
+        }
+
+        dict_config["loggers"]["cloudbot"]["handlers"].append("file")
+
     if logging_config.get("console_debug", False):
         dict_config["handlers"]["console"]["level"] = "DEBUG"
         dict_config["loggers"]["asyncio"] = {
@@ -89,4 +96,5 @@ def _setup():
 
     logging.config.dictConfig(dict_config)
 
+
 _setup()

cloudbot/__main__.py

@@ -41,6 +41,7 @@ def main():
     # define closure for signal handling
     # The handler is called with two arguments: the signal number and the current stack frame
     # These parameters should NOT be removed
+    # noinspection PyUnusedLocal
     def exit_gracefully(signum, frame):
         nonlocal stopped_while_restarting
         if not _bot:

cloudbot/bot.py

@@ -27,6 +27,7 @@
 
     web_installed = True
 except ImportError:
+    WebInterface = None
     web_installed = False
 
 logger = logging.getLogger("cloudbot")
@@ -44,7 +45,7 @@ class CloudBot:
     """
     :type start_time: float
     :type running: bool
-    :type connections: list[Client | IrcClient]
+    :type connections: dict[str, Client]
     :type data_dir: bytes
     :type config: core.config.Config
     :type plugin_manager: PluginManager

cloudbot/hook.py

@@ -318,7 +318,7 @@ def sieve(param=None, **kwargs):
     """
 
     def _sieve_hook(func):
-        assert len(inspect.getfullargspec(func).args) == 3, \
+        assert len(inspect.signature(func).parameters) == 3, \
             "Sieve plugin has incorrect argument count. Needs params: bot, input, plugin"
 
         hook = _get_hook(func, "sieve")

cloudbot/permissions.py

@@ -1,5 +1,5 @@
-from fnmatch import fnmatch
 import logging
+from fnmatch import fnmatch
 
 logger = logging.getLogger("cloudbot")
 

cloudbot/util/colors.py

@@ -39,7 +39,6 @@
 import re
 from random import randint
 
-
 IRC_COLOUR_DICT = {
     "white": "00",
     "black": "01",
@@ -90,7 +89,6 @@
     "clear": "\x0F"
 }
 
-
 COLOR_RE = re.compile(r"\$\(.*?\)", re.I)
 IRC_COLOR_RE = re.compile(r"(\x03(\d+,\d+|\d)|[\x0f\x02\x16\x1f])", re.I)
 

cloudbot/util/filesize.py

@@ -52,50 +52,50 @@
 are listed in the accompanying credits file.
 """
 
-traditional = [
+traditional = (
     (1024 ** 5, 'P'),
     (1024 ** 4, 'T'),
     (1024 ** 3, 'G'),
     (1024 ** 2, 'M'),
     (1024 ** 1, 'K'),
     (1024 ** 0, 'B'),
-]
+)
 
-alternative = [
+alternative = (
     (1024 ** 5, ' PB'),
     (1024 ** 4, ' TB'),
     (1024 ** 3, ' GB'),
     (1024 ** 2, ' MB'),
     (1024 ** 1, ' KB'),
     (1024 ** 0, (' byte', ' bytes')),
-]
+)
 
-verbose = [
+verbose = (
     (1024 ** 5, (' petabyte', ' petabytes')),
     (1024 ** 4, (' terabyte', ' terabytes')),
     (1024 ** 3, (' gigabyte', ' gigabytes')),
     (1024 ** 2, (' megabyte', ' megabytes')),
     (1024 ** 1, (' kilobyte', ' kilobytes')),
     (1024 ** 0, (' byte', ' bytes')),
-]
+)
 
-iec = [
+iec = (
     (1024 ** 5, 'Pi'),
     (1024 ** 4, 'Ti'),
     (1024 ** 3, 'Gi'),
     (1024 ** 2, 'Mi'),
     (1024 ** 1, 'Ki'),
     (1024 ** 0, ''),
-]
+)
 
-si = [
+si = (
     (1000 ** 5, 'P'),
     (1000 ** 4, 'T'),
     (1000 ** 3, 'G'),
     (1000 ** 2, 'M'),
     (1000 ** 1, 'K'),
     (1000 ** 0, 'B'),
-]
+)
 
 # re.I style aliases
 T = traditional
@@ -109,7 +109,7 @@ def size(b, system=traditional):
     """Human-readable file size.
 
     Using the traditional system, where a factor of 1024 is used::
-    
+
     >>> size(10)
     '10B'
     >>> size(100)
@@ -130,7 +130,7 @@ def size(b, system=traditional):
     '976K'
     >>> size(2000000)
     '1M'
-    
+
     Using the SI system, with a factor 1000::
 
     >>> size(10, system=si)
@@ -153,11 +153,14 @@ def size(b, system=traditional):
     '1M'
     >>> size(2000000, system=si)
     '2M'
-    
+
     """
     for factor, suffix in system:
         if b >= factor:
             break
+    else:
+        return
+
     amount = int(b / factor)
     if isinstance(suffix, tuple):
         singular, multiple = suffix

cloudbot/util/formatting.py

@@ -45,14 +45,12 @@
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 import copy
-import re
 import html.entities
-
+import re
 from html.parser import HTMLParser
 
 from cloudbot.util.colors import strip_irc
 
-
 # Constants
 
 IRC_COLOR_RE = re.compile(r"(\x03(\d+,\d+|\d)|[\x0f\x02\x16\x1f])")
@@ -119,6 +117,7 @@ class HTMLTextExtractor(HTMLParser):
     """
     Takes HTML and provides cleaned and stripped text.
     """
+
     def __init__(self):
         HTMLParser.__init__(self)
         self.result = []
@@ -166,6 +165,7 @@ def munge(text, count=0):
                 break
     return text
 
+
 def ireplace(text, old, new, count=None):
     """
     A case-insensitive replace() clone. Return a copy of text with all occurrences of substring
@@ -193,6 +193,7 @@ def translate(match):
 
     return rc.sub(translate, text)
 
+
 # compatibility
 multiword_replace = multi_replace
 
@@ -220,6 +221,7 @@ def truncate(content, length=100, suffix='...'):
     else:
         return content[:length].rsplit(' ', 1)[0] + suffix
 
+
 # compatibility
 truncate_str = truncate
 strip_colors = strip_irc
@@ -230,11 +232,13 @@ def chunk_str(content, length=420):
     Chunks a string into smaller strings of given length. Returns chunks.
     :rtype list
     """
+
     def chunk(c, l):
         while c:
-            out = (c+' ')[:l].rsplit(' ', 1)[0]
+            out = (c + ' ')[:l].rsplit(' ', 1)[0]
             c = c[len(out):].strip()
             yield out
+
     return list(chunk(content, length))
 
 
@@ -245,6 +249,7 @@ def pluralize(num=0, text=''):
     """
     return "{:,} {}{}".format(num, text, "s"[num == 1:])
 
+
 # alternate form
 pluralise = pluralize
 
@@ -261,7 +266,7 @@ def dict_format(args, formats):
             # Check if values can be mapped
             m = f.format(**args)
             # Insert match and number of matched values (max matched values if already in dict)
-            matches[m] = max([matches.get(m, 0), len(re.findall(r'(\{.*?\})', f))])
+            matches[m] = max([matches.get(m, 0), len(re.findall(r'({.*?\})', f))])
         except Exception:
             continue
 

cloudbot/util/http.py

@@ -2,22 +2,21 @@
 
 import http.cookiejar
 import json
-import urllib.request
-import urllib.parse
 import urllib.error
-import urllib.request
 import urllib.error
 import urllib.parse
 import urllib.parse
+import urllib.parse
+import urllib.request
+import urllib.request
+# noinspection PyUnresolvedReferences
+import warnings
 # noinspection PyUnresolvedReferences
 from urllib.parse import quote, quote_plus as _quote_plus
 
 from bs4 import BeautifulSoup
 from lxml import etree, html
 
-# noinspection PyUnresolvedReferences
-from urllib.error import URLError, HTTPError
-
 # security
 parser = etree.XMLParser(resolve_entities=False, no_network=True)
 
@@ -36,13 +35,13 @@
 
 def get(*args, **kwargs):
     if kwargs.get("decode", True):
-        return open(*args, **kwargs).read().decode()
+        return open_request(*args, **kwargs).read().decode()
     else:
-        return open(*args, **kwargs).read()
+        return open_request(*args, **kwargs).read()
 
 
 def get_url(*args, **kwargs):
-    return open(*args, **kwargs).geturl()
+    return open_request(*args, **kwargs).geturl()
 
 
 def get_html(*args, **kwargs):
@@ -62,8 +61,8 @@ def get_json(*args, **kwargs):
     return json.loads(get(*args, **kwargs))
 
 
-def open(url, query_params=None, user_agent=None, post_data=None,
-         referer=None, get_method=None, cookies=False, timeout=None, headers=None, **kwargs):
+def open_request(url, query_params=None, user_agent=None, post_data=None, referer=None, get_method=None, cookies=False,
+                 timeout=None, headers=None, **kwargs):
     if query_params is None:
         query_params = {}
 
@@ -99,6 +98,21 @@ def open(url, query_params=None, user_agent=None, post_data=None,
         return opener.open(request)
 
 
+# noinspection PyShadowingBuiltins
+def open(url, query_params=None, user_agent=None, post_data=None,
+         referer=None, get_method=None, cookies=False, timeout=None, headers=None,
+         **kwargs):  # pylint: disable=locally-disabled, redefined-builtin
+    warnings.warn(
+        "http.open() is deprecated, use http.open_request() instead.",
+        DeprecationWarning
+    )
+
+    return open_request(
+        url, query_params=query_params, user_agent=user_agent, post_data=post_data, referer=referer,
+        get_method=get_method, cookies=cookies, timeout=timeout, headers=headers, **kwargs
+    )
+
+
 def prepare_url(url, queries):
     if queries:
         scheme, netloc, path, query, fragment = urllib.parse.urlsplit(url)