pypa/pip

`pip install git+...` from a branch/tag could be faster

Open

#13,060 opened on Oct 30, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (8,952 stars) (3,032 forks)batch import
C: vcshelp wantedtype: enhancementtype: performance

Description

What's the problem this feature will solve?

pip install git+...@foo-branch clones the whole repository and then checks out foo-branch. This process takes some time if the repository has a long history or many branches.

Describe the solution you'd like

I'd like to leverage git clone parameters to make the whole thing faster when a specific branch is requested. In particular, I'd use `the following:

  • --branch foo-branch
  • --depth 1

Alternative Solutions

The current solution works fine, but is slow in some specific situations.

Additional context

https://git-scm.com/docs/git-clone

Code of Conduct

Contributor guide

Tech stack
python
Domain
clibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of pip's VCS supportFamiliarity with Git operationsPython programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate pip's source code for VCS clone operations, likely in src/pip/ internal/vcs/git.py. Look at how the clone command is constructed and where branch and depth options can be added. Review any previous discussions in the comments of this issue for potential pitfalls.