Convert scripts to the format used by console_scripts

Split from #474

argcomplete/scripts/activate_global_python_argcomplete.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # PYTHON_ARGCOMPLETE_OK
 
 # Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
@@ -17,6 +17,8 @@
 
 import argcomplete
 
+__package__ = "argcomplete"
+
 zsh_shellcode = """
 # Begin added by argcomplete
 fpath=( {zsh_fpath} "${{fpath[@]}}" )
@@ -29,6 +31,13 @@
 # End added by argcomplete
 """
 
+parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
+parser.add_argument("-y", "--yes", help="automatically answer yes for all questions", action="store_true")
+parser.add_argument("--dest", help='Specify the shell completion modules directory to install into, or "-" for stdout')
+parser.add_argument("--user", help="Install into user directory", action="store_true")
+argcomplete.autocomplete(parser)
+args = None
+
 
 def get_local_dir():
     try:
@@ -120,35 +129,37 @@ def link_user_rcfiles():
     append_to_config_file(bash_completion_user_file, bash_shellcode.format(activator=get_activator_path()))
 
 
-parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
-parser.add_argument("-y", "--yes", help="automatically answer yes for all questions", action="store_true")
-parser.add_argument("--dest", help='Specify the shell completion modules directory to install into, or "-" for stdout')
-parser.add_argument("--user", help="Install into user directory", action="store_true")
-argcomplete.autocomplete(parser)
-args = parser.parse_args()
-destinations = []
-
-if args.dest:
-    if args.dest != "-" and not os.path.exists(args.dest):
-        parser.error(f"directory {args.dest} was specified via --dest, but it does not exist")
-    destinations.append(args.dest)
-elif site.ENABLE_USER_SITE and site.USER_SITE in argcomplete.__file__:
-    print(
-        "Argcomplete was installed in the user site local directory. Defaulting to user installation.", file=sys.stderr
-    )
-    link_user_rcfiles()
-elif sys.prefix != sys.base_prefix:
-    print("Argcomplete was installed in a virtual environment. Defaulting to user installation.", file=sys.stderr)
-    link_user_rcfiles()
-elif args.user:
-    link_user_rcfiles()
-else:
-    print("Defaulting to system-wide installation.", file=sys.stderr)
-    destinations.append(f"{get_zsh_system_dir()}/_python-argcomplete")
-    destinations.append(f"{get_bash_system_dir()}/python-argcomplete")
-
-for destination in destinations:
-    install_to_destination(destination)
-
-if args.dest is None:
-    print("Please restart your shell or source the installed file to activate it.", file=sys.stderr)
+def main():
+    global args
+    args = parser.parse_args()
+
+    destinations = []
+
+    if args.dest:
+        if args.dest != "-" and not os.path.exists(args.dest):
+            parser.error(f"directory {args.dest} was specified via --dest, but it does not exist")
+        destinations.append(args.dest)
+    elif site.ENABLE_USER_SITE and site.USER_SITE in argcomplete.__file__:
+        print(
+            "Argcomplete was installed in the user site local directory. Defaulting to user installation.", file=sys.stderr
+        )
+        link_user_rcfiles()
+    elif sys.prefix != sys.base_prefix:
+        print("Argcomplete was installed in a virtual environment. Defaulting to user installation.", file=sys.stderr)
+        link_user_rcfiles()
+    elif args.user:
+        link_user_rcfiles()
+    else:
+        print("Defaulting to system-wide installation.", file=sys.stderr)
+        destinations.append(f"{get_zsh_system_dir()}/_python-argcomplete")
+        destinations.append(f"{get_bash_system_dir()}/python-argcomplete")
+
+    for destination in destinations:
+        install_to_destination(destination)
+
+    if args.dest is None:
+        print("Please restart your shell or source the installed file to activate it.", file=sys.stderr)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

argcomplete/scripts/python_argcomplete_check_easy_install_script.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 # Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
 # Licensed under the Apache License. See https://github.com/kislyuk/argcomplete for more info.
@@ -15,49 +15,56 @@
 
 import sys
 
-if len(sys.argv) != 2:
-    sys.exit(__doc__)
-
-sys.tracebacklimit = 0
-
-with open(sys.argv[1]) as fh:
-    line1, head = fh.read(1024).split("\n", 1)[:2]
-    if line1.startswith("#") and ("py" in line1 or "Py" in line1):
-        import re
-
-        lines = head.split("\n", 12)
-        for line in lines:
-            if line.startswith("# EASY-INSTALL-SCRIPT"):
-                import pkg_resources
-
-                dist, script = re.match("# EASY-INSTALL-SCRIPT: '(.+)','(.+)'", line).groups()
-                if "PYTHON_ARGCOMPLETE_OK" in pkg_resources.get_distribution(dist).get_metadata("scripts/" + script):
-                    exit(0)
-            elif line.startswith("# EASY-INSTALL-ENTRY-SCRIPT"):
-                dist, group, name = re.match("# EASY-INSTALL-ENTRY-SCRIPT: '(.+)','(.+)','(.+)'", line).groups()
-                import pkgutil
-
-                import pkg_resources
-
-                module_name = pkg_resources.get_distribution(dist).get_entry_info(group, name).module_name
-                with open(pkgutil.get_loader(module_name).get_filename()) as mod_fh:
-                    if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
-                        exit(0)
-            elif line.startswith("# EASY-INSTALL-DEV-SCRIPT"):
-                for line2 in lines:
-                    if line2.startswith("__file__"):
-                        filename = re.match("__file__ = '(.+)'", line2).group(1)
-                        with open(filename) as mod_fh:
-                            if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
-                                exit(0)
-            elif line.startswith("# PBR Generated"):
-                module = re.search("from (.*) import", head).groups()[0]
-                import pkgutil
-
-                import pkg_resources
-
-                with open(pkgutil.get_loader(module).get_filename()) as mod_fh:
-                    if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
-                        exit(0)
-
-exit(1)
+__package__ = "argcomplete"
+
+def main():
+    if len(sys.argv) != 2:
+        sys.exit(__doc__)
+
+    sys.tracebacklimit = 0
+
+    with open(sys.argv[1]) as fh:
+        line1, head = fh.read(1024).split("\n", 1)[:2]
+        if line1.startswith("#") and ("py" in line1 or "Py" in line1):
+            import re
+
+            lines = head.split("\n", 12)
+            for line in lines:
+                if line.startswith("# EASY-INSTALL-SCRIPT"):
+                    import pkg_resources
+
+                    dist, script = re.match("# EASY-INSTALL-SCRIPT: '(.+)','(.+)'", line).groups()
+                    if "PYTHON_ARGCOMPLETE_OK" in pkg_resources.get_distribution(dist).get_metadata("scripts/" + script):
+                        return 0
+                elif line.startswith("# EASY-INSTALL-ENTRY-SCRIPT"):
+                    dist, group, name = re.match("# EASY-INSTALL-ENTRY-SCRIPT: '(.+)','(.+)','(.+)'", line).groups()
+                    import pkgutil
+
+                    import pkg_resources
+
+                    module_name = pkg_resources.get_distribution(dist).get_entry_info(group, name).module_name
+                    with open(pkgutil.get_loader(module_name).get_filename()) as mod_fh:
+                        if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
+                            return 0
+                elif line.startswith("# EASY-INSTALL-DEV-SCRIPT"):
+                    for line2 in lines:
+                        if line2.startswith("__file__"):
+                            filename = re.match("__file__ = '(.+)'", line2).group(1)
+                            with open(filename) as mod_fh:
+                                if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
+                                    return 0
+                elif line.startswith("# PBR Generated"):
+                    module = re.search("from (.*) import", head).groups()[0]
+                    import pkgutil
+
+                    import pkg_resources
+
+                    with open(pkgutil.get_loader(module).get_filename()) as mod_fh:
+                        if "PYTHON_ARGCOMPLETE_OK" in mod_fh.read(1024):
+                            return 0
+
+    return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

argcomplete/scripts/register_python_argcomplete.py

@@ -28,44 +28,51 @@
 
 import argcomplete
 
-parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
-
-parser.add_argument(
-    "--no-defaults",
-    dest="use_defaults",
-    action="store_false",
-    default=True,
-    help="when no matches are generated, do not fallback to readline's default completion (affects bash only)",
-)
-parser.add_argument(
-    "--complete-arguments",
-    nargs=argparse.REMAINDER,
-    help="arguments to call complete with; use of this option discards default options (affects bash only)",
-)
-parser.add_argument(
-    "-s",
-    "--shell",
-    choices=("bash", "zsh", "tcsh", "fish", "powershell"),
-    default="bash",
-    help="output code for the specified shell",
-)
-parser.add_argument(
-    "-e", "--external-argcomplete-script", help="external argcomplete script for auto completion of the executable"
-)
-
-parser.add_argument("executable", nargs="+", help="executable to completed (when invoked by exactly this name)")
-
-argcomplete.autocomplete(parser)
-
-if len(sys.argv) == 1:
-    parser.print_help()
-    sys.exit(1)
-
-args = parser.parse_args()
-
-
-sys.stdout.write(
-    argcomplete.shellcode(
-        args.executable, args.use_defaults, args.shell, args.complete_arguments, args.external_argcomplete_script
+__package__ = "argcomplete"
+
+def main():
+    parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    parser.add_argument(
+        "--no-defaults",
+        dest="use_defaults",
+        action="store_false",
+        default=True,
+        help="when no matches are generated, do not fallback to readline's default completion (affects bash only)",
+    )
+    parser.add_argument(
+        "--complete-arguments",
+        nargs=argparse.REMAINDER,
+        help="arguments to call complete with; use of this option discards default options (affects bash only)",
+    )
+    parser.add_argument(
+        "-s",
+        "--shell",
+        choices=("bash", "zsh", "tcsh", "fish", "powershell"),
+        default="bash",
+        help="output code for the specified shell",
+    )
+    parser.add_argument(
+        "-e", "--external-argcomplete-script", help="external argcomplete script for auto completion of the executable"
+    )
+
+    parser.add_argument("executable", nargs="+", help="executable to completed (when invoked by exactly this name)")
+
+    argcomplete.autocomplete(parser)
+
+    if len(sys.argv) == 1:
+        parser.print_help()
+        sys.exit(1)
+
+    args = parser.parse_args()
+
+
+    sys.stdout.write(
+        argcomplete.shellcode(
+            args.executable, args.use_defaults, args.shell, args.complete_arguments, args.external_argcomplete_script
+        )
     )
-)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

scripts/activate-global-python-argcomplete

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+# PYTHON_ARGCOMPLETE_OK
+
+# Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
+# Licensed under the Apache License. See https://github.com/kislyuk/argcomplete for more info.
+
+import sys
+from argcomplete.scripts import activate_global_python_argcomplete
+sys.exit(activate_global_python_argcomplete())

scripts/python-argcomplete-check-easy-install-script

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+
+# Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
+# Licensed under the Apache License. See https://github.com/kislyuk/argcomplete for more info.
+
+import sys
+from argcomplete.scripts import python_argcomplete_check_easy_install_script
+sys.exit(python_argcomplete_check_easy_install_script())

scripts/register-python-argcomplete

@@ -0,0 +1,6 @@
+# Copyright 2012-2023, Andrey Kislyuk and argcomplete contributors.
+# Licensed under the Apache License. See https://github.com/kislyuk/argcomplete for more info.
+
+import sys
+from argcomplete.scripts import register_python_argcomplete
+sys.exit(register_python_argcomplete())