Add more docstrings and type hints

pyiron_base/cli/control.py

@@ -32,7 +32,7 @@
 }
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser(prog="pyiron", description=__doc__)
     parser.add_argument(
         "-d", "--dirty", action="store_true", help="do not remove pyiron log files"

pyiron_base/cli/cp.py

@@ -5,15 +5,17 @@
 Copy a pyiron project to a new location.
 """
 
+from argparse import ArgumentParser, Namespace
+
 from pyiron_base.project.generic import Project
 
 
-def register(parser):
+def register(parser: ArgumentParser) -> None:
     parser.add_argument("src", help="source project")
     parser.add_argument("dst", help="destination project")
 
 
-def main(args):
+def main(args: Namespace) -> None:
     src = Project(args.src)
     dst = Project(args.dst)
     src.copy_to(dst)

pyiron_base/cli/install.py

@@ -5,6 +5,8 @@
 Install pyiron config and resources for the first time.
 """
 
+from argparse import ArgumentParser, Namespace
+
 from pyiron_base.state.install import install_pyiron
 
 __author__ = "Marvin Poul"
@@ -19,7 +21,7 @@
 __date__ = "Jun 26, 2020"
 
 
-def register(parser):
+def register(parser: ArgumentParser) -> None:
     parser.add_argument(
         "-c",
         "--config",
@@ -46,7 +48,7 @@ def register(parser):
     )
 
 
-def main(args):
+def main(args: Namespace) -> None:
     install_pyiron(
         config_file_name=args.config,
         project_path=args.project,

pyiron_base/cli/ls.py

@@ -43,7 +43,7 @@
 """
 
 
-def register(parser):
+def register(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "project", default=".", nargs="?", help="path to pyiron project"
     )
@@ -123,7 +123,7 @@ def register(parser):
     )
 
 
-def main(args):
+def main(args: argparse.Namespace) -> None:
     if args.status:
         if "status" not in args.columns:
             args.columns = args.columns + ["status"]

pyiron_base/cli/mv.py

@@ -5,15 +5,17 @@
 Move a pyiron project to a new location.
 """
 
+from argparse import ArgumentParser, Namespace
+
 from pyiron_base.project.generic import Project
 
 
-def register(parser):
+def register(parser: ArgumentParser) -> None:
     parser.add_argument("src", help="source project")
     parser.add_argument("dst", help="destination project")
 
 
-def main(args):
+def main(args: Namespace) -> None:
     src = Project(args.src)
     dst = Project(args.dst)
     src.move_to(dst)

pyiron_base/cli/reloadfile.py

@@ -3,14 +3,15 @@
 # Distributed under the terms of "New BSD License", see the LICENSE file.
 import os
 import shutil
+from argparse import ArgumentParser, Namespace
 
 from h5io_browser.base import _open_hdf
 
 from pyiron_base import Project
 from pyiron_base.state import state
 
 
-def register(parser):
+def register(parser: ArgumentParser) -> None:
     parser.add_argument(
         "-i",
         "--input-path",
@@ -23,7 +24,7 @@ def register(parser):
     )
 
 
-def main(args):
+def main(args: Namespace) -> None:
     with _open_hdf(filename=args.input_path, mode="r") as f:
         job_name = list(f.keys())[0]
     project_path = os.path.join(os.path.abspath("."), job_name + ".h5")

pyiron_base/cli/rm.py

@@ -5,6 +5,7 @@
 """
 
 import os
+from argparse import ArgumentParser, Namespace
 
 from pyiron_base.project.generic import Project
 
@@ -20,7 +21,7 @@
 __date__ = "23 Jun, 2020"
 
 
-def register(parser):
+def register(parser: ArgumentParser):
     parser.add_argument(
         "project", default=".", nargs="?", help="path to pyiron project"
     )
@@ -32,7 +33,7 @@ def register(parser):
     )
 
 
-def main(args):
+def main(args: Namespace) -> None:
     pr = Project(args.project)
     if args.jobs_only:
         pr.remove_jobs(recursive=args.recursive, silently=True)

pyiron_base/cli/wrapper.py

@@ -4,10 +4,12 @@
 Run a job from hdf5.
 """
 
+from argparse import ArgumentParser, Namespace
+
 from pyiron_base.jobs.job.wrapper import job_wrapper_function
 
 
-def register(parser):
+def register(parser: ArgumentParser):
     parser.add_argument(
         "-d",
         "--debug",
@@ -33,7 +35,7 @@ def register(parser):
     )
 
 
-def main(args):
+def main(args: Namespace) -> None:
     job_wrapper_function(
         working_directory=args.project,
         job_id=args.job_id,