ci: Add a lot of opinionated linters

Add a pre-commit configuration to apply a collection of linting and
formatting plugins. These will be automatically run by tox in CI, but
can also be setup to run as a pre-commit action in the local repo.

Highlights:
* Use black for code formatting
* Use isort for import formatting
* Add a number of flake8 plugins including bugbear

Author: bd808

.pre-commit-config.yaml

@@ -0,0 +1,69 @@
+default_language_version:
+    python: python3.11
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: check-toml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: name-tests-test
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v3.1.0
+    hooks:
+      - id: add-trailing-comma
+        args: ["--py36-plus"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.13.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py37-plus"]
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+  - repo: https://github.com/asottile/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.9.1]
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-backticks
+  - repo: https://github.com/tox-dev/tox-ini-fmt
+    rev: "1.3.1"
+    hooks:
+      - id: tox-ini-fmt
+        args: ["-p", "lint"]
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear==23.3.12
+          - flake8-comprehensions==3.11.1
+          - flake8-pytest-style==1.7.2
+          - flake8-unused-arguments==0.0.13
+          - flake8-noqa==1.3.1
+          - pep8-naming==0.13.3
+          - flake8-pyproject==1.2.3
+  - repo: https://github.com/PyCQA/doc8
+    rev: v1.1.1
+    hooks:
+      - id: doc8
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

HISTORY.rst

@@ -4,6 +4,10 @@ UNRELEASED
 * Require irc>=20.0.0
 * Convert to hatchling build system backend
 * Replace Travis CI with GitHub Actions
+* Use pre-commit for linter checks
+* Use black for code formatting
+* Use isort for import formatting
+* Add a number of flake8 plugins including bugbear
 
 v0.2.0
 ------

docs/conf.py

@@ -1,19 +1,18 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 import datetime
 import importlib.metadata
 
 import sphinx_rtd_theme
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'irc': ('https://python-irc.readthedocs.io/en/stable/', None),
+    "python": ("https://docs.python.org/3", None),
+    "irc": ("https://python-irc.readthedocs.io/en/stable/", None),
 }
 
 # General information about the project.
@@ -25,13 +24,13 @@
 _origin_date = datetime.date(2017, 2, 19)
 _today = datetime.date.today()
 
-copyright = f'{_origin_date.year}-{_today.year} {author} and contributors'
+copyright = f"{_origin_date.year}-{_today.year} {author} and contributors"
 release = version
 
-master_doc = 'index'
-pygments_style = 'sphinx'
-html_theme = 'sphinx_rtd_theme'
+master_doc = "index"
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-suppress_warnings = ['image.nonlocal_uri']
+suppress_warnings = ["image.nonlocal_uri"]

examples/nickserv.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # This file is part of IRC Bot Behavior Bundle (IB3)
 # Copyright (C) 2017 Bryan Davis and contributors
@@ -23,11 +22,10 @@
 from ib3.auth import NickServ
 from ib3.connection import SSL
 
-
 logging.basicConfig(
     level=logging.DEBUG,
-    format='%(asctime)s %(name)s %(levelname)s: %(message)s',
-    datefmt='%Y-%m-%dT%H:%M:%SZ'
+    format="%(asctime)s %(name)s %(levelname)s: %(message)s",
+    datefmt="%Y-%m-%dT%H:%M:%SZ",
 )
 logging.captureWarnings(True)
 
@@ -36,31 +34,33 @@ class TestBot(NickServ, SSL, Bot):
     pass
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description='Example bot with NickServ auth')
-    parser.add_argument('nick')
-    parser.add_argument('password')
-    parser.add_argument('channel')
+        description="Example bot with NickServ auth",
+    )
+    parser.add_argument("nick")
+    parser.add_argument("password")
+    parser.add_argument("channel")
     parser.add_argument(
-        '-u', '--username',
-        help='Account name if different than nick',
+        "-u",
+        "--username",
+        help="Account name if different than nick",
     )
     args = parser.parse_args()
 
     bot = TestBot(
-        server_list=[('irc.libera.chat', 6697)],
+        server_list=[("irc.libera.chat", 6697)],
         nickname=args.nick,
         realname=args.nick,
         username=args.username,
         ident_password=args.password,
-        channels=[args.channel]
+        channels=[args.channel],
     )
     try:
         bot.start()
     except KeyboardInterrupt:
-        bot.disconnect('KeyboardInterrupt!')
+        bot.disconnect("KeyboardInterrupt!")
     except Exception:
-        logging.getLogger('root').exception('Killed by unhandled exception')
-        bot.disconnect('Exception!')
+        logging.getLogger("root").exception("Killed by unhandled exception")
+        bot.disconnect("Exception!")
         raise SystemExit()

examples/saslbot.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # This file is part of IRC Bot Behavior Bundle (IB3)
 # Copyright (C) 2017 Bryan Davis and contributors
@@ -26,24 +25,24 @@
 import ib3.connection
 import ib3.nick
 
-
 logging.basicConfig(
     level=logging.DEBUG,
-    format='%(asctime)s %(name)s %(levelname)s: %(message)s',
-    datefmt='%Y-%m-%dT%H:%M:%SZ'
+    format="%(asctime)s %(name)s %(levelname)s: %(message)s",
+    datefmt="%Y-%m-%dT%H:%M:%SZ",
 )
 logging.captureWarnings(True)
 
-logger = logging.getLogger('saslbot')
+logger = logging.getLogger("saslbot")
 
 
 class SaslBot(ib3.auth.SASL, ib3.nick.Regain, ib3.connection.SSL, ib3.Bot):
     """Example bot showing use of SASL auth, REGAIN, and SSL encryption."""
+
     def on_privmsg(self, conn, event):
         self.do_command(conn, event, event.arguments[0])
 
     def on_pubmsg(self, conn, event):
-        args = event.arguments[0].split(':', 1)
+        args = event.arguments[0].split(":", 1)
         if len(args) > 1:
             to = irc.strings.lower(args[0])
             if to == irc.strings.lower(conn.get_nickname()):
@@ -54,27 +53,28 @@ def do_command(self, conn, event, cmd):
         if to == conn.get_nickname():
             to = event.source.nick
 
-        if cmd == 'disconnect':
+        if cmd == "disconnect":
             self.disconnect()
-        elif cmd == 'die':
+        elif cmd == "die":
             self.die()
         else:
-            conn.privmsg(to, 'What does "{}" mean?'.format(cmd))
+            conn.privmsg(to, f'What does "{cmd}" mean?')
 
 
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser(description='Example bot with SASL auth')
-    parser.add_argument('nick')
-    parser.add_argument('password')
-    parser.add_argument('channel')
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Example bot with SASL auth")
+    parser.add_argument("nick")
+    parser.add_argument("password")
+    parser.add_argument("channel")
     parser.add_argument(
-        '-u', '--username',
-        help='Account name if different than nick',
+        "-u",
+        "--username",
+        help="Account name if different than nick",
     )
     args = parser.parse_args()
 
     bot = SaslBot(
-        server_list=[('irc.libera.chat', 6697)],
+        server_list=[("irc.libera.chat", 6697)],
         nickname=args.nick,
         realname=args.nick,
         username=args.username,
@@ -84,8 +84,8 @@ def do_command(self, conn, event, cmd):
     try:
         bot.start()
     except KeyboardInterrupt:
-        bot.disconnect('KeyboardInterrupt!')
+        bot.disconnect("KeyboardInterrupt!")
     except Exception:
-        logger.exception('Killed by unhandled exception')
-        bot.disconnect('Exception!')
+        logger.exception("Killed by unhandled exception")
+        bot.disconnect("Exception!")
         raise SystemExit()

pyproject.toml

@@ -52,3 +52,12 @@ build.targets.sdist.include = [
 
 [tool.hatch.version]
 source = "vcs"
+
+[tool.black]
+line_length = 88
+target_version = ["py37"]
+
+[tool.isort]
+known_first_party = ["ib3", "tests"]
+line_length = 88
+profile = "black"

src/ib3/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # This file is part of IRC Bot Behavior Bundle (IB3)
 # Copyright (C) 2017 Bryan Davis and contributors
@@ -19,8 +18,8 @@
 import logging
 
 import irc.bot
-from jaraco.stream import buffer
 import irc.client
+from jaraco.stream import buffer
 
 logger = logging.getLogger(__name__)
 
@@ -32,11 +31,11 @@ class Bot(irc.bot.SingleServerIRCBot):
     UTF-8 encoding handling for inbound messages. This is a nice base to start
     from when adding other IB3 mixins.
     """
+
     def __init__(self, *args, **kwargs):
         # A UTF-8 only world is a nice dream but the real world is all yucky
         # and full of legacy encoding issues that should not crash our bot.
-        buffer.LenientDecodingLineBuffer.errors = 'replace'
-        irc.client.ServerConnection.buffer_class = \
-            buffer.LenientDecodingLineBuffer
+        buffer.LenientDecodingLineBuffer.errors = "replace"
+        irc.client.ServerConnection.buffer_class = buffer.LenientDecodingLineBuffer
 
-        super(Bot, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)