Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-77065: Add optional keyword-only argument echo_char for getpass.getpass #130496

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.

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 24 commits into from
May 6, 2025

Conversation

donBarbos
Copy link
Contributor

@donBarbos donBarbos commented Feb 24, 2025

@donBarbos
Copy link
Contributor Author

donBarbos commented Feb 27, 2025

@picnixz sorry for choosing you, I just haven't found anyone else from the core team who is active yet (I looked at who is involved in issue and experts table). could you review?

@picnixz picnixz self-requested a review March 1, 2025 15:17
@picnixz
Copy link
Member

picnixz commented Mar 1, 2025

You can ping me for anything that is remotely related to security and cryptography

picnixz
picnixz previously requested changes Mar 1, 2025
Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

A mask is something else for me. So I would either name it "echochar" or "maskchar" or "hidechar", at least with some "char" inside it.

In addition, for termios, you should use ECHOE to handle ERASE

@bedevere-app
Copy link

bedevere-app bot commented Mar 1, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-authored-by: Bénédikt Tran <[email protected]>
@donBarbos
Copy link
Contributor Author

@picnixz I chose mask because it was used in the issue examples and also it seems that *char assumes one character while our argument can take arbitrary length. But it's not very important for me.
As for using keyword-only argument, I don't quite understand why that is.

@picnixz
Copy link
Member

picnixz commented Mar 1, 2025

As for using keyword-only argument, I don't quite understand why that is.

Because if you were to use it, you would write getpass(mask="*"), likely not changing the prompt nor the stream value. And keyword-only arguments is good for future compatibility (e.g., if we want to add more options, we are not held back by the order of the arguments)

@picnixz
Copy link
Member

picnixz commented Mar 1, 2025

I chose mask because it was used in the issue examples and also it seems that *char

Usually, you expect 1 character indeed. I don't think we should write something else than 1 char (or maybe we do but it's because of colors?) I would not expect words to be put as placeholders. Maybe colorized characters, which in this case are allowed to be strings of length > 1, but not real words.

Also, what we are echoing is really the corresponding password character. For each character, we use that placeholder. mask is really not a good idea because it could hint that we would (bitwise) mask the password (namely perform some & operation). But this is something we can think of at the end.

@donBarbos
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Mar 1, 2025

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from picnixz March 1, 2025 18:15
@donBarbos donBarbos changed the title gh-77065: Add optional argument mask for getpass.getpass gh-77065: Add optional keyword-only argument echochar for getpass.getpass Mar 1, 2025
@donBarbos
Copy link
Contributor Author

donBarbos commented Mar 1, 2025

@picnixz I just thought maybe we also should to add , *, echochar=None to getpass.fallback_getpass to have a unified interface

@bedevere-app
Copy link

bedevere-app bot commented Mar 25, 2025

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from picnixz March 25, 2025 23:18
@donBarbos
Copy link
Contributor Author

@picnixz, I added test cases, what do you think about them?

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Can we have tests where we exercise control characters? this is quite important because we want to get the correct feedback

@donBarbos
Copy link
Contributor Author

Can we have tests where we exercise control characters? this is quite important because we want to get the correct feedback

I added test case with control chars \t and \b. but mock_output.getvalue() have ***\x08 \x08 in the end of string without removing * unlike the real console where * is removed by itself and \x08 is not displayed

@donBarbos
Copy link
Contributor Author

Can we have tests where we exercise control characters? this is quite important because we want to get the correct feedback

I added test case with control chars \t and \b. but mock_output.getvalue() have ***\x08 \x08 in the end of string without removing * unlike the real console where * is removed by itself and \x08 is not displayed

cc @picnixz

@donBarbos
Copy link
Contributor Author

@picnixz It seems that all the tests that you requested already exist, but maybe it will be possible to add more since there is already an issue for covering the module with tests

I would like to have time to accept before feature freeze :-)

@picnixz
Copy link
Member

picnixz commented May 4, 2025

I am travelling (I'm back after the beta release) so I won't merge anything on mobile. I'll defer this to @gpshead, sorry but it passed under my radar :( (in the future, a request for review is more likely to be noticed)

Lib/getpass.py Outdated
@@ -151,6 +176,42 @@ def _raw_input(prompt="", stream=None, input=None):
return line


def _input_with_echochar(prompt, stream, input, echochar):
Copy link
Member

Choose a reason for hiding this comment

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

rather than duplicating so much of _raw_input's logic, I suggest making a _readline_with_echochar() function and just conditionally calling that vs the existing input.readline() call within _raw_input().

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds reasonable, please check my diff

@donBarbos donBarbos requested a review from gpshead May 5, 2025 17:17
@donBarbos donBarbos requested a review from hugovk May 6, 2025 10:53
@donBarbos donBarbos changed the title gh-77065: Add optional keyword-only argument echochar for getpass.getpass gh-77065: Add optional keyword-only argument echo_char for getpass.getpass May 6, 2025
@hugovk hugovk merged commit bf8bbe9 into python:main May 6, 2025
39 checks passed
@donBarbos
Copy link
Contributor Author

Thank you everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants