pypa/pipx

Provide `ensurepath` with a check option or create an `init` command

Open

#1014 aperta il 3 lug 2023

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Python (363 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (7844 star)
Metriche merge PR
 (Merge medio 5g 2h) (16 PR mergiate in 30 g)

Descrizione

How would this feature be useful?

Currently, pipx ensurepath does not tell me what changes will it make. I would like to stay in control: see what changes it would make, and then decide if it's okay with me.

Describe the solution you'd like

  • Add a --check or --dry-run option that checks for necessary changes and outputs them. 
    > pipx ensurepath --dry-run
# append lines to ~/.config/fish/config.fish
fish_add_path ~/.local/bin
# ... and other configs

Describe alternatives you've considered

  • Add an init command that outputs the shell config changes - similarly to how pyenv does it: 
    > pipx init --fish
# Add this to your config.fish file if You haven't yet
fish_add_path ~/.local/bin
# ... other configs - similarly --zsh or --bash or --tcsh

Here is how pyenv does it:

> pyenv init
# Add pyenv executable to PATH by running
# the following interactively:

set -Ux PYENV_ROOT $HOME/.pyenv
set -U fish_user_paths $PYENV_ROOT/bin $fish_user_paths

# Load pyenv automatically by appending
# the following to ~/.config/fish/config.fish:

pyenv init - | source


# Restart your shell for the changes to take effect.

Guida contributor

Direzione di ricerca
La richiesta propone di aggiungere un flag dry run a `pipx ensurepath` o un nuovo comando `init` simile a pyenv. Esamina l'implementazione esistente di `ensurepath` in `pipx/commands/ensure path.py` per capire come vengono effettuate le modifiche alla configurazione della shell. Implementa un'opzione dry run che stampa le modifiche senza applicarle, o un comando `init` che emetta righe di configurazione specifiche per la shell. Considera il supporto per più shell (fish, bash, zsh, tcsh) come fa pyenv. Si tratta di una richiesta di funzionalità ben documentata, con esempi chiari e alternative.
Tech stack
python
Dominio
clideveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Basic PythonFamiliarity with pipx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75