8000 gh-135788: Support NETRC environment variable in `netrc` by berthin · Pull Request #135802 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-135788: Support NETRC environment variable in netrc #135802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

gh-135788: Support NETRC environment variable in netrc #135802

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4c3c39a
iadd 8000 support for the envvar and implement tests
Jun 21, 2025
50ca1d0
refactor tests and double check logic for security
Jun 21, 2025
f17476b
add documentation
Jun 21, 2025
c1e3abf
fix linting issues
Jun 21, 2025
d877728
fix doc linting
Jun 21, 2025
b46c00a
Add docstrings and fix documentation
Jun 22, 2025
45d4f4c
Wrap lines to 80 chars
Jun 22, 2025
33ac518
Fix comments
Jun 22, 2025
5b9fcfc
Undo security test
Jun 22, 2025
21ab173
add versionadded
Jun 22, 2025
67a4645
doc change in whatsnew
Jun 22, 2025
2715bda
add news.d entry
Jun 22, 2025
1ae9bbf
Apply suggestions from code review
berthin Jun 22, 2025
2d60212
clean up
Jun 22, 2025
c156440
fix tests
Jun 22, 2025
ca3155c
try mocking expanduser to fix windows issues
Jun 22, 2025
b4c22e9
undo 80 chars, try again with os_helper.temp_dir
Jun 22, 2025
cddf942
catch up with main
Jun 22, 2025
895d707
Address review comments
Jun 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
iadd support for the envvar and implement tests
  • Loading branch information
Berthin Torres authored and Berthin Torres committed Jun 21, 2025
commit 4c3c39a1ea9a3bfe017e49fce8d94727a96e6932
2 changes: 1 addition & 1 deletion Lib/netrc.py
8000
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class netrc:
def __init__(self, file=None):
default_netrc = file is None
if file is None:
file = os.path.join(os.path.expanduser("~"), ".netrc")
file = os.environ.get("NETRC", "") or os.path.join(os.path.expanduser("~"), ".netrc")
self.hosts = {}
self.macros = {}
try:
Expand Down
109 changes: 79 additions & 30 deletions Lib/test/test_netrc.py
View file
Open in desktop
10000
Original file line numberDiff line number Diff line change
@@ -1,45 +1,92 @@
import netrc, os, unittest, sys, textwrap
from test.support import os_helper
import netrc, os, unittest, sys, textwrap, tempfile

from test import support
from unittest import mock

try:
import pwd
except ImportError:
pwd = None

temp_filename = os_helper.TESTFN

def generate_netrc(directory, filename, data):
data = textwrap.dedent(data)
mode = 'w'
mode = 'w'
if sys.platform != 'cygwin':
mode += 't'
with open(os.path.join(directory, filename), mode, encoding="utf-8") as fp:
fp.write(data)


class NetrcTestCase(unittest.TestCase):

def make_nrc(self, test_data):
test_data = textwrap.dedent(test_data)
mode = 'w'
if sys.platform != 'cygwin':
mode += 't'
with open(temp_filename, mode, encoding="utf-8") as fp:
fp.write(test_data)
try:
nrc = netrc.netrc(temp_filename)
finally:
os.unlink(temp_filename)
@staticmethod
def home_netrc(data):
with support.os_helper.EnvironmentVarGuard() as environ, \
tempfile.TemporaryDirectory() as tmpdir:
environ.unset('NETRC')
environ.unset('HOME')

generate_netrc(tmpdir, ".netrc", data)
os.chmod(os.path.join(tmpdir, ".netrc"), 0o600)

with mock.patch("os.path.expanduser"):
os.path.expanduser.return_value = tmpdir
nrc = netrc.netrc()

return nrc

def test_toplevel_non_ordered_tokens(self):
nrc = self.make_nrc("""\
@staticmethod
def envvar_netrc(data):
with support.os_helper.EnvironmentVarGuard() as environ:
with tempfile.TemporaryDirectory() as tmpdir:
environ.set('NETRC', os.path.join(tmpdir, ".netrc"))
environ.unset('HOME')

generate_netrc(tmpdir, ".netrc", data)
os.chmod(os.path.join(tmpdir, ".netrc"), 0o600)

nrc = netrc.netrc()

return nrc

@staticmethod
def file_argument(data):
with support.os_helper.EnvironmentVarGuard() as environ:
with tempfile.TemporaryDirectory() as tmpdir:
environ.set('NETRC', 'not-a-file.random')

generate_netrc(tmpdir, ".netrc", data)
os.chmod(os.path.join(tmpdir, ".netrc"), 0o600)

nrc = netrc.netrc(os.path.join(tmpdir, ".netrc"))

return nrc

def make_nrc(self, test_data):
return self.file_argument(test_data)

@support.subTests('nrc_builder', (home_netrc, envvar_netrc, file_argument))
def test_toplevel_non_ordered_tokens(self, nrc_builder):
nrc = nrc_builder("""\
machine host.domain.com password pass1 login log1 account acct1
default login log2 password pass2 account acct2
""")
self.assertEqual(nrc.hosts['host.domain.com'], ('log1', 'acct1', 'pass1'))
self.assertEqual(nrc.hosts['default'], ('log2', 'acct2', 'pass2'))

def test_toplevel_tokens(self):
nrc = self.make_nrc("""\
@support.subTests('nrc_builder', (home_netrc, envvar_netrc, file_argument))
def test_toplevel_tokens(self, nrc_builder):
nrc = nrc_builder("""\
machine host.domain.com login log1 password pass1 account acct1
default login log2 password pass2 account acct2
""")
self.assertEqual(nrc.hosts['host.domain.com'], ('log1', 'acct1', 'pass1'))
self.assertEqual(nrc.hosts['default'], ('log2', 'acct2', 'pass2'))

def test_macros(self):
@support.subTests('nrc_builder', (home_netrc, envvar_netrc, file_argument))
def test_macros(self, nrc_builder):
data = """\
macdef macro1
line1
Expand All @@ -50,14 +97,15 @@ def test_macros(self):
line4

"""
nrc = self.make_nrc(data)
nrc = nrc_builder(data)
self.assertEqual(nrc.macros, {'macro1': ['line1\n', 'line2\n'],
'macro2': ['line3\n', 'line4\n']})
# strip the last \n
self.assertRaises(netrc.NetrcParseError, self.make_nrc,
data.rstrip(' ')[:-1])

def test_optional_tokens(self):
@support.subTests('nrc_builder', (home_netrc, envvar_netrc, file_argument))
def test_optional_tokens(self, nrc_builder):
data = (
"machine host.domain.com",
"machine host.domain.com login",
Expand All @@ -68,7 +116,7 @@ def test_optional_tokens(self):
"machine host.domain.com account \"\" password"
)
for item in data:
nrc = self.make_nrc(item)
nrc = nrc_builder(item)
self.assertEqual(nrc.hosts['host.domain.com'], ('', '', ''))
data = (
"default",
Expand All @@ -83,7 +131,8 @@ def test_optional_tokens(self):
nrc = self.make_nrc(item)
self.assertEqual(nrc.hosts['default'], ('', '', ''))

def test_invalid_tokens(self):
@support.subTests('nrc_builder', (home_netrc, envvar_netrc, file_argument))
def test_invalid_tokens(self, nrc_builder):
data = (
"invalid host.domain.com",
"machine host.domain.com invalid",
Expand All @@ -92,7 +141,7 @@ def test_invalid_tokens(self):
"default host.domain.com login log password pass account acct invalid"
)
for item in data:
self.assertRaises(netrc.NetrcParseError, self.make_nrc, item)
self.assertRaises(netrc.NetrcParseError, nrc_builder, item)

def _test_token_x(self, nrc, token, value):
nrc = self.make_nrc(nrc)
Expand All @@ -102,7 +151,7 @@ def _test_token_x(self, nrc, token, value):
self.assertEqual(nrc.hosts['host.domain.com'], ('log', value, 'pass'))
elif token == 'password':
self.assertEqual(nrc.hosts['host.domain.com'], ('log', 'acct', value))

def test_token_value_quotes(self):
self._test_token_x("""\
machine host.domain.com login "log" password pass account acct
Expand Down Expand Up @@ -272,20 +321,20 @@ def test_comment_at_end_of_machine_line_pass_has_hash(self):

@unittest.skipUnless(os.name == 'posix', 'POSIX only test')
@unittest.skipIf(pwd is None, 'security check requires pwd module')
@os_helper.skip_unless_working_chmod
@support.os_helper.skip_unless_working_chmod
def test_security(self):
# This test is incomplete since we are normally not run as root and
# therefore can't test the file ownership being wrong.
d = os_helper.TESTFN
d = support.os_helper.TESTFN
os.mkdir(d)
self.addCleanup(os_helper.rmtree, d)
self.addCleanup(support.os_helper.rmtree, d)
fn = os.path.join(d, '.netrc')
with open(fn, 'wt') as f:
f.write("""\
machine foo.domain.com login bar password pass
default login foo password pass
""")
with os_helper.EnvironmentVarGuard() as environ:
with support.os_helper.EnvironmentVarGuard() as environ:
environ.set('HOME', d)
os.chmod(fn, 0o600)
nrc = netrc.netrc()
Expand All @@ -298,7 +347,7 @@ def test_security(self):
machine foo.domain.com login anonymous password pass
default login foo password pass
""")
with os_helper.EnvironmentVarGuard() as environ:
with support.os_helper.EnvironmentVarGuard() as environ:
environ.set('HOME', d)
os.chmod(fn, 0o600)
nrc = netrc.netrc()
Expand Down
0