backend should translate exceptions from API

Open
#520 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
api, backend

Research direction

Start by reading issue #517 and tracing how backend calls to APIs expose exceptions to the keyring caller. Identify the canonical exceptions and the expected backend failures that need translation. Done means expected backend exceptions no longer leak as non-canonical exceptions.

Written by the indexing model from the issue text.

Description

good-first-issue help wanted macOS

In #517, this project learned that when an exception occurs in the backend's called functions (like the API) and that exception is allowed to pass to the keyring caller, that can cause some confusion. Users are expecting to have to handle only the canonical exceptions and not other exceptions.

In cases where there are expected exceptions, the backends should take responsibility to translate those exceptions into canonical exceptions.

Dominant language
Python
Stars
1.5k
Forks
208
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jaraco/keyring

All issues in jaraco/keyring

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.