eyed3 package

Subpackages

Submodules

eyed3.core module

Basic core types and utilities.

class eyed3.core.CountAndTotalTuple(count, total)

Bases: tuple

Create new instance of CountAndTotalTuple(count, total)

count

Alias for field number 0

total

Alias for field number 1

class eyed3.core.ArtistOrigin(city: str, state: str, country: str)[source]

Bases: object

city: str
state: str
country: str
id3Encode()[source]
class eyed3.core.AudioInfo(time_secs: float, size_bytes: int)[source]

Bases: object

A base container for common audio details.

time_secs: float
size_bytes: int
class eyed3.core.Tag(title=None, artist=None, album=None, album_artist=None, track_num=None)[source]

Bases: object

An abstract interface for audio tag (meta) data (e.g. artist, title, etc.)

read_only: bool = False
property title
property artist
property album
property album_artist
property track_num: CountAndTotalTuple

Track number property. Must return a 2-tuple of (track-number, total-number-of-tracks). Either tuple value may be None.

class eyed3.core.AudioFile(path)[source]

Bases: object

Abstract base class for audio file types (AudioInfo + Tag)

Construct with a path and invoke _read. All other members are set to None.

initTag(version=None)[source]
rename(name, fsencoding='utf-8', preserve_file_time=False)[source]

Rename the file to name. The encoding used for the file name is eyed3.LOCAL_FS_ENCODING unless overridden by fsencoding. Note, if the target file already exists, or the full path contains non-existent directories the operation will fail with IOError. File times are not modified when preserve_file_time is True, False is the default.

property info: AudioInfo

Returns a concrete implementation of eyed3.core.AudioInfo

property tag

Returns a concrete implementation of eyed3.core.Tag

property path

The absolute path of this file.

class eyed3.core.Date(*args, **kwargs)[source]

Bases: object

A class for representing a date and time (optional). This class differs from datetime.datetime in that the default values for month, day, hour, minute, and second is None and not ‘January 1, 00:00:00’. This allows for an object that is simply 1987, and not January 1 12AM, for example. But when more resolution is required those vales can be set as well.

TIME_STAMP_FORMATS = ['%Y', '%Y-%m', '%Y-%m-%d', '%Y-%m-%dT%H', '%Y-%m-%dT%H:%M', '%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%HZ', '%Y-%m-%dT%H:%MZ', '%Y-%m-%dT%H:%M:%SZ', '%Y-%m-%d %H:%M:%S', '%Y-00-00', '%Y%m%d', 'D%d-%m', 'T%H:%M']

Valid time stamp formats per ISO 8601 and used by strptime.

property year
property month
property day
property hour
property minute
property second
static parse(s)[source]

Parses date strings that conform to ISO-8601.

eyed3.core.parseError(ex) → None[source]

A function that is invoked when non-fatal parse, format, etc. errors occur. In most cases the invalid values will be ignored or possibly fixed. This function simply logs the error.

eyed3.core.load(path, tag_version=None) → AudioFile | None[source]

Loads the file identified by path and returns a concrete type of eyed3.core.AudioFile. If path is not a file an IOError is raised. None is returned when the file type (i.e. mime-type) is not recognized. The following AudioFile types are supported:

If tag_version is not None (the default) only a specific version of metadata is loaded. This value must be a version constant specific to the eventual format of the metadata.

eyed3.main module

eyed3.main.main(args, config)[source]
eyed3.main.profileMain(args, config)[source]

This is the main function for profiling http://code.google.com/appengine/kb/commontasks.html#profiling

eyed3.main.setFileScannerOpts(arg_parser, default_recursive=False, paths_metavar='PATH', paths_help='Files or directory paths')[source]
eyed3.main.makeCmdLineParser(subparser=None)[source]
eyed3.main.parseCommandLine(cmd_line_args=None)[source]

eyed3.mimetype module

eyed3.mimetype.guessMimetype(filename)[source]

Return the mime-type for filename.

class eyed3.mimetype.Mp2x[source]

Bases: Type

Implements the MP2.x audio type matcher.

MIME = 'audio/mpeg'
EXTENSION = 'mp3'
match(buf)[source]
class eyed3.mimetype.Mp3Invalids[source]

Bases: Type

Implements a MP3 audio type matcher this is odd or/corrupt mp3.

MIME = 'audio/mpeg'
EXTENSION = 'mp3'
match(buf)[source]
class eyed3.mimetype.Id3Tag[source]

Bases: Type

Implements a MP3 audio type matcher this is odd or/corrupt mp3.

MIME = 'application/x-id3'
EXTENSION = 'id3'
match(buf)[source]
class eyed3.mimetype.Id3TagExt[source]

Bases: Id3Tag

EXTENSION = 'tag'
class eyed3.mimetype.M3u[source]

Bases: Type

Implements the m3u playlist matcher.

MIME = 'audio/x-mpegurl'
EXTENSION = 'm3u'
match(buf)[source]

Module contents

class eyed3.AudioFile(path)[source]

Bases: object

Abstract base class for audio file types (AudioInfo + Tag)

Construct with a path and invoke _read. All other members are set to None.

property info: AudioInfo

Returns a concrete implementation of eyed3.core.AudioInfo

initTag(version=None)[source]
property path

The absolute path of this file.

rename(name, fsencoding='utf-8', preserve_file_time=False)[source]

Rename the file to name. The encoding used for the file name is eyed3.LOCAL_FS_ENCODING unless overridden by fsencoding. Note, if the target file already exists, or the full path contains non-existent directories the operation will fail with IOError. File times are not modified when preserve_file_time is True, False is the default.

property tag

Returns a concrete implementation of eyed3.core.Tag

eyed3.load(path, tag_version=None) → AudioFile | None[source]

Loads the file identified by path and returns a concrete type of eyed3.core.AudioFile. If path is not a file an IOError is raised. None is returned when the file type (i.e. mime-type) is not recognized. The following AudioFile types are supported:

If tag_version is not None (the default) only a specific version of metadata is loaded. This value must be a version constant specific to the eventual format of the metadata.

exception eyed3.Error(*args)[source]

Bases: Exception

Base exception type for all eyed3 errors.