switch to ruff for linting

Author: dhellmann

pyproject.toml

@@ -37,7 +37,7 @@ homepage = "https://sphinxcontribdatatemplates.readthedocs.io/en/latest/"
 repository = "http://github.com/sphinx-contrib/datatemplates"
 
 [project.optional-dependencies]
-linter = ["flake8"]
+linter = ["ruff"]
 test = ["pytest", "beautifulsoup4"]
 build = ["twine"]
 
@@ -62,7 +62,8 @@ features = ["test", "linter", "build"]
 dependencies = ["check-python-versions"]
 [tool.hatch.envs.test.scripts]
 test = "pytest tests"
-lint = "flake8 sphinxcontrib"
+lint = ["ruff check sphinxcontrib", "ruff format --check sphinxcontrib"]
+lint-fix = ["ruff format sphinxcontrib"]
 pkglint = [
     "hatch build",
     "twine check dist/*.tar.gz",

sphinxcontrib/datatemplates/__init__.py

@@ -7,12 +7,12 @@
 
 
 def setup(app):
-    LOG.info('initializing sphinxcontrib.datatemplates')
-    app.add_directive('datatemplate', directive.DataTemplateLegacy)
+    LOG.info("initializing sphinxcontrib.datatemplates")
+    app.add_directive("datatemplate", directive.DataTemplateLegacy)
     app.add_domain(domain.DataTemplateDomain)
 
     return {
-        'version': version.__version__,
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": version.__version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }

sphinxcontrib/datatemplates/cli.py

@@ -14,50 +14,50 @@
 def main():
     parser = argparse.ArgumentParser()
     parser.add_argument(
-        '--config-file',
-        help='the path to conf.py',
+        "--config-file",
+        help="the path to conf.py",
     )
     subparsers = parser.add_subparsers(
-        title='commands',
-        description='valid commands',
-        dest='command',
+        title="commands",
+        description="valid commands",
+        dest="command",
     )
 
     do_render = subparsers.add_parser(
-        'render',
-        help='render a template to stdout',
+        "render",
+        help="render a template to stdout",
     )
     do_render.add_argument(
-        '--option',
-        '-o',
-        action='append',
+        "--option",
+        "-o",
+        action="append",
         default=[],
-        help='options given as key:value passed through to loader and template'
+        help="options given as key:value passed through to loader and template",
     )
     do_render.add_argument(
-        'template',
-        help='the path to the template file',
+        "template",
+        help="the path to the template file",
     )
     do_render.add_argument(
-        'source',
-        help='the path to the data file',
+        "source",
+        help="the path to the data file",
     )
     do_render.set_defaults(func=render)
 
     do_dump = subparsers.add_parser(
-        'dump',
-        help='dump the data to stdout without a template',
+        "dump",
+        help="dump the data to stdout without a template",
     )
     do_dump.add_argument(
-        '--option',
-        '-o',
-        action='append',
+        "--option",
+        "-o",
+        action="append",
         default=[],
-        help='options given as key:value passed through to loader and template'
+        help="options given as key:value passed through to loader and template",
     )
     do_dump.add_argument(
-        'source',
-        help='the path to the data file',
+        "source",
+        help="the path to the data file",
     )
     do_dump.set_defaults(func=dump)
 
@@ -69,7 +69,7 @@ def main():
 
     conf = {}
     if args.config_file:
-        with io.open(args.config_file, 'r', encoding='utf-8-sig') as f:
+        with io.open(args.config_file, "r", encoding="utf-8-sig") as f:
             config_body = f.read()
         exec(config_body, conf)
 
@@ -82,58 +82,58 @@ def _parse_options(options):
     # treat the option as a flag.
     results = {}
     for opt in options:
-        if ':' in opt:
-            k, _, v = opt.partition(':')
+        if ":" in opt:
+            k, _, v = opt.partition(":")
         else:
             k = opt
             v = True
-        results[k.replace('-', '_')] = v
+        results[k.replace("-", "_")] = v
     return results
 
 
 def render(args, conf):
     conf.update(_parse_options(args.option))
-    conf.update({
-        "source": args.source,
-        "template": args.template,
-        "absolute_resolved_path": os.path.abspath(args.source)
-    })
+    conf.update(
+        {
+            "source": args.source,
+            "template": args.template,
+            "absolute_resolved_path": os.path.abspath(args.source),
+        }
+    )
 
     load = loaders.loader_for_source(args.source)
     if load is None:
-        print('Could not find loader for {}'.format(args.source))
+        print("Could not find loader for {}".format(args.source))
         return 1
 
-    with io.open(args.template, 'r', encoding='utf-8-sig') as f:
+    with io.open(args.template, "r", encoding="utf-8-sig") as f:
         template_body = f.read()
 
     template = jinja2.Template(template_body)
     with load(**conf) as data:
         rendered = template.render(
             make_list_table=helpers.make_list_table,
-            make_list_table_from_mappings=helpers.
-            make_list_table_from_mappings,
+            make_list_table_from_mappings=helpers.make_list_table_from_mappings,
             data=data,
-            **conf
+            **conf,
         )
     print(rendered)
 
 
 def dump(args, conf):
     conf.update(_parse_options(args.option))
-    conf.update({
-        "source": args.source,
-        "absolute_resolved_path": os.path.abspath(args.source)
-    })
+    conf.update(
+        {"source": args.source, "absolute_resolved_path": os.path.abspath(args.source)}
+    )
 
     load = loaders.loader_for_source(args.source)
     if load is None:
-        print('Could not find loader for {}'.format(args.source))
+        print("Could not find loader for {}".format(args.source))
         return 1
 
     with load(**conf) as data:
         pprint.pprint(data)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()