sharkdp/shell-functools

Handling of type-inference errors (file named `3`)?

Open

#19 opened on Apr 1, 2018

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (52 forks)github user discovery
help wantedquestion

Repository metrics

Stars
 (1,242 stars)
PR merge metrics
 (PR metrics pending)

Description

As we always read strings via stdin, we have to guess the type of each input line (via add_dynamic_type). This can lead to errors:

> touch a b
> ls | map filesize  # okay
> touch 3
> ls | map filesize  # Incompatible input type: expected 'Path', got 'Int'

How should we handle this? Add explicit type annotations? Always assume everything to be a string?

Contributor guide

Research direction
Examine the `add dynamic type` function and determine how to distinguish between file paths and numbers in input lines. Consider adding explicit type annotations or falling back to string type when ambiguous.
Tech stack
python
Domain
cli
Issue type
Bug
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.
1-3 hours
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65