Filter unnecessary deps from User-Agent string (#871)

* Canonicalize dependencies

Closes: #870

* Explicitly select packages for User-Agent inclusion

Revert back to a manual list of packages reported in the User-Agent
string and --version. Reverting the part of #858 that switched to
parsing twine's requires.

See: #870

* Update package list

* Remove dependencies from User-Agent

* Add changelog entry

Co-authored-by: Brian Rutledge <[email protected]>

Author: stefanor

changelog/871.bugfix.rst

@@ -0,0 +1 @@
+Remove Twine's dependencies from the ``User-Agent`` header when uploading.

setup.cfg

@@ -37,12 +37,12 @@ packages =
 python_requires = >=3.6
 install_requires=
     pkginfo >= 1.8.1
-    readme_renderer >= 21.0
+    readme-renderer >= 21.0
     requests >= 2.20
     requests-toolbelt >= 0.8.0, != 0.9.0
     urllib3 >= 1.26.0
     tqdm >= 4.14
-    importlib_metadata >= 3.6
+    importlib-metadata >= 3.6
     keyring >= 15.1
     rfc3986 >= 1.4.0
     colorama >= 0.4.3

tests/test_repository.py

@@ -85,18 +85,8 @@ def test_set_certificate_authority(default_repo):
 
 
 def test_make_user_agent_string(default_repo):
-    """Add twine and its dependencies to User-Agent session header."""
-    assert "User-Agent" in default_repo.session.headers
-
-    user_agent = default_repo.session.headers["User-Agent"]
-    packages = (
-        "twine/",
-        "requests/",
-        "requests-toolbelt/",
-        "pkginfo/",
-        "importlib_metadata/",
-    )
-    assert all(p in user_agent for p in packages)
+    """Add twine to User-Agent session header."""
+    assert "twine/" in default_repo.session.headers["User-Agent"]
 
 
 def response_with(**kwattrs):

twine/cli.py

@@ -15,16 +15,21 @@
 from typing import Any, List, Tuple
 
 import importlib_metadata
-from packaging import requirements
 
 import twine
 
 args = argparse.Namespace()
 
 
 def list_dependencies_and_versions() -> List[Tuple[str, str]]:
-    requires = importlib_metadata.requires("twine")  # type: ignore[no-untyped-call] # python/importlib_metadata#288  # noqa: E501
-    deps = [requirements.Requirement(r).name for r in requires]
+    deps = (
+        "importlib-metadata",
+        "keyring",
+        "pkginfo",
+        "requests",
+        "requests-toolbelt",
+        "urllib3",
+    )
     return [(dep, importlib_metadata.version(dep)) for dep in deps]  # type: ignore[no-untyped-call] # python/importlib_metadata#288  # noqa: E501
 
 

twine/repository.py

@@ -88,12 +88,8 @@ def _make_adapter_with_retries() -> adapters.HTTPAdapter:
 
     @staticmethod
     def _make_user_agent_string() -> str:
-        from twine import cli
-
-        dependencies = cli.list_dependencies_and_versions()
         user_agent_string = (
             user_agent.UserAgentBuilder("twine", twine.__version__)
-            .include_extras(dependencies)
             .include_implementation()
             .build()
         )