Add ability to override pip's user agent with PIP_USER_AGENT_INSTALLE…

…R_OVERRIDE
pypa · Feb 26, 2019 · 8e81664 · 8e81664
1 parent c2661ef
commit 8e81664
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/news/66F69322-5F5D-442A-B2FE-6ABD8D3B8A1F.trivial b/news/66F69322-5F5D-442A-B2FE-6ABD8D3B8A1F.trivial
diff --git a/src/pip/_internal/download.py b/src/pip/_internal/download.py
@@ -167,8 +167,14 @@ def user_agent():
     # value to make it easier to know that the check has been run.
     data["ci"] = True if looks_like_ci() else None
 
-    return "{data[installer][name]}/{data[installer][version]} {json}".format(
-        data=data,
+    installer = os.environ.get("PIP_USER_AGENT_INSTALLER_OVERRIDE")
+    if not installer:
+        installer = (
+            "{data[installer][name]}/{data[installer][version]}".format(
+                data=data))
+
+    return "{installer} {json}".format(
+        installer=installer,
         json=json.dumps(data, separators=(",", ":"), sort_keys=True),
     )
 

diff --git a/tests/unit/test_download.py b/tests/unit/test_download.py
@@ -88,6 +88,11 @@ def test_user_agent__ci(monkeypatch, name, expected_like_ci):
     assert ('"ci":null' in user_agent) == (not expected_like_ci)
 
 
+def test_user_agent_override(monkeypatch):
+    monkeypatch.setenv("PIP_USER_AGENT_INSTALLER_OVERRIDE", "pipenv/1.0.0")
+    PipSession().headers["User-Agent"].startswith("pipenv/1.0.0")
+
+
 class FakeStream(object):
 
     def __init__(self, contents):