Skip to content

Commit

Permalink
Deprecate git+git@ form of VCS url
Browse files Browse the repository at this point in the history
  • Loading branch information
sbidoul committed Jan 2, 2020
1 parent 68e49b9 commit cb4de30
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,6 @@ Here are the supported forms::
[-e] git+ssh://git.example.com/MyProject#egg=MyProject
[-e] git+git://git.example.com/MyProject#egg=MyProject
[-e] git+file:///home/user/projects/MyProject#egg=MyProject
-e [email protected]:MyProject#egg=MyProject

Passing a branch name, a commit hash, a tag name or a git ref is possible like so::

Expand Down
3 changes: 3 additions & 0 deletions news/7543.removal
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Support for the git+git@ form of VCS requirement is being deprecated and
will be removed in pip 21.0. Switch to the equivalent git+git:// or
git+ssh://.
13 changes: 13 additions & 0 deletions src/pip/_internal/req/req_install.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from pip._internal.operations.install.wheel import install_wheel
from pip._internal.pyproject import load_pyproject_toml, make_pyproject_path
from pip._internal.req.req_uninstall import UninstallPathSet
from pip._internal.utils.deprecation import deprecated
from pip._internal.utils.hashes import Hashes
from pip._internal.utils.logging import indent_log
from pip._internal.utils.marker_files import (
Expand Down Expand Up @@ -633,6 +634,18 @@ def update_editable(self, obtain=True):
vc_type, url = self.link.url.split('+', 1)
vcs_backend = vcs.get_backend(vc_type)
if vcs_backend:
if not self.link.is_vcs:
reason = (
"This form of VCS URL is being deprecated: {}."
).format(
self.link.url
)
replacement = None
if self.link.url.startswith("git+git@"):
replacement = (
"git+git:// or git+ssh://"
)
deprecated(reason, replacement, gone_in="21.0")
hidden_url = hide_url(self.link.url)
if obtain:
vcs_backend.obtain(self.source_dir, url=hidden_url)
Expand Down

0 comments on commit cb4de30

Please sign in to comment.