Skip to content
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

Support username and password from keyring #1734

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 11 additions & 6 deletions src/hatch/publish/auth.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from __future__ import annotations

import keyring
Copy link
Contributor

Choose a reason for hiding this comment

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

i'm pretty sure @ofek prefers that to be imported only when it's needed in _read_keyring.


from hatch.utils.fs import Path


Expand Down Expand Up @@ -44,12 +46,6 @@ def __get_password(self) -> str:
if password is not None:
return password

import keyring

password = keyring.get_password(self._repo, self.username)
if password is not None:
return password

if self._options['no_prompt']:
self._app.abort('Missing required option: auth')

Expand All @@ -62,6 +58,7 @@ def __get_username(self) -> str:
or self._repo_config.get('user')
or self._read_pypirc()
or self._read_previous_working_user_data()
or self._read_keyring()
)
if username is not None:
return username
Expand All @@ -72,6 +69,14 @@ def __get_username(self) -> str:
self.__username_was_read = True
return self._app.prompt(f"Username for '{self._repo_config['url']}' [__token__]") or '__token__'

def _read_keyring(self) -> str | None:
Copy link
Contributor

Choose a reason for hiding this comment

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

this could also store the __password property as i'm assuming that using a username from this credentials source doesn't make sense with a password from another source.

Copy link
Author

Choose a reason for hiding this comment

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

You are right, no need to run read the password again if we already have it. I pushed my changes. Thanks for the review

creds = keyring.get_credential(self._repo, None)
if not creds:
return None
self.__password = creds.password
self.__password_was_read = True
return creds.username

def _read_previous_working_user_data(self) -> str | None:
if self._pwu_path.is_file():
contents = self._pwu_path.read_text()
Expand Down
30 changes: 30 additions & 0 deletions tests/utils/test_auth.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
import pytest

import hatch.publish.auth
from hatch.publish.auth import AuthenticationCredentials
from hatch.utils.fs import Path


@pytest.fixture(autouse=True)
def mock_keyring(monkeypatch):
class MockKeyring:
@staticmethod
def get_credential(*_):
class Credential:
username = 'gat'
password = 'guido'

return Credential()

monkeypatch.setattr(hatch.publish.auth, 'keyring', MockKeyring)


def test_pypirc(fs):
fs.create_file(
Path.home() / '.pypirc',
Expand Down Expand Up @@ -42,3 +59,16 @@ def test_pypirc(fs):
)
assert credentials.username == 'guido'
assert credentials.password == 'gat'


def test_keyring_credentials():
credentials = AuthenticationCredentials(
app=None,
cache_dir=Path('/none'),
options={},
repo='arbitrary',
repo_config={'url': 'https://kaashandel.nl/'},
)

assert credentials.username == 'gat'
assert credentials.password == 'guido'