How to examine user text frames?

[mschmitt]

I would like to examine files for complete tagging before releasing them into my radiostation playlist. The tags I'm looking for are the following:

• Artist/TPE1
• Title/TIT2
• User Text Frames:
  • Description: Local usage note
  • Description: Local license tag
  • Description: Local download URL
• APIC:
  • Description: Proof of license at download

Let's focus on the User Text Frames for now.

#!/usr/bin/env python3
import eyed3
import subprocess
from icecream import ic

subprocess.run(["eyeD3", "test.mp3"]) # FYI

af = eyed3.load("test.mp3")
print("frame_set:")
ic(af.tag.frame_set)
print("Trying to examine frames:")
for fid in list(af.tag.frame_set):
        ic(fid)
        try:
                ic(af.tag.getTextFrame(fid))
        except Exception as e:
                print(f"Exception on frame ID {fid}: {e}")

/home/martin/testarea/eyed3/test.mp3                                                                                                  [ 16.37 MB ]
---------------------------------------------------------------------------------------------------------------------------------------------------
Time: 07:00     MPEG1, Layer III        [ 320 kb/s @ 44100 Hz - Joint stereo ]
---------------------------------------------------------------------------------------------------------------------------------------------------
ID3 v2.3:
title: Conduit
artist: metre
album:
album artist: Metre
track:          genre: Electronica & Dance (id None)
UserTextFrame: [Description: Local usage note]
This file was downloaded under a Creative Commons CC0 or Public Domain license and is being used accordingly. Screenshot archived and embedded as proof.
UserTextFrame: [Description: Local license tag]
CC0/PD
UserTextFrame: [Description: Local download URL]
https://freemusicarchive.org/music/Metre/conduit
OTHER Image: [Size: 349880 bytes] [Type: image/png]
Description: Proof of license at download

---------------------------------------------------------------------------------------------------------------------------------------------------
frame_set:
ic| af.tag.frame_set: {b'APIC': [<eyed3.id3.frames.ImageFrame object at 0x7f556437f910>],
                       b'TCON': [<eyed3.id3.frames.TextFrame object at 0x7f5563ee6a50>],
                       b'TIT2': [<eyed3.id3.frames.TextFrame object at 0x7f5563ee6b90>],
                       b'TPE1': [<eyed3.id3.frames.TextFrame object at 0x7f5563ee6e50>],
                       b'TPE2': [<eyed3.id3.frames.TextFrame object at 0x7f5563ee6f50>],
                       b'TXXX': [<eyed3.id3.frames.UserTextFrame object at 0x7f5563ee7090>,
                                 <eyed3.id3.frames.UserTextFrame object at 0x7f5563ee7150>,
                                 <eyed3.id3.frames.UserTextFrame object at 0x7f5563ee7290>]}
Trying to examine frames:
ic| fid: b'APIC'
Exception on frame ID b'APIC': Invalid frame-id for text frame
ic| fid: b'TCON'
ic| af.tag.getTextFrame(fid): 'Electronica & Dance'
ic| fid: b'TIT2'
ic| af.tag.getTextFrame(fid): 'Conduit'
ic| fid: b'TPE1'
ic| af.tag.getTextFrame(fid): 'metre'
ic| fid: b'TPE2'
ic| af.tag.getTextFrame(fid): 'Metre'
ic| fid: b'TXXX'
Exception on frame ID b'TXXX': Invalid frame-id for text frame

Let's ignore the expected APIC exception for now.

How does one drill into the list of TXXX frames?

The "Musicbrainz" question in #473 was unfortunately abandoned by the original poster and I can't draw any help from the unfinished discussion there.

I'm attaching the exact MP3 used, for reference. It's Public Domain and safe to post here.
test.zip

[mschmitt]

I think I've made a bit of progress to the point where I can start using what I have:

#!/usr/bin/env python3
import eyed3
import subprocess
from icecream import ic

#subprocess.run(["eyeD3", "test.mp3"]) # FYI

af = eyed3.load("test.mp3")
print("Trying to examine frames:")
for fid in af.tag.frame_set[b'TXXX']:
        print(f"{fid.description}: {fid.text}")

for fid in af.tag.frame_set[b'APIC']:
        print(f"{fid.description}: is present")

Trying to examine frames:
Local usage note: This file was downloaded under a Creative Commons CC0 or Public Domain license and is being used accordingly. Screenshot archived and embedded as proof.
Local license tag: CC0/PD
Local download URL: https://freemusicarchive.org/music/Metre/conduit
Proof of license at download: is present

Must the list of frames be iterated like that, or is it possible to ask for a specific frame that has a given description? How do the contents of frame_set and the getTextFrame method relate to each other?

[nicfit]

The class Tag in eyed.core and eyed3.id3 define the interface. There are options, including looking at each frame as you are doing. There is also:

for f in af.tag.user_text_frames:
    print(f"{f.description}: {f.text}")

to iterate of each user text frame, vs standard text frames.

[WGroleau]

I have a similar issue with tags GRP1 and TCOP.  But I've been retired for many years and no longer feel like writing code (and Python was never one of my languages).  So I'd really prefer a command line option to show text frame contents.  There is an option to show everything, but I don't remember what it is, and I can't find it in the --help output.  (Besides, it only shows that they exist without showing their values.)