facebook/TestSlide

Simplify typehints

Open

#248 opened on Oct 2, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (58 forks)auto 404
easyenhancementgood first issuehelp wanted

Repository metrics

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

Description

As per @fornellas comments on #246 do these:

  • Unions of BaseException & other exception types (eg: Exception). Shouldn't BaseException be enough? All Python exception are subclasses of it, I think it should work just fine with only it.

  • There are lots of Callable types (no args, no return) or Callable[[a,b,c...], d], mostly related to DSL hooks, such as examples, before / after hooks etc. TBH, this PR is awesome as it is, but I was thinking about having custom types such as ExampleFunction = Callable[[_ContextData], None] (non-blocking here to be clear).

Contributor guide

Research direction
Review PR #246 for context. Examine current type hints in exception handling and callable signatures. Simplify unions to BaseException and define custom Callable types as suggested.
Tech stack
python
Domain
testing
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70