Skip to content

bpo-23878: Remove an unneeded fseek() call in _Py_FindEnvConfigValue() #15424

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

Merged
merged 3 commits into from
Aug 28, 2019
Merged

bpo-23878: Remove an unneeded fseek() call in _Py_FindEnvConfigValue() #15424

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6f45af
bpo-23878: Check the fseek() call in _Py_FindEnvConfigValue()
ZackerySpytz Aug 23, 2019
ef94dc1
Merge remote-tracking branch 'upstream/master' into bpo-23878-fseek-s…
ZackerySpytz Aug 27, 2019
fbb949a
Remove the fseek() call.
ZackerySpytz Aug 27, 2019
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
4 changes: 3 additions & 1 deletion Python/pathconfig.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,9 @@ _Py_FindEnvConfigValue(FILE *env_file, const wchar_t *key,
char buffer[MAXPATHLEN * 2 + 1]; /* allow extra for key, '=', etc. */
buffer[Py_ARRAY_LENGTH(buffer)-1] = '\0';

Copy link
Member

@vstinner vstinner Aug 26, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the function comment: explain that it returns 1 and copy it into value if found, or return 0 on error or if not found. Something like that.

I'm not sure why key is a parameter: its value is always "home". Maybe write a following PR to remove the key parameter? (need to update getpath.c and getpathp.c)

Copy link
Member

@vstinner vstinner Aug 26, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I'm not sure why fseek(0) is called: we just opened the file in read mode, not in append mode, the file cursor should already be 0.

Copy link
Contributor Author

@ZackerySpytz ZackerySpytz Aug 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for your review, @vstinner. I have removed the fseek() call -- it indeed seems to be unneeded.
I will create a pull request to remove the key parameter.

fseek(env_file, 0, SEEK_SET);
if (fseek(env_file, 0, SEEK_SET) < 0) {
return 0;
}
while (!feof(env_file)) {
char * p = fgets(buffer, Py_ARRAY_LENGTH(buffer) - 1, env_file);

Expand Down