cli revisions

Author: Gerit Wagner

docs/source/index.rst

@@ -177,18 +177,18 @@ To translate a search query on the command line, run
 Arguments
 ---------
 
-- ``--from`` (required):  
-  The source query format.  
+- ``--from`` (required):
+  The source query format.
   Example: ``colrev_web_of_science``
 
-- ``--input`` (required):  
+- ``--input`` (required):
   Path to the input file containing the original query.
 
-- ``--to`` (required):  
-  The target query format.  
+- ``--to`` (required):
+  The target query format.
   Example: ``colrev_pubmed``
 
-- ``--output`` (required):  
+- ``--output`` (required):
   Path to the file where the converted query will be written.
 
 

pyproject.toml

@@ -39,8 +39,8 @@ dev = [
 ]
 
 [project.scripts]
-search-query-translate = "search_query.cli:main"
-search-query-lint = "search_query.linter:main"
+search-query-translate = "search_query.cli:translate"
+search-query-lint = "search_query.linter:lint"
 
 [tool.pylint.MAIN]
 extension-pkg-whitelist = "lxml.etree"

search_query/__init__.py

@@ -20,4 +20,4 @@
 
 # Instead of adding elements to __all__,
 # prefixing methods/variables with "__" is preferred.
-# Imports like "from x import *" are discouraged.
+# Imports like "from x import *" are discouraged.

search_query/cli.py

@@ -2,12 +2,14 @@
 """CLI for search-query."""
 import argparse
 from pathlib import Path
+
+import search_query.linter
 import search_query.parser
-from search_query import SearchFile
 from search_query import load_search_file
 
 
-def main():
+def translate() -> None:
+    """Main entrypoint for the query translation CLI"""
     parser = argparse.ArgumentParser(
         description="Convert search queries between formats"
     )
@@ -47,17 +49,18 @@ def main():
     print(f"Convert from {args.source} to {args.target}")
 
     if Path(args.input_file).suffix == ".json":
-
         search_file = load_search_file(args.input_file)
-        query = search_query.parser.parse(search_file.search_string, syntax=args.source, search_field_general="")
+        query = search_query.parser.parse(
+            search_file.search_string, syntax=args.source, search_field_general=""
+        )
         converted_query = query.to_string(syntax=args.target)
         search_file.search_string = converted_query
         search_file.save()
 
     else:
-        raise NotImplemented
-
+        raise NotImplementedError
 
 
-if __name__ == "__main__":
-    main()
+def lint() -> None:
+    """Main entrypoint for the query linter hook"""
+    raise SystemExit(search_query.linter.pre_commit_hook())

search_query/linter.py

@@ -64,12 +64,3 @@ def pre_commit_hook() -> int:
         return ExitCodes.FAIL
 
     return ExitCodes.SUCCESS
-
-
-def main() -> None:
-    """Main entrypoint for the query linter hook"""
-    raise SystemExit(pre_commit_hook())
-
-
-if __name__ == "__main__":
-    main()