GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||||||||||
GeezerVison is showing github.com — bpo-28334: fix netrc not working when $HOME is not set by dmerejkowsky · Pull Request #123 · python/cpython Conversation
|
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA. This is necessary for legal reasons before we can look at your contribution. Please follow these steps to help rectify the issue:
Thanks again to your contribution and we look forward to looking at it! |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
As discussed during patch review, no tests were added, but doc was updated. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@the-knights-who-say-ni : |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, but like I said in review we can't accept this without a test case.
It should be easy to test at least the FileNotFoundError case by changing $HOME env variable.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Style nit:
.. versionchanged:: 3.7 Now uses :func:`os.path.expanduser`, so if [...]
Sorry, something went wrong.
There was an error while loading. Please reload this page.
f9e303b to
cb9777b
Compare
|
Rebased, added a test, and fix doc style as requested. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I would like the name just test_file_not_found.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
agreed
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
When you explicitly pass a not exist file, it could also raise the error.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
OK. I wrote an other test for this. (I like to follow the 'one assert per test' rule)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
cb9777b to
7119217
Compare
|
LGTM. But I'd wait for others' reviews for some time. And I want to treat this as an enhancement though it looks like a bug on Windows. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks good to me, just left some minor comments. Also, since this a behavior change we need to add a note to Misc/NEWS.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I think the "if :envvar:HOME is not set [...]" part should be moved to the main documentation block and the versionchanged annotation should only mention that it now uses expanduser() to determine the location of the .netrc file if *file* is not passed.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Makes sense.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Double spaces before "will".
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
oups, sorry :)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
No need to use unlikely_file here. Just pass "unlikely_netrc" to the constructor.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
agreed
Sorry, something went wrong.
There was an error while loading. Please reload this page.
7119217 to
62ff357
Compare
|
@berkerpeksag rebased and conformed with your latest comments |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
62ff357 to
86a9333
Compare
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Two spaces before "If the file ...".
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
done
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Uppercase please and colon at end. And instead of fixing, I'd rather something like "Use os.path.expanduser rather than barely checking $HOME is set or not when no argument is given to netrc.netrc().". Ignore my wording, I am not a native speaker. :-(
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Also done. It's a bit long, but I hope it documents precisely the new behavior
Sorry, something went wrong.
There was an error while loading. Please reload this page.
df1f1bc to
09abcaf
Compare
There was an error while loading. Please reload this page.
|
@zhangyangyu Thanks for the suggestions! It's worth making sure the documentation is as best as possible :) |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Too wordy. Just
bpo-28334: Use os.path.expanduser() to find the ~/.netrc file in netrc.netrc().
If the file does not exist, a FileNotFoundError is raised.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
There are many causes why the file can't be read. It can be a directory or broken symlink, or user can not have permissions to read it. Different OSError subclasses are raised in these cases. I think no need to specify this is explicitly. Exceptions that can be raised by the function are rarely documented in Python docs.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Fair enough. I removed the sentence.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
This doesn't test a new behavior. Needed a test for the case when HOME is not set.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
This doesn't test a new behavior
I think it does. It checks the type of the exception raised, which is the whole point of this patch,
getting rid of the weird 'OSError' about HOME not set ...
Needed a test for the case when HOME is not set.
Yeah I was not sure about this one. I've added a test where I monkeypatch os.path.expanduser, but I'm not sure it's useful. My guts tell me such a test is too close to the implementation.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Serhiy is right that we need a test for this case and unless I'm missing something you can do it without doing any mocking:
with support.EnvironmentVarGuard() as environ: environ.unset('HOME') self.assertRaises(FileNotFoundError, netrc.netrc)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
09abcaf to
1d544f5
Compare
|
Wrote a test monkeypatching |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@serhiy-storchaka @berkerpeksag @terryjreedy gentle reminder :) |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@dmerejkowsky For reminding, you don't need to squash your commit every change makes, all commit will be squash when the PR is merged. See devguide last paragraph. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Mocking os.path.expanduser is not needed here in my opinion. If you can change the test to
def test_home_not_set(self): with support.EnvironmentVarGuard() as environ: environ.unset('HOME') self.assertRaises(FileNotFoundError, netrc.netrc)
then we are good to go! :)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I'm afraid not. If we unset HOME and ~/.netrc does exist on the developer box, os.path.expanduser will read /etc/passwd using pwd (see [1]) and no exception will be raised. I'd prefer the tests to not depend on what's on the home directory of the user running the tests.
[1]: https://github.com/python/cpython/blob/master/Lib/posixpath.py#L245-L247
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
~/.netrc -> ``~/.netrc``
(otherwise our doc build will complain)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
done
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@dmerejkowsky and just one more comment: Please add your name to |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Maybe "as determined"? expanduser() itself doesn't return the user's home directory.
Or "as returned by os.path.expanduser('~') ", but this exposes more implementation details and is harder to format as a reference.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I like 'determined', thanks :)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
'/' is Posix specific pathname separator. Windows accepts it too, but it is better to use the native pathname separator, os.sep. Or use os.path.join():
os.path.expanduser(os.path.join("~", ".netrc"))
or
os.path.join(os.path.expanduser("~"), ".netrc")
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
ok.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
~/.netrc is Posix-specific syntax. Windows users of netrc can even not know what ~/ means. Maybe "of the file :file:'.netrc'" of "of the default netrc file"?
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
agreed
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Check the content of nrc for testing that the configuration is read from the right file. Add a random data in the fake .netrc.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Too long line.
Add "Patch by Dimitri Merejkowsky."
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
done
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Is this a new behavior?
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Nope, fixed
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
This is too fragile. If rather than os.path.expanduser("~/.netrc") use one of variants suggested by me, the test will be broken.
I would monkey-patch expanduser with a code like the following:
orig_expanduser = os.path.expanduser called = [] def fake_expanduser(s): called.append(s) environ.set('HOME', d) result = orig_expanduser(s) environ.unset('HOME') return result with test.support.swap_attr(os.path, 'expanduser', fake_expanduser): nrc = netrc.netrc() self.assertTrue(called)
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
You're right, test is less likely to break this way.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
I've fixed merge conflicts, created NEWS entry with blurb and made some cosmetic changes. Is there anything left to do here? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I don't understand how this test is related to the case when HOME is not set. Why not use the simple test suggested by @berkerpeksag above?
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
My suggested test won't work, because of the following code in expanduser:
if 'HOME' not in os.environ: import pwd userhome = pwd.getpwuid(os.getuid()).pw_dir
I have a .netrc file in my HOME directory so the test won't pass:
def test_foo(self): with support.EnvironmentVarGuard() as environ: environ.unset('HOME') self.assertRaises(FileNotFoundError, netrc.netrc)
======================================================================
FAIL: test_foo (test.test_netrc.NetrcTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/berker/projects/cpython/master/Lib/test/test_netrc.py", line 34, in test_foo
self.assertRaises(FileNotFoundError, netrc.netrc)
AssertionError: FileNotFoundError not raised by netrc
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Thanks, now I see that this is the simplest platform-independent test.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Also add more tests to check that proper exceptions are raised
4605b07 to
e8dde32
Compare
|
For some reason, Travis CI didn't pick up latest changes: Serhiy fixed it a while ago and I don't get any warnings in my development environment. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Ok, this looks like a Travis bug to me. I've opened PR #4537 and documentation build passed there. @dmerejkowsky could you please create a new PR? If I merge PR #4537, GitHub overwrite author information and set me as author. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
It's not a problem for me :) It was very nice of you to finish up my pull request, so by all means just merge your own and let GitHub set you as author of the patch, you deserve it. What matters to me is to be listed in the ACKS file 😛 |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
I've just merged PR #4537. Thank you for your work again, @dmerejkowsky. It took more than a year but we eventually fixed the bug :) |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
There was an error while loading. Please reload this page.