bpo-20523: pdb searches for .pdbrc in ~ instead of $HOME by tdhopper · Pull Request #11847 · python/cpython

tdhopper · 2019-02-13T22:11:39Z

Previously pdb checked the $HOME environmental variable
to find the user .pdbrc. If $HOME is not set, the user
.pdbrc would not be found.

Change pdb to use os.path.expanduser('~') to determine
the user's home directory. Thus, if $HOME is not set (as
in tox or on Windows), os.path.expanduser('~') falls
back on other techniques for locating the user's home
directory.

This follows pip's implementation for loading .piprc.

Co-authored-by: Dan Lidral-Porter [email protected]

https://bugs.python.org/issue20523

the-knights-who-say-ni · 2019-02-13T22:11:41Z

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 might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

tdhopper · 2019-02-15T14:42:30Z

This also solves a problem we encountered trying to launch pdb (via pytest --pdb) from within tox. By default, tox strips out nearly all environmental variables, including $HOME. Thus, pdb fails to find $HOME/.pdbrc. This is different from loading the user pip config, because pip looks in expanduser("~") which falls back on the pwd module to find the home directory.

matrixise · 2019-02-15T15:06:19Z

why do you test with '~' ? normally, you won't get the tilde but the full path. I have an other PR but you can check with my code and fix yours. #11855

envHome != '~' is true if expanduser succeeded in finding the full path.

yep, but in which case can you have '~' ? never

Your solution is cleaner. We took the approach of modifying the fewest lines.

in fact, expanduser will replace ~ by the $HOME, $HOMEDRIVE, $HOMEPATH, etc... for Windows and unix-like, so normally, you won't get the ~. my approach is different because I wait for an exception and sometimes, an exception is better than a condition.

You could have ~ if the expansion fails (e.g. if it can't find anything resembling a home directory): "If the expansion fails or if the path does not begin with a tilde, the path is returned unchanged."

yep, it's possible.

use python3 for the documentation (https://docs.python.org/3/library/os.path.html#os.path.expanduser)

if you can't read the file you will get an exception, in this case, you will get OSError or Exception.

Updated to use your cleaner solution

Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]>

matrixise · 2019-02-15T16:03:20Z

-                        self.rcLines.extend(rcFile)
-                except OSError:
-                    pass
+            try:


I think to an other solution:

for path in (os.path.expanduser('~/.pdbrc'), '.pdbrc'): with contextlib.suppress(OSError), open(path) as rcFile: self.rcLines.extend(rcFile)

but I am not sure. need to test it.

Requested changes were made

zooba · 2019-08-02T22:19:49Z

Sorry for the slow reviews, but I'm happy with this, so it can go in for the next releases!

miss-islington · 2019-08-02T22:20:25Z

Thanks @tdhopper for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington · 2019-08-02T22:20:25Z

Thanks @tdhopper for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington · 2019-08-02T22:20:26Z

I'm having trouble backporting to 3.8. Reason: 'Error 110 while writing to socket. Connection timed out.'. Please retry by removing and re-adding the needs backport to 3.8 label.

) Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]> (cherry picked from commit 7ea9a85) Co-authored-by: Timothy Hopper <[email protected]>

bedevere-bot · 2019-08-02T22:20:34Z

GH-15084 is a backport of this pull request to the 3.7 branch.

miss-islington · 2019-08-02T22:20:36Z

Thanks @tdhopper for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington · 2019-08-02T22:20:46Z

Thanks @tdhopper for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

) Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]> (cherry picked from commit 7ea9a85) Co-authored-by: Timothy Hopper <[email protected]>

bedevere-bot · 2019-08-02T22:20:54Z

GH-15085 is a backport of this pull request to the 3.8 branch.

Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]> (cherry picked from commit 7ea9a85) Co-authored-by: Timothy Hopper <[email protected]>

Tim and Dan were authors for GH-11847

) Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]>

Tim and Dan were authors for pythonGH-11847

) Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]>

Tim and Dan were authors for pythonGH-11847

) Previously pdb checked the $HOME environmental variable to find the user .pdbrc. If $HOME is not set, the user .pdbrc would not be found. Change pdb to use `os.path.expanduser('~')` to determine the user's home directory. Thus, if $HOME is not set (as in tox or on Windows), os.path.expanduser('~') falls back on other techniques for locating the user's home directory. This follows pip's implementation for loading .piprc. Co-authored-by: Dan Lidral-Porter <[email protected]>

Tim and Dan were authors for pythonGH-11847

the-knights-who-say-ni added the CLA not signed label Feb 13, 2019

bedevere-bot added the awaiting review label Feb 13, 2019

tirkarthi mentioned this pull request Feb 14, 2019

bpo-20523: pdb.Pdb can read the global ~/.pdbrc file on Windows 7 #11855

Closed

matrixise previously requested changes Feb 15, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Feb 15, 2019

tdhopper force-pushed the fix-issue-20523 branch from 93cddbf to 75c7c58 Compare February 15, 2019 15:52

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Feb 15, 2019

matrixise reviewed Feb 15, 2019

View reviewed changes

📜🤖 Added by blurb_it.

4dddb2f

zooba merged commit 7ea9a85 into python:master Aug 2, 2019

bedevere-bot removed the awaiting core review label Aug 2, 2019

zooba added needs backport to 3.7 labels Aug 2, 2019

bedevere-bot removed the needs backport to 3.7 label Aug 2, 2019

zooba added needs backport to 3.7 and removed needs backport to 3.8 labels Aug 2, 2019

zooba added the needs backport to 3.8 label Aug 2, 2019

bedevere-bot removed the needs backport to 3.8 label Aug 2, 2019

tdhopper added a commit to tdhopper/cpython that referenced this pull request Aug 4, 2019

Adds authors of python#11847

03923b8

tdhopper mentioned this pull request Aug 4, 2019

Adds authors of #11847 #15101

Merged

zooba pushed a commit that referenced this pull request Aug 4, 2019

Adds Tim Hopper and Dan Lidral-Porter to ACKS (GH-15101)

d748a80

Tim and Dan were authors for GH-11847

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019

Adds Tim Hopper and Dan Lidral-Porter to ACKS (pythonGH-15101)

64a14eb

Tim and Dan were authors for pythonGH-11847

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020

Adds Tim Hopper and Dan Lidral-Porter to ACKS (pythonGH-15101)

e5d50e7

Tim and Dan were authors for pythonGH-11847

websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020

Adds Tim Hopper and Dan Lidral-Porter to ACKS (pythonGH-15101)

55ba417

Tim and Dan were authors for pythonGH-11847

Uh oh!

Conversation

tdhopper commented Feb 13, 2019 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Feb 13, 2019

Uh oh!

tdhopper commented Feb 15, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zooba commented Aug 2, 2019

Uh oh!

miss-islington commented Aug 2, 2019

Uh oh!

miss-islington commented Aug 2, 2019

Uh oh!

miss-islington commented Aug 2, 2019

Uh oh!

bedevere-bot commented Aug 2, 2019

Uh oh!

miss-islington commented Aug 2, 2019

Uh oh!

miss-islington commented Aug 2, 2019

Uh oh!

bedevere-bot commented Aug 2, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

tdhopper commented Feb 13, 2019 •

edited by bedevere-bot

Loading