Source code for eyed3.plugins.pymod

# -*- coding: utf-8 -*-
################################################################################
#  Copyright (C) 2014  Travis Shirk <travis@pobox.com>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, see <http://www.gnu.org/licenses/>.
#
################################################################################
from __future__ import print_function

from eyed3.plugins import LoaderPlugin
from eyed3.compat import importmod


_DEFAULT_MOD = "eyeD3mod.py"


[docs]class PyModulePlugin(LoaderPlugin): SUMMARY = u"Imports a Python module file and calls its functions for the "\ "the various plugin events." DESCRIPTION = u""" If no module if provided (see -m/--module) a file named %(_DEFAULT_MOD)s in the current working directory is imported. If any of the following methods exist they still be invoked: def audioFile(audio_file): '''Invoked for every audio file that is encountered. The ``audio_file`` is of type ``eyed3.core.AudioFile``; currently this is the concrete type ``eyed3.mp3.Mp3AudioFile``.''' pass def audioDir(d, audio_files, images): '''This function is invoked for any directory (``d``) that contains audio (``audio_files``) or image (``images``) media.''' pass def done(): '''This method is invoke before successful exit.''' pass """ % globals() NAMES = ["pymod"] def __init__(self, arg_parser): super(PyModulePlugin, self).__init__(arg_parser, cache_files=True, track_images=True) self._mod = None self.arg_group.add_argument("-m", "--module", dest="module", help="The Python module module to invoke. " "The default is ./%s" % _DEFAULT_MOD)
[docs] def start(self, args, config): mod_file = args.module or _DEFAULT_MOD try: self._mod = importmod(mod_file) except IOError as ex: raise IOError("Module file not found: %s" % mod_file) except (NameError, IndentationError, ImportError, SyntaxError) as ex: raise IOError("Module load error: %s" % str(ex))
[docs] def handleFile(self, f): super(PyModulePlugin, self).handleFile(f) if not self.audio_file: return if "audioFile" in dir(self._mod): self._mod.audioFile(self.audio_file)
[docs] def handleDirectory(self, d, _): if not self._file_cache and not self._dir_images: return if "audioDir" in dir(self._mod): self._mod.audioDir(d, self._file_cache, self._dir_images) super(PyModulePlugin, self).handleDirectory(d, _)
[docs] def handleDone(self): super(PyModulePlugin, self).handleDone() if "done" in dir(self._mod): self._mod.done()