Format Python scripts with black

Author: flashcode

setup.py

@@ -22,38 +22,38 @@
 from setuptools import setup, find_packages
 from weechat_script_lint import __version__ as wsl_version
 
-DESCRIPTION = 'Static analysis tool for WeeChat scripts.'
+DESCRIPTION = "Static analysis tool for WeeChat scripts."
 
-with open('README.md', 'r', 'utf-8') as f:
+with open("README.md", "r", "utf-8") as f:
     readme = f.read()
 
 setup(
-    name='weechat-script-lint',
+    name="weechat-script-lint",
     version=wsl_version,
     description=DESCRIPTION,
     long_description=readme,
-    long_description_content_type='text/markdown',
-    author='Sébastien Helleu',
-    author_email='[email protected]',
-    url='https://github.com/weechat/weechat-script-lint',
-    license='GPL3',
-    keywords='static analysis weechat script lint',
+    long_description_content_type="text/markdown",
+    author="Sébastien Helleu",
+    author_email="[email protected]",
+    url="https://github.com/weechat/weechat-script-lint",
+    license="GPL3",
+    keywords="static analysis weechat script lint",
     classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Environment :: Console',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: GNU General Public License v3 '
-        'or later (GPLv3+)',
-        'Natural Language :: English',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Topic :: Software Development',
-        'Topic :: Utilities',
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: GNU General Public License v3 "
+        "or later (GPLv3+)",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Topic :: Software Development",
+        "Topic :: Utilities",
     ],
     packages=find_packages(),
-    tests_require=['pytest'],
+    tests_require=["pytest"],
     entry_points={
-        'console_scripts': ['weechat-script-lint=weechat_script_lint:main'],
-    }
+        "console_scripts": ["weechat-script-lint=weechat_script_lint:main"],
+    },
 )

tests/test_main.py

@@ -29,24 +29,24 @@
 
 import weechat_script_lint
 
-SCRIPTS_DIR = Path(__file__).resolve().parent / 'scripts'
+SCRIPTS_DIR = Path(__file__).resolve().parent / "scripts"
 
 
 def test_main_no_scripts():
     """Test main function without scripts."""
 
     # no argument
-    args = ['weechat-script-lint']
+    args = ["weechat-script-lint"]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 2
 
     # display help
-    args = ['weechat-script-lint', '--help']
+    args = ["weechat-script-lint", "--help"]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 0
@@ -56,19 +56,19 @@ def test_main_script():
     """Test main function with a single script."""
 
     # script not found
-    filename = str(SCRIPTS_DIR / 'unknown.py')
-    args = ['weechat-script-lint', filename]
+    filename = str(SCRIPTS_DIR / "unknown.py")
+    args = ["weechat-script-lint", filename]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
-    assert 'FATAL' in exc.value.code
+    assert "FATAL" in exc.value.code
 
     # check script OK
-    filename = str(SCRIPTS_DIR / 'script_valid.py')
-    args = ['weechat-script-lint', filename]
+    filename = str(SCRIPTS_DIR / "script_valid.py")
+    args = ["weechat-script-lint", filename]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 0
@@ -79,89 +79,91 @@ def test_main_dir():
 
     # check directory with scripts
     args = [
-        'weechat-script-lint',
-        '--verbose',
-        '--recursive',
+        "weechat-script-lint",
+        "--verbose",
+        "--recursive",
         str(SCRIPTS_DIR),
     ]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 7
 
     # check directory with scripts, treat warnings as errors
     args = [
-        'weechat-script-lint',
-        '--strict',
-        '--verbose',
-        '--recursive',
+        "weechat-script-lint",
+        "--strict",
+        "--verbose",
+        "--recursive",
         str(SCRIPTS_DIR),
     ]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 23
 
     args = [
-        'weechat-script-lint',
-        '--ignore-files', 'script_valid.py,script_missing_email.py',
-        '--verbose',
-        '--recursive',
+        "weechat-script-lint",
+        "--ignore-files",
+        "script_valid.py,script_missing_email.py",
+        "--verbose",
+        "--recursive",
         str(SCRIPTS_DIR),
     ]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 6
 
     # check a script returning only a warning
-    filename = str(SCRIPTS_DIR / 'script_modifier_irc_in.py')
+    filename = str(SCRIPTS_DIR / "script_modifier_irc_in.py")
     args = [
-        'weechat-script-lint',
-        '--verbose',
+        "weechat-script-lint",
+        "--verbose",
         filename,
     ]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 0
 
     # check a script returning only an info
-    filename = str(SCRIPTS_DIR / 'script_unneeded_shebang.py')
+    filename = str(SCRIPTS_DIR / "script_unneeded_shebang.py")
     args = [
-        'weechat-script-lint',
-        '--verbose',
+        "weechat-script-lint",
+        "--verbose",
         filename,
     ]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 0
 
     # check a file that isn't a WeeChat script
-    filename = str(SCRIPTS_DIR / 'not_a_script.txt')
-    args = ['weechat-script-lint', '--verbose', filename]
+    filename = str(SCRIPTS_DIR / "not_a_script.txt")
+    args = ["weechat-script-lint", "--verbose", filename]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(sys, "argv", args):
             weechat_script_lint.main()
     assert exc.type == SystemExit
     assert exc.value.code == 0
 
 
 def test_init():
     """Test init function."""
-    filename = str(SCRIPTS_DIR / 'script_valid.py')
-    args = ['weechat-script-lint', filename]
+    filename = str(SCRIPTS_DIR / "script_valid.py")
+    args = ["weechat-script-lint", filename]
     with pytest.raises(SystemExit) as exc:
-        with mock.patch.object(weechat_script_lint, 'main', return_value=0):
-            with mock.patch.object(weechat_script_lint,
-                                   '__name__', '__main__'):
-                with mock.patch.object(sys, 'argv', args):
+        with mock.patch.object(weechat_script_lint, "main", return_value=0):
+            with mock.patch.object(
+                weechat_script_lint, "__name__", "__main__"
+            ):
+                with mock.patch.object(sys, "argv", args):
                     weechat_script_lint.init(force=True)
     assert exc.type == SystemExit
     assert exc.value.code == 0

tests/test_script.py

@@ -24,102 +24,99 @@
 
 from weechat_script_lint import WeechatScript
 
-SCRIPTS_DIR = Path(__file__).resolve().parent / 'scripts'
+SCRIPTS_DIR = Path(__file__).resolve().parent / "scripts"
 
 ALL_ERRORS = [
-    ('error', 1, 'missing_email'),
-    ('error', 17, 'missing_infolist_free'),
-    ('error', 18, 'python2_bin'),
-    ('warning', 27, 'sys_exit'),
-    ('warning', 19, 'deprecated_hook_completion_get_string'),
-    ('warning', 20, 'deprecated_hook_completion_list_add'),
-    ('warning', 22, 'deprecated_irc_nick_color'),
-    ('warning', 23, 'deprecated_irc_nick_color_name'),
-    ('warning', 24, 'modifier_irc_in'),
-    ('warning', 25, 'signal_irc_out'),
-    ('warning', 26, 'signal_irc_outtags'),
-    ('info', 1, 'unneeded_shebang'),
-    ('info', 13, 'url_weechat'),
+    ("error", 1, "missing_email"),
+    ("error", 17, "missing_infolist_free"),
+    ("error", 18, "python2_bin"),
+    ("warning", 27, "sys_exit"),
+    ("warning", 19, "deprecated_hook_completion_get_string"),
+    ("warning", 20, "deprecated_hook_completion_list_add"),
+    ("warning", 22, "deprecated_irc_nick_color"),
+    ("warning", 23, "deprecated_irc_nick_color_name"),
+    ("warning", 24, "modifier_irc_in"),
+    ("warning", 25, "signal_irc_out"),
+    ("warning", 26, "signal_irc_outtags"),
+    ("info", 1, "unneeded_shebang"),
+    ("info", 13, "url_weechat"),
 ]
 
 
 def test_script_valid():
     """Tests on a valid script."""
-    path = SCRIPTS_DIR / 'script_valid.py'
+    path = SCRIPTS_DIR / "script_valid.py"
 
     script = WeechatScript(path)
-    assert str(script) == ''
+    assert str(script) == ""
     assert script.path == path.resolve()
     assert script.ignored_msg == []
     assert script.msg_level == 2
     assert script.use_colors is True
     assert script.messages == []
-    assert script.count == {'error': 0, 'warning': 0, 'info': 0}
+    assert script.count == {"error": 0, "warning": 0, "info": 0}
     assert script.script
     script.check()
-    assert str(script) == ''
-    assert script.count == {'error': 0, 'warning': 0, 'info': 0}
-    assert script.get_report(False) == ''
-    assert script.get_report(True) == ''
+    assert str(script) == ""
+    assert script.count == {"error": 0, "warning": 0, "info": 0}
+    assert script.get_report(False) == ""
+    assert script.get_report(True) == ""
 
 
 def test_script_all_errors():
     """Tests on a script with all possible messages."""
-    path = SCRIPTS_DIR / 'script_all_errors.py'
+    path = SCRIPTS_DIR / "script_all_errors.py"
 
     script = WeechatScript(path)
-    assert str(script) == ''
+    assert str(script) == ""
     assert script.path == path.resolve()
     assert script.ignored_msg == []
     assert script.msg_level == 2
     assert script.use_colors is True
     assert script.messages == []
-    assert script.count == {'error': 0, 'warning': 0, 'info': 0}
+    assert script.count == {"error": 0, "warning": 0, "info": 0}
     assert script.script
     script.check()
     assert str(script)
-    assert len(str(script).split('\n')) == 13
-    assert script.count == {'error': 3, 'warning': 8, 'info': 2}
-    errors = [
-        (msg.level, msg.line, msg.msg_name)
-        for msg in script.messages
-    ]
+    assert len(str(script).split("\n")) == 13
+    assert script.count == {"error": 3, "warning": 8, "info": 2}
+    errors = [(msg.level, msg.line, msg.msg_name) for msg in script.messages]
     assert errors == ALL_ERRORS
-    assert len(script.get_report(False).split('\n')) == 13
-    assert script.get_report(True) == 'script_all_errors.py'
+    assert len(script.get_report(False).split("\n")) == 13
+    assert script.get_report(True) == "script_all_errors.py"
 
     # ignore 2 messages: "missing_email" and "sys_exit"
-    script = WeechatScript(path, ignore='missing_email,sys_exit')
-    assert str(script) == ''
+    script = WeechatScript(path, ignore="missing_email,sys_exit")
+    assert str(script) == ""
     assert script.path == path.resolve()
-    assert script.ignored_msg == ['missing_email', 'sys_exit']
+    assert script.ignored_msg == ["missing_email", "sys_exit"]
     assert script.msg_level == 2
     assert script.use_colors is True
     assert script.messages == []
-    assert script.count == {'error': 0, 'warning': 0, 'info': 0}
+    assert script.count == {"error": 0, "warning": 0, "info": 0}
     assert script.script
     script.check()
     assert str(script)
-    assert len(str(script).split('\n')) == 11
-    assert script.count == {'error': 2, 'warning': 7, 'info': 2}
-    assert len(script.get_report(False).split('\n')) == 11
-    assert script.get_report(True) == 'script_all_errors.py'
+    assert len(str(script).split("\n")) == 11
+    assert script.count == {"error": 2, "warning": 7, "info": 2}
+    assert len(script.get_report(False).split("\n")) == 11
+    assert script.get_report(True) == "script_all_errors.py"
 
 
 def test_script_empty_file():
     """Tests on a script with all possible messages."""
-    path = SCRIPTS_DIR / 'script_empty.py'
+    path = SCRIPTS_DIR / "script_empty.py"
     script = WeechatScript(path)
-    assert str(script) == ''
+    assert str(script) == ""
     assert script.path == path.resolve()
     assert script.ignored_msg == []
     assert script.msg_level == 2
     assert script.use_colors is True
     assert script.messages == []
-    assert script.count == {'error': 0, 'warning': 0, 'info': 0}
-    assert script.script == ''
+    assert script.count == {"error": 0, "warning": 0, "info": 0}
+    assert script.script == ""
     script.check()
     assert str(script)
-    assert script.count == {'error': 1, 'warning': 0, 'info': 0}
-    assert len(script.get_report(False).split('\n')) == 1
-    assert script.get_report(True) == 'script_empty.py'
+    assert script.count == {"error": 1, "warning": 0, "info": 0}
+    assert len(script.get_report(False).split("\n")) == 1
+    assert script.get_report(True) == "script_empty.py"