nicfit/eyeD3

__str__() and __repr__() methods for frames and elsewhere

Open

#523 opened on Feb 12, 2021

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (58 forks)batch import
help wanted

Repository metrics

Stars
 (487 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

In using eyeD3, I found it very difficult to figure out what each object contains and how to inspect them. I ended up needing to read a lot of the eyeD3 source code, documentation, and even using the inspect module to figure out what I was looking at. I think using eyeD3 would be a lot easier if when I type print(tag.chapters) or print(t.chapters.get(b'ch1')) I got readable feedback rather than ChaptersAccessor object or ChapterFrame object. If it told me the ChapterFrame has title "Chapter 1" then I'd know I can also call tag.chapters.get(b"ch1").title to get the title.

Contributor guide

Research direction
Locate the classes representing frames and accessors (e.g., ChapterFrame, ChaptersAccessor) in the eyeD3 codebase and add str and repr methods to provide meaningful representation of their contents.
Tech stack
python
Domain
backend
Issue type
Feature
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80