cli to replace python main_out.py

.github/workflows/ci.yml

@@ -26,8 +26,13 @@ jobs:
         pip install -r requirements.txt
         pip install pytest pytest-cov pytest-shell
         python setup.py install
+    - name: Install Python Poetry
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+        poetry install --with dev
     - name: Generate coverage report
-      run: pytest --cov=domainlab tests/ --cov-report=xml
+      run: poetry run pytest --cov=domainlab tests/ --cov-report=xml
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
       with:

domainlab/cli.py

@@ -0,0 +1,26 @@
+"""
+command-line interface (CLI) for the domainlab package
+"""
+
+from domainlab.arg_parser import parse_cmd_args
+from domainlab.exp.exp_cuda_seed import set_seed  # reproducibility
+from domainlab.exp.exp_main import Exp
+from domainlab.exp_protocol import aggregate_results
+from domainlab.utils.generate_benchmark_plots import gen_benchmark_plots
+
+
+def domainlab_cli():
+    """
+    Function used to run domainlab as a command line tool for the package installed with pip.
+    """
+    args = parse_cmd_args()
+    if args.bm_dir:
+        aggregate_results.agg_main(args.bm_dir)
+    elif args.plot_data is not None:
+        gen_benchmark_plots(
+            args.plot_data, args.outp_dir, use_param_index=args.param_idx
+        )
+    else:
+        set_seed(args.seed)
+        exp = Exp(args=args)
+        exp.execute()

main_out.py

@@ -1,18 +1,9 @@
 from domainlab.arg_parser import parse_cmd_args
+from domainlab.cli import domainlab_cli
 from domainlab.exp.exp_cuda_seed import set_seed  # reproducibility
 from domainlab.exp.exp_main import Exp
 from domainlab.exp_protocol import aggregate_results
 from domainlab.utils.generate_benchmark_plots import gen_benchmark_plots
 
 if __name__ == "__main__":
-    args = parse_cmd_args()
-    if args.bm_dir:
-        aggregate_results.agg_main(args.bm_dir)
-    elif args.plot_data is not None:
-        gen_benchmark_plots(
-            args.plot_data, args.outp_dir, use_param_index=args.param_idx
-        )
-    else:
-        set_seed(args.seed)
-        exp = Exp(args=args)
-        exp.execute()
+    domainlab_cli()

pyproject.toml

@@ -22,9 +22,13 @@ scikit-learn = "^1.2.1"
 pyyaml = "^6.0"
 gdown = "^4.7.1"
 
+[tool.poetry.scripts]
+domainlab = 'domainlab.cli:domainlab_cli'
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^6.2.5"
+pytest-cov = "^4.1.0"
+pytest-shell = "^0.3.2"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_cli.py

@@ -0,0 +1,52 @@
+"""
+test 'domainlab' entry point
+"""
+
+from importlib.metadata import entry_points
+
+from domainlab.cli import domainlab_cli
+
+
+def test_entry_point():
+    """
+    Test the entry point for the 'domainlab' console script.
+
+    This function retrieves all entry points and asserts that the 'domainlab'
+    entry point is correctly associated with the 'domainlab_cli' function.
+    """
+    eps = entry_points()
+    cli_entry = eps.select(group="console_scripts")["domainlab"]
+    assert cli_entry.load() is domainlab_cli
+
+
+def test_domainlab_cli(monkeypatch):
+    """
+    Test the 'domainlab_cli' function by simulating command-line arguments.
+
+    This function uses the 'monkeypatch' fixture to set the command-line
+    arguments for the 'domainlab_cli' function and then calls it to ensure
+    it processes the arguments correctly. The test arguments simulate a
+    representative command-line input for the 'domainlab' tool.
+    """
+    test_args = [
+        "--te_d",
+        "1",
+        "2",
+        "--tr_d",
+        "0",
+        "3",
+        "--task",
+        "mnistcolor10",
+        "--epos",
+        "500",
+        "--bs",
+        "16",
+        "--model",
+        "erm",
+        "--nname",
+        "conv_bn_pool_2",
+        "--lr",
+        "1e-3",
+    ]
+    monkeypatch.setattr("sys.argv", ["domainlab"] + test_args)
+    domainlab_cli()