Move --global option into shared parser (pypa#1397)

* Move `--global` option into shared parser

* Add changelog

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update tests

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

changelog.d/1397.bugfix.md

@@ -0,0 +1 @@
+Move `--global` option into shared parser, such that it can be passed after the subcommand, for example `pipx ensurepath --global`.

pyproject.toml

@@ -66,6 +66,7 @@ lint.extend-select = [
   "PLE",
   "PLW",
   "RSE",
+  "RUF100",
   "W",
 ]
 lint.isort = {known-first-party = ["helpers", "package_info", "pipx"]}

src/pipx/main.py

@@ -877,6 +877,14 @@ def get_command_parser() -> Tuple[argparse.ArgumentParser, Dict[str, argparse.Ar
         ),
     )
 
+    if not constants.WINDOWS:
+        shared_parser.add_argument(
+            "--global",
+            action="store_true",
+            dest="is_global",
+            help="Perform action globally for all users.",
+        )
+
     parser = argparse.ArgumentParser(
         prog=prog_name(),
         formatter_class=LineWrapRawTextHelpFormatter,
@@ -906,13 +914,6 @@ def get_command_parser() -> Tuple[argparse.ArgumentParser, Dict[str, argparse.Ar
     _add_ensurepath(subparsers, shared_parser)
     _add_environment(subparsers, shared_parser)
 
-    if not constants.WINDOWS:
-        parser.add_argument(
-            "--global",
-            action="store_true",
-            dest="is_global",
-            help="Perform action globally for all users.",
-        )
     parser.add_argument("--version", action="store_true", help="Print version and exit")
     subparsers.add_parser(
         "completions",

tests/test_environment.py

@@ -51,7 +51,7 @@ def test_resolve_user_dir_in_env_paths(monkeypatch):
 
 @skip_if_windows
 def test_cli_global(pipx_temp_env, monkeypatch, capsys):
-    assert not run_pipx_cli(["--global", "environment"])
+    assert not run_pipx_cli(["environment", "--global"])
     captured = capsys.readouterr()
     assert fnmatch.fnmatch(captured.out, "*PIPX_HOME=*global/pipxhome*")
     assert fnmatch.fnmatch(captured.out, "*PIPX_BIN_DIR=*global_otherdir/pipxbindir*")

tests/test_inject.py

@@ -11,8 +11,8 @@ def test_inject_simple(pipx_temp_env, capsys):
 
 @skip_if_windows
 def test_inject_simple_global(pipx_temp_env, capsys):
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
-    assert not run_pipx_cli(["--global", "inject", "pycowsay", PKG["black"]["spec"]])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
+    assert not run_pipx_cli(["inject", "--global", "pycowsay", PKG["black"]["spec"]])
 
 
 @pytest.mark.parametrize("metadata_version", PIPX_METADATA_LEGACY_VERSIONS)

tests/test_list.py

@@ -34,7 +34,7 @@ def test_cli_global(pipx_temp_env, monkeypatch, capsys):
     captured = capsys.readouterr()
     assert "installed package" in captured.out
 
-    assert not run_pipx_cli(["--global", "list"])
+    assert not run_pipx_cli(["list", "--global"])
     captured = capsys.readouterr()
     assert "nothing has been installed with pipx" in captured.err
 

tests/test_reinstall.py

@@ -12,8 +12,8 @@ def test_reinstall(pipx_temp_env, capsys):
 
 @skip_if_windows
 def test_reinstall_global(pipx_temp_env, capsys):
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
-    assert not run_pipx_cli(["--global", "reinstall", "--python", sys.executable, "pycowsay"])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
+    assert not run_pipx_cli(["reinstall", "--global", "--python", sys.executable, "pycowsay"])
 
 
 def test_reinstall_nonexistent(pipx_temp_env, capsys):

tests/test_runpip.py

@@ -8,5 +8,5 @@ def test_runpip(pipx_temp_env, monkeypatch, capsys):
 
 @skip_if_windows
 def test_runpip_global(pipx_temp_env, monkeypatch, capsys):
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
-    assert not run_pipx_cli(["--global", "runpip", "pycowsay", "list"])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
+    assert not run_pipx_cli(["runpip", "--global", "pycowsay", "list"])

tests/test_uninject.py

@@ -15,12 +15,12 @@ def test_uninject_simple(pipx_temp_env, capsys):
 
 @skip_if_windows
 def test_uninject_simple_global(pipx_temp_env, capsys):
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
-    assert not run_pipx_cli(["--global", "inject", "pycowsay", PKG["black"]["spec"]])
-    assert not run_pipx_cli(["--global", "uninject", "pycowsay", "black"])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
+    assert not run_pipx_cli(["inject", "--global", "pycowsay", PKG["black"]["spec"]])
+    assert not run_pipx_cli(["uninject", "--global", "pycowsay", "black"])
     captured = capsys.readouterr()
     assert "Uninjected package black" in captured.out
-    assert not run_pipx_cli(["--global", "list", "--include-injected"])
+    assert not run_pipx_cli(["list", "--global", "--include-injected"])
     captured = capsys.readouterr()
     assert "black" not in captured.out
 

tests/test_uninstall.py

@@ -31,8 +31,8 @@ def test_uninstall(pipx_temp_env):
 
 @skip_if_windows
 def test_uninstall_global(pipx_temp_env):
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
-    assert not run_pipx_cli(["--global", "uninstall", "pycowsay"])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
+    assert not run_pipx_cli(["uninstall", "--global", "pycowsay"])
 
 
 def test_uninstall_circular_deps(pipx_temp_env):

tests/test_upgrade.py

@@ -20,15 +20,15 @@ def test_upgrade(pipx_temp_env, capsys):
 
 @skip_if_windows
 def test_upgrade_global(pipx_temp_env, capsys):
-    assert run_pipx_cli(["--global", "upgrade", "pycowsay"])
+    assert run_pipx_cli(["upgrade", "--global", "pycowsay"])
     captured = capsys.readouterr()
     assert "Package is not installed" in captured.err
 
-    assert not run_pipx_cli(["--global", "install", "pycowsay"])
+    assert not run_pipx_cli(["install", "--global", "pycowsay"])
     captured = capsys.readouterr()
     assert "installed package pycowsay" in captured.out
 
-    assert not run_pipx_cli(["--global", "upgrade", "pycowsay"])
+    assert not run_pipx_cli(["upgrade", "--global", "pycowsay"])
     captured = capsys.readouterr()
     assert "pycowsay is already at latest version" in captured.out