apply precommit suggested fixes

Author: willingc

.github/dependabot.yml

@@ -10,4 +10,4 @@ updates:
   groups:
     python-packages:
       patterns:
-        - "*"
+        - "*"

_tasks.py

@@ -27,15 +27,18 @@ def validate_manifest(module_name, project_directory):
     """Validate the new plugin repository against napari requirements."""
     try:
         from npe2 import PluginManifest
-    except ImportError as e:
+    except ImportError:
         logger.error("npe2 is not installed. Skipping manifest validation.")
         return True
 
-    current_directory = Path('.').absolute()
-    if (current_directory.match(project_directory) and not Path(project_directory).is_absolute()):
+    current_directory = Path(".").absolute()
+    if (
+        current_directory.match(project_directory)
+        and not Path(project_directory).is_absolute()
+    ):
         project_directory = current_directory
 
-    path=Path(project_directory) / "src" / Path(module_name) / "napari.yaml"
+    path = Path(project_directory) / "src" / Path(module_name) / "napari.yaml"
 
     valid = False
     try:
@@ -56,18 +59,18 @@ def validate_manifest(module_name, project_directory):
 
 
 def initialize_new_repository(
-        install_precommit=False,
-        plugin_name="napari-foobar",
-        github_repository_url="provide later",
-        github_username_or_organization="githubuser",
-    ):
+    install_precommit=False,
+    plugin_name="napari-foobar",
+    github_repository_url="provide later",
+    github_username_or_organization="githubuser",
+):
     """Initialize new plugin repository with git, and optionally pre-commit."""
 
     msg = ""
 
     # Configure git line ending settings
     # https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration
-    if os.name == 'nt':  # if on Windows, configure git line ending characters
+    if os.name == "nt":  # if on Windows, configure git line ending characters
         subprocess.run(["git", "config", "--global", "core.autocrlf", "true"])
     else:  # for Linux and Mac
         subprocess.run(["git", "config", "--global", "core.autocrlf", "input"])
@@ -83,7 +86,10 @@ def initialize_new_repository(
         # try to install and update pre-commit
         try:
             print("install pre-commit ...")
-            subprocess.run(["python", "-m", "pip", "install", "pre-commit"], stdout=subprocess.DEVNULL)
+            subprocess.run(
+                ["python", "-m", "pip", "install", "pre-commit"],
+                stdout=subprocess.DEVNULL,
+            )
             print("updating pre-commit...")
             subprocess.run(["pre-commit", "autoupdate"], stdout=subprocess.DEVNULL)
             subprocess.run(["git", "add", "."])
@@ -108,15 +114,15 @@ def initialize_new_repository(
     pip install -e .
 """
     else:
-        msg +=f"""
+        msg += f"""
 Your plugin template is ready!  Next steps:
 1. `cd` into your new directory
     cd {plugin_name}
     # you probably want to install your new package into your env
     pip install -e .
 """
     # Ensure full reqd/write/execute permissions for .git files
-    if os.name == 'nt':  # if on Windows OS
+    if os.name == "nt":  # if on Windows OS
         # Avoid permission denied errors on Github Actions CI
         subprocess.run(["attrib", "-h", "rr", ".git", "/s", "/d"])
 
@@ -129,7 +135,7 @@ def initialize_new_repository(
         except Exception:
             logger.error("Error at pre-commit install, skipping pre-commit")
 
-    if github_repository_url != 'provide later':
+    if github_repository_url != "provide later":
         msg += f"""
     2. Create a github repository with the name '{plugin_name}':
     https://github.com/{github_username_or_organization}/{plugin_name}.git
@@ -172,31 +178,35 @@ def initialize_new_repository(
     return msg
 
 
-if __name__=="__main__":
+if __name__ == "__main__":
     logging.basicConfig(level=logging.DEBUG)
     logger = logging.getLogger("pre_gen_project")
     parser = ArgumentParser()
-    parser.add_argument("--plugin_name",
-                        dest="plugin_name",
-                        help="The name of your plugin")
-    parser.add_argument("--module_name",
-                        dest="module_name",
-                        help="Plugin module name")
-    parser.add_argument("--project_directory",
-                        dest="project_directory",
-                        help="Project directory")
-    parser.add_argument("--install_precommit",
-                        dest="install_precommit",
-                        help="Install pre-commit",
-                        default="False")
-    parser.add_argument("--github_repository_url",
-                        dest="github_repository_url",
-                        help="Github repository URL",
-                        default='provide later')
-    parser.add_argument("--github_username_or_organization",
-                        dest="github_username_or_organization",
-                        help="Github user or organisation name",
-                        default='githubuser')
+    parser.add_argument(
+        "--plugin_name", dest="plugin_name", help="The name of your plugin"
+    )
+    parser.add_argument("--module_name", dest="module_name", help="Plugin module name")
+    parser.add_argument(
+        "--project_directory", dest="project_directory", help="Project directory"
+    )
+    parser.add_argument(
+        "--install_precommit",
+        dest="install_precommit",
+        help="Install pre-commit",
+        default="False",
+    )
+    parser.add_argument(
+        "--github_repository_url",
+        dest="github_repository_url",
+        help="Github repository URL",
+        default="provide later",
+    )
+    parser.add_argument(
+        "--github_username_or_organization",
+        dest="github_username_or_organization",
+        help="Github user or organisation name",
+        default="githubuser",
+    )
     args = parser.parse_args()
 
     # Since bool("False") returns True, we need to check the actual string value
@@ -213,4 +223,4 @@ def initialize_new_repository(
         github_repository_url=args.github_repository_url,
         github_username_or_organization=args.github_username_or_organization,
     )
-    print(msg)
+    print(msg)

copier.yaml

@@ -114,4 +114,4 @@ _tasks:
     "--install_precommit={{ install_precommit }}",
     "--github_repository_url={{ github_repository_url }}",
     "--github_username_or_organization={{ github_username_or_organization }}",
-    ]
+    ]

requirements.txt

@@ -3,4 +3,4 @@ jinja2-time
 npe2
 pytest
 pytest-copie
-tox
+tox

template/.github/workflows/test_and_deploy.yml.jinja

@@ -89,4 +89,4 @@ jobs:
           git tag
           python -m build .
           twine upload dist/*
-{% endraw %}
+{% endraw %}

template/.github/{% if install_dependabot %}dependabot.yml{% endif %}.jinja

@@ -12,4 +12,4 @@ updates:
     python-packages:
       patterns:
         - "*"
-{% endraw %}
+{% endraw %}

tests/conftest.py

@@ -1 +1 @@
-pytest_plugins = 'pytester'
+pytest_plugins = "pytester"

tests/test_create_template.py

@@ -3,7 +3,6 @@
 --------------------
 """
 
-
 import os
 import subprocess
 
@@ -16,34 +15,43 @@ def run_tox(plugin):
         subprocess.check_call(
             ["tox", "-c", os.path.join(plugin, "tox.ini"), "-e", "py", "--", plugin]
         )
-    except subprocess.CalledProcessError as e:
+    except subprocess.CalledProcessError:
         pytest.fail("Subprocess fail", pytrace=True)
 
 
 @pytest.mark.parametrize("include_reader_plugin", [True, False])
 @pytest.mark.parametrize("include_writer_plugin", [True, False])
 @pytest.mark.parametrize("include_sample_data_plugin", [True, False])
 @pytest.mark.parametrize("include_widget_plugin", [True, False])
-def test_run_plugin_tests(copie, capsys, include_reader_plugin, include_writer_plugin, include_sample_data_plugin, include_widget_plugin):
+def test_run_plugin_tests(
+    copie,
+    capsys,
+    include_reader_plugin,
+    include_writer_plugin,
+    include_sample_data_plugin,
+    include_widget_plugin,
+):
     """Create a new plugin with the napari plugin template and run its tests."""
-    result = copie.copy(extra_answers={
-        "plugin_name": "foo-bar",
-        "display_name": "Foo Bar",
-        "module_name": "foo_bar",
-        "short_description": "Super fast foo for all the bars",
-        "full_name": "napari bot",
-        "email": "[email protected]",
-        "github_username_or_organization": "napari",
-        "include_reader_plugin": include_reader_plugin,
-        "include_writer_plugin": include_writer_plugin,
-        "include_sample_data_plugin": include_sample_data_plugin,
-        "include_widget_plugin": include_widget_plugin,
-        })
+    result = copie.copy(
+        extra_answers={
+            "plugin_name": "foo-bar",
+            "display_name": "Foo Bar",
+            "module_name": "foo_bar",
+            "short_description": "Super fast foo for all the bars",
+            "full_name": "napari bot",
+            "email": "[email protected]",
+            "github_username_or_organization": "napari",
+            "include_reader_plugin": include_reader_plugin,
+            "include_writer_plugin": include_writer_plugin,
+            "include_sample_data_plugin": include_sample_data_plugin,
+            "include_widget_plugin": include_widget_plugin,
+        }
+    )
 
     assert result.exit_code == 0
     assert result.exception is None
     assert result.project_dir.is_dir()
-    with open(result.project_dir/"README.md") as f:
+    with open(result.project_dir / "README.md") as f:
         assert f.readline() == "# foo-bar\n"
     assert result.project_dir.joinpath("src").is_dir()
     assert result.project_dir.joinpath("src", "foo_bar", "__init__.py").is_file()
@@ -59,31 +67,40 @@ def test_run_plugin_tests(copie, capsys, include_reader_plugin, include_writer_p
         assert (test_path / "test_widget.py").is_file()
 
     # if all are False there are no modules or tests
-    if True in {include_reader_plugin, include_writer_plugin, include_sample_data_plugin, include_widget_plugin}:
+    if True in {
+        include_reader_plugin,
+        include_writer_plugin,
+        include_sample_data_plugin,
+        include_widget_plugin,
+    }:
         run_tox(str(result.project_dir))
 
 
 def test_run_plugin_tests_with_napari_prefix(copie, capsys):
     """make sure it's also ok to use napari prefix."""
     name = "napari-foo"
-    result = copie.copy(extra_answers={
-        "plugin_name": name,
-        "display_name": "napari Foo",
-        "module_name": "napari_foo",
-        "short_description": "Super fast foo for all the bars",
-        "full_name": "napari bot",
-        "email": "[email protected]",
-        "github_username_or_organization": "napari",
-        })
+    result = copie.copy(
+        extra_answers={
+            "plugin_name": name,
+            "display_name": "napari Foo",
+            "module_name": "napari_foo",
+            "short_description": "Super fast foo for all the bars",
+            "full_name": "napari bot",
+            "email": "[email protected]",
+            "github_username_or_organization": "napari",
+        }
+    )
 
     assert result.exit_code == 0
     assert result.exception is None
     assert result.project_dir.is_dir()
-    with open(result.project_dir/"README.md") as f:
+    with open(result.project_dir / "README.md") as f:
         assert f.readline() == f"# {name}\n"
     assert result.project_dir.joinpath("src").is_dir()
     assert result.project_dir.joinpath("src", "napari_foo", "__init__.py").is_file()
-    assert result.project_dir.joinpath("src", "napari_foo", "_tests", "test_reader.py").is_file()
+    assert result.project_dir.joinpath(
+        "src", "napari_foo", "_tests", "test_reader.py"
+    ).is_file()
 
 
 def test_run_select_plugins(copie, capsys):
@@ -106,11 +123,13 @@ def test_run_select_plugins(copie, capsys):
     assert result.exit_code == 0
     assert result.exception is None
     assert result.project_dir.is_dir()
-    with open(result.project_dir/"README.md") as f:
+    with open(result.project_dir / "README.md") as f:
         assert f.readline() == f"# {name}\n"
     assert result.project_dir.joinpath("src").is_dir()
     assert result.project_dir.joinpath("src", name, "__init__.py").is_file()
-    assert result.project_dir.joinpath("src", name, "_tests", "test_reader.py").is_file()
+    assert result.project_dir.joinpath(
+        "src", name, "_tests", "test_reader.py"
+    ).is_file()
 
     assert not result.project_dir.joinpath("src", "anything", "_widget.py").is_file()
     assert not result.project_dir.joinpath(
@@ -126,7 +145,13 @@ def test_run_select_plugins(copie, capsys):
 @pytest.mark.parametrize("include_writer_plugin", [True, False])
 @pytest.mark.parametrize("include_sample_data_plugin", [True, False])
 @pytest.mark.parametrize("include_widget_plugin", [True, False])
-def test_pre_commit_validity(copie, include_reader_plugin, include_writer_plugin, include_sample_data_plugin, include_widget_plugin):
+def test_pre_commit_validity(
+    copie,
+    include_reader_plugin,
+    include_writer_plugin,
+    include_sample_data_plugin,
+    include_widget_plugin,
+):
     result = copie.copy(
         extra_answers={
             "plugin_name": "anything",
@@ -145,6 +170,13 @@ def test_pre_commit_validity(copie, include_reader_plugin, include_writer_plugin
     )
     result.project_dir.joinpath("setup.cfg").is_file()
     try:
-        subprocess.run(["pre-commit", "run", "--all", "--show-diff-on-failure"], cwd=str(result.project_dir), check=True, capture_output=True)
+        subprocess.run(
+            ["pre-commit", "run", "--all", "--show-diff-on-failure"],
+            cwd=str(result.project_dir),
+            check=True,
+            capture_output=True,
+        )
     except subprocess.CalledProcessError as e:
-        pytest.fail(f"pre-commit failed with output:\n{e.stdout.decode()}\nerror:\n{e.stderr.decode()}")
+        pytest.fail(
+            f"pre-commit failed with output:\n{e.stdout.decode()}\nerror:\n{e.stderr.decode()}"
+        )