REGISTER-PYTHON-ARGCOMPLETE(1)

🎀 REGISTER-PYTHON-ARGCOMPLETE(1) 🎀 User Commands

✨ NAME ✨

okay so register-python-argcomplete is the argcomplete module's utility script 💖 it's literally the thing that makes tab completion work for your Python scripts 🫶

💅 DESCRIPTION 💅

Here's the vibe. The usage line looks like this:

usage: register-python-argcomplete [-h] [--no-defaults]
       [--complete-arguments ...]
       [-s {bash,zsh,tcsh,fish,powershell}] [-e
       EXTERNAL_ARGCOMPLETE_SCRIPT] executable [executable ...]

Its whole job is to register a Python executable so the argcomplete module can handle its completions 🔥

To actually register it, you source the output of this script in your bash shell 🐚 and make sure you quote the output so nothing gets interpolated weirdly 🙈

Example:

$ eval "$(register-python-argcomplete my-favorite-script.py)"

For Tcsh 🌸

$ eval `register-python-argcomplete --shell tcsh my-favorite-
script.py`

For Fish 🐟

$ register-python-argcomplete --shell fish my-favourite-script.py
> ~/.config/fish/my-favourite-script.py.fish

🧚 positional arguments 🧚

executable

the executable you want to complete, but only when it gets invoked by exactly this name ✨

👑 options 👑

• -h, --help — shows the help message and exits 💜
• --no-defaults — if no matches get generated, this stops it from falling back to readline's default completion 🙅‍♀️ (bash only!)
• --complete-arguments ... — the arguments you want to pass to complete. heads up: using this option throws out the default options 🗑️ (bash only!)
• -s {bash,zsh,tcsh,fish,powershell}, --shell {bash,zsh,tcsh,fish,powershell} — outputs the code for whichever shell you pick 🐚
• -e EXTERNAL_ARGCOMPLETE_SCRIPT, --external-argcomplete-script EXTERNAL_ARGCOMPLETE_SCRIPT — points to an external argcomplete script that handles auto completion for the executable 🦋

🌈 AUTHORS 🌈

the argcomplete module was written by Andrey Kislyuk 👩‍💻✨

🔗 SEE ALSO 🔗

the full documentation for the argccomplete module lives at https://argcomplete.readthedocs.org/en/latest/ 📚

---

bestie, that's the whole thing 🥹💖 you're officially a register-python-argcomplete girlie now. this has been register-python-argcomplete 3... from November 2023, slay forever 💅🎀