Support comments in netrc file #107

Reference: #107
Signed-off-by: Tushar Goel <[email protected]>

Author: TG1999

src/python_inspector/api.py

@@ -128,6 +128,7 @@ def resolve_dependencies(
     if netrc_file:
         if verbose:
             printer(f"Using netrc file {netrc_file}")
+        netrc_file = utils.ignore_comments_from_netrc(netrc_file)
         netrc = Netrc(file=netrc_file)
     else:
         netrc = 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
@@ -69,3 +70,40 @@ def get_response(url: str) -> Dict:
     resp = requests.get(url)
     if resp.status_code == 200:
         return resp.json()
+
+
+def ignore_comments_from_netrc(netrc_location):
+    """
+    Read the netrc file and if any line starts with ``#`` then return a new temp file
+    with the lines that are not commented out.
+    """
+    if not check_if_file_has_comments(netrc_location):
+        return netrc_location
+    return create_temp_file_without_comments(netrc_location)
+
+
+def create_temp_file_without_comments(netrc_location):
+    """
+    Return a temp file location with the lines that are not commented out.
+    """
+    temp = tempfile.NamedTemporaryFile(delete=False)
+    location = temp.name
+    with open(netrc_location) as f:
+        lines = f.readlines()
+        for line in lines:
+            if not line.startswith("#"):
+                temp.write(line.encode())
+        temp.close()
+    return location
+
+
+def check_if_file_has_comments(file_location):
+    """
+    Return True if the ``file_location`` has commented lines.
+    """
+    with open(file_location) as f:
+        lines = f.readlines()
+        for line in lines:
+            if line.startswith("#"):
+                return True
+    return False

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_utils.py

@@ -20,6 +20,7 @@
 from _packagedcode.pypi import SetupCfgHandler
 from python_inspector.resolution import fetch_and_extract_sdist
 from python_inspector.utils import get_netrc_auth
+from python_inspector.utils import ignore_comments_from_netrc
 from python_inspector.utils_pypi import PypiSimpleRepository
 from python_inspector.utils_pypi import valid_python_version
 
@@ -35,6 +36,13 @@ def test_get_netrc_auth():
     assert get_netrc_auth(url="https://pyp1.org/simple", netrc=netrc) == ("test", "test123")
 
 
+def test_get_commented_netrc_auth():
+    netrc_file = test_env.get_test_loc("test-commented.netrc")
+    netrc_file = ignore_comments_from_netrc(netrc_file)
+    netrc = Netrc(netrc_file)
+    assert get_netrc_auth(url="https://pyp2.org/simple", netrc=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)