Add support for comments in netrc file

Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>

Author: TG1999

src/python_inspector/api.py

@@ -10,6 +10,7 @@
 #
 
 import os
+from netrc import netrc
 from typing import Dict
 from typing import List
 from typing import NamedTuple
@@ -19,7 +20,6 @@
 from packvers.requirements import Requirement
 from resolvelib import BaseReporter
 from resolvelib import Resolver
-from tinynetrc import Netrc
 
 from _packagedcode.models import DependentPackage
 from _packagedcode.models import PackageData
@@ -128,9 +128,9 @@ def resolve_dependencies(
     if netrc_file:
         if verbose:
             printer(f"Using netrc file {netrc_file}")
-        netrc = Netrc(file=netrc_file)
+        parsed_netrc = netrc(netrc_file)
     else:
-        netrc = None
+        parsed_netrc = None
 
     # TODO: deduplicate me
     direct_dependencies = []
@@ -233,8 +233,8 @@ def resolve_dependencies(
                 repos.append(existing)
             else:
                 credentials = None
-                if netrc:
-                    login, password = utils.get_netrc_auth(index_url, netrc)
+                if parsed_netrc:
+                    login, password = utils.get_netrc_auth(index_url, parsed_netrc)
                     credentials = (
                         dict(login=login, password=password) if login and password else None
                     )

src/python_inspector/utils.py

@@ -11,6 +11,7 @@
 
 import json
 import os
+import tempfile
 from typing import Dict
 from typing import List
 from typing import NamedTuple
@@ -23,8 +24,11 @@ def get_netrc_auth(url, netrc):
     Return login and password if url is in netrc
     else return login and password as None
     """
-    if netrc.get(url):
-        return (netrc[url].get("login"), netrc[url].get("password"))
+    hosts = netrc.hosts
+    if url in hosts:
+        url_auth = hosts.get(url)
+        # netrc returns a tuple of (login, account, password)
+        return (url_auth[0], url_auth[2])
     return (None, None)
 
 

tests/data/test-commented.netrc

@@ -0,0 +1,2 @@
+machine https://pyp2.org/simple login test password test123
+# machine https://pyp1.org/simple login test password test123

tests/test_cli.py

@@ -219,7 +219,7 @@ def test_cli_with_multiple_index_url_and_tilde_req_with_max_rounds():
 @pytest.mark.online
 def test_cli_with_multiple_index_url_and_tilde_req_and_netrc_file_without_matching_url():
     expected_file = test_env.get_test_loc("tilde_req-expected.json", must_exist=False)
-    netrc_file = test_env.get_test_loc("test.netrc", must_exist=False)
+    netrc_file = test_env.get_test_loc("test-commented.netrc", must_exist=False)
     specifier = "zipp~=3.8.0"
     extra_options = [
         "--index-url",

tests/test_utils.py

@@ -11,11 +11,11 @@
 import collections
 import json
 import os
+from netrc import netrc
 from unittest import mock
 
 from commoncode.testcase import FileDrivenTesting
 from test_cli import check_json_results
-from tinynetrc import Netrc
 
 from _packagedcode.pypi import SetupCfgHandler
 from python_inspector.resolution import fetch_and_extract_sdist
@@ -31,14 +31,20 @@
 
 def test_get_netrc_auth():
     netrc_file = test_env.get_test_loc("test.netrc")
-    netrc = Netrc(netrc_file)
-    assert get_netrc_auth(url="https://pyp1.org/simple", netrc=netrc) == ("test", "test123")
+    parsed_netrc = netrc(netrc_file)
+    assert get_netrc_auth(url="https://pyp1.org/simple", netrc=parsed_netrc) == ("test", "test123")
+
+
+def test_get_commented_netrc_auth():
+    netrc_file = test_env.get_test_loc("test-commented.netrc")
+    parsed_netrc = netrc(netrc_file)
+    assert get_netrc_auth(url="https://pyp2.org/simple", netrc=parsed_netrc) == ("test", "test123")
 
 
 def test_get_netrc_auth_with_no_matching_url():
     netrc_file = test_env.get_test_loc("test.netrc")
-    netrc = Netrc(netrc_file)
-    assert get_netrc_auth(url="https://pypi2.org/simple", netrc=netrc) == (None, None)
+    parsed_netrc = netrc(netrc_file)
+    assert get_netrc_auth(url="https://pypi2.org/simple", netrc=parsed_netrc) == (None, None)
 
 
 @mock.patch("python_inspector.utils_pypi.CACHE.get")