pypa/pipx

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

Open

#1.014 aberto em 3 de jul. de 2023

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)Python (363 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (7.844 stars)
Métricas de merge de PR
 (Mesclagem média 5d 2h) (16 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
A issue solicita a adição de uma flag dry run ao `pipx ensurepath` ou um novo comando `init` semelhante ao pyenv. Examine a implementação existente do `ensurepath` em `pipx/commands/ensure path.py` para entender como as modificações na configuração do shell são realizadas. Implemente uma opção dry run que imprime as alterações sem aplicá las, ou um comando `init` que emite linhas de configuração específicas do shell. Considere suportar vários shells (fish, bash, zsh, tcsh) como o pyenv faz. Esta é uma solicitação de recurso bem documentada, com exemplos claros e alternativas.
Pilha de tecnologia
python
Domain
clideveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic PythonFamiliarity with pipx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75