thebigmunch/audio-metadata

Add strict/lenient modes with toggles

Open

#18 opened on Feb 15, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (13 forks)github user discovery
designenhancementfeaturehelp wanted

Repository metrics

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

Description

Change certain exceptions, to be determined, to warnings that can be made exceptions based on which mode audio-metadata is in. The exceptions most likely to be changed regard spec-compliance of tags. This would be the precursor of the ability to fix/upgrade tags/tag versions.

  • Which should be default? Current behavior is strict.
  • What API to use to toggle mode?
    • Top-level API functions to enable globally?
    • Arguments to top-level API functions?
    • Both?
  • How will the warnings classes fit in with exceptions hierarchy [#17]?

Contributor guide

Research direction
Examine the current exception hierarchy in audio metadata, understand which exceptions are spec compliance related. Design a toggle mechanism (global flag, per function argument, or both) to switch between strict and lenient modes. Consider how warnings will be represented and how they integrate with the existing exception hierarchy. Look at similar libraries (e.g., mutagen) for patterns.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50