Merge pull request #1 from snoonetIRC/gonzobot

Just syncin' with the original

Author: ElonSatoshi

.travis.yml

@@ -1,28 +1,30 @@
 language: python
 python:
   - "3.4"
+  - "3.5"
+  - "3.6"
+  - "3.7-dev"
+  - "nightly"
+  - "pypy3"
+
+cache: pip
 
 install:
   - "sudo apt-get update -q"
-  - "sudo apt-get install -y python3-lxml"
+  - "sudo apt-get install -y python3-lxml libenchant-dev"
   - "pip install -r ./travis/requirements.txt"
 
 script:
-  - "python ./travis/test_json.py"
-  - "py.test . -v --cov . --cov-report term-missing"
+  - "py.test . -R : -v --cov . --cov-report term-missing --pylint --pylint-rcfile=travis/pylintrc"
 
 after_success:
   - "coveralls"
-  
+
 env:
   - PYTHONPATH=.
+  - PYTHONPATH=. PYTHONASYNCIODEBUG=1
 
-notifications:
-  irc:
-    channels:
-      - "irc.esper.net#cloudbot"
-    template:
-      - "%{repository}#%{build_number} (%{branch} - %{commit}) %{author}: %{message} - %{build_url}"
-  on_failure: always
-  on_success: change
-  skip_join: true
+matrix:
+  allow_failures:
+    - python: "3.7-dev"
+    - python: "nightly"

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/)._
 

README.md

@@ -5,10 +5,10 @@ CloudBot is a simple, fast, expandable open-source Python IRC Bot!
 ## Getting CloudBot
 
 There are currently four different branches of this repository, each with a different level of stability:
- - **gonzobot** *(stable)*: This branch contains everything in the **master** branch plus additional plugins added for Snoonet IRC.
+ - **gonzobot** *(stable)*: This branch contains everything in the **master** branch plus additional plugins added for Snoonet IRC. This branch is the currently maintained branch which will also contain many fixes for various bugs from the master branch.
  - **gonzobot-dev** *(unstable)*: This branch is based off of the **gonzobot** branch and includes new plugins that are not fully tested.
- - **master** *(stable)*: This branch contains stable, tested code. This is the branch you should be using if you just want to run your own CloudBot! This is also the branch that EDI on Snoonet uses.
- - **python3.4** *(unstable)*: This branch is where where test and develop new features. If you would like to help develop CloudBot, you can use this branch.
+ - **master** *(stable (old))*: This branch contains stable, tested code. This branch is based directly on the upstream master branch and is not currently maintained.
+ - **python3.4** *(unstable (old))*: This is the outdated testing branch from the upstream repo.
 
 New releases will be pushed from **python3.4** to **master** whenever we have a stable version to release. These changes will be merged into **gonzobot** then deployed. This should happen on a fairly regular basis, so you'll never be too far behind the latest improvements.
 

cloudbot/__init__.py

@@ -12,7 +12,8 @@
 
 __version__ = "1.0.9"
 
-__all__ = ["util", "bot", "connection", "config", "permissions", "plugin", "event", "hook", "log_dir"]
+__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader",
+           "logging_dir"]
 
 
 def _setup():
@@ -23,6 +24,9 @@ def _setup():
     else:
         logging_config = {}
 
+    file_log = logging_config.get("file_log", False)
+    console_level = "INFO" if logging_config.get("console_log_info", True) else "WARNING"
+
     global logging_dir
     logging_dir = os.path.join(os.path.abspath(os.path.curdir), "logs")
 
@@ -47,35 +51,41 @@ def _setup():
             "console": {
                 "class": "logging.StreamHandler",
                 "formatter": "brief",
-                "level": "INFO",
+                "level": console_level,
                 "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"] = {
             "level": "DEBUG",
-            "handlers": ["console", "file"]
+            "handlers": ["console"]
         }
+        if file_log:
+            dict_config["loggers"]["asyncio"]["handlers"].append("file")
 
-    if logging_config.get("file_debug", True):
+    if logging_config.get("file_debug", False):
         dict_config["handlers"]["debug_file"] = {
             "class": "logging.handlers.RotatingFileHandler",
             "maxBytes": 1000000,
@@ -89,4 +99,5 @@ def _setup():
 
     logging.config.dictConfig(dict_config)
 
+
 _setup()

cloudbot/__main__.py

@@ -1,22 +1,25 @@
-import asyncio
 import logging
 import os
+import signal
 import sys
 import time
-import signal
+
+from pathlib import Path
 
 # store the original working directory, for use when restarting
-original_wd = os.path.realpath(".")
+original_wd = Path().resolve()
 
 # set up environment - we need to make sure we are in the install directory
-path0 = os.path.realpath(sys.path[0] or '.')
-install_dir = os.path.realpath(os.path.dirname(__file__))
+path0 = Path(sys.path[0] or '.').resolve()
+install_dir = Path(__file__).resolve().parent
 if path0 == install_dir:
-    sys.path[0] = path0 = os.path.dirname(install_dir)
-os.chdir(path0)
+    sys.path[0] = path0 = install_dir.parent
+
+os.chdir(str(install_dir.parent))
 
 # import bot
 from cloudbot.bot import CloudBot
+from cloudbot.util import async_util
 
 
 def main():
@@ -40,16 +43,16 @@ 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:
             # we are currently in the process of restarting
             stopped_while_restarting = True
         else:
-            _bot.loop.call_soon_threadsafe(
-                lambda: asyncio.async(_bot.stop("Killed (Received SIGINT {})".format(signum)), loop=_bot.loop))
+            async_util.run_coroutine_threadsafe(_bot.stop("Killed (Received SIGINT {})".format(signum)), _bot.loop)
 
-        logger.warn("Bot received Signal Interrupt ({})".format(signum))
+        logger.warning("Bot received Signal Interrupt ({})".format(signum))
 
         # restore the original handler so if they do it again it triggers
         signal.signal(signal.SIGINT, original_sigint)
@@ -71,7 +74,7 @@ def exit_gracefully(signum, frame):
             logger.info("Received stop signal, no longer restarting")
         else:
             # actually restart
-            os.chdir(original_wd)
+            os.chdir(str(original_wd))
             args = sys.argv
             logger.info("Restarting Bot")
             logger.debug("Restart arguments: {}".format(args))