cybertools/text/interfaces.py
helmutm b380b0fcd7 clean-up of cybertools.text; provide msword conversion
git-svn-id: svn://svn.cy55.de/Zope3/src/cybertools/trunk@1603 fd906abe-77d9-0310-91a1-e0d9ade77398
2007-03-01 11:40:35 +00:00

58 lines
2 KiB
Python

#
# Copyright (c) 2006 Helmut Merz helmutm@cy55.de
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
interface definitions for text transformations.
$Id$
"""
from zope.interface import Interface
class ITextTransform(Interface):
def __call__(fr):
""" Transform the content of file fr (readfile) to plain text and
return the result as unicode.
"""
class IFileTransform(ITextTransform):
""" A transformation that is performed by calling some external program
and that typically uses an intermediate disk file.
"""
def extract(dirname, filename):
""" Extract text contents from the file specified by ``filename``,
using some external programm, and return the result as unicode.
``dirname`` is the path to a temporary directory that
usually (but not necessarily) contains the file and may
be used for creating other (temporary) files if needed.
"""
def execute(command):
""" Execute a system command and return the output of the program
called.
"""
def checkAvailable(progname, logMessage=''):
""" Check the availability of the program named ``progname``.
Return True if available; if ``logMessage`` is given, put this
as a warning message into the log if the program is not available.
"""