libp2p/py-libp2p

Exceptions handling and structure

Open

#261 opened on Aug 23, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (238 forks)auto 404
Interoperabilityhelp wanted

Repository metrics

Stars
 (618 stars)
PR merge metrics
 (PR metrics pending)

Description

  1. We should revisit the whole codebase to ensure exceptions are well defined and handled well.
  2. We don't have a good picture of the exception tree now. As a reference, in trinity, the package trinity has its own exception tree and so do p2p. I'm not sure what is the best structure for us, but I think probably a single exception tree(i.e. all exceptions inherit from BaseLibp2pError and its descendants) can be a start?

@ChihChengLiang @ralexstokes @NIC619 @pipermerriam

Would love to have your comment on it:)

Contributor guide

Research direction
Investigate the current exception classes in the codebase, identify which ones exist and how they are used. Then propose a unified exception hierarchy inheriting from BaseLibp2pError, following the example from trinity.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70