NEWS.rst

@@ -1,3 +1,19 @@
+v24.1.0
+=======
+
+Bugfixes
+--------
+
+- Avoid logging warning when no config file is present. (#635)
+- Include all operations in the error message if no operation was supplied. (#636)
+
+
+Improved Documentation
+----------------------
+
+- Correct name of macOS backend in README. (#637)
+
+
 v24.0.1
 =======
 

README.rst

@@ -153,7 +153,7 @@ Config file content
 
 To specify a keyring backend, set the **default-keyring** option to the
 full path of the class for that backend, such as
-``keyring.backends.OS_X.Keyring``.
+``keyring.backends.macOS.Keyring``.
 
 If **keyring-path** is indicated, keyring will add that path to the Python
 module search path before loading the backend.

keyring/cli.py

@@ -37,9 +37,10 @@ def __init__(self):
         self.parser.add_argument(
             "--disable", action="store_true", help="Disable keyring and exit"
         )
+        self.parser._operations = ["get", "set", "del", "diagnose"]
         self.parser.add_argument(
             'operation',
-            choices=["get", "set", "del", "diagnose"],
+            choices=self.parser._operations,
             nargs="?",
         )
         self.parser.add_argument(
@@ -103,7 +104,7 @@ def diagnose(self):
         print("data root:", platform_.data_root())
 
     def invalid_op(self):
-        self.parser.error("Specify operation 'get', 'del', or 'set'.")
+        self.parser.error(f"Specify operation ({', '.join(self.parser._operations)}).")
 
     def _load_spec_backend(self):
         if self.keyring_backend is None:

keyring/core.py

@@ -150,12 +150,17 @@ def _config_path():
     return platform.config_root() / 'keyringrc.cfg'
 
 
+def _ensure_path(path):
+    if not path.exists():
+        raise FileNotFoundError(path)
+
+
 def load_config() -> typing.Optional[backend.KeyringBackend]:
     """Load a keyring using the config file in the config root."""
 
     config = configparser.RawConfigParser()
     try:
-        config.read(_config_path(), encoding='utf-8')
+        config.read(_ensure_path(_config_path()), encoding='utf-8')
     except FileNotFoundError:
         return None
     _load_keyring_path(config)

tests/test_core.py

@@ -7,3 +7,8 @@ def test_init_recommended(monkeypatch):
     """
     monkeypatch.setattr(keyring.core, 'set_keyring', lambda kr: None)
     keyring.core.init_backend(keyring.core.recommended)
+
+
+def test_load_config_missing(caplog):
+    assert keyring.core.load_config() is None
+    assert not caplog.records