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 (487 stars) (58 forks)batch import
help wanted

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

Tech stack
python
Domain
developer experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python str and repr eyeD3 frame classes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look at the source code in eyeD3 to identify classes that currently lack str and repr methods (e.g., ChaptersAccessor, ChapterFrame). Implement these methods to return human readable representations of the object's key attributes. Ensure consistency with any existing methods in the codebase.