Bump version to 3.0.0rc3.post1

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>

.github/CODEOWNERS

@@ -24,6 +24,8 @@ redbot/core/utils/mod.py                 @palmtree5
 redbot/core/utils/data_converter.py      @mikeshardmind
 redbot/core/utils/antispam.py            @mikeshardmind
 redbot/core/utils/tunnel.py              @mikeshardmind
+redbot/core/utils/caching.py             @mikeshardmind
+redbot/core/utils/common_filters.py      @mikeshardmind
 
 # Cogs
 redbot/cogs/admin/*                 @tekulvw
@@ -43,6 +45,8 @@ redbot/cogs/streams/*               @Twentysix26 @palmtree5
 redbot/cogs/trivia/*                @Tobotimus
 redbot/cogs/dataconverter/*         @mikeshardmind
 redbot/cogs/reports/*               @mikeshardmind
+redbot/cogs/permissions/*           @mikeshardmind
+redbot/cogs/warnings/*              @palmtree5
 
 # Docs
 docs/*                              @tekulvw @palmtree5

.github/CONTRIBUTING.md

@@ -1,23 +1,43 @@
-# Introduction
-### Welcome!
-First off, thank you for contributing to the further development of Red. We're always looking for new ways to improve our project and we appreciate any help you can give us.
+# Contents
+* [1. Introduction](#1-introduction)
+  * [1.1 Why do these guidelines exist?](#11-why-do-these-guidelines-exist)
+  * [1.2 What kinds of contributions are we looking for?](#12-what-kinds-of-contributions-are-we-looking-for)
+* [2. Ground Rules](#2-ground-rules)
+* [3. Your First Contribution](#3-your-first-contribution)
+* [4. Getting Started](#4-getting-started)
+  * [4.1 Setting up your development environment](#41-setting-up-your-development-environment)
+  * [4.2 Testing](#42-testing)
+  * [4.3 Style](#43-style)
+  * [4.4 Make](#44-make)
+  * [4.5 Keeping your dependencies up to date](#45-keeping-your-dependencies-up-to-date)
+  * [4.6 To contribute changes](#46-to-contribute-changes)
+  * [4.7 How To Report A Bug](#47-how-to-report-a-bug)
+  * [4.8 How To Suggest A Feature Or Enhancement](#48-how-to-suggest-a-feature-or-enhancement)
+* [5. Code Review Process](#5-code-review-process)
+  * [5.1 Issues](#51-issues)
+  * [5.2 Pull Requests](#52-pull-requests)
+  * [5.3 Differences between "new features" and "improvements"](#53-differences-between-new-features-and-improvements)
+* [6. Community](#6-community)
 
-### Why do these guidelines exist?
+# 1. Introduction
+**Welcome!** First off, thank you for contributing to the further development of Red. We're always looking for new ways to improve our project and we appreciate any help you can give us.
+
+### 1.1 Why do these guidelines exist?
 Red is an open source project. This means that each and every one of the developers and contributors who have helped make Red what it is today have done so by volunteering their time and effort. It takes a lot of time to coordinate and organize issues and new features and to review and test pull requests. By following these guidelines you will help the developers streamline the contribution process and save them time. In doing so we hope to get back to each and every issue and pull request in a timely manner.
 
-### What kinds of contributions are we looking for?
+### 1.2 What kinds of contributions are we looking for?
 We love receiving contributions from our community. Any assistance you can provide with regards to bug fixes, feature enhancements, and documentation is more than welcome.
 
-# Ground Rules
+# 2. Ground Rules
 We've made a point to use [ZenHub](https://www.zenhub.com/) (a plugin for GitHub) as our main source of collaboration and coordination. Your experience contributing to Red will be greatly improved if you go get that plugin.
 1. Ensure cross compatibility for Windows, Mac OS and Linux.
-2. Ensure all Python features used in contributions exist and work in Python 3.5 and above.
+2. Ensure all Python features used in contributions exist and work in Python 3.6 and above.
 3. Create new tests for code you add or bugs you fix. It helps us help you by making sure we don't accidentally break anything :grinning:
 4. Create any issues for new features you'd like to implement and explain why this feature is useful to everyone and not just you personally.
 5. Don't add new cogs unless specifically given approval in an issue discussing said cog idea.
 6. Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
 
-# Your First Contribution
+# 3. Your First Contribution
 Unsure of how to get started contributing to Red? Please take a look at the Issues section of this repo and sort by the following labels:
 
 * beginner - issues that can normally be fixed in just a few lines of code and maybe a test or two.
@@ -27,35 +47,87 @@ Unsure of how to get started contributing to Red? Please take a look at the Issu
 
 At this point you're ready to start making changes. Feel free to ask for help; everyone was a beginner at some point!
 
-# Getting Started
-### Testing
-We've recently started adding unit-testing into Red. All current tests can be found in the `tests/` directory at the root level of the repository. You will need `py.test` installed in order to run them (which is already in `requirement.txt`). Tests can be run by simply calling `pytest` once you've `cd`'d into the Red repository folder.
+# 4. Getting Started
 
-### To contribute changes
-1. Create your own fork of the Red repository.
-2. Make the changes in your own fork.
+Red's repository is configured to follow a particular development workflow, using various reputable tools. We kindly ask that you stick to this workflow when contributing to Red, by following the guides below. This will help you to easily produce quality code, identify errors early, and streamline the code review process.
+
+### 4.1 Setting up your development environment
+The following requirements must be installed prior to setting up:
+ - Python 3.6.2 or greater (3.6.6 or greater on Windows)
+ - git
+ - pip
+ - pipenv
+ 
+If you're not on Windows, you can optionally install [pyenv](https://github.com/pyenv/pyenv), which will help you run tests for different python versions.
+
+1. Fork and clone the repository to a directory on your local machine.
+2. Open a command line in that directory and execute the following commands:
+    ```bash
+    pip install pipenv
+    pipenv install --dev
+    ```
+    Red, its dependencies, and all required development tools, are now installed to a virtual environment. Red is installed in editable mode, meaning that edits you make to the source code in the repository will be reflected when you run Red.
+3. Activate the new virtual environment with the command:
+    ```bash
+    pipenv shell
+    ```
+    From here onwards, we will assume you are executing commands from within this shell. Each time you open a new command line, you should execute this command first.
+ 
+Note: If you haven't used `pipenv` before but are comfortable with virtualenvs, just run `pip install pipenv` in the virtualenv you're already using and invoke the command above from the cloned Red repo. It will do the correct thing.
+
+### 4.2 Testing
+We've recently started using [tox](https://github.com/tox-dev/tox) to run all of our tests. It's extremely simple to use, and if you followed the previous section correctly, it is already installed to your virtual environment.
+
+Currently, tox does the following, creating its own virtual environments for each stage:
+- Runs all of our unit tests with [pytest](https://github.com/pytest-dev/pytest) on python 3.6 and 3.7 (test environments `py36` and `py37`)
+- Ensures documentation builds without warnings, and all hyperlinks have a valid destination (test environment `docs`)
+- Ensures that the code meets our style guide with [black](https://github.com/ambv/black) (test environment `style`)
+
+To run all of these tests, just run the command `tox` in the project directory.
+
+To run a subset of these tests, use the command `tox -e <env>`, where `<env>` is the test environment you want tox to run. The test environments are noted in the dot points above.
+
+Your PR will not be merged until all of these tests pass.
+
+### 4.3 Style
+Our style checker of choice, [black](https://github.com/ambv/black), actually happens to be an auto-formatter. The checking functionality simply detects whether or not it would try to reformat something in your code, should you run the formatter on it. For this reason, we recommend using this tool as a formatter, regardless of any disagreements you might have with the style it enforces.
+
+Use the command `black --help` to see how to use this tool. The full style guide is explained in detail on [black's GitHub repository](https://github.com/ambv/black). **There is one exception to this**, however, which is that we set the line length to 99, instead of black's default 88. When using `black` on the command line, simply use it like so: `black -l 99 -N <src>`.
+
+### 4.4 Make
+You may have noticed we have a `Makefile` and a `make.bat` in the top-level directory. For now, you can do two things with them:
+1. `make reformat`: Reformat all python files in the project with Black
+2. `make stylecheck`: Check if any `.py` files in the project need reformatting
+
+### 4.5 Keeping your dependencies up to date
+Whenever you pull from upstream (V3/develop on the main repository) and you notice the file `Pipfile.lock` has been changed, it usually means one of the package dependencies have been updated, added or removed. To make sure you're testing and formatting with the most up-to-date versions of our dependencies, run `pipenv install --dev` again.
+
+### 4.6 To contribute changes
+
+1. Create a new branch on your fork
+2. Make the changes
 3. If you like the changes and think the main Red project could use it:
-    * Ensure your code follows (generally) the PEP8 Python style guide
+    * Run tests with `tox` to ensure your code is up to scratch
     * Create a Pull Request on GitHub with your changes
 
-### How To Report A Bug
+### 4.7 How To Report A Bug
 Please see our **ISSUES.MD** for more information.
 
-### How To Suggest A Feature Or Enhancement
+### 4.8 How To Suggest A Feature Or Enhancement
 The goal of Red is to be as useful to as many people as possible, this means that all features must be useful to anyone and any server that uses Red.
 
 If you find yourself wanting a feature that Red does not already have, you're probably not alone. There's bound to be a great number of users out there needing the same thing and a lot of the features that Red has today have been added because of the needs of our users. Open an issue on our issues list and describe the feature you would like to see, how you would use it, how it should work, and why it would be useful to the Red community as a whole.
 
-# Code Review Process
+# 5. Code Review Process
 
 We have a core team working tirelessly to implement new features and fix bugs for the Red community. This core team looks at and evaluates new issues and PRs on a daily basis.
 
 The decisions we make are based on a simple majority of that team or by decree of the project owner.
 
-### Issues
+### 5.1 Issues
 Any new issues will be looked at and evaluated for validity of a bug or for the usefulness of a suggested feature. If we have questions about your issue we will get back as soon as we can (usually in a day or two) and will try to make a decision within a week.
 
-### Pull Requests
+### 5.2 Pull Requests
 Pull requests are evaluated by their quality and how effectively they solve their corresponding issue. The process for reviewing pull requests is as follows:
 
 1. A pull request is submitted
@@ -66,10 +138,10 @@ Pull requests are evaluated by their quality and how effectively they solve thei
 4. If any feedback is given we expect a response within 1 week or we may decide to close the PR.
 5. If your pull request is not vetoed and no core member requests changes then it will be approved and merged into the project.
 
-### Differences between "new features" and "improvements"
+### 5.3 Differences between "new features" and "improvements"
 The difference between a new feature and improvement can be quite fuzzy and the project owner reserves all rights to decide under which category your PR falls.
 
 At a very basic level a PR is a new feature if it changes the intended way any part of the Red project currently works or if it modifies the user experience (UX) in any significant way. Otherwise, it is likely to be considered an improvement.
 
-# Community
+# 6. Community
 You can chat with the core team and other community members about issues or pull requests in the #coding channel of the Red support server located [here](https://discord.gg/red).

.github/ISSUE_TEMPLATE/command_bug.md

@@ -0,0 +1,25 @@
+# Command bugs
+
+<!-- 
+Did you find a bug with a command? Fill out the following:
+-->
+
+#### Command name
+
+<!-- Replace this line with the name of the command -->
+
+#### What cog is this command from?
+
+<!-- Replace this line with the name of the cog -->
+
+#### What were you expecting to happen?
+
+<!-- Replace this line with a description of what you were expecting to happen -->
+
+#### What actually happened?
+
+<!-- Replace this line with a description of what actually happened. Include any error messages -->
+
+#### How can we reproduce this issue?
+
+<!-- Replace with numbered steps to reproduce the issue -->

.github/ISSUE_TEMPLATE/feature_req.md

@@ -0,0 +1,35 @@
+# Feature request
+
+<!-- This template is for feature requests. Please fill out the following: -->
+
+
+#### Select the type of feature you are requesting:
+
+<!-- To check a box, replace the space between the [] with a x -->
+
+- [ ] Cog
+- [ ] Command
+- [ ] API functionality
+
+#### Describe your requested feature
+
+<!--
+Feel free to describe in as much detail as you wish.
+
+If you are requesting a cog to be included in core: 
+    - Describe the functionality in as much detail as possible
+    - Include the command structure, if possible
+    - Please note that unless it's something that should be core functionality,
+      we reserve the right to reject your suggestion and point you to our cog 
+      board to request it for a third-party cog
+      
+If you are requesting a command:
+    - Include what cog it should be in and a name for the command
+    - Describe the intended functionality for the command
+    - Note any restrictions on who can use the command or where it can be used
+
+If you are requesting API functionality:
+    - Describe what it should do
+    - Note whether it is to extend existing functionality or introduce new functionality
+   
+-->

.github/ISSUE_TEMPLATE/other_bug.md

@@ -0,0 +1,21 @@
+# Other bugs
+
+<!-- 
+Did you find a bug with something other than a command? Fill out the following:
+-->
+
+#### What were you trying to do?
+
+<!-- Replace this line with a description of what you were trying to do -->
+
+#### What were you expecting to happen?
+
+<!-- Replace this line with a description of what you were expecting to happen -->
+
+#### What actually happened?
+
+<!-- Replace this line with a description of what actually happened. Include any error messages -->
+
+#### How can we reproduce this issue?
+
+<!-- Replace with numbered steps to reproduce the issue -->

.github/PULL_REQUEST_TEMPLATE/bugfix.md

@@ -0,0 +1,14 @@
+# Bugfix request
+
+<!--
+To be used for pull requests that fix a bug
+-->
+
+#### Describe the bug being fixed
+
+<!-- 
+If an issue exists for the bug, mention 
+that this PR fixes that issue
+-->
+
+#### Anything we need to know about this fix?

.github/PULL_REQUEST_TEMPLATE/enhancement.md

@@ -0,0 +1,20 @@
+# Enhancement request
+
+<!--
+To be used for PRs which enhance existing features
+-->
+
+#### Describe the enhancement
+
+<!--
+Describe what your changes do.
+If adding commands, describe any restrictions on their usage.
+  - For example, who can use the command? Where can it be used?
+-->
+
+#### Does this enhancement break existing functionality?
+
+<!-- To check a box, replace the space between the [] with a x -->
+
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE/new_feature.md

@@ -0,0 +1,21 @@
+# New feature addition
+
+<!--
+To be used for PRs which add a new feature
+Examples of this include new APIs, new core cogs, etc.
+-->
+
+#### What type of feature is this?
+
+<!-- To check a box, replace the space between the [] with a x -->
+
+- [ ] New core cog
+- [ ] New API
+- [ ] Other
+
+#### Describe the feature
+
+<!--
+If you are adding a cog, describe its commands in detail (functionality, usage restrictions, etc).
+If the new feature introduces new requirements, please try to explain why they are necessary.
+-->

.github/PULL_REQUEST_TEMPLATE/release.md

@@ -0,0 +1,16 @@
+# New release
+
+<!--
+To be used by collaborators for doing releases.
+Most contributors will not need to use this.
+-->
+
+#### Version
+
+
+
+#### Has a draft release been created for this?
+
+- [ ] Yes
+- [ ] No
+

.github/PULL_REQUEST_TEMPLATE/translations.md

@@ -0,0 +1,5 @@
+# Translations update
+
+<!--
+Used for PRs updating translations from Crowdin
+-->

.gitignore

@@ -1,40 +1,16 @@
-# Trivia list repo injection
-redbot/trivia/
-
 *.json
 *.exe
 *.dll
+*.pot
 .data
+!/tests/cogs/dataconverter/data/**/*.json
 
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# CMake
-cmake-build-debug/
-
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
-## File-based project format:
+.idea/
 *.iws
 
 ## Plugin-specific files:

.readthedocs.yml

@@ -4,11 +4,11 @@ formats:
 build:
   image: latest
 
-requirements_file: docs/requirements.txt
+requirements_file: dependency_links.txt
 
 python:
   version: 3.6
   pip_install: true
   extra_requirements:
     - docs
-    - mongo
+    - mongo

.travis.yml

@@ -1,27 +1,40 @@
-dist: trusty
+dist: xenial
 language: python
 cache: pip
 notifications:
   email: false
+sudo: true
 
 python:
-- 3.5.3
-- 3.6.1
+- 3.6.6
+- 3.7
+env:
+  global:
+    PIPENV_IGNORE_VIRTUALENVS=1
+  matrix:
+    TOXENV=py
+
 install:
-- echo "git+https://github.com/Rapptz/discord.py.git@rewrite#egg=discord.py[voice]" >> requirements.txt
-- pip install -r requirements.txt
-- pip install .[test]
+- pip install --upgrade pip tox
+
 script:
-- python -m compileall ./redbot/cogs
-- python -m pytest
+- tox
 
 jobs:
   include:
+
+    - python: 3.6.6
+      env: TOXENV=docs
+    - python: 3.6.6
+      env: TOXENV=style
+
+    # These jobs only occur on tag creation if the prior ones succeed
     - stage: PyPi Deployment
       if: tag IS present
-      python: 3.5.3
+      python: 3.6.6
       env:
         - DEPLOYING=true
+        - TOXENV=py36
       deploy:
         - provider: pypi
           user: Red-DiscordBot
@@ -30,25 +43,25 @@ jobs:
           skip_cleanup: true
           on:
             repo: Cog-Creators/Red-DiscordBot
-            branch: V3/develop
-            python: 3.5.3
+            python: 3.6.6
             tags: true
     - stage: Crowdin Deployment
       if: tag IS present
-      python: 3.5.3
+      python: 3.6.6
       env:
         - DEPLOYING=true
-      before_deployment:
+        - TOXENV=py36
+      before_deploy:
       - curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
       - echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
       - sudo apt-get update -qq
       - sudo apt-get install -y crowdin
+      - pip install redgettext==2.2
       deploy:
       - provider: script
-        script: python3 ./generate_strings.py
+        script: make gettext
         skip_cleanup: true
         on:
           repo: Cog-Creators/Red-DiscordBot
-          branch: V3/develop
-          python: 3.5.3
+          python: 3.6.6
           tags: true

MANIFEST.in

@@ -1,5 +1,3 @@
-include README.rst
+include README.md
 include LICENSE
-include requirements.txt
-include discord/bin/*.dll
-include redbot/cogs/audio/application.yml
+include dependency_links.txt

Makefile

@@ -0,0 +1,7 @@
+reformat:
+	black -l 99 -N `git ls-files "*.py"`
+stylecheck:
+	black --check -l 99 -N `git ls-files "*.py"`
+gettext:
+	redgettext --command-docstrings --verbose --recursive redbot --exclude-files "redbot/pytest/**/*"
+	crowdin upload

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+"discord.py" = { git = 'git://github.com/Rapptz/discord.py', ref = 'rewrite', editable = true }
+"e1839a8" = { path = ".", editable = true, extras = ['mongo', 'voice'] }
+
+[dev-packages]
+tox = "*"
+"e1839a9" = { path = ".", editable = true, extras = ['docs', 'test', 'style'] }

Pipfile.lock

@@ -0,0 +1,781 @@
+{
+    "_meta": {
+        "hash": {
+            "sha256": "edd35f353e1fadc20094e40de6627db77fd61303da01794214c44d748e99838b"
+        },
+        "pipfile-spec": 6,
+        "requires": {},
+        "sources": [
+            {
+                "name": "pypi",
+                "url": "https://pypi.org/simple",
+                "verify_ssl": true
+            }
+        ]
+    },
+    "default": {
+        "aiohttp": {
+            "hashes": [
+                "sha256:0419705a36b43c0ac6f15469f9c2a08cad5c939d78bd12a5c23ea167c8253b2b",
+                "sha256:1812fc4bc6ac1bde007daa05d2d0f61199324e0cc893b11523e646595047ca08",
+                "sha256:2214b5c0153f45256d5d52d1e0cafe53f9905ed035a142191727a5fb620c03dd",
+                "sha256:275909137f0c92c61ba6bb1af856a522d5546f1de8ea01e4e726321c697754ac",
+                "sha256:3983611922b561868428ea1e7269e757803713f55b53502423decc509fef1650",
+                "sha256:51afec6ffa50a9da4cdef188971a802beb1ca8e8edb40fa429e5e529db3475fa",
+                "sha256:589f2ec8a101a0f340453ee6945bdfea8e1cd84c8d88e5be08716c34c0799d95",
+                "sha256:789820ddc65e1f5e71516adaca2e9022498fa5a837c79ba9c692a9f8f916c330",
+                "sha256:7a968a0bdaaf9abacc260911775611c9a602214a23aeb846f2eb2eeaa350c4dc",
+                "sha256:7aeefbed253f59ea39e70c5848de42ed85cb941165357fc7e87ab5d8f1f9592b",
+                "sha256:7b2eb55c66512405103485bd7d285a839d53e7fdc261ab20e5bcc51d7aaff5de",
+                "sha256:87bc95d3d333bb689c8d755b4a9d7095a2356108002149523dfc8e607d5d32a4",
+                "sha256:9d80e40db208e29168d3723d1440ecbb06054d349c5ece6a2c5a611490830dd7",
+                "sha256:a1b442195c2a77d33e4dbee67c9877ccbdd3a1f686f91eb479a9577ed8cc326b",
+                "sha256:ab3d769413b322d6092f169f316f7b21cd261a7589f7e31db779d5731b0480d8",
+                "sha256:b066d3dec5d0f5aee6e34e5765095dc3d6d78ef9839640141a2b20816a0642bd",
+                "sha256:b24e7845ae8de3e388ef4bcfcf7f96b05f52c8e633b33cf8003a6b1d726fc7c2",
+                "sha256:c59a953c3f8524a7c86eaeaef5bf702555be12f5668f6384149fe4bb75c52698",
+                "sha256:cf2cc6c2c10d242790412bea7ccf73726a9a44b4c4b073d2699ef3b48971fd95",
+                "sha256:e0c9c8d4150ae904f308ff27b35446990d2b1dfc944702a21925937e937394c6",
+                "sha256:f1839db4c2b08a9c8f9788112644f8a8557e8e0ecc77b07091afabb941dc55d0",
+                "sha256:f3df52362be39908f9c028a65490fae0475e4898b43a03d8aa29d1e765b45e07"
+            ],
+            "version": "==3.4.4"
+        },
+        "aiohttp-json-rpc": {
+            "hashes": [
+                "sha256:00d72f40edfc7271578d545a8c47874c0e23cc5d3201ed8128481f6a4af47e32",
+                "sha256:02d83b6998f8a0b7e59b46f0cb8a96b475bbf82600b1f9527df47135353f1ca8"
+            ],
+            "version": "==0.11.2"
+        },
+        "appdirs": {
+            "hashes": [
+                "sha256:9e5896d1372858f8dd3344faf4e5014d21849c756c8d5701f78f8a103b372d92",
+                "sha256:d8b24664561d0d34ddfaec54636d502d7cea6e29c3eaf68f3df6180863e2166e"
+            ],
+            "version": "==1.4.3"
+        },
+        "async-timeout": {
+            "hashes": [
+                "sha256:0c3c816a028d47f659d6ff5c745cb2acf1f966da1fe5c19c77a70282b25f4c5f",
+                "sha256:4291ca197d287d274d0b6cb5d6f8f8f82d434ed288f962539ff18cc9012f9ea3"
+            ],
+            "version": "==3.0.1"
+        },
+        "attrs": {
+            "hashes": [
+                "sha256:10cbf6e27dbce8c30807caf056c8eb50917e0eaafe86347671b57254006c3e69",
+                "sha256:ca4be454458f9dec299268d472aaa5a11f67a4ff70093396e1ceae9c76cf4bbb"
+            ],
+            "version": "==18.2.0"
+        },
+        "chardet": {
+            "hashes": [
+                "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae",
+                "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"
+            ],
+            "version": "==3.0.4"
+        },
+        "colorama": {
+            "hashes": [
+                "sha256:05eed71e2e327246ad6b38c540c4a3117230b19679b875190486ddd2d721422d",
+                "sha256:f8ac84de7840f5b9c4e3347b3c1eaa50f7e49c2b07596221daec5edaabbd7c48"
+            ],
+            "version": "==0.4.1"
+        },
+        "discord-py": {
+            "editable": true,
+            "git": "git://github.com/Rapptz/discord.py",
+            "ref": "7f4c57dd5ad20b7fa10aea485f674a4bc24b9547"
+        },
+        "discord.py": {
+            "editable": true,
+            "git": "git://github.com/Rapptz/discord.py",
+            "ref": "rewrite"
+        },
+        "distro": {
+            "hashes": [
+                "sha256:224041cef9600e72d19ae41ba006e71c05c4dc802516da715d7fda55ba3d8742",
+                "sha256:6ec8e539cf412830e5ccf521aecf879f2c7fcf60ce446e33cd16eef1ed8a0158"
+            ],
+            "version": "==1.3.0"
+        },
+        "dnspython": {
+            "hashes": [
+                "sha256:36c5e8e38d4369a08b6780b7f27d790a292b2b08eea01607865bf0936c558e01",
+                "sha256:f69c21288a962f4da86e56c4905b49d11aba7938d3d740e80d9e366ee4f1632d"
+            ],
+            "version": "==1.16.0"
+        },
+        "e1839a8": {
+            "editable": true,
+            "extras": [
+                "mongo",
+                "voice"
+            ],
+            "path": "."
+        },
+        "fuzzywuzzy": {
+            "hashes": [
+                "sha256:5ac7c0b3f4658d2743aa17da53a55598144edbc5bee3c6863840636e6926f254",
+                "sha256:6f49de47db00e1c71d40ad16da42284ac357936fa9b66bea1df63fed07122d62"
+            ],
+            "version": "==0.17.0"
+        },
+        "idna": {
+            "hashes": [
+                "sha256:c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407",
+                "sha256:ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c"
+            ],
+            "version": "==2.8"
+        },
+        "idna-ssl": {
+            "hashes": [
+                "sha256:a933e3bb13da54383f9e8f35dc4f9cb9eb9b3b78c6b36f311254d6d0d92c6c7c"
+            ],
+            "version": "==1.1.0"
+        },
+        "motor": {
+            "hashes": [
+                "sha256:462fbb824f4289481c158227a2579d6adaf1ec7c70cf7ebe60ed6ceb321e5869",
+                "sha256:d035c09ab422bc50bf3efb134f7405694cae76268545bd21e14fb22e2638f84e"
+            ],
+            "version": "==2.0.0"
+        },
+        "multidict": {
+            "hashes": [
+                "sha256:024b8129695a952ebd93373e45b5d341dbb87c17ce49637b34000093f243dd4f",
+                "sha256:041e9442b11409be5e4fc8b6a97e4bcead758ab1e11768d1e69160bdde18acc3",
+                "sha256:045b4dd0e5f6121e6f314d81759abd2c257db4634260abcfe0d3f7083c4908ef",
+                "sha256:047c0a04e382ef8bd74b0de01407e8d8632d7d1b4db6f2561106af812a68741b",
+                "sha256:068167c2d7bbeebd359665ac4fff756be5ffac9cda02375b5c5a7c4777038e73",
+                "sha256:148ff60e0fffa2f5fad2eb25aae7bef23d8f3b8bdaf947a65cdbe84a978092bc",
+                "sha256:1d1c77013a259971a72ddaa83b9f42c80a93ff12df6a4723be99d858fa30bee3",
+                "sha256:1d48bc124a6b7a55006d97917f695effa9725d05abe8ee78fd60d6588b8344cd",
+                "sha256:31dfa2fc323097f8ad7acd41aa38d7c614dd1960ac6681745b6da124093dc351",
+                "sha256:34f82db7f80c49f38b032c5abb605c458bac997a6c3142e0d6c130be6fb2b941",
+                "sha256:3d5dd8e5998fb4ace04789d1d008e2bb532de501218519d70bb672c4c5a2fc5d",
+                "sha256:4a6ae52bd3ee41ee0f3acf4c60ceb3f44e0e3bc52ab7da1c2b2aa6703363a3d1",
+                "sha256:4b02a3b2a2f01d0490dd39321c74273fed0568568ea0e7ea23e02bd1fb10a10b",
+                "sha256:4b843f8e1dd6a3195679d9838eb4670222e8b8d01bc36c9894d6c3538316fa0a",
+                "sha256:5de53a28f40ef3c4fd57aeab6b590c2c663de87a5af76136ced519923d3efbb3",
+                "sha256:61b2b33ede821b94fa99ce0b09c9ece049c7067a33b279f343adfe35108a4ea7",
+                "sha256:6a3a9b0f45fd75dc05d8e93dc21b18fc1670135ec9544d1ad4acbcf6b86781d0",
+                "sha256:76ad8e4c69dadbb31bad17c16baee61c0d1a4a73bed2590b741b2e1a46d3edd0",
+                "sha256:7ba19b777dc00194d1b473180d4ca89a054dd18de27d0ee2e42a103ec9b7d014",
+                "sha256:7c1b7eab7a49aa96f3db1f716f0113a8a2e93c7375dd3d5d21c4941f1405c9c5",
+                "sha256:7fc0eee3046041387cbace9314926aa48b681202f8897f8bff3809967a049036",
+                "sha256:8ccd1c5fff1aa1427100ce188557fc31f1e0a383ad8ec42c559aabd4ff08802d",
+                "sha256:8e08dd76de80539d613654915a2f5196dbccc67448df291e69a88712ea21e24a",
+                "sha256:c18498c50c59263841862ea0501da9f2b3659c00db54abfbf823a80787fde8ce",
+                "sha256:c49db89d602c24928e68c0d510f4fcf8989d77defd01c973d6cbe27e684833b1",
+                "sha256:ce20044d0317649ddbb4e54dab3c1bcc7483c78c27d3f58ab3d0c7e6bc60d26a",
+                "sha256:d1071414dd06ca2eafa90c85a079169bfeb0e5f57fd0b45d44c092546fcd6fd9",
+                "sha256:d3be11ac43ab1a3e979dac80843b42226d5d3cccd3986f2e03152720a4297cd7",
+                "sha256:db603a1c235d110c860d5f39988ebc8218ee028f07a7cbc056ba6424372ca31b"
+            ],
+            "version": "==4.5.2"
+        },
+        "pymongo": {
+            "hashes": [
+                "sha256:025f94fc1e1364f00e50badc88c47f98af20012f23317234e51a11333ef986e6",
+                "sha256:02aa7fb282606331aefbc0586e2cf540e9dbe5e343493295e7f390936ad2738e",
+                "sha256:057210e831573e932702cf332012ed39da78edf0f02d24a3f0b213264a87a397",
+                "sha256:0d946b79c56187fe139276d4c8ed612a27a616966c8b9779d6b79e2053587c8b",
+                "sha256:104790893b928d310aae8a955e0bdbaa442fb0ac0a33d1bbb0741c791a407778",
+                "sha256:15527ef218d95a8717486106553b0d54ff2641e795b65668754e17ab9ca6e381",
+                "sha256:1826527a0b032f6e20e7ac7f72d7c26dd476a5e5aa82c04aa1c7088a59fded7d",
+                "sha256:22e3aa4ce1c3eebc7f70f9ca7fd4ce1ea33e8bdb7b61996806cd312f08f84a3a",
+                "sha256:244e1101e9a48615b9a16cbd194f73c115fdfefc96894803158608115f703b26",
+                "sha256:24b8c04fdb633a84829d03909752c385faef249c06114cc8d8e1700b95aae5c8",
+                "sha256:2c276696350785d3104412cbe3ac70ab1e3a10c408e7b20599ee41403a3ed630",
+                "sha256:2d8474dc833b1182b651b184ace997a7bd83de0f51244de988d3c30e49f07de3",
+                "sha256:3119b57fe1d964781e91a53e81532c85ed1701baaddec592e22f6b77a9fdf3df",
+                "sha256:3bee8e7e0709b0fcdaa498a3e513bde9ffc7cd09dbceb11e425bd91c89dbd5b6",
+                "sha256:436c071e01a464753d30dbfc8768dd93aecf2a8e378e5314d130b95e77b4d612",
+                "sha256:46635e3f19ad04d5a7d7cf23d232388ddbfccf46d9a3b7436b6abadda4e84813",
+                "sha256:4772e0b679717e7ac4608d996f57b6f380748a919b457cb05bb941467b888b22",
+                "sha256:4e2cd80e16f481a62c3175b607373200e714ed29025f21559ebf7524f295689f",
+                "sha256:52732960efa0e003ca1c092dc0a3c65276e897681287a788a01ca78dda3b41f0",
+                "sha256:55a7de51ec7d1731b2431886d0349146645f2816e5b8eb982d7c49f89472c9f3",
+                "sha256:5f8ed5934197a2d4b2087646e98de3e099a237099dcf498b9e38dd3465f74ef4",
+                "sha256:64b064124fcbc8eb04a155117dc4d9a336e3cda3f069958fbc44fe70c3c3d1e9",
+                "sha256:65958b8e4319f992e85dad59d8081888b97fcdbde5f0d14bc28f2848b92d3ef1",
+                "sha256:7683428862e20c6a790c19e64f8ccf487f613fbc83d47e3d532df9c81668d451",
+                "sha256:78566d5570c75a127c2491e343dc006798a384f06be588fe9b0cbe5595711559",
+                "sha256:7d1cb00c093dbf1d0b16ccf123e79dee3b82608e4a2a88947695f0460eef13ff",
+                "sha256:8c74e2a9b594f7962c62cef7680a4cb92a96b4e6e3c2f970790da67cc0213a7e",
+                "sha256:8e60aa7699170f55f4b0f56ee6f8415229777ac7e4b4b1aa41fc61eec08c1f1d",
+                "sha256:9447b561529576d89d3bf973e5241a88cf76e45bd101963f5236888713dea774",
+                "sha256:970055bfeb0be373f2f5299a3db8432444bad3bc2f198753ee6c2a3a781e0959",
+                "sha256:a6344b8542e584e140dc3c651d68bde51270e79490aa9320f9e708f9b2c39bd5",
+                "sha256:ce309ca470d747b02ba6069d286a17b7df8e9c94d10d727d9cf3a64e51d85184",
+                "sha256:cfbd86ed4c2b2ac71bbdbcea6669bf295def7152e3722ddd9dda94ac7981f33d",
+                "sha256:d7929c513732dff093481f4a0954ed5ff16816365842136b17caa0b4992e49d3"
+            ],
+            "version": "==3.7.2"
+        },
+        "python-levenshtein": {
+            "hashes": [
+                "sha256:033a11de5e3d19ea25c9302d11224e1a1898fe5abd23c61c7c360c25195e3eb1"
+            ],
+            "version": "==0.12.0"
+        },
+        "pyyaml": {
+            "hashes": [
+                "sha256:3d7da3009c0f3e783b2c873687652d83b1bbfd5c88e9813fb7e5b03c0dd3108b",
+                "sha256:3ef3092145e9b70e3ddd2c7ad59bdd0252a94dfe3949721633e41344de00a6bf",
+                "sha256:40c71b8e076d0550b2e6380bada1f1cd1017b882f7e16f09a65be98e017f211a",
+                "sha256:558dd60b890ba8fd982e05941927a3911dc409a63dcb8b634feaa0cda69330d3",
+                "sha256:a7c28b45d9f99102fa092bb213aa12e0aaf9a6a1f5e395d36166639c1f96c3a1",
+                "sha256:aa7dd4a6a427aed7df6fb7f08a580d68d9b118d90310374716ae90b710280af1",
+                "sha256:bc558586e6045763782014934bfaf39d48b8ae85a2713117d16c39864085c613",
+                "sha256:d46d7982b62e0729ad0175a9bc7e10a566fc07b224d2c79fafb5e032727eaa04",
+                "sha256:d5eef459e30b09f5a098b9cea68bebfeb268697f78d647bd255a085371ac7f3f",
+                "sha256:e01d3203230e1786cd91ccfdc8f8454c8069c91bee3962ad93b87a4b2860f537",
+                "sha256:e170a9e6fcfd19021dd29845af83bb79236068bf5fd4df3327c1be18182b2531"
+            ],
+            "version": "==3.13"
+        },
+        "raven": {
+            "hashes": [
+                "sha256:3fa6de6efa2493a7c827472e984ce9b020797d0da16f1db67197bcc23c8fae54",
+                "sha256:44a13f87670836e153951af9a3c80405d36b43097db869a36e92809673692ce4"
+            ],
+            "version": "==6.10.0"
+        },
+        "raven-aiohttp": {
+            "hashes": [
+                "sha256:1444a49c93a85b8bb57c6ee649e512368dce7a26ad64ac3a01d86aa5669d77f3",
+                "sha256:6a34b6a9841ad0fd827eeb158edb5826c5c5bd7babe2cde2a3f23eb85313af04"
+            ],
+            "version": "==0.7.0"
+        },
+        "red-lavalink": {
+            "hashes": [
+                "sha256:6a1a34471ccf4630eee537049568dd87e8e93614f1d1ce355dd74e5b10079782"
+            ],
+            "version": "==0.1.2"
+        },
+        "schema": {
+            "hashes": [
+                "sha256:d994b0dc4966000037b26898df638e3e2a694cc73636cb2050e652614a350687",
+                "sha256:fa1a53fe5f3b6929725a4e81688c250f46838e25d8c1885a10a590c8c01a7b74"
+            ],
+            "version": "==0.6.8"
+        },
+        "websockets": {
+            "hashes": [
+                "sha256:0e2f7d6567838369af074f0ef4d0b802d19fa1fee135d864acc656ceefa33136",
+                "sha256:2a16dac282b2fdae75178d0ed3d5b9bc3258dabfae50196cbb30578d84b6f6a6",
+                "sha256:5a1fa6072405648cb5b3688e9ed3b94be683ce4a4e5723e6f5d34859dee495c1",
+                "sha256:5c1f55a1274df9d6a37553fef8cff2958515438c58920897675c9bc70f5a0538",
+                "sha256:669d1e46f165e0ad152ed8197f7edead22854a6c90419f544e0f234cc9dac6c4",
+                "sha256:695e34c4dbea18d09ab2c258994a8bf6a09564e762655408241f6a14592d2908",
+                "sha256:6b2e03d69afa8d20253455e67b64de1a82ff8612db105113cccec35d3f8429f0",
+                "sha256:79ca7cdda7ad4e3663ea3c43bfa8637fc5d5604c7737f19a8964781abbd1148d",
+                "sha256:7fd2dd9a856f72e6ed06f82facfce01d119b88457cd4b47b7ae501e8e11eba9c",
+                "sha256:82c0354ac39379d836719a77ee360ef865377aa6fdead87909d50248d0f05f4d",
+                "sha256:8f3b956d11c5b301206382726210dc1d3bee1a9ccf7aadf895aaf31f71c3716c",
+                "sha256:91ec98640220ae05b34b79ee88abf27f97ef7c61cf525eec57ea8fcea9f7dddb",
+                "sha256:952be9540d83dba815569d5cb5f31708801e0bbfc3a8c5aef1890b57ed7e58bf",
+                "sha256:99ac266af38ba1b1fe13975aea01ac0e14bb5f3a3200d2c69f05385768b8568e",
+                "sha256:9fa122e7adb24232247f8a89f2d9070bf64b7869daf93ac5e19546b409e47e96",
+                "sha256:a0873eadc4b8ca93e2e848d490809e0123eea154aa44ecd0109c4d0171869584",
+                "sha256:cb998bd4d93af46b8b49ecf5a72c0a98e5cc6d57fdca6527ba78ad89d6606484",
+                "sha256:e02e57346f6a68523e3c43bbdf35dde5c440318d1f827208ae455f6a2ace446d",
+                "sha256:e79a5a896bcee7fff24a788d72e5c69f13e61369d055f28113e71945a7eb1559",
+                "sha256:ee55eb6bcf23ecc975e6b47c127c201b913598f38b6a300075f84eeef2d3baff",
+                "sha256:f1414e6cbcea8d22843e7eafdfdfae3dd1aba41d1945f6ca66e4806c07c4f454"
+            ],
+            "version": "==6.0"
+        },
+        "yarl": {
+            "hashes": [
+                "sha256:024ecdc12bc02b321bc66b41327f930d1c2c543fa9a561b39861da9388ba7aa9",
+                "sha256:2f3010703295fbe1aec51023740871e64bb9664c789cba5a6bdf404e93f7568f",
+                "sha256:3890ab952d508523ef4881457c4099056546593fa05e93da84c7250516e632eb",
+                "sha256:3e2724eb9af5dc41648e5bb304fcf4891adc33258c6e14e2a7414ea32541e320",
+                "sha256:5badb97dd0abf26623a9982cd448ff12cb39b8e4c94032ccdedf22ce01a64842",
+                "sha256:73f447d11b530d860ca1e6b582f947688286ad16ca42256413083d13f260b7a0",
+                "sha256:7ab825726f2940c16d92aaec7d204cfc34ac26c0040da727cf8ba87255a33829",
+                "sha256:b25de84a8c20540531526dfbb0e2d2b648c13fd5dd126728c496d7c3fea33310",
+                "sha256:c6e341f5a6562af74ba55205dbd56d248daf1b5748ec48a0200ba227bb9e33f4",
+                "sha256:c9bb7c249c4432cd47e75af3864bc02d26c9594f49c82e2a28624417f0ae63b8",
+                "sha256:e060906c0c585565c718d1c3841747b61c5439af2211e185f6739a9412dfbde1"
+            ],
+            "version": "==1.3.0"
+        }
+    },
+    "develop": {
+        "aiohttp": {
+            "hashes": [
+                "sha256:0419705a36b43c0ac6f15469f9c2a08cad5c939d78bd12a5c23ea167c8253b2b",
+                "sha256:1812fc4bc6ac1bde007daa05d2d0f61199324e0cc893b11523e646595047ca08",
+                "sha256:2214b5c0153f45256d5d52d1e0cafe53f9905ed035a142191727a5fb620c03dd",
+                "sha256:275909137f0c92c61ba6bb1af856a522d5546f1de8ea01e4e726321c697754ac",
+                "sha256:3983611922b561868428ea1e7269e757803713f55b53502423decc509fef1650",
+                "sha256:51afec6ffa50a9da4cdef188971a802beb1ca8e8edb40fa429e5e529db3475fa",
+                "sha256:589f2ec8a101a0f340453ee6945bdfea8e1cd84c8d88e5be08716c34c0799d95",
+                "sha256:789820ddc65e1f5e71516adaca2e9022498fa5a837c79ba9c692a9f8f916c330",
+                "sha256:7a968a0bdaaf9abacc260911775611c9a602214a23aeb846f2eb2eeaa350c4dc",
+                "sha256:7aeefbed253f59ea39e70c5848de42ed85cb941165357fc7e87ab5d8f1f9592b",
+                "sha256:7b2eb55c66512405103485bd7d285a839d53e7fdc261ab20e5bcc51d7aaff5de",
+                "sha256:87bc95d3d333bb689c8d755b4a9d7095a2356108002149523dfc8e607d5d32a4",
+                "sha256:9d80e40db208e29168d3723d1440ecbb06054d349c5ece6a2c5a611490830dd7",
+                "sha256:a1b442195c2a77d33e4dbee67c9877ccbdd3a1f686f91eb479a9577ed8cc326b",
+                "sha256:ab3d769413b322d6092f169f316f7b21cd261a7589f7e31db779d5731b0480d8",
+                "sha256:b066d3dec5d0f5aee6e34e5765095dc3d6d78ef9839640141a2b20816a0642bd",
+                "sha256:b24e7845ae8de3e388ef4bcfcf7f96b05f52c8e633b33cf8003a6b1d726fc7c2",
+                "sha256:c59a953c3f8524a7c86eaeaef5bf702555be12f5668f6384149fe4bb75c52698",
+                "sha256:cf2cc6c2c10d242790412bea7ccf73726a9a44b4c4b073d2699ef3b48971fd95",
+                "sha256:e0c9c8d4150ae904f308ff27b35446990d2b1dfc944702a21925937e937394c6",
+                "sha256:f1839db4c2b08a9c8f9788112644f8a8557e8e0ecc77b07091afabb941dc55d0",
+                "sha256:f3df52362be39908f9c028a65490fae0475e4898b43a03d8aa29d1e765b45e07"
+            ],
+            "version": "==3.4.4"
+        },
+        "aiohttp-json-rpc": {
+            "hashes": [
+                "sha256:00d72f40edfc7271578d545a8c47874c0e23cc5d3201ed8128481f6a4af47e32",
+                "sha256:02d83b6998f8a0b7e59b46f0cb8a96b475bbf82600b1f9527df47135353f1ca8"
+            ],
+            "version": "==0.11.2"
+        },
+        "alabaster": {
+            "hashes": [
+                "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359",
+                "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"
+            ],
+            "version": "==0.7.12"
+        },
+        "appdirs": {
+            "hashes": [
+                "sha256:9e5896d1372858f8dd3344faf4e5014d21849c756c8d5701f78f8a103b372d92",
+                "sha256:d8b24664561d0d34ddfaec54636d502d7cea6e29c3eaf68f3df6180863e2166e"
+            ],
+            "version": "==1.4.3"
+        },
+        "async-timeout": {
+            "hashes": [
+                "sha256:0c3c816a028d47f659d6ff5c745cb2acf1f966da1fe5c19c77a70282b25f4c5f",
+                "sha256:4291ca197d287d274d0b6cb5d6f8f8f82d434ed288f962539ff18cc9012f9ea3"
+            ],
+            "version": "==3.0.1"
+        },
+        "atomicwrites": {
+            "hashes": [
+                "sha256:0312ad34fcad8fac3704d441f7b317e50af620823353ec657a53e981f92920c0",
+                "sha256:ec9ae8adaae229e4f8446952d204a3e4b5fdd2d099f9be3aaf556120135fb3ee"
+            ],
+            "version": "==1.2.1"
+        },
+        "attrs": {
+            "hashes": [
+                "sha256:10cbf6e27dbce8c30807caf056c8eb50917e0eaafe86347671b57254006c3e69",
+                "sha256:ca4be454458f9dec299268d472aaa5a11f67a4ff70093396e1ceae9c76cf4bbb"
+            ],
+            "version": "==18.2.0"
+        },
+        "babel": {
+            "hashes": [
+                "sha256:6778d85147d5d85345c14a26aada5e478ab04e39b078b0745ee6870c2b5cf669",
+                "sha256:8cba50f48c529ca3fa18cf81fa9403be176d374ac4d60738b839122dfaaa3d23"
+            ],
+            "version": "==2.6.0"
+        },
+        "black": {
+            "hashes": [
+                "sha256:817243426042db1d36617910df579a54f1afd659adb96fc5032fcf4b36209739",
+                "sha256:e030a9a28f542debc08acceb273f228ac422798e5215ba2a791a6ddeaaca22a5"
+            ],
+            "version": "==18.9b0"
+        },
+        "certifi": {
+            "hashes": [
+                "sha256:47f9c83ef4c0c621eaef743f133f09fa8a74a9b75f037e8624f83bd1b6626cb7",
+                "sha256:993f830721089fef441cdfeb4b2c8c9df86f0c63239f06bd025a76a7daddb033"
+            ],
+            "version": "==2018.11.29"
+        },
+        "chardet": {
+            "hashes": [
+                "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae",
+                "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"
+            ],
+            "version": "==3.0.4"
+        },
+        "click": {
+            "hashes": [
+                "sha256:2335065e6395b9e67ca716de5f7526736bfa6ceead690adf616d925bdc622b13",
+                "sha256:5b94b49521f6456670fdb30cd82a4eca9412788a93fa6dd6df72c94d5a8ff2d7"
+            ],
+            "version": "==7.0"
+        },
+        "colorama": {
+            "hashes": [
+                "sha256:05eed71e2e327246ad6b38c540c4a3117230b19679b875190486ddd2d721422d",
+                "sha256:f8ac84de7840f5b9c4e3347b3c1eaa50f7e49c2b07596221daec5edaabbd7c48"
+            ],
+            "version": "==0.4.1"
+        },
+        "distro": {
+            "hashes": [
+                "sha256:224041cef9600e72d19ae41ba006e71c05c4dc802516da715d7fda55ba3d8742",
+                "sha256:6ec8e539cf412830e5ccf521aecf879f2c7fcf60ce446e33cd16eef1ed8a0158"
+            ],
+            "version": "==1.3.0"
+        },
+        "docutils": {
+            "hashes": [
+                "sha256:02aec4bd92ab067f6ff27a38a38a41173bf01bed8f89157768c1573f53e474a6",
+                "sha256:51e64ef2ebfb29cae1faa133b3710143496eca21c530f3f71424d77687764274",
+                "sha256:7a4bd47eaf6596e1295ecb11361139febe29b084a87bf005bf899f9a42edc3c6"
+            ],
+            "version": "==0.14"
+        },
+        "e1839a9": {
+            "editable": true,
+            "extras": [
+                "docs",
+                "test",
+                "style"
+            ],
+            "path": "."
+        },
+        "filelock": {
+            "hashes": [
+                "sha256:b8d5ca5ca1c815e1574aee746650ea7301de63d87935b3463d26368b76e31633",
+                "sha256:d610c1bb404daf85976d7a82eb2ada120f04671007266b708606565dd03b5be6"
+            ],
+            "version": "==3.0.10"
+        },
+        "fuzzywuzzy": {
+            "hashes": [
+                "sha256:5ac7c0b3f4658d2743aa17da53a55598144edbc5bee3c6863840636e6926f254",
+                "sha256:6f49de47db00e1c71d40ad16da42284ac357936fa9b66bea1df63fed07122d62"
+            ],
+            "version": "==0.17.0"
+        },
+        "idna": {
+            "hashes": [
+                "sha256:c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407",
+                "sha256:ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c"
+            ],
+            "version": "==2.8"
+        },
+        "idna-ssl": {
+            "hashes": [
+                "sha256:a933e3bb13da54383f9e8f35dc4f9cb9eb9b3b78c6b36f311254d6d0d92c6c7c"
+            ],
+            "version": "==1.1.0"
+        },
+        "imagesize": {
+            "hashes": [
+                "sha256:3f349de3eb99145973fefb7dbe38554414e5c30abd0c8e4b970a7c9d09f3a1d8",
+                "sha256:f3832918bc3c66617f92e35f5d70729187676313caa60c187eb0f28b8fe5e3b5"
+            ],
+            "version": "==1.1.0"
+        },
+        "jinja2": {
+            "hashes": [
+                "sha256:74c935a1b8bb9a3947c50a54766a969d4846290e1e788ea44c1392163723c3bd",
+                "sha256:f84be1bb0040caca4cea721fcbbbbd61f9be9464ca236387158b0feea01914a4"
+            ],
+            "version": "==2.10"
+        },
+        "markupsafe": {
+            "hashes": [
+                "sha256:048ef924c1623740e70204aa7143ec592504045ae4429b59c30054cb31e3c432",
+                "sha256:130f844e7f5bdd8e9f3f42e7102ef1d49b2e6fdf0d7526df3f87281a532d8c8b",
+                "sha256:19f637c2ac5ae9da8bfd98cef74d64b7e1bb8a63038a3505cd182c3fac5eb4d9",
+                "sha256:1b8a7a87ad1b92bd887568ce54b23565f3fd7018c4180136e1cf412b405a47af",
+                "sha256:1c25694ca680b6919de53a4bb3bdd0602beafc63ff001fea2f2fc16ec3a11834",
+                "sha256:1f19ef5d3908110e1e891deefb5586aae1b49a7440db952454b4e281b41620cd",
+                "sha256:1fa6058938190ebe8290e5cae6c351e14e7bb44505c4a7624555ce57fbbeba0d",
+                "sha256:31cbb1359e8c25f9f48e156e59e2eaad51cd5242c05ed18a8de6dbe85184e4b7",
+                "sha256:3e835d8841ae7863f64e40e19477f7eb398674da6a47f09871673742531e6f4b",
+                "sha256:4e97332c9ce444b0c2c38dd22ddc61c743eb208d916e4265a2a3b575bdccb1d3",
+                "sha256:525396ee324ee2da82919f2ee9c9e73b012f23e7640131dd1b53a90206a0f09c",
+                "sha256:52b07fbc32032c21ad4ab060fec137b76eb804c4b9a1c7c7dc562549306afad2",
+                "sha256:52ccb45e77a1085ec5461cde794e1aa037df79f473cbc69b974e73940655c8d7",
+                "sha256:5c3fbebd7de20ce93103cb3183b47671f2885307df4a17a0ad56a1dd51273d36",
+                "sha256:5e5851969aea17660e55f6a3be00037a25b96a9b44d2083651812c99d53b14d1",
+                "sha256:5edfa27b2d3eefa2210fb2f5d539fbed81722b49f083b2c6566455eb7422fd7e",
+                "sha256:7d263e5770efddf465a9e31b78362d84d015cc894ca2c131901a4445eaa61ee1",
+                "sha256:83381342bfc22b3c8c06f2dd93a505413888694302de25add756254beee8449c",
+                "sha256:857eebb2c1dc60e4219ec8e98dfa19553dae33608237e107db9c6078b1167856",
+                "sha256:98e439297f78fca3a6169fd330fbe88d78b3bb72f967ad9961bcac0d7fdd1550",
+                "sha256:bf54103892a83c64db58125b3f2a43df6d2cb2d28889f14c78519394feb41492",
+                "sha256:d9ac82be533394d341b41d78aca7ed0e0f4ba5a2231602e2f05aa87f25c51672",
+                "sha256:e982fe07ede9fada6ff6705af70514a52beb1b2c3d25d4e873e82114cf3c5401",
+                "sha256:edce2ea7f3dfc981c4ddc97add8a61381d9642dc3273737e756517cc03e84dd6",
+                "sha256:efdc45ef1afc238db84cb4963aa689c0408912a0239b0721cb172b4016eb31d6",
+                "sha256:f137c02498f8b935892d5c0172560d7ab54bc45039de8805075e19079c639a9c",
+                "sha256:f82e347a72f955b7017a39708a3667f106e6ad4d10b25f237396a7115d8ed5fd",
+                "sha256:fb7c206e01ad85ce57feeaaa0bf784b97fa3cad0d4a5737bc5295785f5c613a1"
+            ],
+            "version": "==1.1.0"
+        },
+        "more-itertools": {
+            "hashes": [
+                "sha256:38a936c0a6d98a38bcc2d03fdaaedaba9f412879461dd2ceff8d37564d6522e4",
+                "sha256:c0a5785b1109a6bd7fac76d6837fd1feca158e54e521ccd2ae8bfe393cc9d4fc",
+                "sha256:fe7a7cae1ccb57d33952113ff4fa1bc5f879963600ed74918f1236e212ee50b9"
+            ],
+            "version": "==5.0.0"
+        },
+        "multidict": {
+            "hashes": [
+                "sha256:024b8129695a952ebd93373e45b5d341dbb87c17ce49637b34000093f243dd4f",
+                "sha256:041e9442b11409be5e4fc8b6a97e4bcead758ab1e11768d1e69160bdde18acc3",
+                "sha256:045b4dd0e5f6121e6f314d81759abd2c257db4634260abcfe0d3f7083c4908ef",
+                "sha256:047c0a04e382ef8bd74b0de01407e8d8632d7d1b4db6f2561106af812a68741b",
+                "sha256:068167c2d7bbeebd359665ac4fff756be5ffac9cda02375b5c5a7c4777038e73",
+                "sha256:148ff60e0fffa2f5fad2eb25aae7bef23d8f3b8bdaf947a65cdbe84a978092bc",
+                "sha256:1d1c77013a259971a72ddaa83b9f42c80a93ff12df6a4723be99d858fa30bee3",
+                "sha256:1d48bc124a6b7a55006d97917f695effa9725d05abe8ee78fd60d6588b8344cd",
+                "sha256:31dfa2fc323097f8ad7acd41aa38d7c614dd1960ac6681745b6da124093dc351",
+                "sha256:34f82db7f80c49f38b032c5abb605c458bac997a6c3142e0d6c130be6fb2b941",
+                "sha256:3d5dd8e5998fb4ace04789d1d008e2bb532de501218519d70bb672c4c5a2fc5d",
+                "sha256:4a6ae52bd3ee41ee0f3acf4c60ceb3f44e0e3bc52ab7da1c2b2aa6703363a3d1",
+                "sha256:4b02a3b2a2f01d0490dd39321c74273fed0568568ea0e7ea23e02bd1fb10a10b",
+                "sha256:4b843f8e1dd6a3195679d9838eb4670222e8b8d01bc36c9894d6c3538316fa0a",
+                "sha256:5de53a28f40ef3c4fd57aeab6b590c2c663de87a5af76136ced519923d3efbb3",
+                "sha256:61b2b33ede821b94fa99ce0b09c9ece049c7067a33b279f343adfe35108a4ea7",
+                "sha256:6a3a9b0f45fd75dc05d8e93dc21b18fc1670135ec9544d1ad4acbcf6b86781d0",
+                "sha256:76ad8e4c69dadbb31bad17c16baee61c0d1a4a73bed2590b741b2e1a46d3edd0",
+                "sha256:7ba19b777dc00194d1b473180d4ca89a054dd18de27d0ee2e42a103ec9b7d014",
+                "sha256:7c1b7eab7a49aa96f3db1f716f0113a8a2e93c7375dd3d5d21c4941f1405c9c5",
+                "sha256:7fc0eee3046041387cbace9314926aa48b681202f8897f8bff3809967a049036",
+                "sha256:8ccd1c5fff1aa1427100ce188557fc31f1e0a383ad8ec42c559aabd4ff08802d",
+                "sha256:8e08dd76de80539d613654915a2f5196dbccc67448df291e69a88712ea21e24a",
+                "sha256:c18498c50c59263841862ea0501da9f2b3659c00db54abfbf823a80787fde8ce",
+                "sha256:c49db89d602c24928e68c0d510f4fcf8989d77defd01c973d6cbe27e684833b1",
+                "sha256:ce20044d0317649ddbb4e54dab3c1bcc7483c78c27d3f58ab3d0c7e6bc60d26a",
+                "sha256:d1071414dd06ca2eafa90c85a079169bfeb0e5f57fd0b45d44c092546fcd6fd9",
+                "sha256:d3be11ac43ab1a3e979dac80843b42226d5d3cccd3986f2e03152720a4297cd7",
+                "sha256:db603a1c235d110c860d5f39988ebc8218ee028f07a7cbc056ba6424372ca31b"
+            ],
+            "version": "==4.5.2"
+        },
+        "packaging": {
+            "hashes": [
+                "sha256:0886227f54515e592aaa2e5a553332c73962917f2831f1b0f9b9f4380a4b9807",
+                "sha256:f95a1e147590f204328170981833854229bb2912ac3d5f89e2a8ccd2834800c9"
+            ],
+            "version": "==18.0"
+        },
+        "pluggy": {
+            "hashes": [
+                "sha256:8ddc32f03971bfdf900a81961a48ccf2fb677cf7715108f85295c67405798616",
+                "sha256:980710797ff6a041e9a73a5787804f848996ecaa6f8a1b1e08224a5894f2074a"
+            ],
+            "version": "==0.8.1"
+        },
+        "py": {
+            "hashes": [
+                "sha256:bf92637198836372b520efcba9e020c330123be8ce527e535d185ed4b6f45694",
+                "sha256:e76826342cefe3c3d5f7e8ee4316b80d1dd8a300781612ddbc765c17ba25a6c6"
+            ],
+            "version": "==1.7.0"
+        },
+        "pygments": {
+            "hashes": [
+                "sha256:5ffada19f6203563680669ee7f53b64dabbeb100eb51b61996085e99c03b284a",
+                "sha256:e8218dd399a61674745138520d0d4cf2621d7e032439341bc3f647bff125818d"
+            ],
+            "version": "==2.3.1"
+        },
+        "pyparsing": {
+            "hashes": [
+                "sha256:40856e74d4987de5d01761a22d1621ae1c7f8774585acae358aa5c5936c6c90b",
+                "sha256:f353aab21fd474459d97b709e527b5571314ee5f067441dc9f88e33eecd96592"
+            ],
+            "version": "==2.3.0"
+        },
+        "pytest": {
+            "hashes": [
+                "sha256:3e65a22eb0d4f1bdbc1eacccf4a3198bf8d4049dea5112d70a0c61b00e748d02",
+                "sha256:5924060b374f62608a078494b909d341720a050b5224ff87e17e12377486a71d"
+            ],
+            "version": "==4.1.0"
+        },
+        "pytest-asyncio": {
+            "hashes": [
+                "sha256:9fac5100fd716cbecf6ef89233e8590a4ad61d729d1732e0a96b84182df1daaf",
+                "sha256:d734718e25cfc32d2bf78d346e99d33724deeba774cc4afdf491530c6184b63b"
+            ],
+            "version": "==0.10.0"
+        },
+        "python-levenshtein": {
+            "hashes": [
+                "sha256:033a11de5e3d19ea25c9302d11224e1a1898fe5abd23c61c7c360c25195e3eb1"
+            ],
+            "version": "==0.12.0"
+        },
+        "pytz": {
+            "hashes": [
+                "sha256:32b0891edff07e28efe91284ed9c31e123d84bea3fd98e1f72be2508f43ef8d9",
+                "sha256:d5f05e487007e29e03409f9398d074e158d920d36eb82eaf66fb1136b0c5374c"
+            ],
+            "version": "==2018.9"
+        },
+        "pyyaml": {
+            "hashes": [
+                "sha256:3d7da3009c0f3e783b2c873687652d83b1bbfd5c88e9813fb7e5b03c0dd3108b",
+                "sha256:3ef3092145e9b70e3ddd2c7ad59bdd0252a94dfe3949721633e41344de00a6bf",
+                "sha256:40c71b8e076d0550b2e6380bada1f1cd1017b882f7e16f09a65be98e017f211a",
+                "sha256:558dd60b890ba8fd982e05941927a3911dc409a63dcb8b634feaa0cda69330d3",
+                "sha256:a7c28b45d9f99102fa092bb213aa12e0aaf9a6a1f5e395d36166639c1f96c3a1",
+                "sha256:aa7dd4a6a427aed7df6fb7f08a580d68d9b118d90310374716ae90b710280af1",
+                "sha256:bc558586e6045763782014934bfaf39d48b8ae85a2713117d16c39864085c613",
+                "sha256:d46d7982b62e0729ad0175a9bc7e10a566fc07b224d2c79fafb5e032727eaa04",
+                "sha256:d5eef459e30b09f5a098b9cea68bebfeb268697f78d647bd255a085371ac7f3f",
+                "sha256:e01d3203230e1786cd91ccfdc8f8454c8069c91bee3962ad93b87a4b2860f537",
+                "sha256:e170a9e6fcfd19021dd29845af83bb79236068bf5fd4df3327c1be18182b2531"
+            ],
+            "version": "==3.13"
+        },
+        "raven": {
+            "hashes": [
+                "sha256:3fa6de6efa2493a7c827472e984ce9b020797d0da16f1db67197bcc23c8fae54",
+                "sha256:44a13f87670836e153951af9a3c80405d36b43097db869a36e92809673692ce4"
+            ],
+            "version": "==6.10.0"
+        },
+        "raven-aiohttp": {
+            "hashes": [
+                "sha256:1444a49c93a85b8bb57c6ee649e512368dce7a26ad64ac3a01d86aa5669d77f3",
+                "sha256:6a34b6a9841ad0fd827eeb158edb5826c5c5bd7babe2cde2a3f23eb85313af04"
+            ],
+            "version": "==0.7.0"
+        },
+        "requests": {
+            "hashes": [
+                "sha256:502a824f31acdacb3a35b6690b5fbf0bc41d63a24a45c4004352b0242707598e",
+                "sha256:7bf2a778576d825600030a110f3c0e3e8edc51dfaafe1c146e39a2027784957b"
+            ],
+            "version": "==2.21.0"
+        },
+        "schema": {
+            "hashes": [
+                "sha256:d994b0dc4966000037b26898df638e3e2a694cc73636cb2050e652614a350687",
+                "sha256:fa1a53fe5f3b6929725a4e81688c250f46838e25d8c1885a10a590c8c01a7b74"
+            ],
+            "version": "==0.6.8"
+        },
+        "six": {
+            "hashes": [
+                "sha256:3350809f0555b11f552448330d0b52d5f24c91a322ea4a15ef22629740f3761c",
+                "sha256:d16a0141ec1a18405cd4ce8b4613101da75da0e9a7aec5bdd4fa804d0e0eba73"
+            ],
+            "version": "==1.12.0"
+        },
+        "snowballstemmer": {
+            "hashes": [
+                "sha256:919f26a68b2c17a7634da993d91339e288964f93c274f1343e3bbbe2096e1128",
+                "sha256:9f3bcd3c401c3e862ec0ebe6d2c069ebc012ce142cce209c098ccb5b09136e89"
+            ],
+            "version": "==1.2.1"
+        },
+        "sphinx": {
+            "hashes": [
+                "sha256:429e3172466df289f0f742471d7e30ba3ee11f3b5aecd9a840480d03f14bcfe5",
+                "sha256:c4cb17ba44acffae3d3209646b6baec1e215cad3065e852c68cc569d4df1b9f8"
+            ],
+            "version": "==1.8.3"
+        },
+        "sphinx-rtd-theme": {
+            "hashes": [
+                "sha256:02f02a676d6baabb758a20c7a479d58648e0f64f13e07d1b388e9bb2afe86a09",
+                "sha256:d0f6bc70f98961145c5b0e26a992829363a197321ba571b31b24ea91879e0c96"
+            ],
+            "version": "==0.4.2"
+        },
+        "sphinxcontrib-asyncio": {
+            "hashes": [
+                "sha256:96627b1ec4eba08d09ad577ff9416c131910333ef37a2c82a2716e59646739f0"
+            ],
+            "version": "==0.2.0"
+        },
+        "sphinxcontrib-websupport": {
+            "hashes": [
+                "sha256:68ca7ff70785cbe1e7bccc71a48b5b6d965d79ca50629606c7861a21b206d9dd",
+                "sha256:9de47f375baf1ea07cdb3436ff39d7a9c76042c10a769c52353ec46e4e8fc3b9"
+            ],
+            "version": "==1.1.0"
+        },
+        "toml": {
+            "hashes": [
+                "sha256:229f81c57791a41d65e399fc06bf0848bab550a9dfd5ed66df18ce5f05e73d5c",
+                "sha256:235682dd292d5899d361a811df37e04a8828a5b1da3115886b73cf81ebc9100e"
+            ],
+            "version": "==0.10.0"
+        },
+        "tox": {
+            "hashes": [
+                "sha256:2a8d8a63660563e41e64e3b5b677e81ce1ffa5e2a93c2c565d3768c287445800",
+                "sha256:edfca7809925f49bdc110d0a2d9966bbf35a0c25637216d9586e7a5c5de17bfb"
+            ],
+            "index": "pypi",
+            "version": "==3.6.1"
+        },
+        "urllib3": {
+            "hashes": [
+                "sha256:61bf29cada3fc2fbefad4fdf059ea4bd1b4a86d2b6d15e1c7c0b582b9752fe39",
+                "sha256:de9529817c93f27c8ccbfead6985011db27bd0ddfcdb2d86f3f663385c6a9c22"
+            ],
+            "version": "==1.24.1"
+        },
+        "virtualenv": {
+            "hashes": [
+                "sha256:34b9ae3742abed2f95d3970acf4d80533261d6061b51160b197f84e5b4c98b4c",
+                "sha256:fa736831a7b18bd2bfeef746beb622a92509e9733d645952da136b0639cd40cd"
+            ],
+            "version": "==16.2.0"
+        },
+        "websockets": {
+            "hashes": [
+                "sha256:0e2f7d6567838369af074f0ef4d0b802d19fa1fee135d864acc656ceefa33136",
+                "sha256:2a16dac282b2fdae75178d0ed3d5b9bc3258dabfae50196cbb30578d84b6f6a6",
+                "sha256:5a1fa6072405648cb5b3688e9ed3b94be683ce4a4e5723e6f5d34859dee495c1",
+                "sha256:5c1f55a1274df9d6a37553fef8cff2958515438c58920897675c9bc70f5a0538",
+                "sha256:669d1e46f165e0ad152ed8197f7edead22854a6c90419f544e0f234cc9dac6c4",
+                "sha256:695e34c4dbea18d09ab2c258994a8bf6a09564e762655408241f6a14592d2908",
+                "sha256:6b2e03d69afa8d20253455e67b64de1a82ff8612db105113cccec35d3f8429f0",
+                "sha256:79ca7cdda7ad4e3663ea3c43bfa8637fc5d5604c7737f19a8964781abbd1148d",
+                "sha256:7fd2dd9a856f72e6ed06f82facfce01d119b88457cd4b47b7ae501e8e11eba9c",
+                "sha256:82c0354ac39379d836719a77ee360ef865377aa6fdead87909d50248d0f05f4d",
+                "sha256:8f3b956d11c5b301206382726210dc1d3bee1a9ccf7aadf895aaf31f71c3716c",
+                "sha256:91ec98640220ae05b34b79ee88abf27f97ef7c61cf525eec57ea8fcea9f7dddb",
+                "sha256:952be9540d83dba815569d5cb5f31708801e0bbfc3a8c5aef1890b57ed7e58bf",
+                "sha256:99ac266af38ba1b1fe13975aea01ac0e14bb5f3a3200d2c69f05385768b8568e",
+                "sha256:9fa122e7adb24232247f8a89f2d9070bf64b7869daf93ac5e19546b409e47e96",
+                "sha256:a0873eadc4b8ca93e2e848d490809e0123eea154aa44ecd0109c4d0171869584",
+                "sha256:cb998bd4d93af46b8b49ecf5a72c0a98e5cc6d57fdca6527ba78ad89d6606484",
+                "sha256:e02e57346f6a68523e3c43bbdf35dde5c440318d1f827208ae455f6a2ace446d",
+                "sha256:e79a5a896bcee7fff24a788d72e5c69f13e61369d055f28113e71945a7eb1559",
+                "sha256:ee55eb6bcf23ecc975e6b47c127c201b913598f38b6a300075f84eeef2d3baff",
+                "sha256:f1414e6cbcea8d22843e7eafdfdfae3dd1aba41d1945f6ca66e4806c07c4f454"
+            ],
+            "version": "==6.0"
+        },
+        "yarl": {
+            "hashes": [
+                "sha256:024ecdc12bc02b321bc66b41327f930d1c2c543fa9a561b39861da9388ba7aa9",
+                "sha256:2f3010703295fbe1aec51023740871e64bb9664c789cba5a6bdf404e93f7568f",
+                "sha256:3890ab952d508523ef4881457c4099056546593fa05e93da84c7250516e632eb",
+                "sha256:3e2724eb9af5dc41648e5bb304fcf4891adc33258c6e14e2a7414ea32541e320",
+                "sha256:5badb97dd0abf26623a9982cd448ff12cb39b8e4c94032ccdedf22ce01a64842",
+                "sha256:73f447d11b530d860ca1e6b582f947688286ad16ca42256413083d13f260b7a0",
+                "sha256:7ab825726f2940c16d92aaec7d204cfc34ac26c0040da727cf8ba87255a33829",
+                "sha256:b25de84a8c20540531526dfbb0e2d2b648c13fd5dd126728c496d7c3fea33310",
+                "sha256:c6e341f5a6562af74ba55205dbd56d248daf1b5748ec48a0200ba227bb9e33f4",
+                "sha256:c9bb7c249c4432cd47e75af3864bc02d26c9594f49c82e2a28624417f0ae63b8",
+                "sha256:e060906c0c585565c718d1c3841747b61c5439af2211e185f6739a9412dfbde1"
+            ],
+            "version": "==1.3.0"
+        }
+    }
+}

README.md

@@ -0,0 +1,135 @@
+<h1 align="center">
+  <br>
+  <a href="https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop"><img src="https://imgur.com/pY1WUFX.png" alt="Red - Discord Bot"></a>
+  <br>
+  Red Discord Bot
+  <br>
+</h1>
+
+<h4 align="center">Music, Moderation, Trivia, Stream Alerts and Fully Modular.</h4>
+
+<p align="center">
+  <a href="https://discord.gg/red">
+    <img src="https://discordapp.com/api/guilds/133049272517001216/widget.png?style=shield" alt="Discord Server">
+  </a>
+  <a href="https://www.patreon.com/Red_Devs">
+    <img src="https://img.shields.io/badge/Support-Red!-yellow.svg" alt="Support Red on Patreon!">
+  </a>
+  <a href="https://www.python.org/downloads/">
+    <img src="https://img.shields.io/badge/Made%20With-Python%203-blue.svg?style=for-the-badge" alt="Made with Python 3">
+  </a>
+  <a href="https://crowdin.com/project/red-discordbot">
+    <img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg" alt="Localized with Crowdin">
+  </a>
+  <a href="https://github.com/Rapptz/discord.py/tree/rewrite">
+      <img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
+  </a>
+</p>
+<p align="center">
+  <a href="https://travis-ci.org/Cog-Creators/Red-DiscordBot">
+    <img src="https://api.travis-ci.org/Cog-Creators/Red-DiscordBot.svg?branch=V3/develop" alt="Travis CI">
+  </a>
+  <a href="http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop">
+    <img src="https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop" alt="Red on readthedocs.org">
+  </a>
+  <a href="https://github.com/ambv/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
+  </a>
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#overview">Overview</a>
+  •
+  <a href="#installation">Installation</a>
+  •
+  <a href="http://red-discordbot.readthedocs.io/en/v3-develop/index.html">Documentation</a>
+  •
+  <a href="#plugins">Plugins</a>
+  •
+  <a href="#join-the-community">Community</a>
+  •
+  <a href="#license">License</a>
+</p>
+
+# Overview
+
+Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your
+liking, making it completely customizable. This is also a *self-hosted bot* – meaning you will need
+to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot,
+new best friend or all of these together!  
+
+[Installation](#installation) is easy, and you do **NOT** need to know anything about coding! Aside
+from installation and updating, every part of the bot can be controlled from within Discord.
+
+**The default set of modules includes and is not limited to:**
+
+- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)
+- Trivia (lists are included and can be easily added)
+- Music features (YouTube, SoundCloud, local files, playlists, queues)
+- Stream alerts (Twitch, Youtube, Mixer, Hitbox, Picarto)
+- Bank (slot machine, user credits)
+- Custom commands
+- Imgur/gif search
+- Admin automation (self-role assignment, cross-server announcements, mod-mail reports)
+- Customisable command permissions
+
+**Additionally, other [plugins](#plugins) (cogs) can be easily found and added from our growing
+community of cog repositories.**
+
+# Installation
+
+**The following platforms are officially supported:** 
+
+- [Windows](https://red-discordbot.readthedocs.io/en/v3-develop/install_windows.html)
+- [MacOS](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+- [Ubuntu](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+- [Debian Stretch](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+- [CentOS 7](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+- [Arch Linux](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+- [Raspbian Stretch](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html)
+
+Already using **Red** V2? Take a look at the [Data Converter](https://red-discordbot.readthedocs.io/en/v3-develop/cog_dataconverter.html)
+to import your data to V3.
+
+If after reading the guide you are still experiencing issues, feel free to join the
+[Official Discord Server](https://discord.gg/red) and ask in the **#v3-support** channel for help.
+
+# Plugins
+
+Red is fully modular, allowing you to load and unload plugins of your choice, and install 3rd party
+plugins directly from Discord! A few examples are:
+
+- Cleverbot integration (talk to Red and she talks back)
+- Ban sync
+- Welcome messages
+- Casino
+- Reaction roles
+- Slow Mode
+- Anilist
+- And much, much more!
+
+Feel free to take a [peek](https://github.com/Cog-Creators/Red-DiscordBot/issues/1398) at a list of
+available 3rd party cogs!
+
+# Join the community!
+
+**Red** is in continuous development, and it’s supported by an active community which produces new
+content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t
+[find](https://github.com/Cog-Creators/Red-DiscordBot/issues/1398) the cog you’re looking for,
+consult our [guide](https://red-discordbot.readthedocs.io/en/v3-develop/guide_cog_creation.html) on
+building your own cogs!
+
+Join us on our [Official Discord Server](https://discord.gg/red)!
+
+# License
+
+Released under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.
+
+Red is named after the main character of "Transistor", a video game by
+[Super Giant Games](https://www.supergiantgames.com/games/transistor/).
+
+Artwork created by [Sinlaire](https://sinlaire.deviantart.com/) on Deviant Art for the Red Discord
+Bot Project.

README.rst

@@ -1,42 +0,0 @@
-.. image:: https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop
-    :target: http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop
-    :alt: Documentation Status
-
-.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
-    :target: http://makeapullrequest.com
-    :alt: PRs Welcome
-
-.. image:: https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg
-    :target: https://crowdin.com/project/red-discordbot
-    :alt: Crowdin
-    
-.. image:: https://img.shields.io/badge/Support-Red!-orange.svg
-    :target: https://www.patreon.com/Red_Devs
-    :alt: Patreon
-
-********************
-Red - Discord Bot v3
-********************
-
-**This is in beta and very much a work in progress. Regular use is not recommended.
-There will not be any effort made to prevent the breaking of current installations.**
-
-How to install
-^^^^^^^^^^^^^^
-
-Using python3 pip::
-
-    pip install --process-dependency-links -U Red-DiscordBot
-    redbot-setup
-    redbot <name>
-
-To install requirements for voice::
-
-    pip install --process-dependency-links -U Red-DiscordBot[voice]
-
-To install all requirements for docs and tests::
-
-    pip install --process-dependency-links -U Red-DiscordBot[test,docs]
-
-For the latest git build, replace ``Red-DiscordBot`` in the above commands with
-``git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop``.

crowdin.yml

@@ -1,5 +1,5 @@
 api_key_env: CROWDIN_API_KEY
 project_identifier_env: CROWDIN_PROJECT_ID
 files:
-  - source: /**/*.pot
+  - source: /redbot/**/*.pot
     translation: /%original_path%/%locale%.po

dependency_links.txt

@@ -0,0 +1 @@
+https://github.com/Rapptz/discord.py/tarball/7f4c57dd5ad20b7fa10aea485f674a4bc24b9547#egg=discord.py-1.0.0a0

docs/Makefile

@@ -14,6 +14,9 @@ help:
 
 .PHONY: help Makefile
 
+init:
+	cd .. && pipenv lock -r --dev > docs/requirements.txt && echo 'git+https://github.com/Rapptz/discord.py@rewrite#egg=discord.py-1.0' >> docs/requirements.txt
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/autostart_systemd.rst

@@ -1,16 +1,16 @@
 .. systemd service guide
 
-==========================
+==============================================
 Setting up auto-restart using systemd on Linux
-==========================
+==============================================
 
----------------------------
+-------------------------
 Creating the service file
----------------------------
+-------------------------
 
 Create the new service file:
 
-:code:`sudo nano /etc/systemd/system/red@.service`
+:code:`sudo -e /etc/systemd/system/red@.service`
 
 Paste the following and replace all instances of :code:`username` with the username your bot is running under (hopefully not root):
 
@@ -27,15 +27,18 @@ Paste the following and replace all instances of :code:`username` with the usern
     Type=idle
     Restart=always
     RestartSec=15
+    RestartPreventExitStatus=0
 
     [Install]
     WantedBy=multi-user.target
 
 Save and exit :code:`ctrl + O; enter; ctrl + x`
 
----------------------------
+---------------------------------
 Starting and enabling the service
----------------------------
+---------------------------------
+
+.. note:: This same file can be used to start as many instances of the bot as you wish, without creating more service files, just start and enable more services and add any bot instance name after the **@**
 
 To start the bot, run the service and add the instance name after the **@**:
 
@@ -45,4 +48,6 @@ To set the bot to start on boot, you must enable the service, again adding the i
 
 :code:`sudo systemctl enable red@instancename`
 
-.. note:: This same file can be used to start as many instances of the bot as you wish, without creating more service files, just start and enable more services and add any bot instance name after the **@**
+To view Red’s log, you can acccess through journalctl:
+
+:code:`sudo journalctl -u red@instancename`

docs/cog_customcom.rst

@@ -0,0 +1,109 @@
+.. CustomCommands Cog Reference
+
+============================
+CustomCommands Cog Reference
+============================
+
+------------
+How it works
+------------
+
+CustomCommands allows you to create simple commands for your bot without requiring you to code your own cog for Red.
+
+If the command you attempt to create shares a name with an already loaded command, you cannot overwrite it with this cog.
+
+---------
+Cooldowns
+---------
+
+You can set cooldowns for your custom commands. If a command is on cooldown, it will not be triggered.
+
+You can set cooldowns per member or per channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
+
+------------------
+Context Parameters
+------------------
+
+You can enhance your custom command's response by leaving spaces for the bot to substitute.
+
++-----------+----------------------------------------+
+| Argument  | Substitute                             |
++===========+========================================+
+| {message} | The message the bot is responding to.  |
++-----------+----------------------------------------+
+| {author}  | The user who called the command.       |
++-----------+----------------------------------------+
+| {channel} | The channel the command was called in. |
++-----------+----------------------------------------+
+| {server}  | The server the command was called in.  |
++-----------+----------------------------------------+
+| {guild}   | Same as with {server}.                 |
++-----------+----------------------------------------+
+
+You can further refine the response with dot notation. For example, {author.mention} will mention the user who called the command.
+
+------------------
+Command Parameters
+------------------
+
+You can further enhance your custom command's response by leaving spaces for the user to substitute.
+
+To do this, simply put {#} in the response, replacing # with any number starting with 0. Each number will be replaced with what the user gave the command, in order.
+
+You can refine the response with colon notation. For example, {0:Member} will accept members of the server, and {0:int} will accept a number. If no colon notation is provided, the argument will be returned unchanged.
+
++-----------------+--------------------------------+
+| Argument        | Substitute                     |
++=================+================================+
+| {#:Member}      | A member of your server.       |
++-----------------+--------------------------------+
+| {#:TextChannel} | A text channel in your server. |
++-----------------+--------------------------------+
+| {#:Role}        | A role in your server.         |
++-----------------+--------------------------------+
+| {#:int}         | A whole number.                |
++-----------------+--------------------------------+
+| {#:float}       | A decimal number.              |
++-----------------+--------------------------------+
+| {#:bool}        | True or False.                 |
++-----------------+--------------------------------+
+
+You can specify more than the above with colon notation, but those are the most common.
+
+As with context parameters, you can use dot notation to further refine the response. For example, {0.mention:Member} will mention the Member specified.
+
+----------------
+Example commands
+----------------
+
+Showing your own avatar
+
+.. code-block:: none
+
+    [p]customcom add simple avatar {author.avatar_url}
+    [p]avatar
+        https://cdn.discordapp.com/avatars/133801473317404673/be4c4a4fe47cb3e74c31a0504e7a295e.webp?size=1024
+
+Repeating the user
+
+.. code-block:: none
+
+    [p]customcom add simple say {0}
+    [p]say Pete and Repeat
+        Pete and Repeat
+
+Greeting the specified member
+
+.. code-block:: none
+
+    [p]customcom add simple greet Hello, {0.mention:Member}!
+    [p]greet Twentysix
+        Hello, @Twentysix!
+
+Comparing two text channel's categories
+
+.. code-block:: none
+
+    [p]customcom add simple comparecategory {0.category:TextChannel}  |  {1.category:TextChannel}
+    [p]comparecategory #support #general
+        Red  |  Community

docs/cog_permissions.rst

@@ -0,0 +1,97 @@
+.. Permissions Cog Reference
+
+=========================
+Permissions Cog Reference
+=========================
+
+------------
+How it works
+------------
+
+When loaded, the permissions cog will allow you to define extra custom rules for who can use a
+command.
+
+If no applicable rules are found, the command will behave normally.
+
+Rules can also be added to cogs, which will affect all commands from that cog. The cog name can be
+found from the help menu.
+
+-------------
+Rule priority
+-------------
+
+Rules set for subcommands will take precedence over rules set for the parent commands, which
+lastly take precedence over rules set for the cog. So for example, if a user is denied the Core
+cog, but allowed the ``[p]set token`` command, the user will not be able to use any command in the
+Core cog except for ``[p]set token``.
+
+In terms of scope, global rules will be checked first, then server rules.
+
+For each of those, the first rule pertaining to one of the following models will be used:
+
+1. User
+2. Voice channel
+3. Text channel
+4. Channel category
+5. Roles, highest to lowest
+6. Server (can only be in global rules)
+7. Default rules
+
+In private messages, only global rules about a user will be checked.
+
+-------------------------
+Setting Rules From a File
+-------------------------
+
+The permissions cog can also set, display or update rules with a YAML file with the
+``[p]permissions yaml`` command. Models must be represented by ID. Rules must be ``true`` for
+allow, or ``false`` for deny. Here is an example:
+
+.. code-block:: yaml
+
+    COG:
+      Admin:
+        78631113035100160: true
+        96733288462286848: false
+      Audio:
+        133049272517001216: true
+        default: false
+    COMMAND:
+      cleanup bot:
+        78631113035100160: true
+        default: false
+      ping:
+        96733288462286848: false
+        default: true
+
+----------------------
+Example configurations
+----------------------
+
+Locking the ``[p]play`` command to approved server(s) as a bot owner:
+
+.. code-block:: none
+
+    [p]permissions setglobaldefault play deny
+    [p]permissions addglobalrule allow play [server ID or name]
+
+Locking the ``[p]play`` command to specific voice channel(s) as a serverowner or admin:
+
+.. code-block:: none
+
+    [p]permissions setserverdefault deny play
+    [p]permissions setserverdefault deny "playlist start"
+    [p]permissions addserverrule allow play [voice channel ID or name]
+    [p]permissions addserverrule allow "playlist start" [voice channel ID or name]
+
+Allowing extra roles to use ``[p]cleanup``:
+
+.. code-block:: none
+
+    [p]permissions addserverrule allow cleanup [role ID]
+
+Preventing ``[p]cleanup`` from being used in channels where message history is important:
+
+.. code-block:: none
+
+    [p]permissions addserverrule deny cleanup [channel ID or mention]

docs/conf.py

@@ -19,9 +19,10 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
-os.environ['BUILDING_DOCS'] = "1"
+sys.path.insert(0, os.path.abspath(".."))
+
+os.environ["BUILDING_DOCS"] = "1"
 
 
 # -- General configuration ------------------------------------------------
@@ -34,35 +35,37 @@ os.environ['BUILDING_DOCS'] = "1"
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib.asyncio'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.doctest",
+    "sphinxcontrib.asyncio",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Red - Discord Bot'
-copyright = '2018, Cog Creators'
-author = 'Cog Creators'
+project = "Red - Discord Bot"
+copyright = "2018, Cog Creators"
+author = "Cog Creators"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 from redbot.core import __version__
+
 # The short X.Y version.
 version = __version__
 # The full version, including alpha/beta/rc tags.
@@ -78,10 +81,10 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -95,7 +98,7 @@ default_role = "any"
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -105,16 +108,16 @@ html_theme = 'sphinx_rtd_theme'
 
 html_context = {
     # Enable the "Edit in GitHub link within the header of each page.
-    'display_github': True,
-    'github_user': 'Cog-Creators',
-    'github_repo': 'Red-DiscordBot',
-    'github_version': 'V3/develop/docs/'
+    "display_github": True,
+    "github_user": "Cog-Creators",
+    "github_repo": "Red-DiscordBot",
+    "github_version": "V3/develop/docs/",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -122,12 +125,12 @@ html_static_path = ['_static']
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-        'donate.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
+        "donate.html",
     ]
 }
 
@@ -135,7 +138,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Red-DiscordBotdoc'
+htmlhelp_basename = "Red-DiscordBotdoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -144,15 +147,12 @@ latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -162,8 +162,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Red-DiscordBot.tex', 'Red - Discord Bot Documentation',
-     'Cog Creators', 'manual'),
+    (master_doc, "Red-DiscordBot.tex", "Red - Discord Bot Documentation", "Cog Creators", "manual")
 ]
 
 
@@ -171,10 +170,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'red-discordbot', 'Red - Discord Bot Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "red-discordbot", "Red - Discord Bot Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -183,15 +179,35 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Red-DiscordBot', 'Red - Discord Bot Documentation',
-     author, 'Red-DiscordBot', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "Red-DiscordBot",
+        "Red - Discord Bot Documentation",
+        author,
+        "Red-DiscordBot",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 
+# -- Options for linkcheck builder ----------------------------------------
+
+# A list of regular expressions that match URIs that should not be
+# checked when doing a linkcheck build.
+linkcheck_ignore = [r"https://java.com*"]
 
 
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python': ('https://docs.python.org/3.5', None),
-                       'dpy': ('https://discordpy.readthedocs.io/en/rewrite/', None),
-                       'motor': ('https://motor.readthedocs.io/en/stable/', None)}
+# -- Options for extensions -----------------------------------------------
+
+# Intersphinx
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.6", None),
+    "dpy": ("https://discordpy.readthedocs.io/en/rewrite/", None),
+    "motor": ("https://motor.readthedocs.io/en/stable/", None),
+}
+
+# Doctest
+# If this string is non-empty, all blocks with ``>>>`` in them will be
+# tested, not just the ones explicitly marked with ``.. doctest::``
+doctest_test_doctest_blocks = ""

docs/framework_bot.rst

@@ -11,6 +11,10 @@ RedBase
 
 .. autoclass:: RedBase
     :members:
+    :exclude-members: get_context
+
+    .. automethod:: register_rpc_handler
+    .. automethod:: unregister_rpc_handler
 
 Red
 ^^^

docs/framework_checks.rst

@@ -0,0 +1,11 @@
+.. _checks:
+
+========================
+Command Check Decorators
+========================
+
+The following are all decorators for commands, which add restrictions to where and when they can be
+run.
+
+.. automodule:: redbot.core.checks
+    :members:

docs/framework_commands.rst

@@ -0,0 +1,26 @@
+.. red commands module documentation
+
+================
+Commands Package
+================
+
+This package acts almost identically to :doc:`discord.ext.commands <dpy:ext/commands/api>`; i.e.
+all of the attributes from discord.py's are also in ours. 
+Some of these attributes, however, have been slightly modified, while others have been added to
+extend functionlities used throughout the bot, as outlined below.
+
+.. autofunction:: redbot.core.commands.command
+
+.. autofunction:: redbot.core.commands.group
+
+.. autoclass:: redbot.core.commands.Command
+    :members:
+
+.. autoclass:: redbot.core.commands.Group
+    :members:
+
+.. autoclass:: redbot.core.commands.Context
+    :members:
+
+.. automodule:: redbot.core.commands.requires
+    :members: PrivilegeLevel, PermState, Requires

docs/framework_config.rst

@@ -29,7 +29,7 @@ Basic Usage
 
         @commands.command()
         async def return_some_data(self, ctx):
-            await ctx.send(await config.foo())
+            await ctx.send(await self.config.foo())
 
 ********
 Tutorial
@@ -187,6 +187,7 @@ This usage guide will cover the following features:
 
 - :py:meth:`Group.get_raw`
 - :py:meth:`Group.set_raw`
+- :py:meth:`Group.clear_raw`
 
 For this example let's suppose that we're creating a cog that allows users to buy and own multiple pets using
 the built-in Economy credits::
@@ -290,6 +291,37 @@ We're responsible pet owners here, so we've also got to have a way to feed our p
 
             await ctx.send("Your pet is now at {}/100 hunger!".format(new_hunger)
 
+Of course, if we're less than responsible pet owners, there are consequences::
+
+    #continued
+        @commands.command()
+        async def adopt(self, ctx, pet_name: str, *, member: discord.Member):
+            try:
+                pet = await self.conf.user(member).pets.get_raw(pet_name)
+            except KeyError:
+                await ctx.send("That person doesn't own that pet!")
+                return
+
+            hunger = pet.get("hunger")
+            if hunger < 80:
+                await ctx.send("That pet is too well taken care of to be adopted.")
+                return
+
+            await self.conf.user(member).pets.clear_raw(pet_name)
+
+            # this is equivalent to doing the following
+
+            pets = await self.conf.user(member).pets()
+            del pets[pet_name]
+            await self.conf.user(member).pets.set(pets)
+
+            await self.conf.user(ctx.author).pets.set_raw(pet_name, value=pet)
+            await ctx.send(
+                "Your request to adopt this pet has been granted due to "
+                "how poorly it was taken care of."
+            )
+
+
 *************
 V2 Data Usage
 *************
@@ -342,6 +374,21 @@ API Reference
     inside the bot itself! Simply take a peek inside of the :code:`tests/core/test_config.py` file for examples of using
     Config in all kinds of ways.
 
+.. important::
+
+    When getting, setting or clearing values in Config, all keys are casted to `str` for you. This
+    includes keys within a `dict` when one is being set, as well as keys in  nested dictionaries
+    within that `dict`. For example::
+
+        >>> conf = Config.get_conf(self, identifier=999)
+        >>> conf.register_global(foo={})
+        >>> await conf.foo.set_raw(123, value=True)
+        >>> await conf.foo()
+        {'123': True}
+        >>> await conf.foo.set({123: True, 456: {789: False}}
+        >>> await conf.foo()
+        {'123': True, '456': {'789': False}}
+
 .. automodule:: redbot.core.config
 
 Config

docs/framework_context.rst

@@ -1,10 +0,0 @@
-.. red invocation context documentation
-
-==========================
-Command Invocation Context
-==========================
-
-.. automodule:: redbot.core.context
-
-.. autoclass:: redbot.core.RedContext
-    :members:

docs/framework_downloader.rst

@@ -6,21 +6,35 @@ Downloader Framework
 Info.json
 *********
 
-The info.json file may exist inside every package folder in the repo,
-it is optional however. This string describes the valid keys within
-an info file (and maybe how the Downloader cog uses them).
+The optional info.json file may exist inside every package folder in the repo, 
+as well as in the root of the repo. The following sections describe the valid 
+keys within an info file (and maybe how the Downloader cog uses them).
 
-KEYS (case sensitive):
+Keys common to both repo and cog info.json (case sensitive)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- ``author`` (list of strings) - list of names of authors of the cog
+- ``author`` (list of strings) - list of names of authors of the cog or repo.
+
+- ``description`` (string) - A long description of the cog or repo. For cogs, this 
+  is displayed when a user executes ``!cog info``.
+
+- ``install_msg`` (string) - The message that gets displayed when a cog 
+  is installed or a repo is added
+  
+  .. tip:: You can use the ``[p]`` key in your string to use the prefix
+      used for installing.
+
+- ``short`` (string) - A short description of the cog or repo. For cogs, this info 
+  is displayed when a user executes ``!cog list``
+
+Keys specific to the cog info.json (case sensitive)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - ``bot_version`` (list of integer) - Min version number of Red in the format ``(MAJOR, MINOR, PATCH)``
 
-- ``description`` (string) - A long description of the cog that appears when a user executes ```!cog info``.
+- ``hidden`` (bool) - Determines if a cog is visible in the cog list for a repo.
 
-- ``hidden`` (bool) - Determines if a cog is available for install.
-
-- ``install_msg`` (string) - The message that gets displayed when a cog is installed
+- ``disabled`` (bool) - Determines if a cog is available for install.
 
 - ``required_cogs`` (map of cogname to repo URL) - A map of required cogs that this cog depends on.
   Downloader will not deal with this functionality but it may be useful for other cogs.
@@ -29,9 +43,6 @@ KEYS (case sensitive):
   passed to pip on cog install. ``SHARED_LIBRARIES`` do NOT go in this
   list.
 
-- ``short`` (string) - A short description of the cog that appears when
-  a user executes `!cog list`
-
 - ``tags`` (list of strings) - A list of strings that are related to the
   functionality of the cog. Used to aid in searching.
 

docs/framework_i18n.rst

@@ -13,11 +13,12 @@ Basic Usage
 
 .. code-block:: python
 
-    from discord.ext import commands
-    from redbot.core.i18n import CogI18n
+    from redbot.core import commands
+    from redbot.core.i18n import Translator, cog_i18n
     
-    _ = CogI18n("ExampleCog", __file__)
+    _ = Translator("ExampleCog", __file__)
 
+    @cog_i18n(_)
     class ExampleCog:
         """description"""
 
@@ -39,16 +40,19 @@ In a command prompt in your cog's package (where yourcog.py is),
 create a directory called "locales".
 Then do one of the following:
 
-Windows: :code:`python <your python install path>\Tools\i18n\pygettext.py -n -p locales`
+Windows: :code:`python <your python install path>\Tools\i18n\pygettext.py -D -n -p locales`
 
 Mac: ?
 
-Linux: :code:`pygettext3 -n -p locales`
+Linux: :code:`pygettext3 -D -n -p locales`
 
-This will generate a messages.pot file with strings to be translated
+This will generate a messages.pot file with strings to be translated, including
+docstrings.
 
 -------------
 API Reference
 -------------
 
-.. automodule:: redbot.core.i18n
+.. automodule:: redbot.core.i18n
+    :members:
+    :special-members: __call__

docs/framework_rpc.rst

@@ -4,5 +4,60 @@
 RPC
 ===
 
-.. automodule:: redbot.core.rpc
-    :members:
+V3 comes default with an internal RPC server that may be used to remotely control the bot in various ways.
+Cogs must register functions to be exposed to RPC clients.
+Each of those functions must only take JSON serializable parameters and must return JSON serializable objects.
+
+To enable the internal RPC server you must start the bot with the ``--rpc`` flag.
+
+********
+Examples
+********
+
+.. code-block:: Python
+
+    def setup(bot):
+        c = Cog()
+        bot.add_cog(c)
+        bot.register_rpc_handler(c.rpc_method)
+
+*******************************
+Interacting with the RPC Server
+*******************************
+
+The RPC server opens a websocket bound to port ``6133`` on ``127.0.0.1``.
+This is not configurable for security reasons as broad access to this server gives anyone complete control over your bot.
+To access the server you must find a library that implements websocket based JSONRPC in the language of your choice.
+
+There are a few built-in RPC methods to note:
+
+* ``GET_METHODS`` - Returns a list of available RPC methods.
+* ``GET_METHOD_INFO`` - Will return the docstring for an available RPC method. Useful for finding information about the method's parameters and return values.
+* ``GET_TOPIC`` - Returns a list of available RPC message topics.
+* ``GET_SUBSCRIPTIONS`` - Returns a list of RPC subscriptions.
+* ``SUBSCRIBE`` - Subscribes to an available RPC message topic.
+* ``UNSUBSCRIBE`` - Unsubscribes from an RPC message topic.
+
+All RPC methods accept a list of parameters.
+The built-in methods above expect their parameters to be in list format.
+
+All cog-based methods expect their parameter list to take one argument, a JSON object, in the following format::
+
+    params = [
+        {
+            "args": [],  # A list of positional arguments
+            "kwargs": {},  # A dictionary of keyword arguments
+        }
+    ]
+
+    # As an example, here's a call to "get_method_info"
+    rpc_call("GET_METHOD_INFO", ["get_methods",])
+
+    # And here's a call to "core__load"
+    rpc_call("CORE__LOAD", {"args": [["general", "economy", "downloader"],], "kwargs": {}})
+
+*************
+API Reference
+*************
+
+Please see the :class:`redbot.core.bot.RedBase` class for details on the RPC handler register and unregister methods.

docs/framework_utils.rst

@@ -4,6 +4,12 @@
 Utility Functions
 =================
 
+General Utility
+===============
+
+.. automodule:: redbot.core.utils
+    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter
+
 Chat Formatting
 ===============
 
@@ -16,6 +22,18 @@ Embed Helpers
 .. automodule:: redbot.core.utils.embed
     :members:
 
+Reaction Menus
+==============
+
+.. automodule:: redbot.core.utils.menus
+    :members:
+
+Event Predicates
+================
+
+.. automodule:: redbot.core.utils.predicates
+    :members:
+
 Mod Helpers
 ===========
 
@@ -32,4 +50,10 @@ Tunnel
 ======
 
 .. automodule:: redbot.core.utils.tunnel
-    :members: Tunnel
+    :members: Tunnel
+
+Common Filters
+==============
+
+.. automodule:: redbot.core.utils.common_filters
+    :members:

docs/guide_cog_creation.rst

@@ -17,11 +17,10 @@ you in the process.
 Getting started
 ---------------
 
-To start off, be sure that you have installed Python 3.5 or higher (if you
-are on Windows, stick with 3.5). Open a terminal or command prompt and type
-:code:`pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=redbot[test]`
+To start off, be sure that you have installed Python 3.6.2 or higher (3.6.6 or higher on Windows).
+Open a terminal or command prompt and type :code:`pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=redbot[test]`
 (note that if you get an error with this, try again but put :code:`python -m` in front of the command
-This will install the latest version of V3. 
+This will install the latest version of V3.
 
 --------------------
 Setting up a package
@@ -45,7 +44,7 @@ In that file, place the following code:
 
 .. code-block:: python
 
-    from discord.ext import commands
+    from redbot.core import commands
 
     class Mycog:
         """My custom cog"""
@@ -90,6 +89,6 @@ have successfully created a cog!
 Additional resources
 --------------------
 
-Be sure to check out the `migration guide </guide_migration>`_ for some resources
+Be sure to check out the :doc:`/guide_migration` for some resources
 on developing cogs for V3. This will also cover differences between V2 and V3 for
 those who developed cogs for V2.

docs/index.rst

@@ -11,12 +11,8 @@ Welcome to Red - Discord Bot's documentation!
     :caption: Installation Guides:
 
     install_windows
-    install_mac
-    install_ubuntu
-    install_debian
-    install_centos
-    install_arch
-    install_raspbian
+    install_linux_mac
+    venv_guide
     cog_dataconverter
     autostart_systemd
 
@@ -24,7 +20,9 @@ Welcome to Red - Discord Bot's documentation!
     :maxdepth: 2
     :caption: Cog Reference:
 
+    cog_customcom
     cog_downloader
+    cog_permissions
 
 .. toctree::
     :maxdepth: 2
@@ -35,9 +33,10 @@ Welcome to Red - Discord Bot's documentation!
     guide_data_conversion
     framework_bank
     framework_bot
+    framework_checks
     framework_cogmanager
+    framework_commands
     framework_config
-    framework_context
     framework_datamanager
     framework_downloader
     framework_events

docs/install_arch.rst

@@ -1,55 +0,0 @@
-.. arch install guide
-
-==============================
-Installing Red on Arch Linux
-==============================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, make a new one.
-
-:code:`https://wiki.archlinux.org/index.php/Users_and_groups`
-
--------------------------------
-Installing the pre-requirements
--------------------------------
-
-.. code-block:: none
-
-    sudo pacman -Sy python-pip git base-devel jre8-openjdk
-
-------------------
-Installing the bot
-------------------
-
-To install without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot --user`
-
-To install with audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice] --user`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot --user`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice] --user`
-
-------------------------
-Setting up your instance
-------------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_centos.rst

@@ -1,56 +0,0 @@
-.. centos install guide
-
-==========================
-Installing Red on CentOS 7
-==========================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/4/html/Step_by_Step_Guide/s1-starting-create-account.html>`_.
-
----------------------------
-Installing pre-requirements
----------------------------
-
-.. code-block:: none
-
-    yum -y groupinstall development
-    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
-    yum -y install yum-utils wget which python35u python35u-pip python35u-devel openssl-devel libffi-devel git java-1.8.0-openjdk
-    sh -c "$(wget https://gist.githubusercontent.com/mustafaturan/7053900/raw/27f4c8bad3ee2bb0027a1a52dc8501bf1e53b270/latest-ffmpeg-centos6.sh -O -)"
-
---------------
-Installing Red
---------------
-
-Without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot --user`
-
-With audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice] --user`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot --user`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice] --user`
-
-----------------------
-Setting up an instance
-----------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_debian.rst

@@ -1,55 +0,0 @@
-.. debian install guide
-
-================================
-Installing Red on Debian Stretch
-================================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one <https://manpages.debian.org/stretch/adduser/adduser.8.en.html>`_.
-
----------------------------
-Installing pre-requirements
----------------------------
-
-.. code-block:: none
-
-    echo "deb http://httpredir.debian.org/debian stretch-backports main contrib non-free" >> /etc/apt/sources.list
-    apt-get update
-    apt-get install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y
-
-------------------
-Installing the bot
-------------------
-
-To install without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot`
-
-To install with audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
-
-------------------------
-Setting up your instance
-------------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_linux_mac.rst

@@ -0,0 +1,203 @@
+.. _linux-mac-install-guide:
+
+==============================
+Installing Red on Linux or Mac
+==============================
+
+.. warning::
+
+    For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
+    a new user, see the man page for the ``useradd`` command.
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Please install the pre-requirements using the commands listed for your operating system.
+
+The pre-requirements are:
+ - Python 3.6.2 or greater
+ - pip 9.0 or greater
+ - git
+ - Java Runtime Environment 8 or later (for audio support)
+
+~~~~~~~~~~
+Arch Linux
+~~~~~~~~~~
+
+.. code-block:: none
+
+    sudo pacman -Syu python-pip git base-devel jre8-openjdk
+
+~~~~~~~~
+CentOS 7
+~~~~~~~~
+
+.. code-block:: none
+
+    yum -y groupinstall development
+    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
+    yum -y install yum-utils wget which python36u python36u-pip python36u-devel openssl-devel libffi-devel git java-1.8.0-openjdk
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Debian and Raspbian Stretch
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. warning::
+
+    Audio will not work on Raspberry Pi's **below** 2B. This is a CPU problem and
+    *cannot* be fixed.
+
+We recommend installing pyenv as a method of installing non-native versions of python on
+Debian/Raspbian Stretch. This guide will tell you how. First, run the following commands:
+
+.. code-block:: none
+
+    sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev git unzip default-jre
+    curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash
+
+After that last command, you may see a warning about 'pyenv' not being in the load path. Follow the
+instructions given to fix that, then close and reopen your shell.
+
+Then run the following command:
+
+.. code-block:: none
+
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.7.0 -v
+
+This may take a long time to complete.
+
+After that is finished, run:
+
+.. code-block:: none
+
+    pyenv global 3.7.0
+
+Pyenv is now installed and your system should be configured to run Python 3.7.
+
+~~~
+Mac
+~~~
+
+Install Brew: in Finder or Spotlight, search for and open *Terminal*. In the terminal, paste the
+following, then press Enter:
+
+.. code-block:: none
+
+    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+After the installation, install the required packages by pasting the commands and pressing enter,
+one-by-one:
+
+.. code-block:: none
+
+    brew install python3 --with-brewed-openssl
+    brew install git
+    brew tap caskroom/versions
+    brew cask install java8
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Ubuntu 18.04 Bionic Beaver
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+    sudo apt install python3.6-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y
+
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Ubuntu 16.04 Xenial Xerus
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We recommend adding the ``deadsnakes`` apt repository to install Python 3.6.2 or greater:
+
+.. code-block:: none
+
+    sudo apt install software-properties-common
+    sudo add-apt-repository ppa:deadsnakes/ppa
+    sudo apt update
+
+Now, install python, pip, git and java with the following commands:
+
+.. code-block:: none
+
+    sudo apt install python3.6-dev build-essential libssl-dev libffi-dev git unzip default-jre wget -y
+    wget https://bootstrap.pypa.io/get-pip.py
+    sudo python3.6 get-pip.py
+
+------------------------------
+Creating a Virtual Environment
+------------------------------
+
+We **strongly** recommend installing Red into a virtual environment. See the section
+`installing-in-virtual-environment`.
+
+.. _installing-red-linux-mac:
+
+--------------
+Installing Red
+--------------
+
+Choose one of the following commands to install Red.
+
+.. note::
+
+    If you're not inside an activated virtual environment, include the ``--user`` flag with all
+    ``pip3`` commands.
+
+To install without audio support:
+
+.. code-block:: none
+
+    pip3 install -U --process-dependency-links --no-cache-dir Red-DiscordBot
+
+Or, to install with audio support:
+
+.. code-block:: none
+
+    pip3 install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice]
+
+Or, install with audio and MongoDB support:
+
+.. code-block:: none
+
+    pip3 install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice,mongo]
+
+.. note::
+
+  To install the development version, replace ``Red-DiscordBot`` in the above commands with the
+  following link:
+
+  .. code-block:: none
+
+      git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
+
+--------------------------
+Setting Up and Running Red
+--------------------------
+
+After installation, set up your instance with the following command:
+
+.. code-block:: none
+
+    redbot-setup
+
+This will set the location where data will be stored, as well as your
+storage backend and the name of the instance (which will be used for
+running the bot).
+
+Once done setting up the instance, run the following command to run Red:
+
+.. code-block:: none
+
+    redbot <your instance name>
+
+It will walk through the initial setup, asking for your token and a prefix.
+
+You may also run Red via the launcher, which allows you to restart the bot
+from discord, and enable auto-restart. You may also update the bot from the
+launcher menu. Use the following command to run the launcher:
+
+.. code-block:: none
+
+    redbot-launcher
+

docs/install_mac.rst

@@ -1,53 +0,0 @@
-.. mac install guide
-
-=====================
-Installing Red on Mac
-=====================
-
----------------------------
-Installing pre-requirements
----------------------------
-
-* Install Brew
-    * In Finder or Spotlight, search for and open terminal. In the window that will open, paste this:
-      :code:`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
-      and press enter.
-* After the installation, install the required packages by pasting the commands and pressing enter, one-by-one:
-    * :code:`brew install python3 --with-brewed-openssl`
-    * :code:`brew install git`
-    * :code:`brew tap caskroom/versions`
-    * :code:`brew cask install java8`
-
---------------
-Installing Red
---------------
-
-Without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot`
-
-With audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
-
-----------------------
-Setting up an instance
-----------------------
-
-To set up an instance, run :code:`redbot-setup` and follow the steps there, providing the requested information
-or accepting the defaults. Keep in mind that the instance name will be the one you use when running the bot, so
-make it something you can remember
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and go through the initial setup (it will ask for the token and a prefix).

docs/install_raspbian.rst

@@ -1,56 +0,0 @@
-.. raspbian install guide
-
-==================================
-Installing Red on Raspbian Stretch
-==================================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one <https://www.raspberrypi.org/documentation/linux/usage/users.md>`_.
-
----------------------------
-Installing pre-requirements
----------------------------
-
-.. code-block:: none
-
-    sudo apt-get install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y
-
-
---------------
-Installing Red
---------------
-
-Without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot --user`
-
-With audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice] --user`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot --user`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice] --user`
-
-----------------------
-Setting up an instance
-----------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.
-
-.. warning:: Audio will not work on Raspberry Pi's **below** 2B. This is a CPU problem and *cannot* be fixed.

docs/install_ubuntu.rst

@@ -1,54 +0,0 @@
-.. ubuntu install guide
-
-==============================
-Installing Red on Ubuntu 16.04
-==============================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, `make a new one <http://manpages.ubuntu.com/manpages/artful/man8/adduser.8.html>`_.
-
--------------------------------
-Installing the pre-requirements
--------------------------------
-
-.. code-block:: none
-
-    sudo apt install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y
-
-
-------------------
-Installing the bot
-------------------
-
-To install without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot --user`
-
-To install with audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice] --user`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot --user`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice] --user`
-
-------------------------
-Setting up your instance
-------------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_windows.rst

@@ -1,4 +1,4 @@
-.. windows installation docs
+.. _windows-install-guide:
 
 =========================
 Installing Red on Windows
@@ -8,11 +8,7 @@ Installing Red on Windows
 Needed Software
 ---------------
 
-* `Python <https://python.org/downloads/>`_ - Red needs at least Python 3.5
-
-.. attention:: Please note that 3.6 has issues on some versions of Windows.
-               If you try using Red with 3.6 and experience issues, uninstall
-               Python 3.6 and install the latest version of Python 3.5
+* `Python <https://www.python.org/downloads/>`_ - Red needs Python 3.6.6 or greater on Windows
 
 .. note:: Please make sure that the box to add Python to PATH is CHECKED, otherwise
           you may run into issues when trying to run Red
@@ -25,23 +21,74 @@ Needed Software
 
 .. attention:: Please choose the "Windows Online" installer
 
+.. _installing-red-windows:
+
 --------------
 Installing Red
 --------------
 
 1. Open a command prompt (open Start, search for "command prompt", then click it)
-2. Run the appropriate command, depending on if you want audio or not
+2. Create and activate a virtual environment (strongly recommended), see the section `using-venv`
+3. Run **one** of the following commands, depending on what extras you want installed
 
-  * No audio: :code:`python -m pip install -U --process-dependency-links Red-DiscordBot`
-  * Audio: :code:`python -m pip install -U --process-dependency-links Red-DiscordBot[voice]`
-  * Development version (without audio): :code:`python -m pip install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-  * Development version (with audio): :code:`python -m pip install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
+  .. note::
 
-3. Once that has completed, run :code:`redbot-setup` to set up your instance
+      If you're not inside an activated virtual environment, include the ``--user`` flag with all
+      ``pip`` commands.
 
-  * This will set the location where data will be stored, as well as your
-    storage backend and the name of the instance (which will be used for
-    running the bot)
+  * No audio:
 
-4. Once done setting up the instance, run :code:`redbot <your instance name>` to run Red.
-   It will walk through the initial setup, asking for your token and a prefix
+    .. code-block:: none
+
+        python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot
+
+  * With audio:
+
+    .. code-block:: none
+
+        python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice]
+
+  * With audio and MongoDB support:
+
+    .. code-block:: none
+
+        python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice,mongo]
+
+  .. note::
+
+      To install the development version, replace ``Red-DiscordBot`` in the above commands with the
+      following link:
+
+      .. code-block:: none
+
+          git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
+
+--------------------------
+Setting Up and Running Red
+--------------------------
+
+After installation, set up your instance with the following command:
+
+.. code-block:: none
+
+    redbot-setup
+
+This will set the location where data will be stored, as well as your
+storage backend and the name of the instance (which will be used for
+running the bot).
+
+Once done setting up the instance, run the following command to run Red:
+
+.. code-block:: none
+
+    redbot <your instance name>
+
+It will walk through the initial setup, asking for your token and a prefix.
+
+You may also run Red via the launcher, which allows you to restart the bot
+from discord, and enable auto-restart. You may also update the bot from the
+launcher menu. Use the following command to run the launcher:
+
+.. code-block:: none
+
+    redbot-launcher

docs/requirements.txt

@@ -1,4 +0,0 @@
-sphinx==1.6.5
-sphinxcontrib-asyncio
-sphinx_rtd_theme
-git+https://github.com/Rapptz/discord.py@rewrite#egg=discord.py[voice]

docs/venv_guide.rst

@@ -0,0 +1,132 @@
+.. _installing-in-virtual-environment:
+
+=======================================
+Installing Red in a Virtual Environment
+=======================================
+Virtual environments allow you to isolate red's library dependencies, cog dependencies and python
+binaries from the rest of your system. It is strongly recommended you use this if you use python
+for more than just Red.
+
+.. _using-venv:
+
+--------------
+Using ``venv``
+--------------
+This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
+python.
+
+First, choose a directory where you would like to create your virtual environment. It's a good idea
+to keep it in a location which is easy to type out the path to. From now, we'll call it
+``path/to/venv/`` (or ``path\to\venv\`` on Windows).
+
+~~~~~~~~~~~~~~~~~~~~~~~~
+``venv`` on Linux or Mac
+~~~~~~~~~~~~~~~~~~~~~~~~
+Create your virtual environment with the following command::
+
+    python3 -m venv path/to/venv/
+
+And activate it with the following command::
+
+    source path/to/venv/bin/activate
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red.
+
+Continue reading `below <after-activating-virtual-environment>`.
+
+~~~~~~~~~~~~~~~~~~~
+``venv`` on Windows
+~~~~~~~~~~~~~~~~~~~
+Create your virtual environment with the following command::
+
+    python -m venv path\to\venv\
+
+And activate it with the following command::
+
+    path\to\venv\Scripts\activate.bat
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    Command Prompt to run, install or update Red.
+
+Continue reading `below <after-activating-virtual-environment>`.
+
+.. _using-pyenv-virtualenv:
+
+--------------------------
+Using ``pyenv virtualenv``
+--------------------------
+
+.. note::
+
+    This is for non-Windows users only.
+
+Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
+environments. If you haven't already, install pyenv with `pyenv-installer`_.
+
+First, ensure your pyenv interpreter is set to python 3.6.2 or greater with the following command::
+
+    pyenv version
+
+Now, create a virtual environment with the following command::
+
+    pyenv virtualenv <name>
+
+Replace ``<name>`` with whatever you like. If you forget what you named it, use the command ``pyenv
+versions``.
+
+Now activate your virtualenv with the following command::
+
+    pyenv shell <name>
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red.
+
+Continue reading `below <after-activating-virtual-environment>`.
+
+.. _pyenv-installer: https://github.com/pyenv/pyenv-installer/blob/master/README.rst
+
+----
+
+.. _after-activating-virtual-environment:
+
+Once activated, your ``PATH`` environment variable will be modified to use the virtual
+environment's python executables, as well as other executables like ``pip``.
+
+From here, install Red using the commands listed on your installation guide (`Windows
+<installing-red-windows>` or `Non-Windows <installing-red-linux-mac>`).
+
+.. note::
+
+    The alternative to activating the virtual environment each time you open a new shell is to
+    provide the full path to the executable. This will automatically use the virtual environment's
+    python interpreter and installed libraries.
+
+--------------------------------------------
+Virtual Environments with Multiple Instances
+--------------------------------------------
+If you are running multiple instances of Red on the same machine, you have the option of either
+using the same virtual environment for all of them, or creating separate ones.
+
+.. note::
+
+    This only applies for multiple instances of V3. If you are running a V2 instance as well,
+    You **must** use separate virtual environments.
+
+The advantages of using a *single* virtual environment for all of your V3 instances are:
+
+- When updating Red, you will only need to update it once for all instances (however you will still need to restart all instances for the changes to take effect)
+- It will save space on your hard drive
+
+On the other hand, you may wish to update each of your instances individually.
+
+.. important::
+
+    Windows users with multiple instances should create *separate* virtual environments, as
+    updating multiple running instances at once is likely to cause errors.

generate_strings.py

@@ -1,33 +0,0 @@
-import subprocess
-import os
-import sys
-
-
-def main():
-    interpreter = sys.executable
-    print(interpreter)
-    root_dir = os.getcwd()
-    cogs = [i for i in os.listdir("redbot/cogs") if os.path.isdir(os.path.join("redbot/cogs", i))]
-    for d in cogs:
-        if "locales" in os.listdir(os.path.join("redbot/cogs", d)):
-            os.chdir(os.path.join("redbot/cogs", d, "locales"))
-            if "regen_messages.py" not in os.listdir(os.getcwd()):
-                print("Directory 'locales' exists for {} but no 'regen_messages.py' is available!".format(d))
-                exit(1)
-            else:
-                print("Running 'regen_messages.py' for {}".format(d))
-                retval = subprocess.run([interpreter, "regen_messages.py"])
-                if retval.returncode != 0:
-                    exit(1)
-                os.chdir(root_dir)
-    os.chdir("redbot/core/locales")
-    print("Running 'regen_messages.py' for core")
-    retval = subprocess.run([interpreter, "regen_messages.py"])
-    if retval.returncode != 0:
-        exit(1)
-    os.chdir(root_dir)
-    subprocess.run(["crowdin", "upload"])
-
-
-if __name__ == "__main__":
-    main()

make.bat

@@ -0,0 +1,30 @@
+@echo off
+
+if "%1"=="" goto help
+
+REM This allows us to expand variables at execution
+setlocal ENABLEDELAYEDEXPANSION
+
+REM This will set PYFILES as a list of tracked .py files
+set PYFILES=
+for /F "tokens=* USEBACKQ" %%A in (`git ls-files "*.py"`) do (
+    set PYFILES=!PYFILES! %%A
+)
+
+goto %1
+
+:reformat
+black -l 99 -N !PYFILES!
+exit /B %ERRORLEVEL%
+
+:stylecheck
+black -l 99 -N --check !PYFILES!
+exit /B %ERRORLEVEL%
+
+:help
+echo Usage:
+echo   make ^<command^>
+echo.
+echo Commands:
+echo   reformat                   Reformat all .py files being tracked by git.
+echo   stylecheck                 Check which tracked .py files need reformatting.

redbot/__init__.py

@@ -1,11 +1,34 @@
 import sys
-import typing
+import warnings
 import discord
+import colorama
 
 # Let's do all the dumb version checking in one place.
+if sys.platform == "win32":
+    # Due to issues with ProactorEventLoop prior to 3.6.6 (bpo-26819)
+    MIN_PYTHON_VERSION = (3, 6, 6)
+else:
+    MIN_PYTHON_VERSION = (3, 6, 2)
+
+if sys.version_info < MIN_PYTHON_VERSION:
+    print(
+        f"Python {'.'.join(map(str, MIN_PYTHON_VERSION))} is required to run Red, but you have "
+        f"{sys.version}! Please update Python."
+    )
+    sys.exit(1)
 
 if discord.version_info.major < 1:
-    print("You are not running the rewritten version of discord.py.\n\n"
-          "In order to use Red v3 you MUST be running d.py version"
-          " >= 1.0.0.")
+    print(
+        "You are not running the rewritten version of discord.py.\n\n"
+        "In order to use Red V3 you MUST be running d.py version "
+        "1.0.0 or greater."
+    )
     sys.exit(1)
+
+
+colorama.init()
+
+# Filter fuzzywuzzy slow sequence matcher warning
+warnings.filterwarnings("ignore", module=r"fuzzywuzzy.*")
+# Prevent discord PyNaCl missing warning
+discord.voice_client.VoiceClient.warn_nacl = False

redbot/__main__.py

@@ -6,19 +6,31 @@ import sys
 import discord
 from redbot.core.bot import Red, ExitCodes
 from redbot.core.cog_manager import CogManagerUI
-from redbot.core.data_manager import load_basic_configuration, config_file
+from redbot.core.data_manager import create_temp_config, load_basic_configuration, config_file
 from redbot.core.json_io import JsonIO
 from redbot.core.global_checks import init_global_checks
 from redbot.core.events import init_events
 from redbot.core.cli import interactive_config, confirm, parse_cli_flags, ask_sentry
 from redbot.core.core_commands import Core
 from redbot.core.dev_commands import Dev
-from redbot.core import rpc, __version__
+from redbot.core import __version__
 import asyncio
 import logging.handlers
 import logging
 import os
 
+# Let's not force this dependency, uvloop is much faster on cpython
+if sys.implementation.name == "cpython":
+    try:
+        import uvloop
+    except ImportError:
+        pass
+    else:
+        asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
+
+if sys.platform == "win32":
+    asyncio.set_event_loop(asyncio.ProactorEventLoop())
+
 
 #
 #               Red - Discord Bot v3
@@ -40,24 +52,25 @@ def init_loggers(cli_flags):
     logger = logging.getLogger("red")
 
     red_format = logging.Formatter(
-        '%(asctime)s %(levelname)s %(module)s %(funcName)s %(lineno)d: '
-        '%(message)s',
-        datefmt="[%d/%m/%Y %H:%M]")
+        "%(asctime)s %(levelname)s %(module)s %(funcName)s %(lineno)d: %(message)s",
+        datefmt="[%d/%m/%Y %H:%M]",
+    )
 
     stdout_handler = logging.StreamHandler(sys.stdout)
     stdout_handler.setFormatter(red_format)
 
     if cli_flags.debug:
-        os.environ['PYTHONASYNCIODEBUG'] = '1'
+        os.environ["PYTHONASYNCIODEBUG"] = "1"
         logger.setLevel(logging.DEBUG)
     else:
-        logger.setLevel(logging.WARNING)
+        logger.setLevel(logging.INFO)
 
     from redbot.core.data_manager import core_data_path
-    logfile_path = core_data_path() / 'red.log'
+
+    logfile_path = core_data_path() / "red.log"
     fhandler = logging.handlers.RotatingFileHandler(
-        filename=str(logfile_path), encoding='utf-8', mode='a',
-        maxBytes=10**7, backupCount=5)
+        filename=str(logfile_path), encoding="utf-8", mode="a", maxBytes=10 ** 7, backupCount=5
+    )
     fhandler.setFormatter(red_format)
 
     logger.addHandler(fhandler)
@@ -76,15 +89,17 @@ async def _get_prefix_and_token(red, indict):
     :param indict:
     :return:
     """
-    indict['token'] = await red.db.token()
-    indict['prefix'] = await red.db.prefix()
-    indict['enable_sentry'] = await red.db.enable_sentry()
+    indict["token"] = await red.db.token()
+    indict["prefix"] = await red.db.prefix()
+    indict["enable_sentry"] = await red.db.enable_sentry()
 
 
 def list_instances():
     if not config_file.exists():
-        print("No instances have been configured! Configure one "
-              "using `redbot-setup` before trying to run the bot!")
+        print(
+            "No instances have been configured! Configure one "
+            "using `redbot-setup` before trying to run the bot!"
+        )
         sys.exit(1)
     else:
         data = JsonIO(config_file)._load_json()
@@ -103,12 +118,20 @@ def main():
     elif cli_flags.version:
         print(description)
         sys.exit(0)
-    elif not cli_flags.instance_name:
+    elif not cli_flags.instance_name and not cli_flags.no_instance:
         print("Error: No instance name was provided!")
         sys.exit(1)
+    if cli_flags.no_instance:
+        print(
+            "\033[1m"
+            "Warning: The data will be placed in a temporary folder and removed on next system reboot."
+            "\033[0m"
+        )
+        cli_flags.instance_name = "temporary_red"
+        create_temp_config()
     load_basic_configuration(cli_flags.instance_name)
     log, sentry_log = init_loggers(cli_flags)
-    red = Red(cli_flags, description=description, pm_help=None)
+    red = Red(cli_flags=cli_flags, description=description, pm_help=None)
     init_global_checks(red)
     init_events(red, cli_flags)
     red.add_cog(Core(red))
@@ -118,30 +141,30 @@ def main():
     loop = asyncio.get_event_loop()
     tmp_data = {}
     loop.run_until_complete(_get_prefix_and_token(red, tmp_data))
-    token = os.environ.get("RED_TOKEN", tmp_data['token'])
-    prefix = cli_flags.prefix or tmp_data['prefix']
-    if token is None or not prefix:
+    token = os.environ.get("RED_TOKEN", tmp_data["token"])
+    if cli_flags.token:
+        token = cli_flags.token
+    prefix = cli_flags.prefix or tmp_data["prefix"]
+    if not (token and prefix):
         if cli_flags.no_prompt is False:
-            new_token = interactive_config(red, token_set=bool(token),
-                                           prefix_set=bool(prefix))
+            new_token = interactive_config(red, token_set=bool(token), prefix_set=bool(prefix))
             if new_token:
                 token = new_token
         else:
             log.critical("Token and prefix must be set in order to login.")
             sys.exit(1)
     loop.run_until_complete(_get_prefix_and_token(red, tmp_data))
-    if tmp_data['enable_sentry']:
+
+    if cli_flags.dry_run:
+        loop.run_until_complete(red.http.close())
+        sys.exit(0)
+    if tmp_data["enable_sentry"]:
         red.enable_sentry()
-    cleanup_tasks = True
     try:
-        loop.run_until_complete(red.start(token, bot=not cli_flags.not_bot))
+        loop.run_until_complete(red.start(token, bot=True))
     except discord.LoginFailure:
-        cleanup_tasks = False  # No login happened, no need for this
-        log.critical("This token doesn't seem to be valid. If it belongs to "
-                     "a user account, remember that the --not-bot flag "
-                     "must be used. For self-bot functionalities instead, "
-                     "--self-bot")
-        db_token = red.db.token()
+        log.critical("This token doesn't seem to be valid.")
+        db_token = loop.run_until_complete(red.db.token())
         if db_token and not cli_flags.no_prompt:
             print("\nDo you want to reset the token? (y/n)")
             if confirm("> "):
@@ -156,15 +179,16 @@ def main():
         sentry_log.critical("Fatal Exception", exc_info=e)
         loop.run_until_complete(red.logout())
     finally:
-        rpc.clean_up()
-        if cleanup_tasks:
-            pending = asyncio.Task.all_tasks(loop=red.loop)
-            gathered = asyncio.gather(
-                *pending, loop=red.loop, return_exceptions=True)
-            gathered.cancel()
+        pending = asyncio.Task.all_tasks(loop=red.loop)
+        gathered = asyncio.gather(*pending, loop=red.loop, return_exceptions=True)
+        gathered.cancel()
+        try:
+            red.rpc.server.close()
+        except AttributeError:
+            pass
 
         sys.exit(red._shutdown_mode.value)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

redbot/cogs/admin/admin.py

@@ -1,57 +1,60 @@
+import logging
 from typing import Tuple
 
 import discord
-from discord.ext import commands
-
-from redbot.core import Config, checks
-
-import logging
 
+from redbot.core import Config, checks, commands
+from redbot.core.i18n import Translator, cog_i18n
 from redbot.core.utils.chat_formatting import box
 from .announcer import Announcer
 from .converters import MemberDefaultAuthor, SelfRole
 
 log = logging.getLogger("red.admin")
 
-GENERIC_FORBIDDEN = (
+T_ = Translator("Admin", __file__)
+
+_ = lambda s: s
+GENERIC_FORBIDDEN = _(
     "I attempted to do something that Discord denied me permissions for."
     " Your command failed to successfully complete."
 )
 
-HIERARCHY_ISSUE = (
+HIERARCHY_ISSUE = _(
     "I tried to add {role.name} to {member.display_name} but that role"
-    " is higher than my highest role in the Discord heirarchy so I was"
+    " is higher than my highest role in the Discord hierarchy so I was"
     " unable to successfully add it. Please give me a higher role and "
     "try again."
 )
 
-USER_HIERARCHY_ISSUE = (
+USER_HIERARCHY_ISSUE = _(
     "I tried to add {role.name} to {member.display_name} but that role"
-    " is higher than your highest role in the Discord heirarchy so I was"
+    " is higher than your highest role in the Discord hierarchy so I was"
     " unable to successfully add it. Please get a higher role and "
     "try again."
 )
 
-RUNNING_ANNOUNCEMENT = (
+RUNNING_ANNOUNCEMENT = _(
     "I am already announcing something. If you would like to make a"
     " different announcement please use `{prefix}announce cancel`"
     " first."
 )
+_ = T_
 
 
-class Admin:
+@cog_i18n(_)
+class Admin(commands.Cog):
+    """A collection of server administration utilities."""
+
     def __init__(self, config=Config):
-        self.conf = config.get_conf(self, 8237492837454039,
-                                    force_registration=True)
+        super().__init__()
+        self.conf = config.get_conf(self, 8237492837454039, force_registration=True)
 
-        self.conf.register_global(
-            serverlocked=False
-        )
+        self.conf.register_global(serverlocked=False)
 
         self.conf.register_guild(
             announce_ignore=False,
             announce_channel=None,  # Integer ID
-            selfroles=[]  # List of integer ID's
+            selfroles=[],  # List of integer ID's
         )
 
         self.__current_announcer = None
@@ -63,8 +66,7 @@ class Admin:
             pass
 
     @staticmethod
-    async def complain(ctx: commands.Context, message: str,
-                       **kwargs):
+    async def complain(ctx: commands.Context, message: str, **kwargs):
         await ctx.send(message.format(**kwargs))
 
     def is_announcing(self) -> bool:
@@ -78,8 +80,7 @@ class Admin:
         return self.__current_announcer.active or False
 
     @staticmethod
-    def pass_heirarchy_check(ctx: commands.Context,
-                             role: discord.Role) -> bool:
+    def pass_hierarchy_check(ctx: commands.Context, role: discord.Role) -> bool:
         """
         Determines if the bot has a higher role than the given one.
         :param ctx:
@@ -89,8 +90,7 @@ class Admin:
         return ctx.guild.me.top_role > role
 
     @staticmethod
-    def pass_user_heirarchy_check(ctx: commands.Context,
-                                  role: discord.Role) -> bool:
+    def pass_user_hierarchy_check(ctx: commands.Context, role: discord.Role) -> bool:
         """
         Determines if a user is allowed to add/remove/edit the given role.
         :param ctx:
@@ -99,197 +99,193 @@ class Admin:
         """
         return ctx.author.top_role > role
 
-    async def _addrole(self, ctx: commands.Context, member: discord.Member,
-                       role: discord.Role):
+    async def _addrole(self, ctx: commands.Context, member: discord.Member, role: discord.Role):
         try:
             await member.add_roles(role)
         except discord.Forbidden:
-            if not self.pass_heirarchy_check(ctx, role):
-                await self.complain(ctx, HIERARCHY_ISSUE, role=role,
-                                    member=member)
+            if not self.pass_hierarchy_check(ctx, role):
+                await self.complain(ctx, T_(HIERARCHY_ISSUE), role=role, member=member)
             else:
-                await self.complain(ctx, GENERIC_FORBIDDEN)
+                await self.complain(ctx, T_(GENERIC_FORBIDDEN))
         else:
-            await ctx.send("I successfully added {role.name} to"
-                           " {member.display_name}".format(
-                               role=role, member=member
-                           ))
+            await ctx.send(
+                _("I successfully added {role.name} to {member.display_name}").format(
+                    role=role, member=member
+                )
+            )
 
-    async def _removerole(self, ctx: commands.Context, member: discord.Member,
-                          role: discord.Role):
+    async def _removerole(self, ctx: commands.Context, member: discord.Member, role: discord.Role):
         try:
             await member.remove_roles(role)
         except discord.Forbidden:
-            if not self.pass_heirarchy_check(ctx, role):
-                await self.complain(ctx, HIERARCHY_ISSUE, role=role,
-                                    member=member)
+            if not self.pass_hierarchy_check(ctx, role):
+                await self.complain(ctx, T_(HIERARCHY_ISSUE), role=role, member=member)
             else:
-                await self.complain(ctx, GENERIC_FORBIDDEN)
+                await self.complain(ctx, T_(GENERIC_FORBIDDEN))
         else:
-            await ctx.send("I successfully removed {role.name} from"
-                           " {member.display_name}".format(
-                               role=role, member=member
-                           ))
+            await ctx.send(
+                _("I successfully removed {role.name} from {member.display_name}").format(
+                    role=role, member=member
+                )
+            )
 
     @commands.command()
     @commands.guild_only()
     @checks.admin_or_permissions(manage_roles=True)
-    async def addrole(self, ctx: commands.Context, rolename: discord.Role, *,
-                      user: MemberDefaultAuthor=None):
-        """
-        Adds a role to a user. If user is left blank it defaults to the
-            author of the command.
+    async def addrole(
+        self, ctx: commands.Context, rolename: discord.Role, *, user: MemberDefaultAuthor = None
+    ):
+        """Add a role to a user.
+
+        If user is left blank it defaults to the author of the command.
         """
         if user is None:
             user = ctx.author
-        if self.pass_user_heirarchy_check(ctx, rolename):
+        if self.pass_user_hierarchy_check(ctx, rolename):
             # noinspection PyTypeChecker
             await self._addrole(ctx, user, rolename)
         else:
-            await self.complain(ctx, USER_HIERARCHY_ISSUE, member=ctx.author)
+            await self.complain(ctx, T_(USER_HIERARCHY_ISSUE), member=ctx.author, role=rolename)
 
     @commands.command()
     @commands.guild_only()
     @checks.admin_or_permissions(manage_roles=True)
-    async def removerole(self, ctx: commands.Context, rolename: discord.Role, *,
-                         user: MemberDefaultAuthor=None):
-        """
-        Removes a role from a user. If user is left blank it defaults to the
-            author of the command.
+    async def removerole(
+        self, ctx: commands.Context, rolename: discord.Role, *, user: MemberDefaultAuthor = None
+    ):
+        """Remove a role from a user.
+
+        If user is left blank it defaults to the author of the command.
         """
         if user is None:
             user = ctx.author
-        if self.pass_user_heirarchy_check(ctx, rolename):
+        if self.pass_user_hierarchy_check(ctx, rolename):
             # noinspection PyTypeChecker
             await self._removerole(ctx, user, rolename)
         else:
-            await self.complain(ctx, USER_HIERARCHY_ISSUE)
+            await self.complain(ctx, T_(USER_HIERARCHY_ISSUE))
 
     @commands.group()
     @commands.guild_only()
     @checks.admin_or_permissions(manage_roles=True)
     async def editrole(self, ctx: commands.Context):
-        """Edits roles settings"""
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+        """Edit role settings."""
+        pass
 
-    @editrole.command(name="colour", aliases=["color", ])
-    async def editrole_colour(self, ctx: commands.Context, role: discord.Role,
-                              value: discord.Colour):
-        """Edits a role's colour
+    @editrole.command(name="colour", aliases=["color"])
+    async def editrole_colour(
+        self, ctx: commands.Context, role: discord.Role, value: discord.Colour
+    ):
+        """Edit a role's colour.
 
         Use double quotes if the role contains spaces.
         Colour must be in hexadecimal format.
-        \"http://www.w3schools.com/colors/colors_picker.asp\"
-        Examples:
-        !editrole colour \"The Transistor\" #ff0000
-        !editrole colour Test #ff9900"""
-        author = ctx.author
-        reason = "{}({}) changed the colour of role '{}'".format(
-            author.name, author.id, role.name)
+        [Online colour picker](http://www.w3schools.com/colors/colors_picker.asp)
 
-        if not self.pass_user_heirarchy_check(ctx, role):
-            await self.complain(ctx, USER_HIERARCHY_ISSUE)
+        Examples:
+            `[p]editrole colour "The Transistor" #ff0000`
+            `[p]editrole colour Test #ff9900`
+        """
+        author = ctx.author
+        reason = "{}({}) changed the colour of role '{}'".format(author.name, author.id, role.name)
+
+        if not self.pass_user_hierarchy_check(ctx, role):
+            await self.complain(ctx, T_(USER_HIERARCHY_ISSUE))
             return
 
         try:
             await role.edit(reason=reason, color=value)
         except discord.Forbidden:
-            await self.complain(ctx, GENERIC_FORBIDDEN)
+            await self.complain(ctx, T_(GENERIC_FORBIDDEN))
         else:
             log.info(reason)
-            await ctx.send("Done.")
+            await ctx.send(_("Done."))
 
     @editrole.command(name="name")
     @checks.admin_or_permissions(administrator=True)
     async def edit_role_name(self, ctx: commands.Context, role: discord.Role, *, name: str):
-        """Edits a role's name
+        """Edit a role's name.
 
         Use double quotes if the role or the name contain spaces.
+
         Examples:
-        !editrole name \"The Transistor\" Test"""
+            `[p]editrole name \"The Transistor\" Test`
+        """
         author = ctx.message.author
         old_name = role.name
         reason = "{}({}) changed the name of role '{}' to '{}'".format(
-            author.name, author.id, old_name, name)
+            author.name, author.id, old_name, name
+        )
 
-        if not self.pass_user_heirarchy_check(ctx, role):
-            await self.complain(ctx, USER_HIERARCHY_ISSUE)
+        if not self.pass_user_hierarchy_check(ctx, role):
+            await self.complain(ctx, T_(USER_HIERARCHY_ISSUE))
             return
 
         try:
             await role.edit(reason=reason, name=name)
         except discord.Forbidden:
-            await self.complain(ctx, GENERIC_FORBIDDEN)
+            await self.complain(ctx, T_(GENERIC_FORBIDDEN))
         else:
             log.info(reason)
-            await ctx.send("Done.")
+            await ctx.send(_("Done."))
 
     @commands.group(invoke_without_command=True)
     @checks.is_owner()
     async def announce(self, ctx: commands.Context, *, message: str):
-        """
-        Announces a message to all servers the bot is in.
-        """
+        """Announce a message to all servers the bot is in."""
         if not self.is_announcing():
             announcer = Announcer(ctx, message, config=self.conf)
             announcer.start()
 
             self.__current_announcer = announcer
 
-            await ctx.send("The announcement has begun.")
+            await ctx.send(_("The announcement has begun."))
         else:
             prefix = ctx.prefix
-            await self.complain(ctx, RUNNING_ANNOUNCEMENT,
-                                prefix=prefix)
+            await self.complain(ctx, T_(RUNNING_ANNOUNCEMENT), prefix=prefix)
 
     @announce.command(name="cancel")
     @checks.is_owner()
     async def announce_cancel(self, ctx):
-        """
-        Cancels a running announce.
-        """
+        """Cancel a running announce."""
         try:
             self.__current_announcer.cancel()
         except AttributeError:
             pass
 
-        await ctx.send("The current announcement has been cancelled.")
+        await ctx.send(_("The current announcement has been cancelled."))
 
     @announce.command(name="channel")
     @commands.guild_only()
     @checks.guildowner_or_permissions(administrator=True)
-    async def announce_channel(self, ctx, *, channel: discord.TextChannel=None):
-        """
-        Changes the channel on which the bot makes announcements.
-        """
+    async def announce_channel(self, ctx, *, channel: discord.TextChannel = None):
+        """Change the channel to which the bot makes announcements."""
         if channel is None:
             channel = ctx.channel
         await self.conf.guild(ctx.guild).announce_channel.set(channel.id)
 
-        await ctx.send("The announcement channel has been set to {}".format(
-            channel.mention
-        ))
+        await ctx.send(
+            _("The announcement channel has been set to {channel.mention}").format(channel=channel)
+        )
 
     @announce.command(name="ignore")
     @commands.guild_only()
     @checks.guildowner_or_permissions(administrator=True)
-    async def announce_ignore(self, ctx, *, guild: discord.Guild=None):
-        """
-        Toggles whether the announcements will ignore the given server.
-            Defaults to the current server if none is provided.
-        """
-        if guild is None:
-            guild = ctx.guild
+    async def announce_ignore(self, ctx):
+        """Toggle announcements being enabled this server."""
+        ignored = await self.conf.guild(ctx.guild).announce_ignore()
+        await self.conf.guild(ctx.guild).announce_ignore.set(not ignored)
 
-        ignored = await self.conf.guild(guild).announce_ignore()
-        await self.conf.guild(guild).announce_ignore.set(not ignored)
-
-        verb = "will" if ignored else "will not"
-
-        await ctx.send("The server {} {} receive announcements.".format(
-            guild.name, verb
-        ))
+        if ignored:  # Keeping original logic....
+            await ctx.send(
+                _("The server {guild.name} will receive announcements.").format(guild=ctx.guild)
+            )
+        else:
+            await ctx.send(
+                _("The server {guild.name} will not receive announcements.").format(
+                    guild=ctx.guild
+                )
+            )
 
     async def _valid_selfroles(self, guild: discord.Guild) -> Tuple[discord.Role]:
         """
@@ -309,45 +305,51 @@ class Admin:
         # noinspection PyTypeChecker
         return valid_roles
 
+    @commands.guild_only()
     @commands.group(invoke_without_command=True)
     async def selfrole(self, ctx: commands.Context, *, selfrole: SelfRole):
-        """
-        Add a role to yourself that server admins have configured as
-            user settable.
+        """Add a role to yourself.
+
+        Server admins must have configured the role as user settable.
+
+        NOTE: The role is case sensitive!
         """
         # noinspection PyTypeChecker
         await self._addrole(ctx, ctx.author, selfrole)
 
     @selfrole.command(name="remove")
     async def selfrole_remove(self, ctx: commands.Context, *, selfrole: SelfRole):
-        """
-        Removes a selfrole from yourself.
+        """Remove a selfrole from yourself.
+
+        NOTE: The role is case sensitive!
         """
         # noinspection PyTypeChecker
         await self._removerole(ctx, ctx.author, selfrole)
 
     @selfrole.command(name="add")
-    @commands.has_permissions(manage_roles=True)
+    @checks.admin_or_permissions(manage_roles=True)
     async def selfrole_add(self, ctx: commands.Context, *, role: discord.Role):
-        """
-        Add a role to the list of available selfroles.
+        """Add a role to the list of available selfroles.
+
+        NOTE: The role is case sensitive!
         """
         async with self.conf.guild(ctx.guild).selfroles() as curr_selfroles:
             if role.id not in curr_selfroles:
                 curr_selfroles.append(role.id)
 
-        await ctx.send("The selfroles list has been successfully modified.")
+        await ctx.send(_("The selfroles list has been successfully modified."))
 
     @selfrole.command(name="delete")
-    @commands.has_permissions(manage_roles=True)
+    @checks.admin_or_permissions(manage_roles=True)
     async def selfrole_delete(self, ctx: commands.Context, *, role: SelfRole):
-        """
-        Removes a role from the list of available selfroles.
+        """Remove a role from the list of available selfroles.
+
+        NOTE: The role is case sensitive!
         """
         async with self.conf.guild(ctx.guild).selfroles() as curr_selfroles:
             curr_selfroles.remove(role.id)
 
-        await ctx.send("The selfroles list has been successfully modified.")
+        await ctx.send(_("The selfroles list has been successfully modified."))
 
     @selfrole.command(name="list")
     async def selfrole_list(self, ctx: commands.Context):
@@ -357,7 +359,7 @@ class Admin:
         selfroles = await self._valid_selfroles(ctx.guild)
         fmt_selfroles = "\n".join(["+ " + r.name for r in selfroles])
 
-        msg = "Available Selfroles:\n{}".format(fmt_selfroles)
+        msg = _("Available Selfroles:\n{selfroles}").format(selfroles=fmt_selfroles)
         await ctx.send(box(msg, "diff"))
 
     async def _serverlock_check(self, guild: discord.Guild) -> bool:
@@ -374,18 +376,19 @@ class Admin:
     @commands.command()
     @checks.is_owner()
     async def serverlock(self, ctx: commands.Context):
-        """
-        Locks a bot to its current servers only.
-        """
+        """Lock a bot to its current servers only."""
         serverlocked = await self.conf.serverlocked()
         await self.conf.serverlocked.set(not serverlocked)
 
-        verb = "is now" if not serverlocked else "is no longer"
+        if serverlocked:
+            await ctx.send(_("The bot is no longer serverlocked."))
+        else:
+            await ctx.send(_("The bot is now serverlocked."))
 
-        await ctx.send("The bot {} serverlocked.".format(verb))
-
-# region Event Handlers
+    # region Event Handlers
     async def on_guild_join(self, guild: discord.Guild):
         if await self._serverlock_check(guild):
             return
+
+
 # endregion

redbot/cogs/admin/announcer.py

@@ -1,13 +1,14 @@
 import asyncio
 
 import discord
-from discord.ext import commands
+from redbot.core import commands
+from redbot.core.i18n import Translator
+
+_ = Translator("Announcer", __file__)
 
 
 class Announcer:
-    def __init__(self, ctx: commands.Context,
-                 message: str,
-                 config=None):
+    def __init__(self, ctx: commands.Context, message: str, config=None):
         """
         :param ctx:
         :param message:
@@ -65,10 +66,9 @@ class Announcer:
             try:
                 await channel.send(self.message)
             except discord.Forbidden:
-                await bot_owner.send("I could not announce to server: {}".format(
-                                         g.id
-                                     ))
+                await bot_owner.send(
+                    _("I could not announce to server: {server.id}").format(server=g)
+                )
             await asyncio.sleep(0.5)
 
         self.active = False
-

redbot/cogs/admin/converters.py

@@ -1,5 +1,8 @@
 import discord
-from discord.ext import commands
+from redbot.core import commands
+from redbot.core.i18n import Translator
+
+_ = Translator("AdminConverters", __file__)
 
 
 class MemberDefaultAuthor(commands.Converter):
@@ -19,7 +22,7 @@ class SelfRole(commands.Converter):
     async def convert(self, ctx: commands.Context, arg: str) -> discord.Role:
         admin = ctx.command.instance
         if admin is None:
-            raise commands.BadArgument("Admin is not loaded.")
+            raise commands.BadArgument(_("The Admin cog is not loaded."))
 
         conf = admin.conf
         selfroles = await conf.guild(ctx.guild).selfroles()
@@ -28,6 +31,5 @@ class SelfRole(commands.Converter):
         role = await role_converter.convert(ctx, arg)
 
         if role.id not in selfroles:
-            raise commands.BadArgument("The provided role is not a valid"
-                                       " selfrole.")
+            raise commands.BadArgument(_("The provided role is not a valid selfrole."))
         return role

redbot/cogs/admin/locales/messages.pot

@@ -1,17 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-

redbot/cogs/admin/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../admin.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/alias/__init__.py

@@ -1,6 +1,6 @@
 from .alias import Alias
-from discord.ext import commands
+from redbot.core.bot import Red
 
 
-def setup(bot: commands.Bot):
+def setup(bot: Red):
     bot.add_cog(Alias(bot))

redbot/cogs/alias/alias.py

@@ -1,41 +1,36 @@
 from copy import copy
 from re import search
-from typing import Generator, Tuple, Iterable
+from typing import Generator, Tuple, Iterable, Optional
 
 import discord
-from redbot.core import Config
-from redbot.core.i18n import CogI18n
+from redbot.core import Config, commands, checks
+from redbot.core.i18n import Translator, cog_i18n
 from redbot.core.utils.chat_formatting import box
-from discord.ext import commands
 
 from redbot.core.bot import Red
 from .alias_entry import AliasEntry
 
-_ = CogI18n("Alias", __file__)
+_ = Translator("Alias", __file__)
 
 
-class Alias:
-    """
-    Alias
-    
-    Aliases are per server shortcuts for commands. They
-        can act as both a lambda (storing arguments for repeated use)
-        or as simply a shortcut to saying "x y z".
-    
+@cog_i18n(_)
+class Alias(commands.Cog):
+    """Create aliases for commands.
+
+    Aliases are alternative names shortcuts for commands. They
+    can act as both a lambda (storing arguments for repeated use)
+    or as simply a shortcut to saying "x y z".
+
     When run, aliases will accept any additional arguments
-        and append them to the stored alias
+    and append them to the stored alias.
     """
 
-    default_global_settings = {
-        "entries": []
-    }
+    default_global_settings = {"entries": []}
 
-    default_guild_settings = {
-        "enabled": False,
-        "entries": []  # Going to be a list of dicts
-    }
+    default_guild_settings = {"enabled": False, "entries": []}  # Going to be a list of dicts
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
         self._aliases = Config.get_conf(self, 8927348724)
 
@@ -49,16 +44,22 @@ class Alias:
         return (AliasEntry.from_json(d) for d in (await self._aliases.entries()))
 
     async def loaded_aliases(self, guild: discord.Guild) -> Generator[AliasEntry, None, None]:
-        return (AliasEntry.from_json(d, bot=self.bot)
-                for d in (await self._aliases.guild(guild).entries()))
+        return (
+            AliasEntry.from_json(d, bot=self.bot)
+            for d in (await self._aliases.guild(guild).entries())
+        )
 
     async def loaded_global_aliases(self) -> Generator[AliasEntry, None, None]:
         return (AliasEntry.from_json(d, bot=self.bot) for d in (await self._aliases.entries()))
 
-    async def is_alias(self, guild: discord.Guild, alias_name: str,
-                       server_aliases: Iterable[AliasEntry]=()) -> (bool, AliasEntry):
+    async def is_alias(
+        self,
+        guild: Optional[discord.Guild],
+        alias_name: str,
+        server_aliases: Iterable[AliasEntry] = (),
+    ) -> Tuple[bool, Optional[AliasEntry]]:
 
-        if not server_aliases:
+        if not server_aliases and guild is not None:
             server_aliases = await self.unloaded_aliases(guild)
 
         global_aliases = await self.unloaded_global_aliases()
@@ -76,10 +77,11 @@ class Alias:
 
     @staticmethod
     def is_valid_alias_name(alias_name: str) -> bool:
-        return not bool(search(r'\s', alias_name)) and alias_name.isprintable()
+        return not bool(search(r"\s", alias_name)) and alias_name.isprintable()
 
-    async def add_alias(self, ctx: commands.Context, alias_name: str,
-                        command: Tuple[str], global_: bool=False) -> AliasEntry:
+    async def add_alias(
+        self, ctx: commands.Context, alias_name: str, command: Tuple[str], global_: bool = False
+    ) -> AliasEntry:
         alias = AliasEntry(alias_name, command, ctx.author, global_=global_)
 
         if global_:
@@ -93,8 +95,9 @@ class Alias:
 
         return alias
 
-    async def delete_alias(self, ctx: commands.Context, alias_name: str,
-                           global_: bool=False) -> bool:
+    async def delete_alias(
+        self, ctx: commands.Context, alias_name: str, global_: bool = False
+    ) -> bool:
         if global_:
             settings = self._aliases
         else:
@@ -120,16 +123,15 @@ class Alias:
         """
         content = message.content
         prefix_list = await self.bot.command_prefix(self.bot, message)
-        prefixes = sorted(prefix_list,
-                          key=lambda pfx: len(pfx),
-                          reverse=True)
+        prefixes = sorted(prefix_list, key=lambda pfx: len(pfx), reverse=True)
         for p in prefixes:
             if content.startswith(p):
                 return p
         raise ValueError(_("No prefix found."))
 
-    def get_extra_args_from_alias(self, message: discord.Message, prefix: str,
-                                  alias: AliasEntry) -> str:
+    def get_extra_args_from_alias(
+        self, message: discord.Message, prefix: str, alias: AliasEntry
+    ) -> str:
         """
         When an alias is executed by a user in chat this function tries
             to get any extra arguments passed in with the call.
@@ -143,25 +145,27 @@ class Alias:
         extra = message.content[known_content_length:].strip()
         return extra
 
-    async def maybe_call_alias(self, message: discord.Message,
-                               aliases: Iterable[AliasEntry]=None):
+    async def maybe_call_alias(
+        self, message: discord.Message, aliases: Iterable[AliasEntry] = None
+    ):
         try:
             prefix = await self.get_prefix(message)
         except ValueError:
             return
 
         try:
-            potential_alias = message.content[len(prefix):].split(" ")[0]
+            potential_alias = message.content[len(prefix) :].split(" ")[0]
         except IndexError:
             return False
 
-        is_alias, alias = await self.is_alias(message.guild, potential_alias, server_aliases=aliases)
+        is_alias, alias = await self.is_alias(
+            message.guild, potential_alias, server_aliases=aliases
+        )
 
         if is_alias:
             await self.call_alias(message, prefix, alias)
 
-    async def call_alias(self, message: discord.Message, prefix: str,
-                         alias: AliasEntry):
+    async def call_alias(self, message: discord.Message, prefix: str, alias: AliasEntry):
         new_message = copy(message)
         args = self.get_extra_args_from_alias(message, prefix, alias)
 
@@ -172,143 +176,169 @@ class Alias:
     @commands.group()
     @commands.guild_only()
     async def alias(self, ctx: commands.Context):
-        """Manage per-server aliases for commands"""
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+        """Manage command aliases."""
+        pass
 
     @alias.group(name="global")
     async def global_(self, ctx: commands.Context):
-        """
-        Manage global aliases.
-        """
-        if ctx.invoked_subcommand is None or \
-                isinstance(ctx.invoked_subcommand, commands.Group):
-            await ctx.send_help()
+        """Manage global aliases."""
+        pass
 
+    @checks.mod_or_permissions(manage_guild=True)
     @alias.command(name="add")
     @commands.guild_only()
-    async def _add_alias(self, ctx: commands.Context,
-                         alias_name: str, *, command):
-        """
-        Add an alias for a command.
-        """
-# region Alias Add Validity Checking
+    async def _add_alias(self, ctx: commands.Context, alias_name: str, *, command):
+        """Add an alias for a command."""
+        # region Alias Add Validity Checking
         is_command = self.is_command(alias_name)
         if is_command:
-            await ctx.send(_("You attempted to create a new alias"
-                             " with the name {} but that"
-                             " name is already a command on this bot.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new alias"
+                    " with the name {name} but that"
+                    " name is already a command on this bot."
+                ).format(name=alias_name)
+            )
             return
 
         is_alias, something_useless = await self.is_alias(ctx.guild, alias_name)
         if is_alias:
-            await ctx.send(_("You attempted to create a new alias"
-                             " with the name {} but that"
-                             " alias already exists on this server.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new alias"
+                    " with the name {name} but that"
+                    " alias already exists on this server."
+                ).format(name=alias_name)
+            )
             return
 
         is_valid_name = self.is_valid_alias_name(alias_name)
         if not is_valid_name:
-            await ctx.send(_("You attempted to create a new alias"
-                             " with the name {} but that"
-                             " name is an invalid alias name. Alias"
-                             " names may not contain spaces.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new alias"
+                    " with the name {name} but that"
+                    " name is an invalid alias name. Alias"
+                    " names may not contain spaces."
+                ).format(name=alias_name)
+            )
             return
-# endregion
+        # endregion
 
         # At this point we know we need to make a new alias
         #   and that the alias name is valid.
 
         await self.add_alias(ctx, alias_name, command)
 
-        await ctx.send(_("A new alias with the trigger `{}`"
-                         " has been created.").format(alias_name))
+        await ctx.send(
+            _("A new alias with the trigger `{name}` has been created.").format(name=alias_name)
+        )
 
+    @checks.is_owner()
     @global_.command(name="add")
-    async def _add_global_alias(self, ctx: commands.Context,
-                                alias_name: str, *, command):
-        """
-        Add a global alias for a command.
-        """
-# region Alias Add Validity Checking
+    async def _add_global_alias(self, ctx: commands.Context, alias_name: str, *, command):
+        """Add a global alias for a command."""
+        # region Alias Add Validity Checking
         is_command = self.is_command(alias_name)
         if is_command:
-            await ctx.send(_("You attempted to create a new global alias"
-                             " with the name {} but that"
-                             " name is already a command on this bot.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new global alias"
+                    " with the name {name} but that"
+                    " name is already a command on this bot."
+                ).format(name=alias_name)
+            )
             return
 
         is_alias, something_useless = await self.is_alias(ctx.guild, alias_name)
         if is_alias:
-            await ctx.send(_("You attempted to create a new global alias"
-                             " with the name {} but that"
-                             " alias already exists on this server.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new global alias"
+                    " with the name {name} but that"
+                    " alias already exists on this server."
+                ).format(name=alias_name)
+            )
             return
 
         is_valid_name = self.is_valid_alias_name(alias_name)
         if not is_valid_name:
-            await ctx.send(_("You attempted to create a new global alias"
-                             " with the name {} but that"
-                             " name is an invalid alias name. Alias"
-                             " names may not contain spaces.").format(alias_name))
+            await ctx.send(
+                _(
+                    "You attempted to create a new global alias"
+                    " with the name {name} but that"
+                    " name is an invalid alias name. Alias"
+                    " names may not contain spaces."
+                ).format(name=alias_name)
+            )
             return
-# endregion
+        # endregion
 
         await self.add_alias(ctx, alias_name, command, global_=True)
 
-        await ctx.send(_("A new global alias with the trigger `{}`"
-                         " has been created.").format(alias_name))
+        await ctx.send(
+            _("A new global alias with the trigger `{name}` has been created.").format(
+                name=alias_name
+            )
+        )
 
     @alias.command(name="help")
     @commands.guild_only()
     async def _help_alias(self, ctx: commands.Context, alias_name: str):
-        """Tries to execute help for the base command of the alias"""
-        is_alias, alias = self.is_alias(ctx.guild, alias_name=alias_name)
+        """Try to execute help for the base command of the alias."""
+        is_alias, alias = await self.is_alias(ctx.guild, alias_name=alias_name)
         if is_alias:
-            base_cmd = alias.command[0]
+            if self.is_command(alias.command):
+                base_cmd = alias.command
+            else:
+                base_cmd = alias.command.rsplit(" ", 1)[0]
 
             new_msg = copy(ctx.message)
-            new_msg.content = "{}help {}".format(ctx.prefix, base_cmd)
+            new_msg.content = _("{prefix}help {command}").format(
+                prefix=ctx.prefix, command=base_cmd
+            )
             await self.bot.process_commands(new_msg)
         else:
-            ctx.send(_("No such alias exists."))
+            await ctx.send(_("No such alias exists."))
 
     @alias.command(name="show")
     @commands.guild_only()
     async def _show_alias(self, ctx: commands.Context, alias_name: str):
-        """Shows what command the alias executes."""
+        """Show what command the alias executes."""
         is_alias, alias = await self.is_alias(ctx.guild, alias_name)
 
         if is_alias:
-            await ctx.send(_("The `{}` alias will execute the"
-                             " command `{}`").format(alias_name, alias.command))
+            await ctx.send(
+                _("The `{alias_name}` alias will execute the command `{command}`").format(
+                    alias_name=alias_name, command=alias.command
+                )
+            )
         else:
-            await ctx.send(_("There is no alias with the name `{}`").format(alias_name))
+            await ctx.send(_("There is no alias with the name `{name}`").format(name=alias_name))
 
+    @checks.mod_or_permissions(manage_guild=True)
     @alias.command(name="del")
     @commands.guild_only()
     async def _del_alias(self, ctx: commands.Context, alias_name: str):
-        """
-        Deletes an existing alias on this server.
-        """
+        """Delete an existing alias on this server."""
         aliases = await self.unloaded_aliases(ctx.guild)
         try:
             next(aliases)
         except StopIteration:
-            await ctx.send(_("There are no aliases on this guild."))
+            await ctx.send(_("There are no aliases on this server."))
             return
 
         if await self.delete_alias(ctx, alias_name):
-            await ctx.send(_("Alias with the name `{}` was successfully"
-                             " deleted.").format(alias_name))
+            await ctx.send(
+                _("Alias with the name `{name}` was successfully deleted.").format(name=alias_name)
+            )
         else:
-            await ctx.send(_("Alias with name `{}` was not found.").format(alias_name))
+            await ctx.send(_("Alias with name `{name}` was not found.").format(name=alias_name))
 
+    @checks.is_owner()
     @global_.command(name="del")
     async def _del_global_alias(self, ctx: commands.Context, alias_name: str):
-        """
-        Deletes an existing global alias.
-        """
+        """Delete an existing global alias."""
         aliases = await self.unloaded_global_aliases()
         try:
             next(aliases)
@@ -317,18 +347,19 @@ class Alias:
             return
 
         if await self.delete_alias(ctx, alias_name, global_=True):
-            await ctx.send(_("Alias with the name `{}` was successfully"
-                             " deleted.").format(alias_name))
+            await ctx.send(
+                _("Alias with the name `{name}` was successfully deleted.").format(name=alias_name)
+            )
         else:
-            await ctx.send(_("Alias with name `{}` was not found.").format(alias_name))
+            await ctx.send(_("Alias with name `{name}` was not found.").format(name=alias_name))
 
     @alias.command(name="list")
     @commands.guild_only()
     async def _list_alias(self, ctx: commands.Context):
-        """
-        Lists the available aliases on this server.
-        """
-        names = [_("Aliases:"), ] + sorted(["+ " + a.name for a in (await self.unloaded_aliases(ctx.guild))])
+        """List the available aliases on this server."""
+        names = [_("Aliases:")] + sorted(
+            ["+ " + a.name for a in (await self.unloaded_aliases(ctx.guild))]
+        )
         if len(names) == 0:
             await ctx.send(_("There are no aliases on this server."))
         else:
@@ -336,10 +367,10 @@ class Alias:
 
     @global_.command(name="list")
     async def _list_global_alias(self, ctx: commands.Context):
-        """
-        Lists the available global aliases on this bot.
-        """
-        names = [_("Aliases:"), ] + sorted(["+ " + a.name for a in await self.unloaded_global_aliases()])
+        """List the available global aliases on this bot."""
+        names = [_("Aliases:")] + sorted(
+            ["+ " + a.name for a in await self.unloaded_global_aliases()]
+        )
         if len(names) == 0:
             await ctx.send(_("There are no aliases on this server."))
         else:

redbot/cogs/alias/alias_entry.py

@@ -1,12 +1,13 @@
 from typing import Tuple
-from discord.ext import commands
 
 import discord
+from redbot.core import commands
 
 
 class AliasEntry:
-    def __init__(self, name: str, command: Tuple[str],
-                 creator: discord.Member, global_: bool=False):
+    def __init__(
+        self, name: str, command: Tuple[str], creator: discord.Member, global_: bool = False
+    ):
         super().__init__()
         self.has_real_data = False
         self.name = name
@@ -43,13 +44,12 @@ class AliasEntry:
             "creator": creator,
             "guild": guild,
             "global": self.global_,
-            "uses": self.uses
+            "uses": self.uses,
         }
 
     @classmethod
-    def from_json(cls, data: dict, bot: commands.Bot=None):
-        ret = cls(data["name"], data["command"],
-                  data["creator"], global_=data["global"])
+    def from_json(cls, data: dict, bot: commands.Bot = None):
+        ret = cls(data["name"], data["command"], data["creator"], global_=data["global"])
 
         if bot:
             ret.has_real_data = True

redbot/cogs/alias/locales/messages.pot

@@ -1,89 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../alias.py:129
-msgid "No prefix found."
-msgstr ""
-
-#: ../alias.py:198
-msgid "You attempted to create a new alias with the name {} but that name is already a command on this bot."
-msgstr ""
-
-#: ../alias.py:205
-msgid "You attempted to create a new alias with the name {} but that alias already exists on this server."
-msgstr ""
-
-#: ../alias.py:212
-msgid "You attempted to create a new alias with the name {} but that name is an invalid alias name. Alias names may not contain spaces."
-msgstr ""
-
-#: ../alias.py:224
-msgid "A new alias with the trigger `{}` has been created."
-msgstr ""
-
-#: ../alias.py:236
-msgid "You attempted to create a new global alias with the name {} but that name is already a command on this bot."
-msgstr ""
-
-#: ../alias.py:243
-msgid "You attempted to create a new global alias with the name {} but that alias already exists on this server."
-msgstr ""
-
-#: ../alias.py:250
-msgid "You attempted to create a new global alias with the name {} but that name is an invalid alias name. Alias names may not contain spaces."
-msgstr ""
-
-#: ../alias.py:259
-msgid "A new global alias with the trigger `{}` has been created."
-msgstr ""
-
-#: ../alias.py:274
-msgid "No such alias exists."
-msgstr ""
-
-#: ../alias.py:283
-msgid "The `{}` alias will execute the command `{}`"
-msgstr ""
-
-#: ../alias.py:286
-msgid "There is no alias with the name `{}`"
-msgstr ""
-
-#: ../alias.py:298
-msgid "There are no aliases on this guild."
-msgstr ""
-
-#: ../alias.py:302 ../alias.py:320
-msgid "Alias with the name `{}` was successfully deleted."
-msgstr ""
-
-#: ../alias.py:305 ../alias.py:323
-msgid "Alias with name `{}` was not found."
-msgstr ""
-
-#: ../alias.py:316
-msgid "There are no aliases on this bot."
-msgstr ""
-
-#: ../alias.py:331 ../alias.py:342
-msgid "Aliases:"
-msgstr ""
-
-#: ../alias.py:333 ../alias.py:344
-msgid "There are no aliases on this server."
-msgstr ""
-

redbot/cogs/alias/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../alias.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/audio/__init__.py

@@ -1,27 +1,29 @@
 from pathlib import Path
 from aiohttp import ClientSession
 import shutil
+import logging
 
 from .audio import Audio
 from .manager import start_lavalink_server
-from discord.ext import commands
+from redbot.core import commands
 from redbot.core.data_manager import cog_data_path
 import redbot.core
 
+log = logging.getLogger("red.audio")
+
 LAVALINK_DOWNLOAD_URL = (
-    "https://github.com/Cog-Creators/Red-DiscordBot/"
-    "releases/download/{}/Lavalink.jar"
+    "https://github.com/Cog-Creators/Red-DiscordBot/releases/download/{}/Lavalink.jar"
 ).format(redbot.core.__version__)
 
 LAVALINK_DOWNLOAD_DIR = cog_data_path(raw_name="Audio")
 LAVALINK_JAR_FILE = LAVALINK_DOWNLOAD_DIR / "Lavalink.jar"
 
 APP_YML_FILE = LAVALINK_DOWNLOAD_DIR / "application.yml"
-BUNDLED_APP_YML_FILE = Path(__file__).parent / "application.yml"
+BUNDLED_APP_YML_FILE = Path(__file__).parent / "data/application.yml"
 
 
 async def download_lavalink(session):
-    with LAVALINK_JAR_FILE.open(mode='wb') as f:
+    with LAVALINK_JAR_FILE.open(mode="wb") as f:
         async with session.get(LAVALINK_DOWNLOAD_URL) as resp:
             while True:
                 chunk = await resp.content.read(512)
@@ -32,16 +34,14 @@ async def download_lavalink(session):
 
 async def maybe_download_lavalink(loop, cog):
     jar_exists = LAVALINK_JAR_FILE.exists()
-    current_build = redbot.core.VersionInfo(*await cog.config.current_build())
-
-    session = ClientSession(loop=loop)
+    current_build = redbot.core.VersionInfo.from_json(await cog.config.current_version())
 
     if not jar_exists or current_build < redbot.core.version_info:
+        log.info("Downloading Lavalink.jar")
         LAVALINK_DOWNLOAD_DIR.mkdir(parents=True, exist_ok=True)
-        await download_lavalink(session)
-        await cog.config.current_build.set(redbot.core.version_info.to_json())
-
-    session.close()
+        async with ClientSession(loop=loop) as session:
+            await download_lavalink(session)
+        await cog.config.current_version.set(redbot.core.version_info.to_json())
 
     shutil.copyfile(str(BUNDLED_APP_YML_FILE), str(APP_YML_FILE))
 
@@ -52,5 +52,6 @@ async def setup(bot: commands.Bot):
         await maybe_download_lavalink(bot.loop, cog)
         await start_lavalink_server(bot.loop)
 
+    await cog.initialize()
+
     bot.add_cog(cog)
-    bot.loop.create_task(cog.init_config())

redbot/cogs/audio/data/application.yml

@@ -14,7 +14,7 @@ lavalink:
       vimeo: true
       mixer: true
       http: true
-      local: false
+      local: true
     sentryDsn: ""
     bufferDurationMs: 400
-    youtubePlaylistLoadLimit: 10000
+    youtubePlaylistLoadLimit: 10000

redbot/cogs/audio/locales/messages.pot

@@ -1,41 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../audio.py:25 ../audio.py:45
-msgid "Join a voice channel first!"
-msgstr ""
-
-#: ../audio.py:33
-msgid "Let's play a file that exists pls"
-msgstr ""
-
-#: ../audio.py:38 ../audio.py:58
-msgid "{} is playing a song..."
-msgstr ""
-
-#: ../audio.py:48
-msgid "Youtube links pls"
-msgstr ""
-
-#: ../audio.py:67 ../audio.py:77 ../audio.py:87 ../audio.py:97
-msgid "I'm not even connected to a voice channel!"
-msgstr ""
-
-#: ../audio.py:95
-msgid "Volume set."
-msgstr ""
-

redbot/cogs/audio/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../audio.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/audio/manager.py

@@ -1,11 +1,16 @@
 import shlex
 import shutil
 import asyncio
-from subprocess import Popen, DEVNULL, PIPE
+import asyncio.subprocess
 import os
 import logging
+import re
+from subprocess import Popen, DEVNULL
+from typing import Optional, Tuple
 
-log = logging.getLogger('red.audio.manager')
+_JavaVersion = Tuple[int, int]
+
+log = logging.getLogger("red.audio.manager")
 
 proc = None
 SHUTDOWN = asyncio.Event()
@@ -13,7 +18,8 @@ SHUTDOWN = asyncio.Event()
 
 def has_java_error(pid):
     from . import LAVALINK_DOWNLOAD_DIR
-    poss_error_file = LAVALINK_DOWNLOAD_DIR / 'hs_err_pid{}.log'.format(pid)
+
+    poss_error_file = LAVALINK_DOWNLOAD_DIR / "hs_err_pid{}.log".format(pid)
     return poss_error_file.exists()
 
 
@@ -29,38 +35,61 @@ async def monitor_lavalink_server(loop):
             log.info("Restarting Lavalink jar.")
             await start_lavalink_server(loop)
         else:
-            log.error("Your Java is borked. Please find the hs_err_pid{}.log file"
-                      " in the Audio data folder and report this issue.".format(
-                proc.pid
-            ))
+            log.error(
+                "Your Java is borked. Please find the hs_err_pid{}.log file"
+                " in the Audio data folder and report this issue.".format(proc.pid)
+            )
 
 
-async def has_java(loop):
-    java_available = shutil.which('java') is not None
+async def has_java(loop) -> Tuple[bool, Optional[_JavaVersion]]:
+    java_available = shutil.which("java") is not None
     if not java_available:
-        return False
+        return False, None
 
     version = await get_java_version(loop)
-    return version >= (1, 8), version
+    return (2, 0) > version >= (1, 8) or version >= (8, 0), version
 
 
-async def get_java_version(loop):
+async def get_java_version(loop) -> _JavaVersion:
     """
     This assumes we've already checked that java exists.
     """
-    proc = Popen(
-        shlex.split("java -version", posix=os.name == 'posix'),
-        stdout=PIPE, stderr=PIPE
+    _proc: asyncio.subprocess.Process = await asyncio.create_subprocess_exec(
+        "java",
+        "-version",
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE,
+        loop=loop,
     )
-    _, err = proc.communicate()
+    # java -version outputs to stderr
+    _, err = await _proc.communicate()
 
-    version_info = str(err, encoding='utf-8')
+    version_info: str = err.decode("utf-8")
+    # We expect the output to look something like:
+    #     $ java -version
+    #     ...
+    #     ... version "MAJOR.MINOR.PATCH[_BUILD]" ...
+    #     ...
+    # We only care about the major and minor parts though.
+    version_line_re = re.compile(
+        r'version "(?P<major>\d+).(?P<minor>\d+).\d+(?:_\d+)?(?:-[A-Za-z0-9]+)?"'
+    )
+    short_version_re = re.compile(r'version "(?P<major>\d+)"')
+
+    lines = version_info.splitlines()
+    for line in lines:
+        match = version_line_re.search(line)
+        short_match = short_version_re.search(line)
+        if match:
+            return int(match["major"]), int(match["minor"])
+        elif short_match:
+            return int(short_match["major"]), 0
+
+    raise RuntimeError(
+        "The output of `java -version` was unexpected. Please report this issue on Red's "
+        "issue tracker."
+    )
 
-    version_line = version_info.split('\n')[0]
-    version_start = version_line.find('"')
-    version_string = version_line[version_start + 1:-1]
-    major, minor = version_string.split('.')[:2]
-    return int(major), int(minor)
 
 async def start_lavalink_server(loop):
     java_available, java_version = await has_java(loop)
@@ -72,13 +101,15 @@ async def start_lavalink_server(loop):
         extra_flags = "-Dsun.zip.disableMemoryMapping=true"
 
     from . import LAVALINK_DOWNLOAD_DIR, LAVALINK_JAR_FILE
+
     start_cmd = "java {} -jar {}".format(extra_flags, LAVALINK_JAR_FILE.resolve())
 
     global proc
     proc = Popen(
-        shlex.split(start_cmd, posix=os.name == 'posix'),
+        shlex.split(start_cmd, posix=os.name == "posix"),
         cwd=str(LAVALINK_DOWNLOAD_DIR),
-        stdout=DEVNULL, stderr=DEVNULL
+        stdout=DEVNULL,
+        stderr=DEVNULL,
     )
 
     log.info("Lavalink jar started. PID: {}".format(proc.pid))
@@ -92,4 +123,5 @@ def shutdown_lavalink_server():
     global proc
     if proc is not None:
         proc.terminate()
+        proc.wait()
         proc = None

redbot/cogs/bank/bank.py

@@ -1,13 +1,12 @@
 import discord
 from redbot.core.utils.chat_formatting import box
 
-from redbot.core import checks, bank
-from redbot.core.i18n import CogI18n
-from discord.ext import commands
+from redbot.core import checks, bank, commands
+from redbot.core.i18n import Translator, cog_i18n
 
 from redbot.core.bot import Red  # Only used for type hints
 
-_ = CogI18n('Bank', __file__)
+_ = Translator("Bank", __file__)
 
 
 def check_global_setting_guildowner():
@@ -15,15 +14,18 @@ def check_global_setting_guildowner():
     Command decorator. If the bank is not global, it checks if the author is
      either the guildowner or has the administrator permission.
     """
+
     async def pred(ctx: commands.Context):
         author = ctx.author
-        if await ctx.bot.is_owner(author):
-            return True
         if not await bank.is_global():
             if not isinstance(ctx.channel, discord.abc.GuildChannel):
                 return False
+            if await ctx.bot.is_owner(author):
+                return True
             permissions = ctx.channel.permissions_for(author)
             return author == ctx.guild.owner or permissions.administrator
+        else:
+            return await ctx.bot.is_owner(author)
 
     return commands.check(pred)
 
@@ -33,33 +35,39 @@ def check_global_setting_admin():
     Command decorator. If the bank is not global, it checks if the author is
      either a bot admin or has the manage_guild permission.
     """
+
     async def pred(ctx: commands.Context):
         author = ctx.author
-        if await ctx.bot.is_owner(author):
-            return True
         if not await bank.is_global():
             if not isinstance(ctx.channel, discord.abc.GuildChannel):
                 return False
+            if await ctx.bot.is_owner(author):
+                return True
             permissions = ctx.channel.permissions_for(author)
             is_guild_owner = author == ctx.guild.owner
             admin_role = await ctx.bot.db.guild(ctx.guild).admin_role()
             return admin_role in author.roles or is_guild_owner or permissions.manage_guild
+        else:
+            return await ctx.bot.is_owner(author)
 
     return commands.check(pred)
 
 
-class Bank:
+@cog_i18n(_)
+class Bank(commands.Cog):
     """Bank"""
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
 
     # SECTION commands
 
-    @commands.group()
+    @check_global_setting_guildowner()
     @checks.guildowner_or_permissions(administrator=True)
+    @commands.group(autohelp=True)
     async def bankset(self, ctx: commands.Context):
-        """Base command for bank settings"""
+        """Base command for bank settings."""
         if ctx.invoked_subcommand is None:
             if await bank.is_global():
                 bank_name = await bank._conf.bank_name()
@@ -67,54 +75,53 @@ class Bank:
                 default_balance = await bank._conf.default_balance()
             else:
                 if not ctx.guild:
-                    await ctx.send_help()
                     return
                 bank_name = await bank._conf.guild(ctx.guild).bank_name()
                 currency_name = await bank._conf.guild(ctx.guild).currency()
                 default_balance = await bank._conf.guild(ctx.guild).default_balance()
 
-            settings = (_(
-                "Bank settings:\n\n"
-                "Bank name: {}\n"
-                "Currency: {}\n"
-                "Default balance: {}"
-                "").format(bank_name, currency_name, default_balance)
+            settings = _(
+                "Bank settings:\n\nBank name: {bank_name}\nCurrency: {currency_name}\n"
+                "Default balance: {default_balance}"
+            ).format(
+                bank_name=bank_name, currency_name=currency_name, default_balance=default_balance
             )
             await ctx.send(box(settings))
-            await ctx.send_help()
 
     @bankset.command(name="toggleglobal")
     @checks.is_owner()
-    async def bankset_toggleglobal(self, ctx: commands.Context, confirm: bool=False):
-        """Toggles whether the bank is global or not
-        If the bank is global, it will become per-server
-        If the bank is per-server, it will become global"""
+    async def bankset_toggleglobal(self, ctx: commands.Context, confirm: bool = False):
+        """Toggle whether the bank is global or not.
+
+        If the bank is global, it will become per-server.
+        If the bank is per-server, it will become global.
+        """
         cur_setting = await bank.is_global()
 
         word = _("per-server") if cur_setting else _("global")
         if confirm is False:
             await ctx.send(
-                _("This will toggle the bank to be {}, deleting all accounts "
-                  "in the process! If you're sure, type `{}`").format(
-                    word, "{}bankset toggleglobal yes".format(ctx.prefix)
-                )
+                _(
+                    "This will toggle the bank to be {banktype}, deleting all accounts "
+                    "in the process! If you're sure, type `{command}`"
+                ).format(banktype=word, command="{}bankset toggleglobal yes".format(ctx.prefix))
             )
         else:
             await bank.set_global(not cur_setting)
-            await ctx.send(_("The bank is now {}.").format(word))
+            await ctx.send(_("The bank is now {banktype}.").format(banktype=word))
 
     @bankset.command(name="bankname")
     @check_global_setting_guildowner()
     async def bankset_bankname(self, ctx: commands.Context, *, name: str):
-        """Set the bank's name"""
+        """Set the bank's name."""
         await bank.set_bank_name(name, ctx.guild)
-        await ctx.send(_("Bank's name has been set to {}").format(name))
+        await ctx.send(_("Bank name has been set to: {name}").format(name=name))
 
     @bankset.command(name="creditsname")
     @check_global_setting_guildowner()
     async def bankset_creditsname(self, ctx: commands.Context, *, name: str):
-        """Set the name for the bank's currency"""
+        """Set the name for the bank's currency."""
         await bank.set_currency_name(name, ctx.guild)
-        await ctx.send(_("Currency name has been set to {}").format(name))
+        await ctx.send(_("Currency name has been set to: {name}").format(name=name))
 
     # ENDSECTION

redbot/cogs/bank/errors.py

@@ -1,6 +1,7 @@
 class BankError(Exception):
     pass
 
+
 class BankNotGlobal(BankError):
     pass
 
@@ -34,4 +35,4 @@ class NegativeValue(BankError):
 
 
 class SameSenderAndReceiver(BankError):
-    pass
+    pass

redbot/cogs/bank/locales/messages.pot

@@ -1,37 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../bank.py:68
-msgid "global"
-msgstr ""
-
-#: ../bank.py:68
-msgid "per-guild"
-msgstr ""
-
-#: ../bank.py:70
-msgid "The bank is now {}."
-msgstr ""
-
-#: ../bank.py:77
-msgid "Bank's name has been set to {}"
-msgstr ""
-
-#: ../bank.py:84
-msgid "Currency name has been set to {}"
-msgstr ""
-

redbot/cogs/bank/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../bank.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/cleanup/cleanup.py

@@ -1,205 +1,153 @@
 import re
+from datetime import datetime, timedelta
+from typing import Union, List, Callable, Set
 
 import discord
-from discord.ext import commands
 
-from redbot.core import checks, RedContext
+from redbot.core import checks, commands
 from redbot.core.bot import Red
-from redbot.core.i18n import CogI18n
+from redbot.core.i18n import Translator, cog_i18n
 from redbot.core.utils.mod import slow_deletion, mass_purge
 from redbot.cogs.mod.log import log
+from redbot.core.utils.predicates import MessagePredicate
 
-_ = CogI18n("Cleanup", __file__)
+_ = Translator("Cleanup", __file__)
 
 
-class Cleanup:
-    """Commands for cleaning messages"""
+@cog_i18n(_)
+class Cleanup(commands.Cog):
+    """Commands for cleaning up messages."""
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
 
     @staticmethod
-    async def check_100_plus(ctx: RedContext, number: int) -> bool:
+    async def check_100_plus(ctx: commands.Context, number: int) -> bool:
         """
-        Called when trying to delete more than 100 messages at once
+        Called when trying to delete more than 100 messages at once.
 
-        Prompts the user to choose whether they want to continue or not
+        Prompts the user to choose whether they want to continue or not.
+
+        Tries its best to cleanup after itself if the response is positive.
         """
-        def author_check(message):
-            return message.author == ctx.author
 
-        await ctx.send(_('Are you sure you want to delete {} messages? (y/n)').format(number))
-        response = await ctx.bot.wait_for('message', check=author_check)
+        prompt = await ctx.send(
+            _("Are you sure you want to delete {number} messages? (y/n)").format(number=number)
+        )
+        response = await ctx.bot.wait_for("message", check=MessagePredicate.same_context(ctx))
 
-        if response.content.lower().startswith('y'):
+        if response.content.lower().startswith("y"):
+            await prompt.delete()
+            try:
+                await response.delete()
+            except discord.HTTPException:
+                pass
             return True
         else:
-            await ctx.send(_('Cancelled.'))
+            await ctx.send(_("Cancelled."))
             return False
 
     @staticmethod
     async def get_messages_for_deletion(
-            ctx: RedContext, channel: discord.TextChannel, number,
-            check=lambda x: True, limit=100, before=None, after=None
-    ) -> list:
+        *,
+        channel: discord.TextChannel,
+        number: int = None,
+        check: Callable[[discord.Message], bool] = lambda x: True,
+        before: Union[discord.Message, datetime] = None,
+        after: Union[discord.Message, datetime] = None,
+        delete_pinned: bool = False,
+    ) -> List[discord.Message]:
         """
         Gets a list of messages meeting the requirements to be deleted.
-
         Generally, the requirements are:
         - We don't have the number of messages to be deleted already
         - The message passes a provided check (if no check is provided,
           this is automatically true)
         - The message is less than 14 days old
-        """
-        to_delete = []
-        too_old = False
+        - The message is not pinned
 
-        while not too_old and len(to_delete) - 1 < number:
-            message = None
-            async for message in channel.history(limit=limit,
-                                                 before=before,
-                                                 after=after):
-                if (not number or len(to_delete) - 1 < number) and check(message) \
-                        and (ctx.message.created_at - message.created_at).days < 14:
-                    to_delete.append(message)
-                elif (ctx.message.created_at - message.created_at).days >= 14:
-                    too_old = True
-                    break
-                elif number and len(to_delete) >= number:
-                    break
-            if message is None:
+        Warning: Due to the way the API hands messages back in chunks,
+        passing after and a number together is not advisable.
+        If you need to accomplish this, you should filter messages on
+        the entire applicable range, rather than use this utility.
+        """
+
+        # This isn't actually two weeks ago to allow some wiggle room on API limits
+        two_weeks_ago = datetime.utcnow() - timedelta(days=14, minutes=-5)
+
+        def message_filter(message):
+            return (
+                check(message)
+                and message.created_at > two_weeks_ago
+                and (delete_pinned or not message.pinned)
+            )
+
+        if after:
+            if isinstance(after, discord.Message):
+                after = after.created_at
+            after = max(after, two_weeks_ago)
+
+        collected = []
+        async for message in channel.history(
+            limit=None, before=before, after=after, reverse=False
+        ):
+            if message.created_at < two_weeks_ago:
                 break
-            else:
-                before = message
-        return to_delete
+            if message_filter(message):
+                collected.append(message)
+                if number and number <= len(collected):
+                    break
+
+        return collected
 
     @commands.group()
     @checks.mod_or_permissions(manage_messages=True)
-    async def cleanup(self, ctx: RedContext):
-        """Deletes messages."""
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+    async def cleanup(self, ctx: commands.Context):
+        """Delete messages."""
+        pass
 
     @cleanup.command()
     @commands.guild_only()
     @commands.bot_has_permissions(manage_messages=True)
-    async def text(self, ctx: RedContext, text: str, number: int):
-        """Deletes last X messages matching the specified text.
+    async def text(
+        self, ctx: commands.Context, text: str, number: int, delete_pinned: bool = False
+    ):
+        """Delete the last X messages matching the specified text.
 
         Example:
-        cleanup text \"test\" 5
+            `[p]cleanup text "test" 5`
 
-        Remember to use double quotes."""
-
-        channel = ctx.channel
-        author = ctx.author
-        is_bot = self.bot.user.bot
-        
-        if number > 100:
-            cont = await self.check_100_plus(ctx, number)
-            if not cont:
-                return
-    
-        def check(m):
-            if text in m.content:
-                return True
-            elif m == ctx.message:
-                return True
-            else:
-                return False
-
-        to_delete = await self.get_messages_for_deletion(
-            ctx, channel, number, check=check, limit=1000, before=ctx.message)
-
-        reason = "{}({}) deleted {} messages "\
-                 " containing '{}' in channel {}.".format(author.name,
-                                                         author.id, len(to_delete), text, channel.id)
-        log.info(reason)
-
-        if is_bot:
-            await mass_purge(to_delete, channel)
-        else:
-            await slow_deletion(to_delete)
-
-    @cleanup.command()
-    @commands.guild_only()
-    @commands.bot_has_permissions(manage_messages=True)
-    async def user(self, ctx: RedContext, user: discord.Member or int, number: int):
-        """Deletes last X messages from specified user.
-
-        Examples:
-        cleanup user @\u200bTwentysix 2
-        cleanup user Red 6"""
-
-        channel = ctx.channel
-        author = ctx.author
-        is_bot = self.bot.user.bot
-       
-        if number > 100:
-            cont = await self.check_100_plus(ctx, number)
-            if not cont:
-                return
-
-        def check(m):
-            if isinstance(user, discord.Member) and m.author == user:
-                return True
-            elif m.author.id == user:  # Allow finding messages based on an ID
-                return True
-            elif m == ctx.message:
-                return True
-            else:
-                return False
-
-        to_delete = await self.get_messages_for_deletion(
-            ctx, channel, number, check=check, limit=1000, before=ctx.message
-        )
-        reason = "{}({}) deleted {} messages "\
-                 " made by {}({}) in channel {}."\
-                 "".format(author.name, author.id, len(to_delete),
-                           user.name, user.id, channel.name)
-        log.info(reason)
-
-        if is_bot:
-            # For whatever reason the purge endpoint requires manage_messages
-            await mass_purge(to_delete, channel)
-        else:
-            await slow_deletion(to_delete)
-
-    @cleanup.command()
-    @commands.guild_only()
-    @commands.bot_has_permissions(manage_messages=True)
-    async def after(self, ctx: RedContext, message_id: int):
-        """Deletes all messages after specified message.
-
-        To get a message id, enable developer mode in Discord's
-        settings, 'appearance' tab. Then right click a message
-        and copy its id.
-
-        This command only works on bots running as bot accounts.
+        Remember to use double quotes.
         """
 
         channel = ctx.channel
+
         author = ctx.author
-        is_bot = self.bot.user.bot
 
-        if not is_bot:
-            await ctx.send(_("This command can only be used on bots with "
-                             "bot accounts."))
-            return
+        if number > 100:
+            cont = await self.check_100_plus(ctx, number)
+            if not cont:
+                return
 
-        after = await channel.get_message(message_id)
-
-        if not after:
-            await ctx.send(_("Message not found."))
-            return
+        def check(m):
+            if text in m.content:
+                return True
+            else:
+                return False
 
         to_delete = await self.get_messages_for_deletion(
-            ctx, channel, 0, limit=None, after=after
+            channel=channel,
+            number=number,
+            check=check,
+            before=ctx.message,
+            delete_pinned=delete_pinned,
         )
+        to_delete.append(ctx.message)
 
-        reason = "{}({}) deleted {} messages in channel {}."\
-                 "".format(author.name, author.id,
-                           len(to_delete), channel.name)
+        reason = "{}({}) deleted {} messages containing '{}' in channel {}.".format(
+            author.name, author.id, len(to_delete), text, channel.id
+        )
         log.info(reason)
 
         await mass_purge(to_delete, channel)
@@ -207,88 +155,232 @@ class Cleanup:
     @cleanup.command()
     @commands.guild_only()
     @commands.bot_has_permissions(manage_messages=True)
-    async def messages(self, ctx: RedContext, number: int):
-        """Deletes last X messages.
+    async def user(
+        self, ctx: commands.Context, user: str, number: int, delete_pinned: bool = False
+    ):
+        """Delete the last X messages from a specified user.
 
-        Example:
-        cleanup messages 26"""
+        Examples:
+            `[p]cleanup user @\u200bTwentysix 2`
+            `[p]cleanup user Red 6`
+        """
+        channel = ctx.channel
+
+        member = None
+        try:
+            member = await commands.MemberConverter().convert(ctx, user)
+        except commands.BadArgument:
+            try:
+                _id = int(user)
+            except ValueError:
+                raise commands.BadArgument()
+        else:
+            _id = member.id
+
+        author = ctx.author
+
+        if number > 100:
+            cont = await self.check_100_plus(ctx, number)
+            if not cont:
+                return
+
+        def check(m):
+            if m.author.id == _id:
+                return True
+            else:
+                return False
+
+        to_delete = await self.get_messages_for_deletion(
+            channel=channel,
+            number=number,
+            check=check,
+            before=ctx.message,
+            delete_pinned=delete_pinned,
+        )
+        to_delete.append(ctx.message)
+
+        reason = (
+            "{}({}) deleted {} messages "
+            " made by {}({}) in channel {}."
+            "".format(author.name, author.id, len(to_delete), member or "???", _id, channel.name)
+        )
+        log.info(reason)
+
+        await mass_purge(to_delete, channel)
+
+    @cleanup.command()
+    @commands.guild_only()
+    @commands.bot_has_permissions(manage_messages=True)
+    async def after(self, ctx: commands.Context, message_id: int, delete_pinned: bool = False):
+        """Delete all messages after a specified message.
+
+        To get a message id, enable developer mode in Discord's
+        settings, 'appearance' tab. Then right click a message
+        and copy its id.
+        """
+
+        channel = ctx.channel
+        author = ctx.author
+
+        try:
+            after = await channel.get_message(message_id)
+        except discord.NotFound:
+            return await ctx.send(_("Message not found."))
+
+        to_delete = await self.get_messages_for_deletion(
+            channel=channel, number=None, after=after, delete_pinned=delete_pinned
+        )
+
+        reason = "{}({}) deleted {} messages in channel {}.".format(
+            author.name, author.id, len(to_delete), channel.name
+        )
+        log.info(reason)
+
+        await mass_purge(to_delete, channel)
+
+    @cleanup.command()
+    @commands.guild_only()
+    @commands.bot_has_permissions(manage_messages=True)
+    async def before(
+        self, ctx: commands.Context, message_id: int, number: int, delete_pinned: bool = False
+    ):
+        """Deletes X messages before specified message.
+
+        To get a message id, enable developer mode in Discord's
+        settings, 'appearance' tab. Then right click a message
+        and copy its id.
+        """
+
+        channel = ctx.channel
+        author = ctx.author
+
+        try:
+            before = await channel.get_message(message_id)
+        except discord.NotFound:
+            return await ctx.send(_("Message not found."))
+
+        to_delete = await self.get_messages_for_deletion(
+            channel=channel, number=number, before=before, delete_pinned=delete_pinned
+        )
+        to_delete.append(ctx.message)
+
+        reason = "{}({}) deleted {} messages in channel {}.".format(
+            author.name, author.id, len(to_delete), channel.name
+        )
+        log.info(reason)
+
+        await mass_purge(to_delete, channel)
+
+    @cleanup.command()
+    @commands.guild_only()
+    @commands.bot_has_permissions(manage_messages=True)
+    async def messages(self, ctx: commands.Context, number: int, delete_pinned: bool = False):
+        """Delete the last X messages.
+
+        Example:
+            `[p]cleanup messages 26`
+        """
 
         channel = ctx.channel
         author = ctx.author
 
-        is_bot = self.bot.user.bot
-        
         if number > 100:
             cont = await self.check_100_plus(ctx, number)
             if not cont:
                 return
 
         to_delete = await self.get_messages_for_deletion(
-            ctx, channel, number, limit=1000, before=ctx.message
+            channel=channel, number=number, before=ctx.message, delete_pinned=delete_pinned
         )
+        to_delete.append(ctx.message)
 
-        reason = "{}({}) deleted {} messages in channel {}."\
-                 "".format(author.name, author.id,
-                           number, channel.name)
+        reason = "{}({}) deleted {} messages in channel {}.".format(
+            author.name, author.id, number, channel.name
+        )
         log.info(reason)
 
-        if is_bot:
-            await mass_purge(to_delete, channel)
-        else:
-            await slow_deletion(to_delete)
+        await mass_purge(to_delete, channel)
 
-    @cleanup.command(name='bot')
+    @cleanup.command(name="bot")
     @commands.guild_only()
     @commands.bot_has_permissions(manage_messages=True)
-    async def cleanup_bot(self, ctx: RedContext, number: int):
-        """Cleans up command messages and messages from the bot."""
+    async def cleanup_bot(self, ctx: commands.Context, number: int, delete_pinned: bool = False):
+        """Clean up command messages and messages from the bot."""
 
-        channel = ctx.message.channel
+        channel = ctx.channel
         author = ctx.message.author
-        is_bot = self.bot.user.bot
 
         if number > 100:
             cont = await self.check_100_plus(ctx, number)
             if not cont:
                 return
 
-        prefixes = await self.bot.get_prefix(ctx.message) # This returns all server prefixes
+        prefixes = await self.bot.get_prefix(ctx.message)  # This returns all server prefixes
         if isinstance(prefixes, str):
             prefixes = [prefixes]
 
         # In case some idiot sets a null prefix
-        if '' in prefixes:
-            prefixes.remove('')
+        if "" in prefixes:
+            prefixes.remove("")
+
+        cc_cog = self.bot.get_cog("CustomCommands")
+        if cc_cog is not None:
+            command_names: Set[str] = await cc_cog.get_command_names(ctx.guild)
+            is_cc = lambda name: name in command_names
+        else:
+            is_cc = lambda name: False
+        alias_cog = self.bot.get_cog("Alias")
+        if alias_cog is not None:
+            alias_names: Set[str] = (
+                set((a.name for a in await alias_cog.unloaded_global_aliases()))
+                | set(a.name for a in await alias_cog.unloaded_aliases(ctx.guild))
+            )
+            is_alias = lambda name: name in alias_names
+        else:
+            is_alias = lambda name: False
+
+        bot_id = self.bot.user.id
 
         def check(m):
-            if m.author.id == self.bot.user.id:
+            if m.author.id == bot_id:
                 return True
             elif m == ctx.message:
                 return True
             p = discord.utils.find(m.content.startswith, prefixes)
             if p and len(p) > 0:
-                cmd_name = m.content[len(p):].split(' ')[0]
-                return bool(self.bot.get_command(cmd_name))
+                cmd_name = m.content[len(p) :].split(" ")[0]
+                return (
+                    bool(self.bot.get_command(cmd_name)) or is_alias(cmd_name) or is_cc(cmd_name)
+                )
             return False
 
         to_delete = await self.get_messages_for_deletion(
-            ctx, channel, number, check=check, limit=1000, before=ctx.message
+            channel=channel,
+            number=number,
+            check=check,
+            before=ctx.message,
+            delete_pinned=delete_pinned,
         )
+        to_delete.append(ctx.message)
 
-        reason = "{}({}) deleted {} "\
-                 " command messages in channel {}."\
-                 "".format(author.name, author.id, len(to_delete),
-                           channel.name)
+        reason = (
+            "{}({}) deleted {} "
+            " command messages in channel {}."
+            "".format(author.name, author.id, len(to_delete), channel.name)
+        )
         log.info(reason)
 
-        if is_bot:
-            await mass_purge(to_delete, channel)
-        else:
-            await slow_deletion(to_delete)
+        await mass_purge(to_delete, channel)
 
-    @cleanup.command(name='self')
-    async def cleanup_self(self, ctx: RedContext, number: int, match_pattern: str = None):
-        """Cleans up messages owned by the bot.
+    @cleanup.command(name="self")
+    async def cleanup_self(
+        self,
+        ctx: commands.Context,
+        number: int,
+        match_pattern: str = None,
+        delete_pinned: bool = False,
+    ):
+        """Clean up messages owned by the bot.
 
         By default, all messages are cleaned. If a third argument is specified,
         it is used for pattern matching: If it begins with r( and ends with ),
@@ -300,7 +392,6 @@ class Cleanup:
         """
         channel = ctx.channel
         author = ctx.message.author
-        is_bot = self.bot.user.bot
 
         if number > 100:
             cont = await self.check_100_plus(ctx, number)
@@ -313,8 +404,7 @@ class Cleanup:
             me = ctx.guild.me
             can_mass_purge = channel.permissions_for(me).manage_messages
 
-        use_re = (match_pattern and match_pattern.startswith('r(') and
-                  match_pattern.endswith(')'))
+        use_re = match_pattern and match_pattern.startswith("r(") and match_pattern.endswith(")")
 
         if use_re:
             match_pattern = match_pattern[1:]  # strip 'r'
@@ -322,10 +412,14 @@ class Cleanup:
 
             def content_match(c):
                 return bool(match_re.match(c))
+
         elif match_pattern:
+
             def content_match(c):
                 return match_pattern in c
+
         else:
+
             def content_match(_):
                 return True
 
@@ -337,25 +431,26 @@ class Cleanup:
             return False
 
         to_delete = await self.get_messages_for_deletion(
-            ctx, channel, number, check=check, limit=1000, before=ctx.message
+            channel=channel,
+            number=number,
+            check=check,
+            before=ctx.message,
+            delete_pinned=delete_pinned,
         )
 
-        # Selfbot convenience, delete trigger message
-        if author == self.bot.user:
-            to_delete.append(ctx.message)
-
-        if channel.name:
-            channel_name = 'channel ' + channel.name
+        if ctx.guild:
+            channel_name = "channel " + channel.name
         else:
             channel_name = str(channel)
 
-        reason = "{}({}) deleted {} messages "\
-                 "sent by the bot in {}."\
-                 "".format(author.name, author.id, len(to_delete),
-                           channel_name)
+        reason = (
+            "{}({}) deleted {} messages "
+            "sent by the bot in {}."
+            "".format(author.name, author.id, len(to_delete), channel_name)
+        )
         log.info(reason)
 
-        if is_bot and can_mass_purge:
+        if can_mass_purge:
             await mass_purge(to_delete, channel)
         else:
             await slow_deletion(to_delete)

redbot/cogs/cleanup/locales/messages.pot

@@ -1,25 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../cleanup.py:150
-msgid "This command can only be used on bots with bot accounts."
-msgstr ""
-
-#: ../cleanup.py:157
-msgid "Message not found."
-msgstr ""
-

redbot/cogs/cleanup/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../cleanup.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/customcom/customcom.py

@@ -1,377 +1,557 @@
-import os
 import re
 import random
-from datetime import datetime
+from datetime import datetime, timedelta
+from inspect import Parameter
+from collections import OrderedDict
+from typing import Mapping, Tuple, Dict, Set
 
 import discord
-from discord.ext import commands
 
-from redbot.core import Config, checks
-from redbot.core.utils.chat_formatting import box, pagify
-from redbot.core.i18n import CogI18n
+from redbot.core import Config, checks, commands
+from redbot.core.i18n import Translator, cog_i18n
+from redbot.core.utils import menus
+from redbot.core.utils.chat_formatting import box, pagify, escape
+from redbot.core.utils.predicates import MessagePredicate
 
-_ = CogI18n("CustomCommands", __file__)
+_ = Translator("CustomCommands", __file__)
 
 
 class CCError(Exception):
     pass
 
 
-class NotFound(CCError):
-    pass
-
-
 class AlreadyExists(CCError):
     pass
 
 
-class CommandObj:
+class ArgParseError(CCError):
+    pass
 
+
+class NotFound(CCError):
+    pass
+
+
+class OnCooldown(CCError):
+    pass
+
+
+class CommandObj:
     def __init__(self, **kwargs):
-        config = kwargs.get('config')
-        self.bot = kwargs.get('bot')
+        config = kwargs.get("config")
+        self.bot = kwargs.get("bot")
         self.db = config.guild
 
     @staticmethod
     async def get_commands(config) -> dict:
-        commands = await config.commands()
-        customcommands = {k: v for k, v in commands.items() if commands[k]}
-        if len(customcommands) == 0:
-            return None
-        return customcommands
+        _commands = await config.commands()
+        return {k: v for k, v in _commands.items() if _commands[k]}
 
     async def get_responses(self, ctx):
-        intro = (_("Welcome to the interactive random {} maker!\n"
-                 "Every message you send will be added as one of the random "
-                 "response to choose from once this {} is "
-                 "triggered. To exit this interactive menu, type `{}`").format(
-            "customcommand", "customcommand", "exit()"
-        ))
+        intro = _(
+            "Welcome to the interactive random {cc} maker!\n"
+            "Every message you send will be added as one of the random "
+            "responses to choose from once this {cc} is "
+            "triggered. To exit this interactive menu, type `{quit}`"
+        ).format(cc="customcommand", quit="exit()")
         await ctx.send(intro)
 
-        def check(m):
-            return m.channel == ctx.channel and m.author == ctx.message.author
         responses = []
+        args = None
         while True:
             await ctx.send(_("Add a random response:"))
-            msg = await self.bot.wait_for('message', check=check)
+            msg = await self.bot.wait_for("message", check=MessagePredicate.same_context(ctx))
 
-            if msg.content.lower() == 'exit()':
+            if msg.content.lower() == "exit()":
                 break
             else:
+                try:
+                    this_args = ctx.cog.prepare_args(msg.content)
+                except ArgParseError as e:
+                    await ctx.send(e.args[0])
+                    continue
+                if args and args != this_args:
+                    await ctx.send(_("Random responses must take the same arguments!"))
+                    continue
+                args = args or this_args
                 responses.append(msg.content)
         return responses
 
-    def get_now(self) -> str:
+    @staticmethod
+    def get_now() -> str:
         # Get current time as a string, for 'created_at' and 'edited_at' fields
         # in the ccinfo dict
-        return '{:%d/%m/%Y %H:%M:%S}'.format(datetime.utcnow())
+        return "{:%d/%m/%Y %H:%M:%S}".format(datetime.utcnow())
 
-    async def get(self,
-                  message: discord.Message,
-                  command: str) -> str:
+    async def get(self, message: discord.Message, command: str) -> Tuple[str, Dict]:
         ccinfo = await self.db(message.guild).commands.get_raw(command, default=None)
         if not ccinfo:
-            raise NotFound
+            raise NotFound()
         else:
-            return ccinfo['response']
+            return ccinfo["response"], ccinfo.get("cooldowns", {})
 
-    async def create(self,
-                     ctx: commands.Context,
-                     command: str,
-                     response):
-        """Create a customcommand"""
+    async def create(self, ctx: commands.Context, command: str, *, response):
+        """Create a custom command"""
         # Check if this command is already registered as a customcommand
         if await self.db(ctx.guild).commands.get_raw(command, default=None):
             raise AlreadyExists()
+        # test to raise
+        ctx.cog.prepare_args(response if isinstance(response, str) else response[0])
         author = ctx.message.author
         ccinfo = {
-            'author': {
-                'id': author.id,
-                'name': author.name
-            },
-            'command': command,
-            'created_at': self.get_now(),
-            'editors': [],
-            'response': response
-
+            "author": {"id": author.id, "name": author.name},
+            "command": command,
+            "cooldowns": {},
+            "created_at": self.get_now(),
+            "editors": [],
+            "response": response,
         }
-        await self.db(ctx.guild).commands.set_raw(
-            command, value=ccinfo)
+        await self.db(ctx.guild).commands.set_raw(command, value=ccinfo)
 
-    async def edit(self,
-                   ctx: commands.Context,
-                   command: str,
-                   response: None):
+    async def edit(
+        self,
+        ctx: commands.Context,
+        command: str,
+        *,
+        response=None,
+        cooldowns: Mapping[str, int] = None,
+        ask_for: bool = True,
+    ):
         """Edit an already existing custom command"""
+        ccinfo = await self.db(ctx.guild).commands.get_raw(command, default=None)
+
         # Check if this command is registered
-        if not await self.db(ctx.guild).commands.get_raw(command, default=None):
+        if not ccinfo:
             raise NotFound()
 
         author = ctx.message.author
-        ccinfo = await self.db(ctx.guild).commands.get_raw(command, default=None)
 
-        def check(m):
-            return m.channel == ctx.channel and m.author == ctx.message.author
+        if ask_for and not response:
+            await ctx.send(_("Do you want to create a 'randomized' custom command? (y/n)"))
 
-        if not response:
-            await ctx.send(
-                _("Do you want to create a 'randomized' cc? {}").format("y/n")
-            )
-
-            msg = await self.bot.wait_for('message', check=check)
-            if msg.content.lower() == 'y':
+            pred = MessagePredicate.yes_or_no(ctx)
+            try:
+                await self.bot.wait_for("message", check=pred, timeout=30)
+            except TimeoutError:
+                await ctx.send(_("Response timed out, please try again later."))
+                return
+            if pred.result is True:
                 response = await self.get_responses(ctx=ctx)
             else:
                 await ctx.send(_("What response do you want?"))
-                response = (await self.bot.wait_for(
-                    'message', check=check)
-                ).content
+                try:
+                    resp = await self.bot.wait_for(
+                        "message", check=MessagePredicate.same_context(ctx), timeout=180
+                    )
+                except TimeoutError:
+                    await ctx.send(_("Response timed out, please try again later."))
+                    return
+                response = resp.content
 
-        ccinfo['response'] = response
-        ccinfo['edited_at'] = self.get_now()
+        if response:
+            # test to raise
+            ctx.cog.prepare_args(response if isinstance(response, str) else response[0])
+            ccinfo["response"] = response
 
-        if author.id not in ccinfo['editors']:
+        if cooldowns:
+            ccinfo.setdefault("cooldowns", {}).update(cooldowns)
+            for key, value in ccinfo["cooldowns"].copy().items():
+                if value <= 0:
+                    del ccinfo["cooldowns"][key]
+
+        if author.id not in ccinfo["editors"]:
             # Add the person who invoked the `edit` coroutine to the list of
             # editors, if the person is not yet in there
-            ccinfo['editors'].append(
-                author.id
-            )
+            ccinfo["editors"].append(author.id)
 
-        await self.db(ctx.guild).commands.set_raw(
-            command, value=ccinfo)
+        ccinfo["edited_at"] = self.get_now()
 
-    async def delete(self,
-                     ctx: commands.Context,
-                     command: str):
+        await self.db(ctx.guild).commands.set_raw(command, value=ccinfo)
+
+    async def delete(self, ctx: commands.Context, command: str):
         """Delete an already exisiting custom command"""
         # Check if this command is registered
         if not await self.db(ctx.guild).commands.get_raw(command, default=None):
             raise NotFound()
-        await self.db(ctx.guild).commands.set_raw(
-            command, value=None)
+        await self.db(ctx.guild).commands.set_raw(command, value=None)
 
 
-class CustomCommands:
-    """Custom commands
-    Creates commands used to display text"""
+@cog_i18n(_)
+class CustomCommands(commands.Cog):
+    """Creates commands used to display text."""
 
     def __init__(self, bot):
+        super().__init__()
         self.bot = bot
         self.key = 414589031223512
-        self.config = Config.get_conf(self,
-                                      self.key)
+        self.config = Config.get_conf(self, self.key)
         self.config.register_guild(commands={})
-        self.commandobj = CommandObj(config=self.config,
-                                     bot=self.bot)
+        self.commandobj = CommandObj(config=self.config, bot=self.bot)
+        self.cooldowns = {}
 
-    @commands.group(aliases=["cc"], no_pm=True)
+    @commands.group(aliases=["cc"])
     @commands.guild_only()
-    async def customcom(self,
-                        ctx: commands.Context):
-        """Custom commands management"""
-        if not ctx.invoked_subcommand:
-            await ctx.send_help()
+    async def customcom(self, ctx: commands.Context):
+        """Custom commands management."""
+        pass
 
-    @customcom.group(name="add")
+    @customcom.group(name="create", aliases=["add"])
     @checks.mod_or_permissions(administrator=True)
-    async def cc_add(self,
-                     ctx: commands.Context):
-        """
-        CCs can be enhanced with arguments:
-        https: // twentysix26.github.io / Red - Docs / red_guide_command_args/
-        """
-        if not ctx.invoked_subcommand or isinstance(ctx.invoked_subcommand,
-                                                    commands.Group):
-            await ctx.send_help()
+    async def cc_create(self, ctx: commands.Context):
+        """Create custom commands.
 
-    @cc_add.command(name='random')
+        CCs can be enhanced with arguments, see the guide
+        [here](https://red-discordbot.readthedocs.io/en/v3-develop/cog_customcom.html).
+        """
+        pass
+
+    @cc_create.command(name="random")
     @checks.mod_or_permissions(administrator=True)
-    async def cc_add_random(self,
-                            ctx: commands.Context,
-                            command: str):
-        """
-        Create a CC where it will randomly choose a response!
-        Note: This is interactive
-        """
-        channel = ctx.channel
-        responses = []
+    async def cc_create_random(self, ctx: commands.Context, command: str.lower):
+        """Create a CC where it will randomly choose a response!
 
+        Note: This command is interactive.
+        """
         responses = await self.commandobj.get_responses(ctx=ctx)
         try:
-            await self.commandobj.create(ctx=ctx,
-                                         command=command,
-                                         response=responses)
+            await self.commandobj.create(ctx=ctx, command=command, response=responses)
             await ctx.send(_("Custom command successfully added."))
         except AlreadyExists:
-            await ctx.send(_(
-                "This command already exists. Use "
-                "`{}` to edit it.").format(
-                    "{}customcom edit".format(ctx.prefix)
-            ))
+            await ctx.send(
+                _("This command already exists. Use `{command}` to edit it.").format(
+                    command="{}customcom edit".format(ctx.prefix)
+                )
+            )
 
-        # await ctx.send(str(responses))
-
-    @cc_add.command(name="simple")
+    @cc_create.command(name="simple")
     @checks.mod_or_permissions(administrator=True)
-    async def cc_add_simple(self,
-                            ctx,
-                            command: str,
-                            *,
-                            text):
-        """Adds a simple custom command
+    async def cc_create_simple(self, ctx, command: str.lower, *, text: str):
+        """Add a simple custom command.
+
         Example:
-        [p]customcom add simple yourcommand Text you want
+        - `[p]customcom create simple yourcommand Text you want`
         """
-        guild = ctx.guild
-        command = command.lower()
         if command in self.bot.all_commands:
-            await ctx.send(_("That command is already a standard command."))
+            await ctx.send(_("There already exists a bot command with the same name."))
             return
         try:
-            await self.commandobj.create(ctx=ctx,
-                                         command=command,
-                                         response=text)
+            await self.commandobj.create(ctx=ctx, command=command, response=text)
             await ctx.send(_("Custom command successfully added."))
         except AlreadyExists:
-            await ctx.send(_(
-                "This command already exists. Use "
-                "`{}` to edit it.").format(
-                    "{}customcom edit".format(ctx.prefix)
-                ))
+            await ctx.send(
+                _("This command already exists. Use `{command}` to edit it.").format(
+                    command="{}customcom edit".format(ctx.prefix)
+                )
+            )
+        except ArgParseError as e:
+            await ctx.send(e.args[0])
 
-    @customcom.command(name="edit")
+    @customcom.command(name="cooldown")
     @checks.mod_or_permissions(administrator=True)
-    async def cc_edit(self,
-                      ctx,
-                      command: str,
-                      *,
-                      text=None):
-        """Edits a custom command
-        Example:
-        [p]customcom edit yourcommand Text you want
-        """
-        guild = ctx.message.guild
-        command = command.lower()
+    async def cc_cooldown(
+        self, ctx, command: str.lower, cooldown: int = None, *, per: str.lower = "member"
+    ):
+        """Set, edit, or view the cooldown for a custom command.
 
+        You may set cooldowns per member, channel, or guild. Multiple
+        cooldowns may be set. All cooldowns must be cooled to call the
+        custom command.
+
+        Example:
+        - `[p]customcom cooldown yourcommand 30`
+        """
+        if cooldown is None:
+            try:
+                cooldowns = (await self.commandobj.get(ctx.message, command))[1]
+            except NotFound:
+                return await ctx.send(_("That command doesn't exist."))
+            if cooldowns:
+                cooldown = []
+                for per, rate in cooldowns.items():
+                    cooldown.append(
+                        _("A {} may call this command every {} seconds").format(per, rate)
+                    )
+                return await ctx.send("\n".join(cooldown))
+            else:
+                return await ctx.send(_("This command has no cooldown."))
+        per = {"server": "guild", "user": "member"}.get(per, per)
+        allowed = ("guild", "member", "channel")
+        if per not in allowed:
+            return await ctx.send(_("{} must be one of {}").format("per", ", ".join(allowed)))
+        cooldown = {per: cooldown}
         try:
-            await self.commandobj.edit(ctx=ctx,
-                                       command=command,
-                                       response=text)
-            await ctx.send(_("Custom command successfully edited."))
+            await self.commandobj.edit(ctx=ctx, command=command, cooldowns=cooldown, ask_for=False)
+            await ctx.send(_("Custom command cooldown successfully edited."))
         except NotFound:
-            await ctx.send(_(
-                "That command doesn't exist. Use "
-                "`{}` to add it.").format(
-                    "{}customcom add".format(ctx.prefix)
-            ))
+            await ctx.send(
+                _("That command doesn't exist. Use `{command}` to add it.").format(
+                    command="{}customcom create".format(ctx.prefix)
+                )
+            )
 
     @customcom.command(name="delete")
     @checks.mod_or_permissions(administrator=True)
-    async def cc_delete(self,
-                        ctx,
-                        command: str):
-        """Deletes a custom command
+    async def cc_delete(self, ctx, command: str.lower):
+        """Delete a custom command
+.
         Example:
-        [p]customcom delete yourcommand"""
-        guild = ctx.message.guild
-        command = command.lower()
+        - `[p]customcom delete yourcommand`
+        """
         try:
-            await self.commandobj.delete(ctx=ctx,
-                                         command=command)
+            await self.commandobj.delete(ctx=ctx, command=command)
             await ctx.send(_("Custom command successfully deleted."))
         except NotFound:
             await ctx.send(_("That command doesn't exist."))
 
+    @customcom.command(name="edit")
+    @checks.mod_or_permissions(administrator=True)
+    async def cc_edit(self, ctx, command: str.lower, *, text: str = None):
+        """Edit a custom command.
+
+        Example:
+        - `[p]customcom edit yourcommand Text you want`
+        """
+        try:
+            await self.commandobj.edit(ctx=ctx, command=command, response=text)
+            await ctx.send(_("Custom command successfully edited."))
+        except NotFound:
+            await ctx.send(
+                _("That command doesn't exist. Use `{command}` to add it.").format(
+                    command="{}customcom create".format(ctx.prefix)
+                )
+            )
+        except ArgParseError as e:
+            await ctx.send(e.args[0])
+
     @customcom.command(name="list")
-    async def cc_list(self,
-                      ctx):
-        """Shows custom commands list"""
+    @checks.bot_has_permissions(add_reactions=True)
+    async def cc_list(self, ctx: commands.Context):
+        """List all available custom commands.
 
-        response = await CommandObj.get_commands(self.config.guild(ctx.guild))
+        The list displays a preview of each command's response, with
+        markdown escaped and newlines replaced with spaces.
+        """
+        cc_dict = await CommandObj.get_commands(self.config.guild(ctx.guild))
 
-        if not response:
-            await ctx.send(_(
-                "There are no custom commands in this server."
-                " Use `{}` to start adding some.").format(
-                    "{}customcom add".format(ctx.prefix)
-            ))
+        if not cc_dict:
+            await ctx.send(
+                _(
+                    "There are no custom commands in this server."
+                    " Use `{command}` to start adding some."
+                ).format(command="{}customcom create".format(ctx.prefix))
+            )
             return
 
         results = []
-
-        for command, body in response.items():
-            responses = body['response']
+        for command, body in sorted(cc_dict.items(), key=lambda t: t[0]):
+            responses = body["response"]
             if isinstance(responses, list):
                 result = ", ".join(responses)
             elif isinstance(responses, str):
                 result = responses
             else:
                 continue
-            results.append("{command:<15} : {result}".format(command=command,
-                                                             result=result))
+            # Cut preview to 52 characters max
+            if len(result) > 52:
+                result = result[:49] + "..."
+            # Replace newlines with spaces
+            result = result.replace("\n", " ")
+            # Escape markdown and mass mentions
+            result = escape(result, formatting=True, mass_mentions=True)
+            results.append((f"{ctx.clean_prefix}{command}", result))
 
-        commands = "\n".join(results)
-
-        if len(commands) < 1500:
-            await ctx.send(box(commands))
+        if await ctx.embed_requested():
+            # We need a space before the newline incase the CC preview ends in link (GH-2295)
+            content = " \n".join(map("**{0[0]}** {0[1]}".format, results))
+            pages = list(pagify(content, page_length=1024))
+            embed_pages = []
+            for idx, page in enumerate(pages, start=1):
+                embed = discord.Embed(
+                    title=_("Custom Command List"),
+                    description=page,
+                    colour=await ctx.embed_colour(),
+                )
+                embed.set_footer(text=_("Page {num}/{total}").format(num=idx, total=len(pages)))
+                embed_pages.append(embed)
+            await menus.menu(ctx, embed_pages, menus.DEFAULT_CONTROLS)
         else:
-            for page in pagify(commands, delims=[" ", "\n"]):
-                await ctx.author.send(box(page))
+            content = "\n".join(map("{0[0]:<12} : {0[1]}".format, results))
+            pages = list(map(box, pagify(content, page_length=2000, shorten_by=10)))
+            await menus.menu(ctx, pages, menus.DEFAULT_CONTROLS)
 
-    async def on_message(self,
-                         message):
+    async def on_message(self, message):
         is_private = isinstance(message.channel, discord.abc.PrivateChannel)
-        if len(message.content) < 2 or is_private:
-            return
-
-        guild = message.guild
-        prefixes = await self.bot.db.guild(guild).get_raw('prefix', default=[])
-
-        if len(prefixes) < 1:
-            def_prefixes = await self.bot.get_prefix(message)
-            for prefix in def_prefixes:
-                prefixes.append(prefix)
 
         # user_allowed check, will be replaced with self.bot.user_allowed or
         # something similar once it's added
-
         user_allowed = True
 
-        for prefix in prefixes:
-            if message.content.startswith(prefix):
-                break
-        else:
+        if len(message.content) < 2 or is_private or not user_allowed or message.author.bot:
             return
 
-        if user_allowed:
-            cmd = message.content[len(prefix):]
-            try:
-                c = await self.commandobj.get(message=message,
-                                              command=cmd)
-                if isinstance(c, list):
-                    command = random.choice(c)
-                elif isinstance(c, str):
-                    command = c
-                else:
-                    raise NotFound()
-            except NotFound:
-                return
-            response = self.format_cc(command, message)
-            await message.channel.send(response)
+        ctx = await self.bot.get_context(message)
 
-    def format_cc(self,
-                  command,
-                  message) -> str:
-        results = re.findall("\{([^}]+)\}", command)
+        if ctx.prefix is None or ctx.valid:
+            return
+
+        try:
+            raw_response, cooldowns = await self.commandobj.get(
+                message=message, command=ctx.invoked_with
+            )
+            if isinstance(raw_response, list):
+                raw_response = random.choice(raw_response)
+            elif isinstance(raw_response, str):
+                pass
+            else:
+                raise NotFound()
+            if cooldowns:
+                self.test_cooldowns(ctx, ctx.invoked_with, cooldowns)
+        except CCError:
+            return
+
+        # wrap the command here so it won't register with the bot
+        fake_cc = commands.Command(ctx.invoked_with, self.cc_callback)
+        fake_cc.params = self.prepare_args(raw_response)
+        ctx.command = fake_cc
+
+        await self.bot.invoke(ctx)
+        if not ctx.command_failed:
+            await self.cc_command(*ctx.args, **ctx.kwargs, raw_response=raw_response)
+
+    async def cc_callback(self, *args, **kwargs) -> None:
+        """
+        Custom command.
+
+        Created via the CustomCom cog. See `[p]customcom` for more details.
+        """
+        # fake command to take advantage of discord.py's parsing and events
+        pass
+
+    async def cc_command(self, ctx, *cc_args, raw_response, **cc_kwargs) -> None:
+        cc_args = (*cc_args, *cc_kwargs.values())
+        results = re.findall(r"{([^}]+)\}", raw_response)
         for result in results:
-            param = self.transform_parameter(result, message)
-            command = command.replace("{" + result + "}", param)
-        return command
+            param = self.transform_parameter(result, ctx.message)
+            raw_response = raw_response.replace("{" + result + "}", param)
+        results = re.findall(r"{((\d+)[^.}]*(\.[^:}]+)?[^}]*)\}", raw_response)
+        if results:
+            low = min(int(result[1]) for result in results)
+            for result in results:
+                index = int(result[1]) - low
+                arg = self.transform_arg(result[0], result[2], cc_args[index])
+                raw_response = raw_response.replace("{" + result[0] + "}", arg)
+        await ctx.send(raw_response)
 
-    def transform_parameter(self,
-                            result,
-                            message) -> str:
+    @staticmethod
+    def prepare_args(raw_response) -> Mapping[str, Parameter]:
+        args = re.findall(r"{(\d+)[^:}]*(:[^.}]*)?[^}]*\}", raw_response)
+        default = [("ctx", Parameter("ctx", Parameter.POSITIONAL_OR_KEYWORD))]
+        if not args:
+            return OrderedDict(default)
+        allowed_builtins = {
+            "bool": bool,
+            "complex": complex,
+            "float": float,
+            "frozenset": frozenset,
+            "int": int,
+            "list": list,
+            "set": set,
+            "str": str,
+            "tuple": tuple,
+        }
+        indices = [int(a[0]) for a in args]
+        low = min(indices)
+        indices = [a - low for a in indices]
+        high = max(indices)
+        if high > 9:
+            raise ArgParseError(_("Too many arguments!"))
+        gaps = set(indices).symmetric_difference(range(high + 1))
+        if gaps:
+            raise ArgParseError(
+                _("Arguments must be sequential. Missing arguments: ")
+                + ", ".join(str(i + low) for i in gaps)
+            )
+        fin = [Parameter("_" + str(i), Parameter.POSITIONAL_OR_KEYWORD) for i in range(high + 1)]
+        for arg in args:
+            index = int(arg[0]) - low
+            anno = arg[1][1:]  # strip initial colon
+            if anno.lower().endswith("converter"):
+                anno = anno[:-9]
+            if not anno or anno.startswith("_"):  # public types only
+                name = "{}_{}".format("text", index if index < high else "final")
+                fin[index] = fin[index].replace(name=name)
+                continue
+            # allow type hinting only for discord.py and builtin types
+            try:
+                anno = getattr(discord, anno)
+                # force an AttributeError if there's no discord.py converter
+                getattr(commands, anno.__name__ + "Converter")
+            except AttributeError:
+                anno = allowed_builtins.get(anno.lower(), Parameter.empty)
+            if (
+                anno is not Parameter.empty
+                and fin[index].annotation is not Parameter.empty
+                and anno != fin[index].annotation
+            ):
+                raise ArgParseError(
+                    _(
+                        'Conflicting colon notation for argument {index}: "{name1}" and "{name2}".'
+                    ).format(
+                        index=index + low,
+                        name1=fin[index].annotation.__name__,
+                        name2=anno.__name__,
+                    )
+                )
+            if anno is not Parameter.empty:
+                fin[index] = fin[index].replace(annotation=anno)
+        # consume rest
+        fin[-1] = fin[-1].replace(kind=Parameter.KEYWORD_ONLY)
+        # name the parameters for the help text
+        for i, param in enumerate(fin):
+            anno = param.annotation
+            name = "{}_{}".format(
+                "text" if anno is Parameter.empty else anno.__name__.lower(),
+                i if i < high else "final",
+            )
+            fin[i] = fin[i].replace(name=name)
+        # insert ctx parameter for discord.py parsing
+        fin = default + [(p.name, p) for p in fin]
+        return OrderedDict(fin)
+
+    def test_cooldowns(self, ctx, command, cooldowns):
+        now = datetime.utcnow()
+        new_cooldowns = {}
+        for per, rate in cooldowns.items():
+            if per == "guild":
+                key = (command, ctx.guild)
+            elif per == "channel":
+                key = (command, ctx.guild, ctx.channel)
+            elif per == "member":
+                key = (command, ctx.guild, ctx.author)
+            else:
+                raise ValueError(per)
+            cooldown = self.cooldowns.get(key)
+            if cooldown:
+                cooldown += timedelta(seconds=rate)
+                if cooldown > now:
+                    raise OnCooldown()
+            new_cooldowns[key] = now
+        # only update cooldowns if the command isn't on cooldown
+        self.cooldowns.update(new_cooldowns)
+
+    @staticmethod
+    def transform_arg(result, attr, obj) -> str:
+        attr = attr[1:]  # strip initial dot
+        if not attr:
+            return str(obj)
+        raw_result = "{" + result + "}"
+        # forbid private members and nested attr lookups
+        if attr.startswith("_") or "." in attr:
+            return raw_result
+        return str(getattr(obj, attr, raw_result))
+
+    @staticmethod
+    def transform_parameter(result, message) -> str:
         """
         For security reasons only specific objects are allowed
         Internals are ignored
@@ -382,7 +562,7 @@ class CustomCommands:
             "author": message.author,
             "channel": message.channel,
             "guild": message.guild,
-            "server": message.guild
+            "server": message.guild,
         }
         if result in objects:
             return str(objects[result])
@@ -395,3 +575,14 @@ class CustomCommands:
         else:
             return raw_result
         return str(getattr(first, second, raw_result))
+
+    async def get_command_names(self, guild: discord.Guild) -> Set[str]:
+        """Get all custom command names in a guild.
+
+        Returns
+        --------
+        Set[str]
+            A set of all custom command names.
+
+        """
+        return set(await CommandObj.get_commands(self.config.guild(guild)))

redbot/cogs/customcom/locales/messages.pot

@@ -1,67 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../customcom.py:44
-msgid ""
-"Welcome to the interactive random {} maker!\n"
-"Every message you send will be added as one of the random response to choose from once this {} is triggered. To exit this interactive menu, type `{}`"
-msgstr ""
-
-#: ../customcom.py:56
-msgid "Add a random response:"
-msgstr ""
-
-#: ../customcom.py:119
-msgid "Do you want to create a 'randomized' cc? {}"
-msgstr ""
-
-#: ../customcom.py:126
-msgid "What response do you want?"
-msgstr ""
-
-#: ../customcom.py:205 ../customcom.py:235
-msgid "Custom command successfully added."
-msgstr ""
-
-#: ../customcom.py:207 ../customcom.py:237
-msgid "This command already exists. Use `{}` to edit it."
-msgstr ""
-
-#: ../customcom.py:229
-msgid "That command is already a standard command."
-msgstr ""
-
-#: ../customcom.py:261
-msgid "Custom command successfully edited."
-msgstr ""
-
-#: ../customcom.py:263
-msgid "That command doesn't exist. Use `{}` to add it."
-msgstr ""
-
-#: ../customcom.py:282
-msgid "Custom command successfully deleted."
-msgstr ""
-
-#: ../customcom.py:284
-msgid "That command doesn't exist."
-msgstr ""
-
-#: ../customcom.py:294
-msgid "There are no custom commands in this guild. Use `{}` to start adding some."
-msgstr ""
-

redbot/cogs/customcom/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../customcom.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/dataconverter/core_specs.py

@@ -16,49 +16,49 @@ class SpecResolver(object):
         self.v2path = path
         self.resolved = set()
         self.available_core_conversions = {
-            'Bank Accounts': {
-                'cfg': ('Bank', None, 384734293238749),
-                'file': self.v2path / 'data' / 'economy' / 'bank.json',
-                'converter': self.bank_accounts_conv_spec
+            "Bank Accounts": {
+                "cfg": ("Bank", None, 384734293238749),
+                "file": self.v2path / "data" / "economy" / "bank.json",
+                "converter": self.bank_accounts_conv_spec,
             },
-            'Economy Settings': {
-                'cfg': ('Economy', 'config', 1256844281),
-                'file': self.v2path / 'data' / 'economy' / 'settings.json',
-                'converter': self.economy_conv_spec
+            "Economy Settings": {
+                "cfg": ("Economy", "config", 1256844281),
+                "file": self.v2path / "data" / "economy" / "settings.json",
+                "converter": self.economy_conv_spec,
             },
-            'Mod Log Cases': {
-                'cfg': ('ModLog', None, 1354799444),
-                'file': self.v2path / 'data' / 'mod' / 'modlog.json',
-                'converter': None  # prevents from showing as available
+            "Mod Log Cases": {
+                "cfg": ("ModLog", None, 1354799444),
+                "file": self.v2path / "data" / "mod" / "modlog.json",
+                "converter": None,  # prevents from showing as available
             },
-            'Filter': {
-                'cfg': ('Filter', 'settings', 4766951341),
-                'file': self.v2path / 'data' / 'mod' / 'filter.json',
-                'converter': self.filter_conv_spec
+            "Filter": {
+                "cfg": ("Filter", "settings", 4766951341),
+                "file": self.v2path / "data" / "mod" / "filter.json",
+                "converter": self.filter_conv_spec,
             },
-            'Past Names': {
-                'cfg': ('Mod', 'settings', 4961522000),
-                'file': self.v2path / 'data' / 'mod' / 'past_names.json',
-                'converter': self.past_names_conv_spec
+            "Past Names": {
+                "cfg": ("Mod", "settings", 4961522000),
+                "file": self.v2path / "data" / "mod" / "past_names.json",
+                "converter": self.past_names_conv_spec,
             },
-            'Past Nicknames': {
-                'cfg': ('Mod', 'settings', 4961522000),
-                'file': self.v2path / 'data' / 'mod' / 'past_nicknames.json',
-                'converter': self.past_nicknames_conv_spec
+            "Past Nicknames": {
+                "cfg": ("Mod", "settings", 4961522000),
+                "file": self.v2path / "data" / "mod" / "past_nicknames.json",
+                "converter": self.past_nicknames_conv_spec,
+            },
+            "Custom Commands": {
+                "cfg": ("CustomCommands", "config", 414589031223512),
+                "file": self.v2path / "data" / "customcom" / "commands.json",
+                "converter": self.customcom_conv_spec,
             },
-            'Custom Commands': {
-                'cfg': ('CustomCommands', 'config', 414589031223512),
-                'file': self.v2path / 'data' / 'customcom' / 'commands.json',
-                'converter': self.customcom_conv_spec
-            }
         }
 
     @property
     def available(self):
         return sorted(
-            k for k, v in self.available_core_conversions.items()
-            if v['file'].is_file() and v['converter'] is not None
-            and k not in self.resolved
+            k
+            for k, v in self.available_core_conversions.items()
+            if v["file"].is_file() and v["converter"] is not None and k not in self.resolved
         )
 
     def unpack(self, parent_key, parent_value):
@@ -75,15 +75,8 @@ class SpecResolver(object):
         """Flatten a nested dictionary structure"""
         dictionary = {(key,): value for key, value in dictionary.items()}
         while True:
-            dictionary = dict(
-                chain.from_iterable(
-                    starmap(self.unpack, dictionary.items())
-                )
-            )
-            if not any(
-                isinstance(value, dict)
-                for value in dictionary.values()
-            ):
+            dictionary = dict(chain.from_iterable(starmap(self.unpack, dictionary.items())))
+            if not any(isinstance(value, dict) for value in dictionary.values()):
                 break
         return dictionary
 
@@ -97,11 +90,8 @@ class SpecResolver(object):
             outerkey, innerkey = tuple(k[:-1]), (k[-1],)
             if outerkey not in ret:
                 ret[outerkey] = {}
-            if innerkey[0] == 'created_at':
-                x = int(
-                    datetime.strptime(
-                        v, "%Y-%m-%d %H:%M:%S").timestamp()
-                )
+            if innerkey[0] == "created_at":
+                x = int(datetime.strptime(v, "%Y-%m-%d %H:%M:%S").timestamp())
                 ret[outerkey].update({innerkey: x})
             else:
                 ret[outerkey].update({innerkey: v})
@@ -121,60 +111,60 @@ class SpecResolver(object):
         raise NotImplementedError("This one isn't ready yet")
 
     def filter_conv_spec(self, data: dict):
-        return {
-            (Config.GUILD, k): {('filter',): v}
-            for k, v in data.items()
-        }
+        return {(Config.GUILD, k): {("filter",): v} for k, v in data.items()}
 
     def past_names_conv_spec(self, data: dict):
-        return {
-            (Config.USER, k): {('past_names',): v}
-            for k, v in data.items()
-        }
+        return {(Config.USER, k): {("past_names",): v} for k, v in data.items()}
 
     def past_nicknames_conv_spec(self, data: dict):
         flatscoped = self.apply_scope(Config.MEMBER, self.flatten_dict(data))
         ret = {}
-        for k, v in flatscoped.items():
-            outerkey, innerkey = (*k[:-1],), (k[-1],)
-            if outerkey not in ret:
-                ret[outerkey] = {}
-            ret[outerkey].update({innerkey: v})
+        for config_identifiers, v2data in flatscoped.items():
+            if config_identifiers not in ret:
+                ret[config_identifiers] = {}
+            ret[config_identifiers].update({("past_nicks",): v2data})
         return ret
 
     def customcom_conv_spec(self, data: dict):
         flatscoped = self.apply_scope(Config.GUILD, self.flatten_dict(data))
         ret = {}
         for k, v in flatscoped.items():
-            outerkey, innerkey = (*k[:-1],), ('commands', k[-1])
+            outerkey, innerkey = (*k[:-1],), ("commands", k[-1])
             if outerkey not in ret:
                 ret[outerkey] = {}
 
             ccinfo = {
-                'author': {
-                    'id': 42,
-                    'name': 'Converted from a v2 instance'
-                },
-                'command': k[-1],
-                'created_at': '{:%d/%m/%Y %H:%M:%S}'.format(datetime.utcnow()),
-                'editors': [],
-                'response': v
+                "author": {"id": 42, "name": "Converted from a v2 instance"},
+                "command": k[-1],
+                "created_at": "{:%d/%m/%Y %H:%M:%S}".format(datetime.utcnow()),
+                "editors": [],
+                "response": v,
             }
             ret[outerkey].update({innerkey: ccinfo})
         return ret
 
-    async def convert(self, bot: Red, prettyname: str):
-        if prettyname not in self.available:
-            raise NotImplementedError("No Conversion Specs for this")
-
-        info = self.available_core_conversions[prettyname]
-        filepath, converter = info['file'], info['converter']
-        (cogname, attr, _id) = info['cfg']
+    def get_config_object(self, bot, cogname, attr, _id):
         try:
             config = getattr(bot.get_cog(cogname), attr)
         except (TypeError, AttributeError):
             config = Config.get_conf(None, _id, cog_name=cogname)
 
+        return config
+
+    def get_conversion_info(self, prettyname: str):
+        info = self.available_core_conversions[prettyname]
+        filepath, converter = info["file"], info["converter"]
+        (cogname, attr, _id) = info["cfg"]
+        return filepath, converter, cogname, attr, _id
+
+    async def convert(self, bot: Red, prettyname: str, config=None):
+        if prettyname not in self.available:
+            raise NotImplementedError("No Conversion Specs for this")
+
+        filepath, converter, cogname, attr, _id = self.get_conversion_info(prettyname)
+        if config is None:
+            config = self.get_config_object(bot, cogname, attr, _id)
+
         try:
             items = converter(dc.json_load(filepath))
             await dc(config).dict_import(items)

redbot/cogs/dataconverter/dataconverter.py

@@ -1,74 +1,63 @@
 from pathlib import Path
 import asyncio
 
-from discord.ext import commands
-
-from redbot.core import checks, RedContext
+from redbot.core import checks, commands
 from redbot.core.bot import Red
-from redbot.core.i18n import CogI18n
+from redbot.core.i18n import Translator, cog_i18n
 from redbot.cogs.dataconverter.core_specs import SpecResolver
 from redbot.core.utils.chat_formatting import box
+from redbot.core.utils.predicates import MessagePredicate
 
-_ = CogI18n('DataConverter', __file__)
+_ = Translator("DataConverter", __file__)
 
 
-class DataConverter:
-    """
-    Cog for importing Red v2 Data
-    """
+@cog_i18n(_)
+class DataConverter(commands.Cog):
+    """Import Red V2 data to your V3 instance."""
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
 
     @checks.is_owner()
     @commands.command(name="convertdata")
-    async def dataconversioncommand(self, ctx: RedContext, v2path: str):
-        """
-        Interactive prompt for importing data from Red v2
+    async def dataconversioncommand(self, ctx: commands.Context, v2path: str):
+        """Interactive prompt for importing data from Red V2.
 
-        Takes the path where the v2 install is
-
-        Overwrites values which have entries in both v2 and v3,
-        use with caution.
+        Takes the path where the V2 install is, and overwrites
+        values which have entries in both V2 and v3; use with caution.
         """
         resolver = SpecResolver(Path(v2path.strip()))
 
         if not resolver.available:
             return await ctx.send(
-                _("There don't seem to be any data files I know how to "
-                  "handle here. Are you sure you gave me the base "
-                  "installation path?")
+                _(
+                    "There don't seem to be any data files I know how to "
+                    "handle here. Are you sure you gave me the base "
+                    "installation path?"
+                )
             )
         while resolver.available:
-            menu = _("Please select a set of data to import by number"
-                     ", or 'exit' to exit")
+            menu = _("Please select a set of data to import by number, or 'exit' to exit")
             for index, entry in enumerate(resolver.available, 1):
                 menu += "\n{}. {}".format(index, entry)
 
             menu_message = await ctx.send(box(menu))
 
-            def pred(m):
-                return m.channel == ctx.channel and m.author == ctx.author
-
             try:
                 message = await self.bot.wait_for(
-                    'message', check=pred, timeout=60
+                    "message", check=MessagePredicate.same_context(ctx), timeout=60
                 )
             except asyncio.TimeoutError:
-                return await ctx.send(
-                    _('Try this again when you are more ready'))
+                return await ctx.send(_("Try this again when you are ready."))
             else:
-                if message.content.strip().lower() in [
-                    'quit', 'exit', '-1', 'q', 'cancel'
-                ]:
+                if message.content.strip().lower() in ["quit", "exit", "-1", "q", "cancel"]:
                     return await ctx.tick()
                 try:
                     message = int(message.content.strip())
                     to_conv = resolver.available[message - 1]
                 except (ValueError, IndexError):
-                    await ctx.send(
-                        _("That wasn't a valid choice.")
-                    )
+                    await ctx.send(_("That wasn't a valid choice."))
                     continue
                 else:
                     async with ctx.typing():
@@ -77,6 +66,8 @@ class DataConverter:
             await menu_message.delete()
         else:
             return await ctx.send(
-                _("There isn't anything else I know how to convert here."
-                  "\nThere might be more things I can convert in the future.")
+                _(
+                    "There isn't anything else I know how to convert here.\n"
+                    "There might be more things I can convert in the future."
+                )
             )

redbot/cogs/dataconverter/locales/messages.pot

@@ -1,43 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-03-12 04:35+EDT\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../dataconverter.py:38
-msgid "There don't seem to be any data files I know how to handle here. Are you sure you gave me the base installation path?"
-msgstr ""
-
-#: ../dataconverter.py:43
-msgid "Please select a set of data to import by number, or 'exit' to exit"
-msgstr ""
-
-#: ../dataconverter.py:59
-msgid "Try this again when you are more ready"
-msgstr ""
-
-#: ../dataconverter.py:70
-msgid "That wasn't a valid choice."
-msgstr ""
-
-#: ../dataconverter.py:76
-msgid "{} converted."
-msgstr ""
-
-#: ../dataconverter.py:80
-msgid ""
-"There isn't anything else I know how to convert here.\n"
-"There might be more things I can convert in the future."
-msgstr ""
-

redbot/cogs/dataconverter/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../dataconverter.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/downloader/__init__.py

@@ -1,6 +1,7 @@
-from redbot.core.bot import Red
 from .downloader import Downloader
 
 
-def setup(bot: Red):
-    bot.add_cog(Downloader(bot))
+async def setup(bot):
+    cog = Downloader(bot)
+    await cog.initialize()
+    bot.add_cog(cog)

redbot/cogs/downloader/checks.py

@@ -1,11 +1,15 @@
 import asyncio
 
-import discord
-from discord.ext import commands
+from redbot.core import commands
+from redbot.core.i18n import Translator
+from redbot.core.utils.predicates import MessagePredicate
 
-__all__ = ["install_agreement", ]
+__all__ = ["do_install_agreement"]
 
-REPO_INSTALL_MSG = (
+T_ = Translator("DownloaderChecks", __file__)
+
+_ = lambda s: s
+REPO_INSTALL_MSG = _(
     "You're about to add a 3rd party repository. The creator of Red"
     " and its community have no responsibility for any potential "
     "damage that the content of 3rd party repositories might cause."
@@ -14,32 +18,23 @@ REPO_INSTALL_MSG = (
     "shown again until the next reboot.\n\nYou have **30** seconds"
     " to reply to this message."
 )
+_ = T_
 
 
-def install_agreement():
-    async def pred(ctx: commands.Context):
-        downloader = ctx.command.instance
-        if downloader is None:
-            return True
-        elif downloader.already_agreed:
-            return True
-        elif ctx.invoked_subcommand is None or \
-                isinstance(ctx.invoked_subcommand, commands.Group):
-            return True
-
-        def does_agree(msg: discord.Message):
-            return ctx.author == msg.author and \
-                   ctx.channel == msg.channel and \
-                   msg.content == "I agree"
-
-        await ctx.send(REPO_INSTALL_MSG)
-
-        try:
-            await ctx.bot.wait_for('message', check=does_agree, timeout=30)
-        except asyncio.TimeoutError:
-            await ctx.send("Your response has timed out, please try again.")
-            return False
-
-        downloader.already_agreed = True
+async def do_install_agreement(ctx: commands.Context):
+    downloader = ctx.cog
+    if downloader is None or downloader.already_agreed:
         return True
-    return commands.check(pred)
+
+    await ctx.send(T_(REPO_INSTALL_MSG))
+
+    try:
+        await ctx.bot.wait_for(
+            "message", check=MessagePredicate.lower_equal_to("i agree", ctx), timeout=30
+        )
+    except asyncio.TimeoutError:
+        await ctx.send(_("Your response has timed out, please try again."))
+        return False
+
+    downloader.already_agreed = True
+    return True

redbot/cogs/downloader/converters.py

@@ -1,19 +1,20 @@
 import discord
-from discord.ext import commands
-from .repo_manager import RepoManager
+from redbot.core import commands
+from redbot.core.i18n import Translator
 from .installable import Installable
 
+_ = Translator("Koala", __file__)
 
-class InstalledCog(commands.Converter):
-    async def convert(self, ctx: commands.Context, arg: str) -> Installable:
+
+class InstalledCog(Installable):
+    @classmethod
+    async def convert(cls, ctx: commands.Context, arg: str) -> Installable:
         downloader = ctx.bot.get_cog("Downloader")
         if downloader is None:
-            raise commands.CommandError("Downloader not loaded.")
+            raise commands.CommandError(_("No Downloader cog found."))
 
         cog = discord.utils.get(await downloader.installed_cogs(), name=arg)
         if cog is None:
-            raise commands.BadArgument(
-                "That cog is not installed"
-            )
+            raise commands.BadArgument(_("That cog is not installed"))
 
         return cog

redbot/cogs/downloader/downloader.py

@@ -1,40 +1,40 @@
+import asyncio
+import contextlib
 import os
 import shutil
+import sys
 from pathlib import Path
 from sys import path as syspath
-from typing import Tuple, Union
+from typing import Tuple, Union, Iterable
 
 import discord
-import sys
-
-from redbot.core import Config
-from redbot.core import checks
-from redbot.core.data_manager import cog_data_path
-from redbot.core.i18n import CogI18n
-from redbot.core.utils.chat_formatting import box, pagify
-from discord.ext import commands
-
+from redbot.core import checks, commands, Config
 from redbot.core.bot import Red
-from .checks import install_agreement
+from redbot.core.data_manager import cog_data_path
+from redbot.core.i18n import Translator, cog_i18n
+from redbot.core.utils.chat_formatting import box, pagify, humanize_list, inline
+from redbot.core.utils.menus import start_adding_reactions
+from redbot.core.utils.predicates import MessagePredicate, ReactionPredicate
+
+from . import errors
+from .checks import do_install_agreement
 from .converters import InstalledCog
-from .errors import CloningError, ExistingGitRepo
 from .installable import Installable
 from .log import log
 from .repo_manager import RepoManager, Repo
 
-_ = CogI18n('Downloader', __file__)
+_ = Translator("Downloader", __file__)
 
 
-class Downloader:
+@cog_i18n(_)
+class Downloader(commands.Cog):
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
 
-        self.conf = Config.get_conf(self, identifier=998240343,
-                                    force_registration=True)
+        self.conf = Config.get_conf(self, identifier=998240343, force_registration=True)
 
-        self.conf.register_global(
-            installed=[]
-        )
+        self.conf.register_global(installed=[])
 
         self.already_agreed = False
 
@@ -45,17 +45,20 @@ class Downloader:
         self.LIB_PATH.mkdir(parents=True, exist_ok=True)
         self.SHAREDLIB_PATH.mkdir(parents=True, exist_ok=True)
         if not self.SHAREDLIB_INIT.exists():
-            with self.SHAREDLIB_INIT.open(mode='w', encoding='utf-8') as _:
+            with self.SHAREDLIB_INIT.open(mode="w", encoding="utf-8") as _:
                 pass
 
         if str(self.LIB_PATH) not in syspath:
             syspath.insert(1, str(self.LIB_PATH))
 
-        self._repo_manager = RepoManager(self.conf)
+        self._repo_manager = RepoManager()
+
+    async def initialize(self):
+        await self._repo_manager.initialize()
 
     async def cog_install_path(self):
         """Get the current cog install path.
-        
+
         Returns
         -------
         pathlib.Path
@@ -66,7 +69,7 @@ class Downloader:
 
     async def installed_cogs(self) -> Tuple[Installable]:
         """Get info on installed cogs.
-        
+
         Returns
         -------
         `tuple` of `Installable`
@@ -79,7 +82,7 @@ class Downloader:
 
     async def _add_to_installed(self, cog: Installable):
         """Mark a cog as installed.
-        
+
         Parameters
         ----------
         cog : Installable
@@ -95,7 +98,7 @@ class Downloader:
 
     async def _remove_from_installed(self, cog: Installable):
         """Remove a cog from the saved list of installed cogs.
-        
+
         Parameters
         ----------
         cog : Installable
@@ -109,7 +112,7 @@ class Downloader:
             installed.remove(cog_json)
             await self.conf.installed.set(installed)
 
-    async def _reinstall_cogs(self, cogs: Tuple[Installable]) -> Tuple[Installable]:
+    async def _reinstall_cogs(self, cogs: Iterable[Installable]) -> Tuple[Installable]:
         """
         Installs a list of cogs, used when updating.
         :param cogs:
@@ -123,7 +126,7 @@ class Downloader:
         # noinspection PyTypeChecker
         return tuple(failed)
 
-    async def _reinstall_libraries(self, cogs: Tuple[Installable]) -> Tuple[Installable]:
+    async def _reinstall_libraries(self, cogs: Iterable[Installable]) -> Tuple[Installable]:
         """
         Reinstalls any shared libraries from the repos of cogs that
             were updated.
@@ -143,7 +146,7 @@ class Downloader:
         # noinspection PyTypeChecker
         return tuple(failed)
 
-    async def _reinstall_requirements(self, cogs: Tuple[Installable]) -> bool:
+    async def _reinstall_requirements(self, cogs: Iterable[Installable]) -> bool:
         """
         Reinstalls requirements for given cogs that have been updated.
             Returns a bool that indicates if all requirement installations
@@ -169,7 +172,7 @@ class Downloader:
         for repo, reqs in has_reqs:
             for req in reqs:
                 # noinspection PyTypeChecker
-                ret = ret and await repo.install_raw_requirements([req, ], self.LIB_PATH)
+                ret = ret and await repo.install_raw_requirements([req], self.LIB_PATH)
         return ret
 
     @staticmethod
@@ -190,193 +193,275 @@ class Downloader:
     @commands.command()
     @checks.is_owner()
     async def pipinstall(self, ctx, *deps: str):
-        """
-        Installs a group of dependencies using pip.
-        """
+        """Install a group of dependencies using pip."""
         repo = Repo("", "", "", Path.cwd(), loop=ctx.bot.loop)
         success = await repo.install_raw_requirements(deps, self.LIB_PATH)
 
         if success:
             await ctx.send(_("Libraries installed."))
         else:
-            await ctx.send(_("Some libraries failed to install. Please check"
-                             " your logs for a complete list."))
+            await ctx.send(
+                _(
+                    "Some libraries failed to install. Please check"
+                    " your logs for a complete list."
+                )
+            )
 
     @commands.group()
     @checks.is_owner()
     async def repo(self, ctx):
-        """
-        Command group for managing Downloader repos.
-        """
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+        """Repo management commands."""
+        pass
 
     @repo.command(name="add")
-    @install_agreement()
-    async def _repo_add(self, ctx, name: str, repo_url: str, branch: str=None):
-        """
-        Add a new repo to Downloader.
+    async def _repo_add(self, ctx, name: str, repo_url: str, branch: str = None):
+        """Add a new repo.
 
-        Name can only contain characters A-z, numbers and underscore
-        Branch will default to master if not specified
+        The name can only contain characters A-z, numbers and underscores.
+        The branch will be the default branch if not specified.
         """
+        agreed = await do_install_agreement(ctx)
+        if not agreed:
+            return
         try:
             # noinspection PyTypeChecker
-            repo = await self._repo_manager.add_repo(
-                name=name,
-                url=repo_url,
-                branch=branch
-            )
-        except ExistingGitRepo:
+            repo = await self._repo_manager.add_repo(name=name, url=repo_url, branch=branch)
+        except errors.ExistingGitRepo:
             await ctx.send(_("That git repo has already been added under another name."))
-        except CloningError:
+        except errors.CloningError as err:
             await ctx.send(_("Something went wrong during the cloning process."))
-            log.exception(_("Something went wrong during the cloning process."))
+            log.exception(
+                "Something went wrong whilst cloning %s (to revision: %s)",
+                repo_url,
+                branch,
+                exc_info=err,
+            )
         else:
-            await ctx.send(_("Repo `{}` successfully added.").format(name))
+            await ctx.send(_("Repo `{name}` successfully added.").format(name=name))
             if repo.install_msg is not None:
-                await ctx.send(repo.install_msg)
+                await ctx.send(repo.install_msg.replace("[p]", ctx.prefix))
 
-    @repo.command(name="delete")
-    async def _repo_del(self, ctx, repo_name: Repo):
-        """
-        Removes a repo from Downloader and its' files.
-        """
-        await self._repo_manager.delete_repo(repo_name.name)
+    @repo.command(name="delete", aliases=["remove"], usage="<repo_name>")
+    async def _repo_del(self, ctx, repo: Repo):
+        """Remove a repo and its files."""
+        await self._repo_manager.delete_repo(repo.name)
 
-        await ctx.send(_("The repo `{}` has been deleted successfully.").format(repo_name.name))
+        await ctx.send(
+            _("The repo `{repo.name}` has been deleted successfully.").format(repo=repo)
+        )
 
     @repo.command(name="list")
     async def _repo_list(self, ctx):
-        """
-        Lists all installed repos.
-        """
+        """List all installed repos."""
         repos = self._repo_manager.get_all_repo_names()
         repos = sorted(repos, key=str.lower)
-        joined = _("Installed Repos:\n") + "\n".join(["+ " + r for r in repos])
+        joined = _("Installed Repos:\n\n")
+        for repo_name in repos:
+            repo = self._repo_manager.get_repo(repo_name)
+            joined += "+ {}: {}\n".format(repo.name, repo.short or "")
 
         for page in pagify(joined, ["\n"], shorten_by=16):
             await ctx.send(box(page.lstrip(" "), lang="diff"))
 
+    @repo.command(name="info", usage="<repo_name>")
+    async def _repo_info(self, ctx, repo: Repo):
+        """Show information about a repo."""
+        if repo is None:
+            await ctx.send(_("Repo `{repo.name}` not found.").format(repo=repo))
+            return
+
+        msg = _("Information on {repo.name}:\n{description}").format(
+            repo=repo, description=repo.description or ""
+        )
+        await ctx.send(box(msg))
+
     @commands.group()
     @checks.is_owner()
     async def cog(self, ctx):
-        """
-        Command group for managing installable Cogs.
-        """
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+        """Cog installation management commands."""
+        pass
 
-    @cog.command(name="install")
-    async def _cog_install(self, ctx, repo_name: Repo, cog_name: str):
-        """
-        Installs a cog from the given repo.
-        """
-        cog = discord.utils.get(repo_name.available_cogs, name=cog_name)  # type: Installable
+    @cog.command(name="install", usage="<repo_name> <cog_name>")
+    async def _cog_install(self, ctx, repo: Repo, cog_name: str):
+        """Install a cog from the given repo."""
+        cog: Installable = discord.utils.get(repo.available_cogs, name=cog_name)
         if cog is None:
-            await ctx.send(_("Error, there is no cog by the name of"
-                           " `{}` in the `{}` repo.").format(cog_name, repo_name.name))
+            await ctx.send(
+                _(
+                    "Error: there is no cog by the name of `{cog_name}` in the `{repo.name}` repo."
+                ).format(cog_name=cog_name, repo=repo)
+            )
             return
         elif cog.min_python_version > sys.version_info:
-            await ctx.send(_(
-                "This cog requires at least python version {}, aborting install.".format(
-                    '.'.join([str(n) for n in cog.min_python_version])
+            await ctx.send(
+                _("This cog requires at least python version {version}, aborting install.").format(
+                    version=".".join([str(n) for n in cog.min_python_version])
                 )
-            ))
+            )
             return
 
-        if not await repo_name.install_requirements(cog, self.LIB_PATH):
-            await ctx.send(_("Failed to install the required libraries for"
-                           " `{}`: `{}`").format(cog.name, cog.requirements))
+        if not await repo.install_requirements(cog, self.LIB_PATH):
+            await ctx.send(
+                _(
+                    "Failed to install the required libraries for `{cog_name}`: `{libraries}`"
+                ).format(cog_name=cog.name, libraries=cog.requirements)
+            )
             return
 
-        await repo_name.install_cog(cog, await self.cog_install_path())
+        await repo.install_cog(cog, await self.cog_install_path())
 
         await self._add_to_installed(cog)
 
-        await repo_name.install_libraries(self.SHAREDLIB_PATH)
+        await repo.install_libraries(self.SHAREDLIB_PATH)
 
-        await ctx.send(_("`{}` cog successfully installed.").format(cog_name))
+        await ctx.send(_("Cog `{cog_name}` successfully installed.").format(cog_name=cog_name))
         if cog.install_msg is not None:
-            await ctx.send(cog.install_msg)
+            await ctx.send(cog.install_msg.replace("[p]", ctx.prefix))
 
-    @cog.command(name="uninstall")
-    async def _cog_uninstall(self, ctx, cog_name: InstalledCog):
+    @cog.command(name="uninstall", usage="<cog_name>")
+    async def _cog_uninstall(self, ctx, cog: InstalledCog):
+        """Uninstall a cog.
+
+        You may only uninstall cogs which were previously installed
+        by Downloader.
         """
-        Allows you to uninstall cogs that were previously installed
-            through Downloader.
-        """
-        # noinspection PyUnresolvedReferences,PyProtectedMember
-        real_name = cog_name.name
+        real_name = cog.name
 
         poss_installed_path = (await self.cog_install_path()) / real_name
         if poss_installed_path.exists():
+            ctx.bot.unload_extension(real_name)
             await self._delete_cog(poss_installed_path)
-            # noinspection PyTypeChecker
-            await self._remove_from_installed(cog_name)
-            await ctx.send(_("`{}` was successfully removed.").format(real_name))
+            await self._remove_from_installed(cog)
+            await ctx.send(
+                _("Cog `{cog_name}` was successfully uninstalled.").format(cog_name=real_name)
+            )
         else:
-            await ctx.send(_("That cog was installed but can no longer"
-                             " be located. You may need to remove it's"
-                             " files manually if it is still usable."))
+            await ctx.send(
+                _(
+                    "That cog was installed but can no longer"
+                    " be located. You may need to remove it's"
+                    " files manually if it is still usable."
+                    " Also make sure you've unloaded the cog"
+                    " with `{prefix}unload {cog_name}`."
+                ).format(prefix=ctx.prefix, cog_name=real_name)
+            )
 
     @cog.command(name="update")
-    async def _cog_update(self, ctx, cog_name: InstalledCog=None):
-        """
-        Updates all cogs or one of your choosing.
-        """
+    async def _cog_update(self, ctx, cog_name: InstalledCog = None):
+        """Update all cogs, or one of your choosing."""
         installed_cogs = set(await self.installed_cogs())
 
-        if cog_name is None:
-            updated = await self._repo_manager.update_all_repos()
+        async with ctx.typing():
+            if cog_name is None:
+                updated = await self._repo_manager.update_all_repos()
 
+            else:
+                try:
+                    updated = await self._repo_manager.update_repo(cog_name.repo_name)
+                except KeyError:
+                    # Thrown if the repo no longer exists
+                    updated = {}
+
+            updated_cogs = set(cog for repo in updated for cog in repo.available_cogs)
+            installed_and_updated = updated_cogs & installed_cogs
+
+            if installed_and_updated:
+                await self._reinstall_requirements(installed_and_updated)
+                await self._reinstall_cogs(installed_and_updated)
+                await self._reinstall_libraries(installed_and_updated)
+                message = _("Cog update completed successfully.")
+
+                cognames = {c.name for c in installed_and_updated}
+                message += _("\nUpdated: ") + humanize_list(tuple(map(inline, cognames)))
+            else:
+                await ctx.send(_("All installed cogs are already up to date."))
+                return
+        await ctx.send(message)
+
+        cognames &= set(ctx.bot.extensions.keys())  # only reload loaded cogs
+        if not cognames:
+            return await ctx.send(
+                _("None of the updated cogs were previously loaded. Update complete.")
+            )
+        message = _("Would you like to reload the updated cogs?")
+        can_react = ctx.channel.permissions_for(ctx.me).add_reactions
+        if not can_react:
+            message += " (y/n)"
+        query: discord.Message = await ctx.send(message)
+        if can_react:
+            # noinspection PyAsyncCall
+            start_adding_reactions(query, ReactionPredicate.YES_OR_NO_EMOJIS, ctx.bot.loop)
+            pred = ReactionPredicate.yes_or_no(query, ctx.author)
+            event = "reaction_add"
         else:
-            try:
-                updated = await self._repo_manager.update_repo(cog_name.repo_name)
-            except KeyError:
-                # Thrown if the repo no longer exists
-                updated = {}
-
-        updated_cogs = set(cog for repo in updated.keys() for cog in repo.available_cogs)
-        installed_and_updated = updated_cogs & installed_cogs
-
-        # noinspection PyTypeChecker
-        await self._reinstall_requirements(installed_and_updated)
-
-        # noinspection PyTypeChecker
-        await self._reinstall_cogs(installed_and_updated)
-
-        # noinspection PyTypeChecker
-        await self._reinstall_libraries(installed_and_updated)
-        await ctx.send(_("Cog update completed successfully."))
-
-    @cog.command(name="list")
-    async def _cog_list(self, ctx, repo_name: Repo):
-        """
-        Lists all available cogs from a single repo.
-        """
-        cogs = repo_name.available_cogs
-        cogs = _("Available Cogs:\n") + "\n".join(
-            ["+ {}: {}".format(c.name, c.short or "") for c in cogs])
-
-        await ctx.send(box(cogs, lang="diff"))
-
-    @cog.command(name="info")
-    async def _cog_info(self, ctx, repo_name: Repo, cog_name: str):
-        """
-        Lists information about a single cog.
-        """
-        cog = discord.utils.get(repo_name.available_cogs, name=cog_name)
-        if cog is None:
-            await ctx.send(_("There is no cog `{}` in the repo `{}`").format(
-                cog_name, repo_name.name
-            ))
+            pred = MessagePredicate.yes_or_no(ctx)
+            event = "message"
+        try:
+            await ctx.bot.wait_for(event, check=pred, timeout=30)
+        except asyncio.TimeoutError:
+            await query.delete()
             return
 
-        msg = _("Information on {}:\n{}").format(cog.name, cog.description or "")
+        if pred.result is True:
+            if can_react:
+                with contextlib.suppress(discord.Forbidden):
+                    await query.clear_reactions()
+            await ctx.invoke(ctx.bot.get_cog("Core").reload, *cognames)
+        else:
+            if can_react:
+                await query.delete()
+            else:
+                await ctx.send(_("OK then."))
+
+    @cog.command(name="list", usage="<repo_name>")
+    async def _cog_list(self, ctx, repo: Repo):
+        """List all available cogs from a single repo."""
+        installed = await self.installed_cogs()
+        installed_str = ""
+        if installed:
+            installed_str = _("Installed Cogs:\n") + "\n".join(
+                [
+                    "- {}{}".format(i.name, ": {}".format(i.short) if i.short else "")
+                    for i in installed
+                    if i.repo_name == repo.name
+                ]
+            )
+        cogs = repo.available_cogs
+        cogs = _("Available Cogs:\n") + "\n".join(
+            [
+                "+ {}: {}".format(c.name, c.short or "")
+                for c in cogs
+                if not (c.hidden or c in installed)
+            ]
+        )
+        cogs = cogs + "\n\n" + installed_str
+        for page in pagify(cogs, ["\n"], shorten_by=16):
+            await ctx.send(box(page.lstrip(" "), lang="diff"))
+
+    @cog.command(name="info", usage="<repo_name> <cog_name>")
+    async def _cog_info(self, ctx, repo: Repo, cog_name: str):
+        """List information about a single cog."""
+        cog = discord.utils.get(repo.available_cogs, name=cog_name)
+        if cog is None:
+            await ctx.send(
+                _("There is no cog `{cog_name}` in the repo `{repo.name}`").format(
+                    cog_name=cog_name, repo=repo
+                )
+            )
+            return
+
+        msg = _(
+            "Information on {cog_name}:\n{description}\n\nRequirements: {requirements}"
+        ).format(
+            cog_name=cog.name,
+            description=cog.description or "",
+            requirements=", ".join(cog.requirements) or "None",
+        )
         await ctx.send(box(msg))
 
-    async def is_installed(self, cog_name: str) -> (bool, Union[Installable, None]):
+    async def is_installed(
+        self, cog_name: str
+    ) -> Union[Tuple[bool, Installable], Tuple[bool, None]]:
         """Check to see if a cog has been installed through Downloader.
 
         Parameters
@@ -396,8 +481,9 @@ class Downloader:
                 return True, installable
         return False, None
 
-    def format_findcog_info(self, command_name: str,
-                            cog_installable: Union[Installable, object]=None) -> str:
+    def format_findcog_info(
+        self, command_name: str, cog_installable: Union[Installable, object] = None
+    ) -> str:
         """Format a cog's info for output to discord.
 
         Parameters
@@ -406,7 +492,7 @@ class Downloader:
             Name of the command which belongs to the cog.
         cog_installable : `Installable` or `object`
             Can be an `Installable` instance or a Cog instance.
-            
+
         Returns
         -------
         str
@@ -416,41 +502,41 @@ class Downloader:
         if isinstance(cog_installable, Installable):
             made_by = ", ".join(cog_installable.author) or _("Missing from info.json")
             repo = self._repo_manager.get_repo(cog_installable.repo_name)
-            repo_url = repo.url
+            repo_url = _("Missing from installed repos") if repo is None else repo.url
             cog_name = cog_installable.name
         else:
             made_by = "26 & co."
-            repo_url = "https://github.com/Twentysix26/Red-DiscordBot"
+            repo_url = "https://github.com/Cog-Creators/Red-DiscordBot"
             cog_name = cog_installable.__class__.__name__
 
-        msg = _("Command: {}\nMade by: {}\nRepo: {}\nCog name: {}")
+        msg = _("Command: {command}\nMade by: {author}\nRepo: {repo}\nCog name: {cog}")
 
-        return msg.format(command_name, made_by, repo_url, cog_name)
+        return msg.format(command=command_name, author=made_by, repo=repo_url, cog=cog_name)
 
     def cog_name_from_instance(self, instance: object) -> str:
         """Determines the cog name that Downloader knows from the cog instance.
 
         Probably.
-        
+
         Parameters
         ----------
         instance : object
             The cog instance.
-            
+
         Returns
         -------
         str
             The name of the cog according to Downloader..
 
         """
-        splitted = instance.__module__.split('.')
+        splitted = instance.__module__.split(".")
         return splitted[-2]
 
     @commands.command()
     async def findcog(self, ctx: commands.Context, command_name: str):
-        """
-        Figures out which cog a command comes from. Only works with loaded
-            cogs.
+        """Find which cog a command comes from.
+
+        This will only work with loaded cogs.
         """
         command = ctx.bot.all_commands.get(command_name)
 

redbot/cogs/downloader/errors.py

@@ -1,12 +1,24 @@
-__all__ = ["DownloaderException", "GitException", "InvalidRepoName", "ExistingGitRepo",
-           "MissingGitRepo", "CloningError", "CurrentHashError", "HardResetError",
-           "UpdateError", "GitDiffError", "PipError"]
+__all__ = [
+    "DownloaderException",
+    "GitException",
+    "InvalidRepoName",
+    "ExistingGitRepo",
+    "MissingGitRepo",
+    "CloningError",
+    "CurrentHashError",
+    "HardResetError",
+    "UpdateError",
+    "GitDiffError",
+    "NoRemoteURL",
+    "PipError",
+]
 
 
 class DownloaderException(Exception):
     """
     Base class for Downloader exceptions.
     """
+
     pass
 
 
@@ -21,6 +33,7 @@ class InvalidRepoName(DownloaderException):
     Throw when a repo name is invalid. Check
     the message for a more detailed reason.
     """
+
     pass
 
 
@@ -29,6 +42,7 @@ class ExistingGitRepo(DownloaderException):
     Thrown when trying to clone into a folder where a
     git repo already exists.
     """
+
     pass
 
 
@@ -37,6 +51,7 @@ class MissingGitRepo(DownloaderException):
     Thrown when a git repo is expected to exist but
     does not.
     """
+
     pass
 
 
@@ -44,6 +59,7 @@ class CloningError(GitException):
     """
     Thrown when git clone returns a non zero exit code.
     """
+
     pass
 
 
@@ -52,6 +68,7 @@ class CurrentHashError(GitException):
     Thrown when git returns a non zero exit code attempting
     to determine the current commit hash.
     """
+
     pass
 
 
@@ -60,6 +77,7 @@ class HardResetError(GitException):
     Thrown when there is an issue trying to execute a hard reset
     (usually prior to a repo update).
     """
+
     pass
 
 
@@ -67,6 +85,7 @@ class UpdateError(GitException):
     """
     Thrown when git pull returns a non zero error code.
     """
+
     pass
 
 
@@ -74,6 +93,15 @@ class GitDiffError(GitException):
     """
     Thrown when a git diff fails.
     """
+
+    pass
+
+
+class NoRemoteURL(GitException):
+    """
+    Thrown when no remote URL exists for a repo.
+    """
+
     pass
 
 
@@ -81,4 +109,5 @@ class PipError(DownloaderException):
     """
     Thrown when pip returns a non-zero return code.
     """
+
     pass

redbot/cogs/downloader/installable.py

@@ -3,9 +3,8 @@ import distutils.dir_util
 import shutil
 from enum import Enum
 from pathlib import Path
-from typing import MutableMapping, Any
+from typing import MutableMapping, Any, TYPE_CHECKING
 
-from redbot.core.utils import TYPE_CHECKING
 from .log import log
 from .json_mixins import RepoJSONMixin
 
@@ -25,7 +24,7 @@ class Installable(RepoJSONMixin):
      - Modules
      - Repo Libraries
      - Other stuff?
-     
+
     The attributes of this class will mostly come from the installation's
     info.json.
 
@@ -56,6 +55,7 @@ class Installable(RepoJSONMixin):
         :class:`InstallationType`.
 
     """
+
     def __init__(self, location: Path):
         """Base installable initializer.
 
@@ -75,6 +75,7 @@ class Installable(RepoJSONMixin):
         self.bot_version = (3, 0, 0)
         self.min_python_version = (3, 5, 1)
         self.hidden = False
+        self.disabled = False
         self.required_cogs = {}  # Cog name -> repo URL
         self.requirements = ()
         self.tags = ()
@@ -114,13 +115,9 @@ class Installable(RepoJSONMixin):
 
         # noinspection PyBroadException
         try:
-            copy_func(
-                src=str(self._location),
-                dst=str(target_dir / self._location.stem)
-            )
+            copy_func(src=str(self._location), dst=str(target_dir / self._location.stem))
         except:
-            log.exception("Error occurred when copying path:"
-                          " {}".format(self._location))
+            log.exception("Error occurred when copying path: {}".format(self._location))
             return False
         return True
 
@@ -130,7 +127,7 @@ class Installable(RepoJSONMixin):
         if self._info_file.exists():
             self._process_info_file()
 
-    def _process_info_file(self, info_file_path: Path=None) -> MutableMapping[str, Any]:
+    def _process_info_file(self, info_file_path: Path = None) -> MutableMapping[str, Any]:
         """
         Processes an information file. Loads dependencies among other
         information into this object.
@@ -144,13 +141,12 @@ class Installable(RepoJSONMixin):
             raise ValueError("No valid information file path was found.")
 
         info = {}
-        with info_file_path.open(encoding='utf-8') as f:
+        with info_file_path.open(encoding="utf-8") as f:
             try:
                 info = json.load(f)
             except json.JSONDecodeError:
                 info = {}
-                log.exception("Invalid JSON information file at path:"
-                              " {}".format(info_file_path))
+                log.exception("Invalid JSON information file at path: {}".format(info_file_path))
             else:
                 self._info = info
 
@@ -167,7 +163,7 @@ class Installable(RepoJSONMixin):
         self.bot_version = bot_version
 
         try:
-            min_python_version = tuple(info.get('min_python_version', [3, 5, 1]))
+            min_python_version = tuple(info.get("min_python_version", [3, 5, 1]))
         except ValueError:
             min_python_version = self.min_python_version
         self.min_python_version = min_python_version
@@ -178,6 +174,12 @@ class Installable(RepoJSONMixin):
             hidden = False
         self.hidden = hidden
 
+        try:
+            disabled = bool(info.get("disabled", False))
+        except ValueError:
+            disabled = False
+        self.disabled = disabled
+
         self.required_cogs = info.get("required_cogs", {})
 
         self.requirements = info.get("requirements", ())
@@ -200,15 +202,12 @@ class Installable(RepoJSONMixin):
         return info
 
     def to_json(self):
-        return {
-            "repo_name": self.repo_name,
-            "cog_name": self.name
-        }
+        return {"repo_name": self.repo_name, "cog_name": self.name}
 
     @classmethod
     def from_json(cls, data: dict, repo_mgr: "RepoManager"):
-        repo_name = data['repo_name']
-        cog_name = data['cog_name']
+        repo_name = data["repo_name"]
+        cog_name = data["cog_name"]
 
         repo = repo_mgr.get_repo(repo_name)
         if repo is not None:

redbot/cogs/downloader/json_mixins.py

@@ -24,7 +24,7 @@ class RepoJSONMixin:
             return
 
         try:
-            with self._info_file.open(encoding='utf-8') as f:
+            with self._info_file.open(encoding="utf-8") as f:
                 info = json.load(f)
         except json.JSONDecodeError:
             return
@@ -34,4 +34,4 @@ class RepoJSONMixin:
         self.author = info.get("author")
         self.install_msg = info.get("install_msg")
         self.short = info.get("short")
-        self.description = info.get("description")
+        self.description = info.get("description")

redbot/cogs/downloader/locales/messages.pot

@@ -1,93 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../downloader.py:215
-msgid "That git repo has already been added under another name."
-msgstr ""
-
-#: ../downloader.py:217 ../downloader.py:218
-msgid "Something went wrong during the cloning process."
-msgstr ""
-
-#: ../downloader.py:220
-msgid "Repo `{}` successfully added."
-msgstr ""
-
-#: ../downloader.py:229
-msgid "The repo `{}` has been deleted successfully."
-msgstr ""
-
-#: ../downloader.py:237
-msgid ""
-"Installed Repos:\n"
-msgstr ""
-
-#: ../downloader.py:258
-msgid "Error, there is no cog by the name of `{}` in the `{}` repo."
-msgstr ""
-
-#: ../downloader.py:263
-msgid "Failed to install the required libraries for `{}`: `{}`"
-msgstr ""
-
-#: ../downloader.py:273
-msgid "`{}` cog successfully installed."
-msgstr ""
-
-#: ../downloader.py:289
-msgid "`{}` was successfully removed."
-msgstr ""
-
-#: ../downloader.py:291
-msgid "That cog was installed but can no longer be located. You may need to remove it's files manually if it is still usable."
-msgstr ""
-
-#: ../downloader.py:315
-msgid "Cog update completed successfully."
-msgstr ""
-
-#: ../downloader.py:323
-msgid ""
-"Available Cogs:\n"
-msgstr ""
-
-#: ../downloader.py:335
-msgid "There is no cog `{}` in the repo `{}`"
-msgstr ""
-
-#: ../downloader.py:340
-msgid ""
-"Information on {}:\n"
-"{}"
-msgstr ""
-
-#: ../downloader.py:381
-msgid "Missing from info.json"
-msgstr ""
-
-#: ../downloader.py:390
-msgid ""
-"Command: {}\n"
-"Made by: {}\n"
-"Repo: {}\n"
-"Cog name: {}"
-msgstr ""
-
-#: ../downloader.py:422
-msgid "That command doesn't seem to exist."
-msgstr ""
-

redbot/cogs/downloader/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../downloader.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/downloader/log.py

@@ -1,3 +1,3 @@
 import logging
 
-log = logging.getLogger("red.downloader")
+log = logging.getLogger("red.downloader")

redbot/cogs/downloader/repo_manager.py

@@ -3,40 +3,47 @@ import functools
 import os
 import pkgutil
 import shutil
+import re
 from concurrent.futures import ThreadPoolExecutor
 from pathlib import Path
 from subprocess import run as sp_run, PIPE
 from sys import executable
-from typing import Tuple, MutableMapping, Union
+from typing import Tuple, MutableMapping, Union, Optional
 
-from discord.ext import commands
-
-from redbot.core import Config
-from redbot.core import data_manager
+from redbot.core import data_manager, commands
 from redbot.core.utils import safe_delete
-from .errors import *
+from redbot.core.i18n import Translator
+
+from . import errors
 from .installable import Installable, InstallableType
 from .json_mixins import RepoJSONMixin
 from .log import log
 
+_ = Translator("RepoManager", __file__)
+
 
 class Repo(RepoJSONMixin):
-    GIT_CLONE = "git clone -b {branch} {url} {folder}"
-    GIT_CLONE_NO_BRANCH = "git clone {url} {folder}"
+    GIT_CLONE = "git clone --recurse-submodules -b {branch} {url} {folder}"
+    GIT_CLONE_NO_BRANCH = "git clone --recurse-submodules {url} {folder}"
     GIT_CURRENT_BRANCH = "git -C {path} rev-parse --abbrev-ref HEAD"
     GIT_LATEST_COMMIT = "git -C {path} rev-parse {branch}"
     GIT_HARD_RESET = "git -C {path} reset --hard origin/{branch} -q"
-    GIT_PULL = "git -C {path} pull -q --ff-only"
-    GIT_DIFF_FILE_STATUS = ("git -C {path} diff --no-commit-id --name-status"
-                            " {old_hash} {new_hash}")
-    GIT_LOG = ("git -C {path} log --relative-date --reverse {old_hash}.."
-               " {relative_file_path}")
+    GIT_PULL = "git -C {path} pull --recurse-submodules -q --ff-only"
+    GIT_DIFF_FILE_STATUS = "git -C {path} diff --no-commit-id --name-status {old_hash} {new_hash}"
+    GIT_LOG = "git -C {path} log --relative-date --reverse {old_hash}.. {relative_file_path}"
     GIT_DISCOVER_REMOTE_URL = "git -C {path} config --get remote.origin.url"
 
     PIP_INSTALL = "{python} -m pip install -U -t {target_dir} {reqs}"
 
-    def __init__(self, name: str, url: str, branch: str, folder_path: Path,
-                 available_modules: Tuple[Installable]=(), loop: asyncio.AbstractEventLoop=None):
+    def __init__(
+        self,
+        name: str,
+        url: str,
+        branch: str,
+        folder_path: Path,
+        available_modules: Tuple[Installable] = (),
+        loop: asyncio.AbstractEventLoop = None,
+    ):
         self.url = url
         self.branch = branch
 
@@ -61,21 +68,24 @@ class Repo(RepoJSONMixin):
     async def convert(cls, ctx: commands.Context, argument: str):
         downloader_cog = ctx.bot.get_cog("Downloader")
         if downloader_cog is None:
-            raise commands.CommandError("No Downloader cog found.")
+            raise commands.CommandError(_("No Downloader cog found."))
 
         # noinspection PyProtectedMember
         repo_manager = downloader_cog._repo_manager
         poss_repo = repo_manager.get_repo(argument)
         if poss_repo is None:
-            raise commands.BadArgument("Repo by the name {} does not exist.".format(argument))
+            raise commands.BadArgument(
+                _('Repo by the name "{repo_name}" does not exist.').format(repo_name=argument)
+            )
         return poss_repo
 
     def _existing_git_repo(self) -> (bool, Path):
-        git_path = self.folder_path / '.git'
+        git_path = self.folder_path / ".git"
         return git_path.exists(), git_path
 
     async def _get_file_update_statuses(
-            self, old_hash: str, new_hash: str) -> MutableMapping[str, str]:
+        self, old_hash: str, new_hash: str
+    ) -> MutableMapping[str, str]:
         """
         Gets the file update status letters for each changed file between
             the two hashes.
@@ -85,29 +95,27 @@ class Repo(RepoJSONMixin):
         """
         p = await self._run(
             self.GIT_DIFF_FILE_STATUS.format(
-                path=self.folder_path,
-                old_hash=old_hash,
-                new_hash=new_hash
+                path=self.folder_path, old_hash=old_hash, new_hash=new_hash
             )
         )
 
         if p.returncode != 0:
-            raise GitDiffError("Git diff failed for repo at path:"
-                               " {}".format(self.folder_path))
+            raise errors.GitDiffError(
+                "Git diff failed for repo at path: {}".format(self.folder_path)
+            )
 
-        stdout = p.stdout.strip().decode().split('\n')
+        stdout = p.stdout.strip().decode().split("\n")
 
         ret = {}
 
         for filename in stdout:
             # TODO: filter these filenames by ones in self.available_modules
-            status, _, filepath = filename.partition('\t')
+            status, _, filepath = filename.partition("\t")
             ret[filepath] = status
 
         return ret
 
-    async def _get_commit_notes(self, old_commit_hash: str,
-                                relative_file_path: str) -> str:
+    async def _get_commit_notes(self, old_commit_hash: str, relative_file_path: str) -> str:
         """
         Gets the commit notes from git log.
         :param old_commit_hash: Point in time to start getting messages
@@ -119,13 +127,15 @@ class Repo(RepoJSONMixin):
             self.GIT_LOG.format(
                 path=self.folder_path,
                 old_hash=old_commit_hash,
-                relative_file_path=relative_file_path
+                relative_file_path=relative_file_path,
             )
         )
 
         if p.returncode != 0:
-            raise GitException("An exception occurred while executing git log on"
-                               " this repo: {}".format(self.folder_path))
+            raise errors.GitException(
+                "An exception occurred while executing git log on"
+                " this repo: {}".format(self.folder_path)
+            )
 
         return p.stdout.decode().strip()
 
@@ -146,10 +156,11 @@ class Repo(RepoJSONMixin):
                         Installable(location=name)
                     )
         """
-        for file_finder, name, is_pkg in pkgutil.walk_packages(path=[str(self.folder_path), ]):
-            curr_modules.append(
-                Installable(location=self.folder_path / name)
-            )
+        for file_finder, name, is_pkg in pkgutil.walk_packages(
+            path=[str(self.folder_path)], onerror=lambda name: None
+        ):
+            if is_pkg:
+                curr_modules.append(Installable(location=self.folder_path / name))
         self.available_modules = curr_modules
 
         # noinspection PyTypeChecker
@@ -157,12 +168,11 @@ class Repo(RepoJSONMixin):
 
     async def _run(self, *args, **kwargs):
         env = os.environ.copy()
-        env['GIT_TERMINAL_PROMPT'] = '0'
-        kwargs['env'] = env
+        env["GIT_TERMINAL_PROMPT"] = "0"
+        kwargs["env"] = env
         async with self._repo_lock:
             return await self._loop.run_in_executor(
-                self._executor,
-                functools.partial(sp_run, *args, stdout=PIPE, **kwargs)
+                self._executor, functools.partial(sp_run, *args, stdout=PIPE, **kwargs)
             )
 
     async def clone(self) -> Tuple[str]:
@@ -176,28 +186,23 @@ class Repo(RepoJSONMixin):
         """
         exists, path = self._existing_git_repo()
         if exists:
-            raise ExistingGitRepo(
-                "A git repo already exists at path: {}".format(path)
-            )
+            raise errors.ExistingGitRepo("A git repo already exists at path: {}".format(path))
 
         if self.branch is not None:
             p = await self._run(
                 self.GIT_CLONE.format(
-                    branch=self.branch,
-                    url=self.url,
-                    folder=self.folder_path
+                    branch=self.branch, url=self.url, folder=self.folder_path
                 ).split()
             )
         else:
             p = await self._run(
-                self.GIT_CLONE_NO_BRANCH.format(
-                    url=self.url,
-                    folder=self.folder_path
-                ).split()
+                self.GIT_CLONE_NO_BRANCH.format(url=self.url, folder=self.folder_path).split()
             )
 
-        if p.returncode != 0:
-            raise CloningError("Error when running git clone.")
+        if p.returncode:
+            # Try cleaning up folder
+            shutil.rmtree(str(self.folder_path), ignore_errors=True)
+            raise errors.CloningError("Error when running git clone.")
 
         if self.branch is None:
             self.branch = await self.current_branch()
@@ -217,30 +222,27 @@ class Repo(RepoJSONMixin):
         """
         exists, _ = self._existing_git_repo()
         if not exists:
-            raise MissingGitRepo(
+            raise errors.MissingGitRepo(
                 "A git repo does not exist at path: {}".format(self.folder_path)
             )
 
-        p = await self._run(
-            self.GIT_CURRENT_BRANCH.format(
-                path=self.folder_path
-            ).split()
-        )
+        p = await self._run(self.GIT_CURRENT_BRANCH.format(path=self.folder_path).split())
 
         if p.returncode != 0:
-            raise GitException("Could not determine current branch"
-                               " at path: {}".format(self.folder_path))
+            raise errors.GitException(
+                "Could not determine current branch at path: {}".format(self.folder_path)
+            )
 
         return p.stdout.decode().strip()
 
-    async def current_commit(self, branch: str=None) -> str:
+    async def current_commit(self, branch: str = None) -> str:
         """Determine the current commit hash of the repo.
 
         Parameters
         ----------
         branch : `str`, optional
             Override for repo's branch attribute.
-            
+
         Returns
         -------
         str
@@ -252,23 +254,20 @@ class Repo(RepoJSONMixin):
 
         exists, _ = self._existing_git_repo()
         if not exists:
-            raise MissingGitRepo(
+            raise errors.MissingGitRepo(
                 "A git repo does not exist at path: {}".format(self.folder_path)
             )
 
         p = await self._run(
-            self.GIT_LATEST_COMMIT.format(
-                path=self.folder_path,
-                branch=branch
-            ).split()
+            self.GIT_LATEST_COMMIT.format(path=self.folder_path, branch=branch).split()
         )
 
         if p.returncode != 0:
-            raise CurrentHashError("Unable to determine old commit hash.")
+            raise errors.CurrentHashError("Unable to determine old commit hash.")
 
         return p.stdout.decode().strip()
 
-    async def current_url(self, folder: Path=None) -> str:
+    async def current_url(self, folder: Path = None) -> str:
         """
         Discovers the FETCH URL for a Git repo.
 
@@ -284,24 +283,21 @@ class Repo(RepoJSONMixin):
 
         Raises
         ------
-        RuntimeError
+        .NoRemoteURL
             When the folder does not contain a git repo with a FETCH URL.
+
         """
         if folder is None:
             folder = self.folder_path
 
-        p = await self._run(
-            Repo.GIT_DISCOVER_REMOTE_URL.format(
-                path=folder
-            ).split()
-        )
+        p = await self._run(Repo.GIT_DISCOVER_REMOTE_URL.format(path=folder).split())
 
         if p.returncode != 0:
-            raise RuntimeError("Unable to discover a repo URL.")
+            raise errors.NoRemoteURL("Unable to discover a repo URL.")
 
         return p.stdout.decode().strip()
 
-    async def hard_reset(self, branch: str=None) -> None:
+    async def hard_reset(self, branch: str = None) -> None:
         """Perform a hard reset on the current repo.
 
         Parameters
@@ -315,21 +311,20 @@ class Repo(RepoJSONMixin):
 
         exists, _ = self._existing_git_repo()
         if not exists:
-            raise MissingGitRepo(
+            raise errors.MissingGitRepo(
                 "A git repo does not exist at path: {}".format(self.folder_path)
             )
 
         p = await self._run(
-            self.GIT_HARD_RESET.format(
-                path=self.folder_path,
-                branch=branch
-            ).split()
+            self.GIT_HARD_RESET.format(path=self.folder_path, branch=branch).split()
         )
 
         if p.returncode != 0:
-            raise HardResetError("Some error occurred when trying to"
-                                 " execute a hard reset on the repo at"
-                                 " the following path: {}".format(self.folder_path))
+            raise errors.HardResetError(
+                "Some error occurred when trying to"
+                " execute a hard reset on the repo at"
+                " the following path: {}".format(self.folder_path)
+            )
 
     async def update(self) -> (str, str):
         """Update the current branch of this repo.
@@ -345,15 +340,13 @@ class Repo(RepoJSONMixin):
 
         await self.hard_reset(branch=curr_branch)
 
-        p = await self._run(
-            self.GIT_PULL.format(
-                path=self.folder_path
-            ).split()
-        )
+        p = await self._run(self.GIT_PULL.format(path=self.folder_path).split())
 
         if p.returncode != 0:
-            raise UpdateError("Git pull returned a non zero exit code"
-                              " for the repo located at path: {}".format(self.folder_path))
+            raise errors.UpdateError(
+                "Git pull returned a non zero exit code"
+                " for the repo located at path: {}".format(self.folder_path)
+            )
 
         new_commit = await self.current_commit(branch=curr_branch)
 
@@ -379,7 +372,7 @@ class Repo(RepoJSONMixin):
 
         """
         if cog not in self.available_cogs:
-            raise DownloaderException("That cog does not exist in this repo")
+            raise errors.DownloaderException("That cog does not exist in this repo")
 
         if not target_dir.is_dir():
             raise ValueError("That target directory is not actually a directory.")
@@ -389,7 +382,9 @@ class Repo(RepoJSONMixin):
 
         return await cog.copy_to(target_dir=target_dir)
 
-    async def install_libraries(self, target_dir: Path, libraries: Tuple[Installable]=()) -> bool:
+    async def install_libraries(
+        self, target_dir: Path, libraries: Tuple[Installable] = ()
+    ) -> bool:
         """Install shared libraries to the target directory.
 
         If :code:`libraries` is not specified, all shared libraries in the repo
@@ -401,7 +396,7 @@ class Repo(RepoJSONMixin):
             Directory to install shared libraries to.
         libraries : `tuple` of `Installable`
             A subset of available libraries.
- 
+
         Returns
         -------
         bool
@@ -423,7 +418,7 @@ class Repo(RepoJSONMixin):
 
     async def install_requirements(self, cog: Installable, target_dir: Path) -> bool:
         """Install a cog's requirements.
-        
+
         Requirements will be installed via pip directly into
         :code:`target_dir`.
 
@@ -469,29 +464,28 @@ class Repo(RepoJSONMixin):
 
         p = await self._run(
             self.PIP_INSTALL.format(
-                python=executable,
-                target_dir=target_dir,
-                reqs=" ".join(requirements)
+                python=executable, target_dir=target_dir, reqs=" ".join(requirements)
             ).split()
         )
 
         if p.returncode != 0:
-            log.error("Something went wrong when installing"
-                      " the following requirements:"
-                      " {}".format(", ".join(requirements)))
+            log.error(
+                "Something went wrong when installing"
+                " the following requirements:"
+                " {}".format(", ".join(requirements))
+            )
             return False
         return True
 
     @property
     def available_cogs(self) -> Tuple[Installable]:
         """`tuple` of `installable` : All available cogs in this Repo.
-        
+
         This excludes hidden or shared packages.
         """
         # noinspection PyTypeChecker
         return tuple(
-            [m for m in self.available_modules
-             if m.type == InstallableType.COG and not m.hidden]
+            [m for m in self.available_modules if m.type == InstallableType.COG and not m.disabled]
         )
 
     @property
@@ -501,8 +495,7 @@ class Repo(RepoJSONMixin):
         """
         # noinspection PyTypeChecker
         return tuple(
-            [m for m in self.available_modules
-             if m.type == InstallableType.SHARED_LIBRARY]
+            [m for m in self.available_modules if m.type == InstallableType.SHARED_LIBRARY]
         )
 
     @classmethod
@@ -515,18 +508,23 @@ class Repo(RepoJSONMixin):
 
 
 class RepoManager:
-    def __init__(self, downloader_config: Config):
-        self.downloader_config = downloader_config
 
+    GITHUB_OR_GITLAB_RE = re.compile("https?://git(?:hub)|(?:lab)\.com/")
+    TREE_URL_RE = re.compile(r"(?P<tree>/tree)/(?P<branch>\S+)$")
+
+    def __init__(self):
         self._repos = {}
 
         loop = asyncio.get_event_loop()
         loop.create_task(self._load_repos(set=True))  # str_name: Repo
 
+    async def initialize(self):
+        await self._load_repos(set=True)
+
     @property
     def repos_folder(self) -> Path:
         data_folder = data_manager.cog_data_path(self)
-        return data_folder / 'repos'
+        return data_folder / "repos"
 
     def does_repo_exist(self, name: str) -> bool:
         return name in self._repos
@@ -534,10 +532,10 @@ class RepoManager:
     @staticmethod
     def validate_and_normalize_repo_name(name: str) -> str:
         if not name.isidentifier():
-            raise InvalidRepoName("Not a valid Python variable name.")
+            raise errors.InvalidRepoName("Not a valid Python variable name.")
         return name.lower()
 
-    async def add_repo(self, url: str, name: str, branch: str="master") -> Repo:
+    async def add_repo(self, url: str, name: str, branch: Optional[str] = None) -> Repo:
         """Add and clone a git repository.
 
         Parameters
@@ -556,14 +554,14 @@ class RepoManager:
 
         """
         if self.does_repo_exist(name):
-            raise InvalidRepoName(
-                "That repo name you provided already exists."
-                " Please choose another."
+            raise errors.ExistingGitRepo(
+                "That repo name you provided already exists. Please choose another."
             )
 
+        url, branch = self._parse_url(url, branch)
+
         # noinspection PyTypeChecker
-        r = Repo(url=url, name=name, branch=branch,
-                 folder_path=self.repos_folder / name)
+        r = Repo(url=url, name=name, branch=branch, folder_path=self.repos_folder / name)
         await r.clone()
 
         self._repos[name] = r
@@ -607,13 +605,13 @@ class RepoManager:
 
         Raises
         ------
-        MissingGitRepo
+        .MissingGitRepo
             If the repo does not exist.
 
         """
         repo = self.get_repo(name)
         if repo is None:
-            raise MissingGitRepo("There is no repo with the name {}".format(name))
+            raise errors.MissingGitRepo("There is no repo with the name {}".format(name))
 
         safe_delete(repo.folder_path)
 
@@ -652,10 +650,26 @@ class RepoManager:
                 continue
             try:
                 ret[folder.stem] = await Repo.from_folder(folder)
-            except RuntimeError:
-                # Thrown when there's no findable git remote URL
-                pass
+            except errors.NoRemoteURL:
+                log.warning("A remote URL does not exist for repo %s", folder.stem)
+            except errors.DownloaderException as err:
+                log.error("Discarding repo %s due to error.", folder.stem, exc_info=err)
+                shutil.rmtree(
+                    str(folder),
+                    onerror=lambda func, path, exc: log.error(
+                        "Failed to remove folder %s", path, exc_info=exc
+                    ),
+                )
 
         if set:
             self._repos = ret
         return ret
+
+    def _parse_url(self, url: str, branch: Optional[str]) -> Tuple[str, Optional[str]]:
+        if self.GITHUB_OR_GITLAB_RE.match(url):
+            tree_url_match = self.TREE_URL_RE.search(url)
+            if tree_url_match:
+                url = url[: tree_url_match.start("tree")]
+                if branch is None:
+                    branch = tree_url_match["branch"]
+        return url, branch

redbot/cogs/economy/economy.py

@@ -3,18 +3,19 @@ import logging
 import random
 from collections import defaultdict, deque
 from enum import Enum
+from typing import cast, Iterable
 
 import discord
 
 from redbot.cogs.bank import check_global_setting_guildowner, check_global_setting_admin
-from redbot.core import Config, bank
-from redbot.core.i18n import CogI18n
-from redbot.core.utils.chat_formatting import pagify, box
-from discord.ext import commands
+from redbot.core import Config, bank, commands, errors
+from redbot.core.i18n import Translator, cog_i18n
+from redbot.core.utils.chat_formatting import box
+from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
 
 from redbot.core.bot import Red
 
-_ = CogI18n("Economy", __file__)
+T_ = Translator("Economy", __file__)
 
 logger = logging.getLogger("red.economy")
 
@@ -34,45 +35,46 @@ class SMReel(Enum):
     snowflake = "\N{SNOWFLAKE}"
 
 
+_ = lambda s: s
 PAYOUTS = {
     (SMReel.two, SMReel.two, SMReel.six): {
         "payout": lambda x: x * 2500 + x,
-        "phrase": _("JACKPOT! 226! Your bid has been multiplied * 2500!")
+        "phrase": _("JACKPOT! 226! Your bid has been multiplied * 2500!"),
     },
     (SMReel.flc, SMReel.flc, SMReel.flc): {
         "payout": lambda x: x + 1000,
-        "phrase": _("4LC! +1000!")
+        "phrase": _("4LC! +1000!"),
     },
     (SMReel.cherries, SMReel.cherries, SMReel.cherries): {
         "payout": lambda x: x + 800,
-        "phrase": _("Three cherries! +800!")
+        "phrase": _("Three cherries! +800!"),
     },
     (SMReel.two, SMReel.six): {
         "payout": lambda x: x * 4 + x,
-        "phrase": _("2 6! Your bid has been multiplied * 4!")
+        "phrase": _("2 6! Your bid has been multiplied * 4!"),
     },
     (SMReel.cherries, SMReel.cherries): {
         "payout": lambda x: x * 3 + x,
-        "phrase": _("Two cherries! Your bid has been multiplied * 3!")
-    },
-    "3 symbols": {
-        "payout": lambda x: x + 500,
-        "phrase": _("Three symbols! +500!")
+        "phrase": _("Two cherries! Your bid has been multiplied * 3!"),
     },
+    "3 symbols": {"payout": lambda x: x + 500, "phrase": _("Three symbols! +500!")},
     "2 symbols": {
         "payout": lambda x: x * 2 + x,
-        "phrase": _("Two consecutive symbols! Your bid has been multiplied * 2!")
+        "phrase": _("Two consecutive symbols! Your bid has been multiplied * 2!"),
     },
 }
 
-SLOT_PAYOUTS_MSG = _("Slot machine payouts:\n"
-                     "{two.value} {two.value} {six.value} Bet * 2500\n"
-                     "{flc.value} {flc.value} {flc.value} +1000\n"
-                     "{cherries.value} {cherries.value} {cherries.value} +800\n"
-                     "{two.value} {six.value} Bet * 4\n"
-                     "{cherries.value} {cherries.value} Bet * 3\n\n"
-                     "Three symbols: +500\n"
-                     "Two symbols: Bet * 2").format(**SMReel.__dict__)
+SLOT_PAYOUTS_MSG = _(
+    "Slot machine payouts:\n"
+    "{two.value} {two.value} {six.value} Bet * 2500\n"
+    "{flc.value} {flc.value} {flc.value} +1000\n"
+    "{cherries.value} {cherries.value} {cherries.value} +800\n"
+    "{two.value} {six.value} Bet * 4\n"
+    "{cherries.value} {cherries.value} Bet * 3\n\n"
+    "Three symbols: +500\n"
+    "Two symbols: Bet * 2"
+).format(**SMReel.__dict__)
+_ = T_
 
 
 def guild_only_check():
@@ -83,6 +85,7 @@ def guild_only_check():
             return True
         else:
             return False
+
     return commands.check(pred)
 
 
@@ -104,10 +107,9 @@ class SetParser:
             raise RuntimeError
 
 
-class Economy:
-    """Economy
-
-    Get rich and have fun with imaginary currency!"""
+@cog_i18n(_)
+class Economy(commands.Cog):
+    """Get rich and have fun with imaginary currency!"""
 
     default_guild_settings = {
         "PAYDAY_TIME": 300,
@@ -115,23 +117,19 @@ class Economy:
         "SLOT_MIN": 5,
         "SLOT_MAX": 100,
         "SLOT_TIME": 0,
-        "REGISTER_CREDITS": 0
+        "REGISTER_CREDITS": 0,
     }
 
     default_global_settings = default_guild_settings
 
-    default_member_settings = {
-        "next_payday": 0,
-        "last_slot": 0
-    }
+    default_member_settings = {"next_payday": 0, "last_slot": 0}
 
-    default_role_settings = {
-        "PAYDAY_CREDITS": 0
-    }
+    default_role_settings = {"PAYDAY_CREDITS": 0}
 
     default_user_settings = default_member_settings
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
         self.file_path = "data/economy/settings.json"
         self.config = Config.get_conf(self, 1256844281)
@@ -142,15 +140,15 @@ class Economy:
         self.config.register_role(**self.default_role_settings)
         self.slot_register = defaultdict(dict)
 
+    @guild_only_check()
     @commands.group(name="bank")
     async def _bank(self, ctx: commands.Context):
-        """Bank operations"""
-        if ctx.invoked_subcommand is None:
-            await ctx.send_help()
+        """Manage the bank."""
+        pass
 
     @_bank.command()
     async def balance(self, ctx: commands.Context, user: discord.Member = None):
-        """Shows balance of user.
+        """Show the user's account balance.
 
         Defaults to yours."""
         if user is None:
@@ -159,79 +157,100 @@ class Economy:
         bal = await bank.get_balance(user)
         currency = await bank.get_currency_name(ctx.guild)
 
-        await ctx.send(_("{}'s balance is {} {}").format(
-            user.display_name, bal, currency))
+        await ctx.send(
+            _("{user}'s balance is {num} {currency}").format(
+                user=user.display_name, num=bal, currency=currency
+            )
+        )
 
     @_bank.command()
     async def transfer(self, ctx: commands.Context, to: discord.Member, amount: int):
-        """Transfer currency to other users"""
+        """Transfer currency to other users."""
         from_ = ctx.author
         currency = await bank.get_currency_name(ctx.guild)
 
         try:
             await bank.transfer_credits(from_, to, amount)
-        except ValueError as e:
-            await ctx.send(str(e))
+        except (ValueError, errors.BalanceTooHigh) as e:
+            return await ctx.send(str(e))
 
-        await ctx.send(_("{} transferred {} {} to {}").format(
-            from_.display_name, amount, currency, to.display_name
-        ))
+        await ctx.send(
+            _("{user} transferred {num} {currency} to {other_user}").format(
+                user=from_.display_name, num=amount, currency=currency, other_user=to.display_name
+            )
+        )
 
     @_bank.command(name="set")
     @check_global_setting_admin()
     async def _set(self, ctx: commands.Context, to: discord.Member, creds: SetParser):
-        """Sets balance of user's bank account. See help for more operations
+        """Set the balance of user's bank account.
 
-        Passing positive and negative values will add/remove currency instead
+        Passing positive and negative values will add/remove currency instead.
 
         Examples:
-            bank set @Twentysix 26 - Sets balance to 26
-            bank set @Twentysix +2 - Increases balance by 2
-            bank set @Twentysix -6 - Decreases balance by 6"""
+        - `[p]bank set @Twentysix 26` - Sets balance to 26
+        - `[p]bank set @Twentysix +2` - Increases balance by 2
+        - `[p]bank set @Twentysix -6` - Decreases balance by 6
+        """
         author = ctx.author
         currency = await bank.get_currency_name(ctx.guild)
 
-        if creds.operation == "deposit":
-            await bank.deposit_credits(to, creds.sum)
-            await ctx.send(_("{} added {} {} to {}'s account.").format(
-                author.display_name, creds.sum, currency, to.display_name
-            ))
-        elif creds.operation == "withdraw":
-            await bank.withdraw_credits(to, creds.sum)
-            await ctx.send(_("{} removed {} {} from {}'s account.").format(
-                author.display_name, creds.sum, currency, to.display_name
-            ))
+        try:
+            if creds.operation == "deposit":
+                await bank.deposit_credits(to, creds.sum)
+                msg = _("{author} added {num} {currency} to {user}'s account.").format(
+                    author=author.display_name,
+                    num=creds.sum,
+                    currency=currency,
+                    user=to.display_name,
+                )
+            elif creds.operation == "withdraw":
+                await bank.withdraw_credits(to, creds.sum)
+                msg = _("{author} removed {num} {currency} from {user}'s account.").format(
+                    author=author.display_name,
+                    num=creds.sum,
+                    currency=currency,
+                    user=to.display_name,
+                )
+            else:
+                await bank.set_balance(to, creds.sum)
+                msg = _("{author} set {user}'s account balance to {num} {currency}.").format(
+                    author=author.display_name,
+                    num=creds.sum,
+                    currency=currency,
+                    user=to.display_name,
+                )
+        except (ValueError, errors.BalanceTooHigh) as e:
+            await ctx.send(str(e))
         else:
-            await bank.set_balance(to, creds.sum)
-            await ctx.send(_("{} set {}'s account to {} {}.").format(
-                author.display_name, to.display_name, creds.sum, currency
-            ))
+            await ctx.send(msg)
 
     @_bank.command()
-    @guild_only_check()
     @check_global_setting_guildowner()
     async def reset(self, ctx, confirmation: bool = False):
-        """Deletes bank accounts"""
+        """Delete all bank accounts."""
         if confirmation is False:
             await ctx.send(
-                _("This will delete all bank accounts for {}.\nIf you're sure, type "
-                  "`{}bank reset yes`").format(
-                    self.bot.user.name if await bank.is_global() else "this server",
-                    ctx.prefix
+                _(
+                    "This will delete all bank accounts for {scope}.\nIf you're sure, type "
+                    "`{prefix}bank reset yes`"
+                ).format(
+                    scope=self.bot.user.name if await bank.is_global() else _("this server"),
+                    prefix=ctx.prefix,
                 )
             )
         else:
-            await bank.wipe_bank()
-            await ctx.send(_("All bank accounts for {} have been "
-                             "deleted.").format(
-                             self.bot.user.name if await bank.is_global() else "this server"
-                             )
-                            )
+            await bank.wipe_bank(guild=ctx.guild)
+            await ctx.send(
+                _("All bank accounts for {scope} have been deleted.").format(
+                    scope=self.bot.user.name if await bank.is_global() else _("this server")
+                )
+            )
 
-    @commands.command()
     @guild_only_check()
+    @commands.command()
     async def payday(self, ctx: commands.Context):
-        """Get some free currency"""
+        """Get some free currency."""
         author = ctx.author
         guild = ctx.guild
 
@@ -240,95 +259,141 @@ class Economy:
         if await bank.is_global():  # Role payouts will not be used
             next_payday = await self.config.user(author).next_payday()
             if cur_time >= next_payday:
-                await bank.deposit_credits(author, await self.config.PAYDAY_CREDITS())
+                try:
+                    await bank.deposit_credits(author, await self.config.PAYDAY_CREDITS())
+                except errors.BalanceTooHigh as exc:
+                    await bank.set_balance(author, exc.max_balance)
+                    await ctx.send(
+                        _(
+                            "You've reached the maximum amount of {currency}! (**{balance:,}**) "
+                            "Please spend some more \N{GRIMACING FACE}\n\n"
+                            "You currently have {new_balance} {currency}."
+                        ).format(currency=credits_name, new_balance=exc.max_balance)
+                    )
+                    return
                 next_payday = cur_time + await self.config.PAYDAY_TIME()
                 await self.config.user(author).next_payday.set(next_payday)
 
                 pos = await bank.get_leaderboard_position(author)
-                await ctx.send(_(
-                    "{0.mention} Here, take some {1}. Enjoy! (+{2} {1}!)\n\n"
-                    "You currently have {3} {1}.\n\n"
-                    "You are currently #{4} on the leaderboard!"
-                ).format(
-                    author, credits_name, str(await self.config.PAYDAY_CREDITS()),
-                    str(await bank.get_balance(author)), pos
-                ))
+                await ctx.send(
+                    _(
+                        "{author.mention} Here, take some {currency}. "
+                        "Enjoy! (+{amount} {currency}!)\n\n"
+                        "You currently have {new_balance} {currency}.\n\n"
+                        "You are currently #{pos} on the global leaderboard!"
+                    ).format(
+                        author=author,
+                        currency=credits_name,
+                        amount=await self.config.PAYDAY_CREDITS(),
+                        new_balance=await bank.get_balance(author),
+                        pos=pos,
+                    )
+                )
 
             else:
                 dtime = self.display_time(next_payday - cur_time)
                 await ctx.send(
-                    _("{} Too soon. For your next payday you have to"
-                      " wait {}.").format(author.mention, dtime)
+                    _(
+                        "{author.mention} Too soon. For your next payday you have to wait {time}."
+                    ).format(author=author, time=dtime)
                 )
         else:
             next_payday = await self.config.member(author).next_payday()
             if cur_time >= next_payday:
                 credit_amount = await self.config.guild(guild).PAYDAY_CREDITS()
                 for role in author.roles:
-                    role_credits = await self.config.role(role).PAYDAY_CREDITS()  # Nice variable name
+                    role_credits = await self.config.role(
+                        role
+                    ).PAYDAY_CREDITS()  # Nice variable name
                     if role_credits > credit_amount:
                         credit_amount = role_credits
-                await bank.deposit_credits(author, credit_amount)
+                try:
+                    await bank.deposit_credits(author, credit_amount)
+                except errors.BalanceTooHigh as exc:
+                    await bank.set_balance(author, exc.max_balance)
+                    await ctx.send(
+                        _(
+                            "You've reached the maximum amount of {currency}! "
+                            "Please spend some more \N{GRIMACING FACE}\n\n"
+                            "You currently have {new_balance} {currency}."
+                        ).format(currency=credits_name, new_balance=exc.max_balance)
+                    )
+                    return
                 next_payday = cur_time + await self.config.guild(guild).PAYDAY_TIME()
                 await self.config.member(author).next_payday.set(next_payday)
                 pos = await bank.get_leaderboard_position(author)
-                await ctx.send(_(
-                    "{0.mention} Here, take some {1}. Enjoy! (+{2} {1}!)\n\n"
-                    "You currently have {3} {1}.\n\n"
-                    "You are currently #{4} on the leaderboard!"
-                ).format(
-                    author, credits_name, credit_amount,
-                    str(await bank.get_balance(author)), pos
-                ))
+                await ctx.send(
+                    _(
+                        "{author.mention} Here, take some {currency}. "
+                        "Enjoy! (+{amount} {currency}!)\n\n"
+                        "You currently have {new_balance} {currency}.\n\n"
+                        "You are currently #{pos} on the global leaderboard!"
+                    ).format(
+                        author=author,
+                        currency=credits_name,
+                        amount=credit_amount,
+                        new_balance=await bank.get_balance(author),
+                        pos=pos,
+                    )
+                )
             else:
                 dtime = self.display_time(next_payday - cur_time)
                 await ctx.send(
-                    _("{} Too soon. For your next payday you have to"
-                      " wait {}.").format(author.mention, dtime))
+                    _(
+                        "{author.mention} Too soon. For your next payday you have to wait {time}."
+                    ).format(author=author, time=dtime)
+                )
 
     @commands.command()
     @guild_only_check()
-    async def leaderboard(self, ctx: commands.Context, top: int = 10, show_global: bool=False):
-        """Prints out the leaderboard
+    async def leaderboard(self, ctx: commands.Context, top: int = 10, show_global: bool = False):
+        """Print the leaderboard.
 
-        Defaults to top 10"""
-        # Originally coded by Airenkun - edited by irdumb, rewritten by Palm__ for v3
+        Defaults to top 10.
+        """
         guild = ctx.guild
+        author = ctx.author
         if top < 1:
             top = 10
-        if await bank.is_global() and show_global:  # show_global is only applicable if bank is global
+        if (
+            await bank.is_global() and show_global
+        ):  # show_global is only applicable if bank is global
             guild = None
         bank_sorted = await bank.get_leaderboard(positions=top, guild=guild)
-        if len(bank_sorted) < top:
-            top = len(bank_sorted)
-        highscore = ""
-        for pos, acc in enumerate(bank_sorted, 1):
-            pos = pos
-            poswidth = 2
-            name = acc[1]["name"]
-            namewidth = 35
-            balance = acc[1]["balance"]
-            balwidth = 2
-            highscore += "{pos: <{poswidth}} {name: <{namewidth}s} {balance: >{balwidth}}\n".format(
-                pos=pos, poswidth=poswidth, name=name, namewidth=namewidth,
-                balance=balance, balwidth=balwidth
+        header = "{pound:4}{name:36}{score:2}\n".format(
+            pound="#", name=_("Name"), score=_("Score")
+        )
+        highscores = [
+            (
+                f"{f'{pos}.': <{3 if pos < 10 else 2}} {acc[1]['name']: <{35}s} "
+                f"{acc[1]['balance']: >{2 if pos < 10 else 1}}\n"
             )
-        if highscore != "":
-            for page in pagify(highscore, shorten_by=12):
-                await ctx.send(box(page, lang="py"))
+            if acc[0] != author.id
+            else (
+                f"{f'{pos}.': <{3 if pos < 10 else 2}} <<{acc[1]['name'] + '>>': <{33}s} "
+                f"{acc[1]['balance']: >{2 if pos < 10 else 1}}\n"
+            )
+            for pos, acc in enumerate(bank_sorted, 1)
+        ]
+        if highscores:
+            pages = [
+                f"```md\n{header}{''.join(''.join(highscores[x:x + 10]))}```"
+                for x in range(0, len(highscores), 10)
+            ]
+            await menu(ctx, pages, DEFAULT_CONTROLS)
         else:
             await ctx.send(_("There are no accounts in the bank."))
 
     @commands.command()
     @guild_only_check()
     async def payouts(self, ctx: commands.Context):
-        """Shows slot machine payouts"""
+        """Show the payouts for the slot machine."""
         await ctx.author.send(SLOT_PAYOUTS_MSG)
 
     @commands.command()
     @guild_only_check()
     async def slot(self, ctx: commands.Context, bid: int):
-        """Play the slot machine"""
+        """Use the slot machine."""
         author = ctx.author
         guild = ctx.guild
         channel = ctx.channel
@@ -337,7 +402,11 @@ class Economy:
             slot_time = await self.config.SLOT_TIME()
             last_slot = await self.config.user(author).last_slot()
         else:
-            valid_bid = await self.config.guild(guild).SLOT_MIN() <= bid <= await self.config.guild(guild).SLOT_MAX()
+            valid_bid = (
+                await self.config.guild(guild).SLOT_MIN()
+                <= bid
+                <= await self.config.guild(guild).SLOT_MAX()
+            )
             slot_time = await self.config.guild(guild).SLOT_TIME()
             last_slot = await self.config.member(author).last_slot()
         now = calendar.timegm(ctx.message.created_at.utctimetuple())
@@ -357,16 +426,19 @@ class Economy:
             await self.config.member(author).last_slot.set(now)
         await self.slot_machine(author, channel, bid)
 
-    async def slot_machine(self, author, channel, bid):
-        default_reel = deque(SMReel)
+    @staticmethod
+    async def slot_machine(author, channel, bid):
+        default_reel = deque(cast(Iterable, SMReel))
         reels = []
         for i in range(3):
             default_reel.rotate(random.randint(-999, 999))  # weeeeee
             new_reel = deque(default_reel, maxlen=3)  # we need only 3 symbols
             reels.append(new_reel)  # for each reel
-        rows = ((reels[0][0], reels[1][0], reels[2][0]),
-                (reels[0][1], reels[1][1], reels[2][1]),
-                (reels[0][2], reels[1][2], reels[2][2]))
+        rows = (
+            (reels[0][0], reels[1][0], reels[2][0]),
+            (reels[0][1], reels[1][1], reels[2][1]),
+            (reels[0][2], reels[1][2], reels[2][2]),
+        )
 
         slot = "~~\n~~"  # Mobile friendly
         for i, row in enumerate(rows):  # Let's build the slot to show
@@ -378,8 +450,7 @@ class Economy:
         payout = PAYOUTS.get(rows[1])
         if not payout:
             # Checks for two-consecutive-symbols special rewards
-            payout = PAYOUTS.get((rows[1][0], rows[1][1]),
-                                 PAYOUTS.get((rows[1][1], rows[1][2])))
+            payout = PAYOUTS.get((rows[1][0], rows[1][1]), PAYOUTS.get((rows[1][1], rows[1][2])))
         if not payout:
             # Still nothing. Let's check for 3 generic same symbols
             # or 2 consecutive symbols
@@ -394,58 +465,79 @@ class Economy:
             then = await bank.get_balance(author)
             pay = payout["payout"](bid)
             now = then - bid + pay
-            await bank.set_balance(author, now)
-            await channel.send(_("{}\n{} {}\n\nYour bid: {}\n{} → {}!"
-                                 "").format(slot, author.mention,
-                                         payout["phrase"], bid, then, now))
+            try:
+                await bank.set_balance(author, now)
+            except errors.BalanceTooHigh as exc:
+                await bank.set_balance(author, exc.max_balance)
+                await channel.send(
+                    _(
+                        "You've reached the maximum amount of {currency}! "
+                        "Please spend some more \N{GRIMACING FACE}\n{old_balance} -> {new_balance}!"
+                    ).format(
+                        currency=await bank.get_currency_name(getattr(channel, "guild", None)),
+                        old_balance=then,
+                        new_balance=exc.max_balance,
+                    )
+                )
+                return
+            phrase = T_(payout["phrase"])
         else:
             then = await bank.get_balance(author)
             await bank.withdraw_credits(author, bid)
             now = then - bid
-            await channel.send(_("{}\n{} Nothing!\nYour bid: {}\n{} → {}!"
-                                 "").format(slot, author.mention, bid, then, now))
+            phrase = _("Nothing!")
+        await channel.send(
+            (
+                "{slot}\n{author.mention} {phrase}\n\n"
+                + _("Your bid: {amount}")
+                + "\n{old_balance} → {new_balance}!"
+            ).format(
+                slot=slot,
+                author=author,
+                phrase=phrase,
+                amount=bid,
+                old_balance=then,
+                new_balance=now,
+            )
+        )
 
     @commands.group()
     @guild_only_check()
     @check_global_setting_admin()
     async def economyset(self, ctx: commands.Context):
-        """Changes economy module settings"""
+        """Manage Economy settings."""
         guild = ctx.guild
         if ctx.invoked_subcommand is None:
-            await ctx.send_help()
             if await bank.is_global():
-                slot_min = await self.config.SLOT_MIN()
-                slot_max = await self.config.SLOT_MAX()
-                slot_time = await self.config.SLOT_TIME()
-                payday_time = await self.config.PAYDAY_TIME()
-                payday_amount = await self.config.PAYDAY_CREDITS()
+                conf = self.config
             else:
-                slot_min = await self.config.guild(guild).SLOT_MIN()
-                slot_max = await self.config.guild(guild).SLOT_MAX()
-                slot_time = await self.config.guild(guild).SLOT_TIME()
-                payday_time = await self.config.guild(guild).PAYDAY_TIME()
-                payday_amount = await self.config.guild(guild).PAYDAY_CREDITS()
-            register_amount = await bank.get_default_balance(guild)
-            msg = box(
-                _("Minimum slot bid: {}\n"
-                  "Maximum slot bid: {}\n"
-                  "Slot cooldown: {}\n"
-                  "Payday amount: {}\n"
-                  "Payday cooldown: {}\n"
-                  "Amount given at account registration: {}"
-                  "").format(
-                    slot_min, slot_max, slot_time,
-                    payday_amount, payday_time, register_amount
-                ),
-                _("Current Economy settings:")
+                conf = self.config.guild(ctx.guild)
+            await ctx.send(
+                box(
+                    _(
+                        "----Economy Settings---\n"
+                        "Minimum slot bid: {slot_min}\n"
+                        "Maximum slot bid: {slot_max}\n"
+                        "Slot cooldown: {slot_time}\n"
+                        "Payday amount: {payday_amount}\n"
+                        "Payday cooldown: {payday_time}\n"
+                        "Amount given at account registration: {register_amount}"
+                    ).format(
+                        slot_min=await conf.SLOT_MIN(),
+                        slot_max=await conf.SLOT_MAX(),
+                        slot_time=await conf.SLOT_TIME(),
+                        payday_time=await conf.PAYDAY_TIME(),
+                        payday_amount=await conf.PAYDAY_CREDITS(),
+                        register_amount=await bank.get_default_balance(guild),
+                    )
+                )
             )
-            await ctx.send(msg)
 
     @economyset.command()
     async def slotmin(self, ctx: commands.Context, bid: int):
-        """Minimum slot machine bid"""
+        """Set the minimum slot machine bid."""
         if bid < 1:
-            await ctx.send(_('Invalid min bid amount.'))
+            await ctx.send(_("Invalid min bid amount."))
             return
         guild = ctx.guild
         if await bank.is_global():
@@ -453,15 +545,18 @@ class Economy:
         else:
             await self.config.guild(guild).SLOT_MIN.set(bid)
         credits_name = await bank.get_currency_name(guild)
-        await ctx.send(_("Minimum bid is now {} {}.").format(bid, credits_name))
+        await ctx.send(
+            _("Minimum bid is now {bid} {currency}.").format(bid=bid, currency=credits_name)
+        )
 
     @economyset.command()
     async def slotmax(self, ctx: commands.Context, bid: int):
-        """Maximum slot machine bid"""
+        """Set the maximum slot machine bid."""
         slot_min = await self.config.SLOT_MIN()
         if bid < 1 or bid < slot_min:
-            await ctx.send(_('Invalid slotmax bid amount. Must be greater'
-                             ' than slotmin.'))
+            await ctx.send(
+                _("Invalid maximum bid amount. Must be greater than the minimum amount.")
+            )
             return
         guild = ctx.guild
         credits_name = await bank.get_currency_name(guild)
@@ -469,75 +564,94 @@ class Economy:
             await self.config.SLOT_MAX.set(bid)
         else:
             await self.config.guild(guild).SLOT_MAX.set(bid)
-        await ctx.send(_("Maximum bid is now {} {}.").format(bid, credits_name))
+        await ctx.send(
+            _("Maximum bid is now {bid} {currency}.").format(bid=bid, currency=credits_name)
+        )
 
     @economyset.command()
     async def slottime(self, ctx: commands.Context, seconds: int):
-        """Seconds between each slots use"""
+        """Set the cooldown for the slot machine."""
         guild = ctx.guild
         if await bank.is_global():
             await self.config.SLOT_TIME.set(seconds)
         else:
             await self.config.guild(guild).SLOT_TIME.set(seconds)
-        await ctx.send(_("Cooldown is now {} seconds.").format(seconds))
+        await ctx.send(_("Cooldown is now {num} seconds.").format(num=seconds))
 
     @economyset.command()
     async def paydaytime(self, ctx: commands.Context, seconds: int):
-        """Seconds between each payday"""
+        """Set the cooldown for payday."""
         guild = ctx.guild
         if await bank.is_global():
             await self.config.PAYDAY_TIME.set(seconds)
         else:
             await self.config.guild(guild).PAYDAY_TIME.set(seconds)
-        await ctx.send(_("Value modified. At least {} seconds must pass "
-                         "between each payday.").format(seconds))
+        await ctx.send(
+            _("Value modified. At least {num} seconds must pass between each payday.").format(
+                num=seconds
+            )
+        )
 
     @economyset.command()
     async def paydayamount(self, ctx: commands.Context, creds: int):
-        """Amount earned each payday"""
+        """Set the amount earned each payday."""
         guild = ctx.guild
-        credits_name = await bank.get_currency_name(guild)
-        if creds <= 0:
+        if creds <= 0 or creds > bank.MAX_BALANCE:
             await ctx.send(_("Har har so funny."))
             return
+        credits_name = await bank.get_currency_name(guild)
         if await bank.is_global():
             await self.config.PAYDAY_CREDITS.set(creds)
         else:
             await self.config.guild(guild).PAYDAY_CREDITS.set(creds)
-        await ctx.send(_("Every payday will now give {} {}."
-                         "").format(creds, credits_name))
+        await ctx.send(
+            _("Every payday will now give {num} {currency}.").format(
+                num=creds, currency=credits_name
+            )
+        )
 
     @economyset.command()
     async def rolepaydayamount(self, ctx: commands.Context, role: discord.Role, creds: int):
-        """Amount earned each payday for a role"""
+        """Set the amount earned each payday for a role."""
         guild = ctx.guild
+        if creds <= 0 or creds > bank.MAX_BALANCE:
+            await ctx.send(_("Har har so funny."))
+            return
         credits_name = await bank.get_currency_name(guild)
         if await bank.is_global():
-            await ctx.send("The bank must be per-server for per-role paydays to work.")
+            await ctx.send(_("The bank must be per-server for per-role paydays to work."))
         else:
             await self.config.role(role).PAYDAY_CREDITS.set(creds)
-            await ctx.send(_("Every payday will now give {} {} to people with the role {}."
-                             "").format(creds, credits_name, role.name))
+            await ctx.send(
+                _(
+                    "Every payday will now give {num} {currency} "
+                    "to people with the role {role_name}."
+                ).format(num=creds, currency=credits_name, role_name=role.name)
+            )
 
     @economyset.command()
     async def registeramount(self, ctx: commands.Context, creds: int):
-        """Amount given on registering an account"""
+        """Set the initial balance for new bank accounts."""
         guild = ctx.guild
         if creds < 0:
             creds = 0
         credits_name = await bank.get_currency_name(guild)
         await bank.set_default_balance(creds, guild)
-        await ctx.send(_("Registering an account will now give {} {}."
-                         "").format(creds, credits_name))
+        await ctx.send(
+            _("Registering an account will now give {num} {currency}.").format(
+                num=creds, currency=credits_name
+            )
+        )
 
     # What would I ever do without stackoverflow?
-    def display_time(self, seconds, granularity=2):
+    @staticmethod
+    def display_time(seconds, granularity=2):
         intervals = (  # Source: http://stackoverflow.com/a/24542445
-            (_('weeks'), 604800),  # 60 * 60 * 24 * 7
-            (_('days'), 86400),  # 60 * 60 * 24
-            (_('hours'), 3600),  # 60 * 60
-            (_('minutes'), 60),
-            (_('seconds'), 1),
+            (_("weeks"), 604800),  # 60 * 60 * 24 * 7
+            (_("days"), 86400),  # 60 * 60 * 24
+            (_("hours"), 3600),  # 60 * 60
+            (_("minutes"), 60),
+            (_("seconds"), 1),
         )
 
         result = []
@@ -547,6 +661,6 @@ class Economy:
             if value:
                 seconds -= value * count
                 if value == 1:
-                    name = name.rstrip('s')
+                    name = name.rstrip("s")
                 result.append("{} {}".format(value, name))
-        return ', '.join(result[:granularity])
+        return ", ".join(result[:granularity])

redbot/cogs/economy/locales/messages.pot

@@ -1,199 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../economy.py:40
-msgid "JACKPOT! 226! Your bid has been multiplied * 2500!"
-msgstr ""
-
-#: ../economy.py:44
-msgid "4LC! +1000!"
-msgstr ""
-
-#: ../economy.py:48
-msgid "Three cherries! +800!"
-msgstr ""
-
-#: ../economy.py:52
-msgid "2 6! Your bid has been multiplied * 4!"
-msgstr ""
-
-#: ../economy.py:56
-msgid "Two cherries! Your bid has been multiplied * 3!"
-msgstr ""
-
-#: ../economy.py:60
-msgid "Three symbols! +500!"
-msgstr ""
-
-#: ../economy.py:64
-msgid "Two consecutive symbols! Your bid has been multiplied * 2!"
-msgstr ""
-
-#: ../economy.py:68
-msgid ""
-"Slot machine payouts:\n"
-"{two.value} {two.value} {six.value} Bet * 2500\n"
-"{flc.value} {flc.value} {flc.value} +1000\n"
-"{cherries.value} {cherries.value} {cherries.value} +800\n"
-"{two.value} {six.value} Bet * 4\n"
-"{cherries.value} {cherries.value} Bet * 3\n"
-"\n"
-"Three symbols: +500\n"
-"Two symbols: Bet * 2"
-msgstr ""
-
-#: ../economy.py:157
-msgid "{}'s balance is {} {}"
-msgstr ""
-
-#: ../economy.py:171
-msgid "{} transferred {} {} to {}"
-msgstr ""
-
-#: ../economy.py:191
-msgid "{} added {} {} to {}'s account."
-msgstr ""
-
-#: ../economy.py:196
-msgid "{} removed {} {} from {}'s account."
-msgstr ""
-
-#: ../economy.py:201
-msgid "{} set {}'s account to {} {}."
-msgstr ""
-
-#: ../economy.py:212
-msgid ""
-"This will delete all bank accounts for {}.\n"
-"If you're sure, type `{}bank reset yes`"
-msgstr ""
-
-#: ../economy.py:229
-msgid "All bank accounts of this guild have been deleted."
-msgstr ""
-
-#: ../economy.py:248 ../economy.py:268
-msgid "{} Here, take some {}. Enjoy! (+{} {}!)"
-msgstr ""
-
-#: ../economy.py:258 ../economy.py:276
-msgid "{} Too soon. For your next payday you have to wait {}."
-msgstr ""
-
-#: ../economy.py:313
-msgid "There are no accounts in the bank."
-msgstr ""
-
-#: ../economy.py:339
-msgid "You're on cooldown, try again in a bit."
-msgstr ""
-
-#: ../economy.py:342
-msgid "That's an invalid bid amount, sorry :/"
-msgstr ""
-
-#: ../economy.py:345
-msgid "You ain't got enough money, friend."
-msgstr ""
-
-#: ../economy.py:391
-msgid ""
-"{}\n"
-"{} {}\n"
-"\n"
-"Your bid: {}\n"
-"{} → {}!"
-msgstr ""
-
-#: ../economy.py:398
-msgid ""
-"{}\n"
-"{} Nothing!\n"
-"Your bid: {}\n"
-"{} → {}!"
-msgstr ""
-
-#: ../economy.py:423
-msgid ""
-"Minimum slot bid: {}\n"
-"Maximum slot bid: {}\n"
-"Slot cooldown: {}\n"
-"Payday amount: {}\n"
-"Payday cooldown: {}\n"
-"Amount given at account registration: {}"
-msgstr ""
-
-#: ../economy.py:433
-msgid "Current Economy settings:"
-msgstr ""
-
-#: ../economy.py:441
-msgid "Invalid min bid amount."
-msgstr ""
-
-#: ../economy.py:449
-msgid "Minimum bid is now {} {}."
-msgstr ""
-
-#: ../economy.py:456
-msgid "Invalid slotmax bid amount. Must be greater than slotmin."
-msgstr ""
-
-#: ../economy.py:465
-msgid "Maximum bid is now {} {}."
-msgstr ""
-
-#: ../economy.py:475
-msgid "Cooldown is now {} seconds."
-msgstr ""
-
-#: ../economy.py:485
-msgid "Value modified. At least {} seconds must pass between each payday."
-msgstr ""
-
-#: ../economy.py:494
-msgid "Har har so funny."
-msgstr ""
-
-#: ../economy.py:500
-msgid "Every payday will now give {} {}."
-msgstr ""
-
-#: ../economy.py:511
-msgid "Registering an account will now give {} {}."
-msgstr ""
-
-#: ../economy.py:517
-msgid "weeks"
-msgstr ""
-
-#: ../economy.py:518
-msgid "days"
-msgstr ""
-
-#: ../economy.py:519
-msgid "hours"
-msgstr ""
-
-#: ../economy.py:520
-msgid "minutes"
-msgstr ""
-
-#: ../economy.py:521
-msgid "seconds"
-msgstr ""
-

redbot/cogs/economy/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../economy.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()

redbot/cogs/filter/filter.py

@@ -1,19 +1,20 @@
 import discord
-from discord.ext import commands
+from typing import Union
 
-from redbot.core import checks, Config, modlog, RedContext
+from redbot.core import checks, Config, modlog, commands
 from redbot.core.bot import Red
-from redbot.core.i18n import CogI18n
+from redbot.core.i18n import Translator, cog_i18n
 from redbot.core.utils.chat_formatting import pagify
-from redbot.core.utils.mod import is_mod_or_superior
 
-_ = CogI18n("Filter", __file__)
+_ = Translator("Filter", __file__)
 
 
-class Filter:
-    """Filter-related commands"""
+@cog_i18n(_)
+class Filter(commands.Cog):
+    """Filter unwanted words and phrases from text channels."""
 
     def __init__(self, bot: Red):
+        super().__init__()
         self.bot = bot
         self.settings = Config.get_conf(self, 4766951341)
         default_guild_settings = {
@@ -21,39 +22,85 @@ class Filter:
             "filterban_count": 0,
             "filterban_time": 0,
             "filter_names": False,
-            "filter_default_name": "John Doe"
-        }
-        default_member_settings = {
-            "filter_count": 0,
-            "next_reset_time": 0
+            "filter_default_name": "John Doe",
         }
+        default_member_settings = {"filter_count": 0, "next_reset_time": 0}
+        default_channel_settings = {"filter": []}
         self.settings.register_guild(**default_guild_settings)
         self.settings.register_member(**default_member_settings)
+        self.settings.register_channel(**default_channel_settings)
         self.register_task = self.bot.loop.create_task(self.register_filterban())
 
     def __unload(self):
         self.register_task.cancel()
 
-    async def register_filterban(self):
+    @staticmethod
+    async def register_filterban():
         try:
             await modlog.register_casetype(
-                "filterban", False, ":filing_cabinet: :hammer:",
-                "Filter ban", "ban"
+                "filterban", False, ":filing_cabinet: :hammer:", "Filter ban", "ban"
             )
         except RuntimeError:
             pass
 
+    @commands.group()
+    @commands.guild_only()
+    @checks.admin_or_permissions(manage_guild=True)
+    async def filterset(self, ctx: commands.Context):
+        """Manage filter settings."""
+        pass
+
+    @filterset.command(name="defaultname")
+    async def filter_default_name(self, ctx: commands.Context, name: str):
+        """Set the nickname for users with a filtered name.
+
+        Note that this has no effect if filtering names is disabled
+        (to toggle, run `[p]filter names`).
+
+        The default name used is *John Doe*.
+        """
+        guild = ctx.guild
+        await self.settings.guild(guild).filter_default_name.set(name)
+        await ctx.send(_("The name to use on filtered names has been set."))
+
+    @filterset.command(name="ban")
+    async def filter_ban(self, ctx: commands.Context, count: int, timeframe: int):
+        """Set the filter's autoban conditions.
+
+        Users will be banned if they send `<count>` filtered words in
+        `<timeframe>` seconds.
+
+        Set both to zero to disable autoban.
+        """
+        if (count <= 0) != (timeframe <= 0):
+            await ctx.send(
+                _(
+                    "Count and timeframe either both need to be 0 "
+                    "or both need to be greater than 0!"
+                )
+            )
+            return
+        elif count == 0 and timeframe == 0:
+            await self.settings.guild(ctx.guild).filterban_count.set(0)
+            await self.settings.guild(ctx.guild).filterban_time.set(0)
+            await ctx.send(_("Autoban disabled."))
+        else:
+            await self.settings.guild(ctx.guild).filterban_count.set(count)
+            await self.settings.guild(ctx.guild).filterban_time.set(timeframe)
+            await ctx.send(_("Count and time have been set."))
+
     @commands.group(name="filter")
     @commands.guild_only()
     @checks.mod_or_permissions(manage_messages=True)
-    async def _filter(self, ctx: RedContext):
-        """Adds/removes words from filter
+    async def _filter(self, ctx: commands.Context):
+        """Add or remove words from server filter.
 
-        Use double quotes to add/remove sentences
-        Using this command with no subcommands will send
-        the list of the server's filtered words."""
+        Use double quotes to add or remove sentences.
+
+        Using this command with no subcommands will send the list of
+        the server's filtered words.
+        """
         if ctx.invoked_subcommand is None:
-            await ctx.send_help()
             server = ctx.guild
             author = ctx.author
             word_list = await self.settings.guild(server).filter()
@@ -66,146 +113,217 @@ class Filter:
                 except discord.Forbidden:
                     await ctx.send(_("I can't send direct messages to you."))
 
-    @_filter.command(name="add")
-    async def filter_add(self, ctx: commands.Context, *, words: str):
-        """Adds words to the filter
+    @_filter.group(name="channel")
+    async def _filter_channel(self, ctx: commands.Context):
+        """Add or remove words from channel filter.
+
+        Use double quotes to add or remove sentences.
+
+        Using this command with no subcommands will send the list of
+        the channel's filtered words.
+        """
+        if ctx.invoked_subcommand is None:
+            channel = ctx.channel
+            author = ctx.author
+            word_list = await self.settings.channel(channel).filter()
+            if word_list:
+                words = ", ".join(word_list)
+                words = _("Filtered in this channel:") + "\n\n" + words
+                try:
+                    for page in pagify(words, delims=[" ", "\n"], shorten_by=8):
+                        await author.send(page)
+                except discord.Forbidden:
+                    await ctx.send(_("I can't send direct messages to you."))
+
+    @_filter_channel.command("add")
+    async def filter_channel_add(self, ctx: commands.Context, *, words: str):
+        """Add words to the filter.
+
+        Use double quotes to add sentences.
 
-        Use double quotes to add sentences
         Examples:
-        filter add word1 word2 word3
-        filter add \"This is a sentence\""""
-        server = ctx.guild
+        - `[p]filter channel add word1 word2 word3`
+        - `[p]filter channel add "This is a sentence"`
+        """
+        channel = ctx.channel
         split_words = words.split()
         word_list = []
         tmp = ""
         for word in split_words:
-            if not word.startswith("\"")\
-                    and not word.endswith("\"") and not tmp:
+            if not word.startswith('"') and not word.endswith('"') and not tmp:
                 word_list.append(word)
             else:
-                if word.startswith("\""):
-                    tmp += word[1:]
-                elif word.endswith("\""):
+                if word.startswith('"'):
+                    tmp += word[1:] + " "
+                elif word.endswith('"'):
                     tmp += word[:-1]
                     word_list.append(tmp)
                     tmp = ""
                 else:
-                    tmp += word
-        added = await self.add_to_filter(server, word_list)
+                    tmp += word + " "
+        added = await self.add_to_filter(channel, word_list)
         if added:
             await ctx.send(_("Words added to filter."))
         else:
             await ctx.send(_("Words already in the filter."))
 
-    @_filter.command(name="remove")
-    async def filter_remove(self, ctx: commands.Context, *, words: str):
-        """Remove words from the filter
+    @_filter_channel.command("remove")
+    async def filter_channel_remove(self, ctx: commands.Context, *, words: str):
+        """Remove words from the filter.
+
+        Use double quotes to remove sentences.
 
-        Use double quotes to remove sentences
         Examples:
-        filter remove word1 word2 word3
-        filter remove \"This is a sentence\""""
-        server = ctx.guild
+        - `[p]filter channel remove word1 word2 word3`
+        - `[p]filter channel remove "This is a sentence"`
+        """
+        channel = ctx.channel
         split_words = words.split()
         word_list = []
         tmp = ""
         for word in split_words:
-            if not word.startswith("\"")\
-                    and not word.endswith("\"") and not tmp:
+            if not word.startswith('"') and not word.endswith('"') and not tmp:
                 word_list.append(word)
             else:
-                if word.startswith("\""):
-                    tmp += word[1:]
-                elif word.endswith("\""):
+                if word.startswith('"'):
+                    tmp += word[1:] + " "
+                elif word.endswith('"'):
                     tmp += word[:-1]
                     word_list.append(tmp)
                     tmp = ""
                 else:
-                    tmp += word
-        removed = await self.remove_from_filter(server, word_list)
+                    tmp += word + " "
+        removed = await self.remove_from_filter(channel, word_list)
         if removed:
             await ctx.send(_("Words removed from filter."))
         else:
             await ctx.send(_("Those words weren't in the filter."))
 
-    @_filter.command(name="names")
-    async def filter_names(self, ctx: RedContext):
+    @_filter.command(name="add")
+    async def filter_add(self, ctx: commands.Context, *, words: str):
+        """Add words to the filter.
+
+        Use double quotes to add sentences.
+
+        Examples:
+        - `[p]filter add word1 word2 word3`
+        - `[p]filter add "This is a sentence"`
         """
-        Toggles whether or not to check names and nicknames against the filter
-        This is disabled by default
+        server = ctx.guild
+        split_words = words.split()
+        word_list = []
+        tmp = ""
+        for word in split_words:
+            if not word.startswith('"') and not word.endswith('"') and not tmp:
+                word_list.append(word)
+            else:
+                if word.startswith('"'):
+                    tmp += word[1:] + " "
+                elif word.endswith('"'):
+                    tmp += word[:-1]
+                    word_list.append(tmp)
+                    tmp = ""
+                else:
+                    tmp += word + " "
+        added = await self.add_to_filter(server, word_list)
+        if added:
+            await ctx.send(_("Words successfully added to filter."))
+        else:
+            await ctx.send(_("Those words were already in the filter."))
+
+    @_filter.command(name="remove")
+    async def filter_remove(self, ctx: commands.Context, *, words: str):
+        """Remove words from the filter.
+
+        Use double quotes to remove sentences.
+
+        Examples:
+        - `[p]filter remove word1 word2 word3`
+        - `[p]filter remove "This is a sentence"`
+        """
+        server = ctx.guild
+        split_words = words.split()
+        word_list = []
+        tmp = ""
+        for word in split_words:
+            if not word.startswith('"') and not word.endswith('"') and not tmp:
+                word_list.append(word)
+            else:
+                if word.startswith('"'):
+                    tmp += word[1:] + " "
+                elif word.endswith('"'):
+                    tmp += word[:-1]
+                    word_list.append(tmp)
+                    tmp = ""
+                else:
+                    tmp += word + " "
+        removed = await self.remove_from_filter(server, word_list)
+        if removed:
+            await ctx.send(_("Words successfully removed from filter."))
+        else:
+            await ctx.send(_("Those words weren't in the filter."))
+
+    @_filter.command(name="names")
+    async def filter_names(self, ctx: commands.Context):
+        """Toggle name and nickname filtering.
+
+        This is disabled by default.
         """
         guild = ctx.guild
         current_setting = await self.settings.guild(guild).filter_names()
         await self.settings.guild(guild).filter_names.set(not current_setting)
         if current_setting:
-            await ctx.send(
-                _("Names and nicknames will no longer be "
-                  "checked against the filter")
-            )
+            await ctx.send(_("Names and nicknames will no longer be filtered."))
         else:
-            await ctx.send(
-                _("Names and nicknames will now be checked against "
-                  "the filter")
-            )
+            await ctx.send(_("Names and nicknames will now be filtered."))
 
-    @_filter.command(name="defaultname")
-    async def filter_default_name(self, ctx: RedContext, name: str):
-        """
-        Sets the default name to use if filtering names is enabled
-        Note that this has no effect if filtering names is disabled
-        The default name used is John Doe
-        """
-        guild = ctx.guild
-        await self.settings.guild(guild).filter_default_name.set(name)
-        await ctx.send(_("The name to use on filtered names has been set"))
-
-    @_filter.command(name="ban")
-    async def filter_ban(
-            self, ctx: commands.Context, count: int, timeframe: int):
-        """
-        Sets up an autoban if the specified number of messages are
-        filtered in the specified amount of time (in seconds)
-        """
-        if (count <= 0) != (timeframe <= 0):
-            await ctx.send(
-                _("Count and timeframe either both need to be 0 "
-                  "or both need to be greater than 0!"
-                  )
-            )
-            return
-        elif count == 0 and timeframe == 0:
-            await self.settings.guild(ctx.guild).filterban_count.set(0)
-            await self.settings.guild(ctx.guild).filterban_time.set(0)
-            await ctx.send(_("Autoban disabled."))
-        else:
-            await self.settings.guild(ctx.guild).filterban_count.set(count)
-            await self.settings.guild(ctx.guild).filterban_time.set(timeframe)
-            await ctx.send(_("Count and time have been set."))
-
-    async def add_to_filter(self, server: discord.Guild, words: list) -> bool:
+    async def add_to_filter(
+        self, server_or_channel: Union[discord.Guild, discord.TextChannel], words: list
+    ) -> bool:
         added = False
-        async with self.settings.guild(server).filter() as cur_list:
-            for w in words:
-                if w.lower() not in cur_list and w:
-                    cur_list.append(w.lower())
-                    added = True
+        if isinstance(server_or_channel, discord.Guild):
+            async with self.settings.guild(server_or_channel).filter() as cur_list:
+                for w in words:
+                    if w.lower() not in cur_list and w:
+                        cur_list.append(w.lower())
+                        added = True
+
+        elif isinstance(server_or_channel, discord.TextChannel):
+            async with self.settings.channel(server_or_channel).filter() as cur_list:
+                for w in words:
+                    if w.lower not in cur_list and w:
+                        cur_list.append(w.lower())
+                        added = True
 
         return added
 
-    async def remove_from_filter(self, server: discord.Guild, words: list) -> bool:
+    async def remove_from_filter(
+        self, server_or_channel: Union[discord.Guild, discord.TextChannel], words: list
+    ) -> bool:
         removed = False
-        async with self.settings.guild(server).filter() as cur_list:
-            for w in words:
-                if w.lower() in cur_list:
-                    cur_list.remove(w.lower())
-                    removed = True
+        if isinstance(server_or_channel, discord.Guild):
+            async with self.settings.guild(server_or_channel).filter() as cur_list:
+                for w in words:
+                    if w.lower() in cur_list:
+                        cur_list.remove(w.lower())
+                        removed = True
+
+        elif isinstance(server_or_channel, discord.TextChannel):
+            async with self.settings.channel(server_or_channel).filter() as cur_list:
+                for w in words:
+                    if w.lower() in cur_list:
+                        cur_list.remove(w.lower())
+                        removed = True
 
         return removed
 
     async def check_filter(self, message: discord.Message):
         server = message.guild
         author = message.author
-        word_list = await self.settings.guild(server).filter()
+        word_list = set(
+            await self.settings.guild(server).filter()
+            + await self.settings.channel(message.channel).filter()
+        )
         filter_count = await self.settings.guild(server).filterban_count()
         filter_time = await self.settings.guild(server).filterban_time()
         user_count = await self.settings.member(author).filter_count()
@@ -213,9 +331,7 @@ class Filter:
         if filter_count > 0 and filter_time > 0:
             if message.created_at.timestamp() >= next_reset_time:
                 next_reset_time = message.created_at.timestamp() + filter_time
-                await self.settings.member(author).next_reset_time.set(
-                    next_reset_time
-                )
+                await self.settings.member(author).next_reset_time.set(next_reset_time)
                 if user_count > 0:
                     user_count = 0
                     await self.settings.member(author).filter_count.set(user_count)
@@ -225,23 +341,30 @@ class Filter:
                 if w in message.content.lower():
                     try:
                         await message.delete()
-                    except:
+                    except discord.HTTPException:
                         pass
                     else:
                         if filter_count > 0 and filter_time > 0:
                             user_count += 1
                             await self.settings.member(author).filter_count.set(user_count)
-                            if user_count >= filter_count and \
-                                    message.created_at.timestamp() < next_reset_time:
-                                reason = "Autoban (too many filtered messages)"
+                            if (
+                                user_count >= filter_count
+                                and message.created_at.timestamp() < next_reset_time
+                            ):
+                                reason = _("Autoban (too many filtered messages.)")
                                 try:
                                     await server.ban(author, reason=reason)
-                                except:
+                                except discord.HTTPException:
                                     pass
                                 else:
                                     await modlog.create_case(
-                                        self.bot, server, message.created_at,
-                                        "filterban", author, server.me, reason
+                                        self.bot,
+                                        server,
+                                        message.created_at,
+                                        "filterban",
+                                        author,
+                                        server.me,
+                                        reason,
                                     )
 
     async def on_message(self, message: discord.Message):
@@ -251,76 +374,41 @@ class Filter:
         valid_user = isinstance(author, discord.Member) and not author.bot
         if not valid_user:
             return
-        
-        #  Bots and mods or superior are ignored from the filter
-        mod_or_superior = await is_mod_or_superior(self.bot, obj=author)
-        if mod_or_superior:
+
+        if await self.bot.is_automod_immune(message):
             return
 
         await self.check_filter(message)
 
-    async def on_message_edit(self, _, message):
-        author = message.author
-        if message.guild is None or self.bot.user == author:
-            return
-        valid_user = isinstance(author, discord.Member) and not author.bot
-        if not valid_user:
-            return
-        
-        #  Bots and mods or superior are ignored from the filter
-        mod_or_superior = await is_mod_or_superior(self.bot, obj=author)
-        if mod_or_superior:
-            return
-
-        await self.check_filter(message)
+    async def on_message_edit(self, _prior, message):
+        # message content has to change for non-bot's currently.
+        # if this changes, we should compare before passing it.
+        await self.on_message(message)
 
     async def on_member_update(self, before: discord.Member, after: discord.Member):
-        if not after.guild.me.guild_permissions.manage_nicknames:
-            return  # No permissions to manage nicknames, so can't do anything
-        word_list = await self.settings.guild(after.guild).filter()
-        filter_names = await self.settings.guild(after.guild).filter_names()
-        name_to_use = await self.settings.guild(after.guild).filter_default_name()
-        if not filter_names:
-            return
-
-        name_filtered = False
-        nick_filtered = False
-
-        for w in word_list:
-            if w in after.name:
-                name_filtered = True
-            if after.nick and w in after.nick:  # since Member.nick can be None
-                nick_filtered = True
-            if name_filtered and nick_filtered:  # Both true, so break from loop
-                break
-
-        if name_filtered and after.nick is None:
-            try:
-                await after.edit(nick=name_to_use, reason="Filtered name")
-            except:
-                pass
-        elif nick_filtered:
-            try:
-                await after.edit(nick=None, reason="Filtered nickname")
-            except:
-                pass
+        if before.display_name != after.display_name:
+            await self.maybe_filter_name(after)
 
     async def on_member_join(self, member: discord.Member):
-        guild = member.guild
-        if not guild.me.guild_permissions.manage_nicknames:
-            return
-        word_list = await self.settings.guild(guild).filter()
-        filter_names = await self.settings.guild(guild).filter_names()
-        name_to_use = await self.settings.guild(guild).filter_default_name()
+        await self.maybe_filter_name(member)
 
-        if not filter_names:
+    async def maybe_filter_name(self, member: discord.Member):
+        if not member.guild.me.guild_permissions.manage_nicknames:
+            return  # No permissions to manage nicknames, so can't do anything
+        if member.top_role >= member.guild.me.top_role:
+            return  # Discord Hierarchy applies to nicks
+        if await self.bot.is_automod_immune(member):
+            return
+        if not await self.settings.guild(member.guild).filter_names():
             return
 
+        word_list = await self.settings.guild(member.guild).filter()
         for w in word_list:
-            if w in member.name:
+            if w in member.display_name.lower():
+                name_to_use = await self.settings.guild(member.guild).filter_default_name()
+                reason = _("Filtered nickname") if member.nick else _("Filtered name")
                 try:
-                    await member.edit(nick=name_to_use, reason="Filtered name")
-                except:
+                    await member.edit(nick=name_to_use, reason=reason)
+                except discord.HTTPException:
                     pass
-                break
-
+                return

redbot/cogs/filter/locales/messages.pot

@@ -1,65 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR ORGANIZATION
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-02-18 14:42+AKST\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: ENCODING\n"
-"Generated-By: pygettext.py 1.5\n"
-
-
-#: ../filter.py:62
-msgid "Filtered in this server:"
-msgstr ""
-
-#: ../filter.py:67
-msgid "I can't send direct messages to you."
-msgstr ""
-
-#: ../filter.py:96
-msgid "Words added to filter."
-msgstr ""
-
-#: ../filter.py:98
-msgid "Words already in the filter."
-msgstr ""
-
-#: ../filter.py:127
-msgid "Words removed from filter."
-msgstr ""
-
-#: ../filter.py:129
-msgid "Those words weren't in the filter."
-msgstr ""
-
-#: ../filter.py:142
-msgid "Names and nicknames will no longer be checked against the filter"
-msgstr ""
-
-#: ../filter.py:147
-msgid "Names and nicknames will now be checked against the filter"
-msgstr ""
-
-#: ../filter.py:160
-msgid "The name to use on filtered names has been set"
-msgstr ""
-
-#: ../filter.py:171
-msgid "Count and timeframe either both need to be 0 or both need to be greater than 0!"
-msgstr ""
-
-#: ../filter.py:179
-msgid "Autoban disabled."
-msgstr ""
-
-#: ../filter.py:183
-msgid "Count and time have been set."
-msgstr ""
-

redbot/cogs/filter/locales/regen_messages.py

@@ -1,15 +0,0 @@
-import subprocess
-
-TO_TRANSLATE = [
-    '../filter.py'
-]
-
-
-def regen_messages():
-    subprocess.run(
-        ['pygettext', '-n'] + TO_TRANSLATE
-    )
-
-
-if __name__ == "__main__":
-    regen_messages()