__init__.py revision 1292
409N/A#!/usr/bin/python2.4
49N/A#
49N/A# CDDL HEADER START
49N/A#
49N/A# The contents of this file are subject to the terms of the
49N/A# Common Development and Distribution License (the "License").
49N/A# You may not use this file except in compliance with the License.
49N/A#
49N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
49N/A# or http://www.opensolaris.org/os/licensing.
49N/A# See the License for the specific language governing permissions
49N/A# and limitations under the License.
49N/A#
49N/A# When distributing Covered Code, include this CDDL HEADER in each
49N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
49N/A# If applicable, add the following below this CDDL HEADER, with the
49N/A# fields enclosed by brackets "[]" replaced with your own identifying
49N/A# information: Portions Copyright [yyyy] [name of copyright owner]
49N/A#
49N/A# CDDL HEADER END
49N/A#
49N/A
49N/A#
873N/A# Copyright 2009 Sun Microsystems, Inc. All rights reserved.
49N/A# Use is subject to license terms.
49N/A#
49N/A
49N/A"""
49N/Apackage containing packaging action (file type) modules
49N/A
49N/AThis package contains modules describing packaging actions, or file types. The
49N/Aactions are dynamically discovered, so that new modules can be placed in this
49N/Apackage directory and they'll just be picked up. The current package contents
49N/Acan be seen in the section "PACKAGE CONTENTS", below.
49N/A
51N/AThis package has one data member: "types". This is a dictionary which maps the
51N/Aaction names to the classes that represent them.
51N/A
51N/AThis package also has one function: "fromstr", which creates an action instance
51N/Abased on a str() representation of an action.
49N/A"""
49N/A
49N/Aimport inspect
49N/Aimport os
49N/A
49N/A# All modules in this package (all python files except __init__.py with their
49N/A# extensions stripped off).
49N/A__all__ = [
49N/A f[:-3]
49N/A for f in os.listdir(__path__[0])
49N/A if f.endswith(".py") and f != "__init__.py"
49N/A]
49N/A
49N/A# A dictionary of all the types in this package, mapping to the classes that
49N/A# define them.
49N/Atypes = {}
49N/Afor modname in __all__:
49N/A module = __import__("%s.%s" % (__name__, modname),
49N/A globals(), locals(), [modname])
49N/A
49N/A nvlist = inspect.getmembers(module, inspect.isclass)
49N/A
49N/A # Pull the class objects out of nvlist, keeping only those that are
49N/A # actually defined in this package.
49N/A classes = [
49N/A c[1]
49N/A for c in nvlist
49N/A if '.'.join(c[1].__module__.split('.')[:-1]) == __name__
49N/A ]
49N/A for cls in classes:
51N/A types[cls.name] = cls
49N/A
49N/A# Clean up after ourselves
49N/Adel f, modname, module, nvlist, classes, c, cls
51N/A
591N/Aclass ActionError(Exception):
873N/A """Base exception class for Action errors."""
873N/A
873N/A def __str__(self):
873N/A raise NotImplementedError()
591N/A
591N/Aclass UnknownActionError(ActionError):
591N/A def __init__(self, *args):
591N/A self.actionstr = args[0]
591N/A self.type = args[1]
591N/A
591N/A def __str__(self):
591N/A if hasattr(self, "fmri") and self.fmri is not None:
873N/A return _("unknown action type '%(type)s' in package "
873N/A "'%(fmri)s' in action '%(action)s'") % {
873N/A "type": self.type, "fmri": self.fmri,
873N/A "action": self.actionstr }
873N/A return _("unknown action type '%(type)s' in action "
873N/A "'%(action)s'") % { "type": self.type,
873N/A "action": self.actionstr }
591N/A
591N/Aclass MalformedActionError(ActionError):
591N/A def __init__(self, *args):
591N/A self.actionstr = args[0]
591N/A self.position = args[1]
591N/A self.errorstr = args[2]
591N/A
591N/A def __str__(self):
591N/A marker = " " * (4 + self.position) + "^"
591N/A if hasattr(self, "fmri") and self.fmri is not None:
873N/A return _("Malformed action in package '%(fmri)s' at "
873N/A "position: %(pos)d:\n %(action)s\n"
873N/A "%(marker)s") % { "fmri": self.fmri,
873N/A "pos": self.position, "action": self.actionstr,
873N/A "marker": marker }
873N/A return _("Malformed action at position: %(pos)d:\n "
873N/A "%(action)s\n%(marker)s") % { "pos": self.position,
873N/A "action": self.actionstr, "marker": marker }
873N/A
873N/A
873N/Aclass ActionDataError(ActionError):
873N/A """Used to indicate that a file-related error occuring during action
873N/A initialization."""
873N/A
873N/A def __init__(self, *args):
873N/A self.error = args[0]
873N/A
873N/A def __str__(self):
873N/A return str(self.error)
873N/A
873N/A
873N/Aclass InvalidActionError(ActionError):
873N/A """Used to indicate that attributes provided were invalid, or required
873N/A attributes were missing for an action."""
873N/A
873N/A def __init__(self, *args):
873N/A self.actionstr = args[0]
873N/A self.errorstr = args[1]
873N/A
873N/A def __str__(self):
873N/A if hasattr(self, "fmri") and self.fmri is not None:
873N/A return _("invalid action in package %(fmri)s: "
873N/A "%(action)s: %(error)s") % { "fmri": self.fmri,
873N/A "action": self.actionstr, "error": self.errorstr }
873N/A return _("invalid action, '%(action)s': %(error)s") % {
873N/A "action": self.actionstr, "error": self.errorstr }
873N/A
591N/A
591N/Afrom _actions import _fromstr
591N/A
1292N/Adef attrsfromstr(string):
1292N/A """Create an attribute dict given a string w/ key=value pairs.
1292N/A
1292N/A Raises MalformedActionError if the attributes have syntactic problems.
1292N/A """
1292N/A return _fromstr("bogus %s" % string)[2]
1292N/A
873N/Adef fromstr(string, data=None):
873N/A """Create an action instance based on a str() representation of an
873N/A action.
279N/A
591N/A Raises UnknownActionError if the action type is unknown.
591N/A Raises MalformedActionError if the action has other syntactic problems.
51N/A """
51N/A
873N/A atype, ahash, attr_dict = _fromstr(string)
873N/A
873N/A if atype not in types:
873N/A raise UnknownActionError(string, atype)
873N/A
873N/A action = types[atype](data=data, **attr_dict)
51N/A
873N/A ka = action.key_attr
873N/A if ka is not None and (ka not in action.attrs or
873N/A action.attrs[ka] is None):
873N/A raise InvalidActionError(string, _("required attribute '%s' "
873N/A "was not provided.") % ka)
542N/A
873N/A if ahash:
873N/A action.hash = ahash
57N/A
591N/A return action
57N/A
873N/Adef fromlist(type, args, hash=None, data=None):
279N/A """Create an action instance based on a sequence of "key=value" strings.
279N/A
591N/A Raises MalformedActionError if the attribute strings are malformed.
279N/A """
305N/A
873N/A if type not in types:
873N/A raise UnknownActionError(("%s %s" % (type,
873N/A " ".join(args))).strip(), type)
873N/A
305N/A attrs = {}
305N/A
305N/A try:
305N/A for a, v in [kv.split("=", 1) for kv in args]:
305N/A if v == '' or a == '':
591N/A kvi = args.index(kv) + 1
591N/A p1 = " ".join(args[:kvi])
591N/A p2 = " ".join(args[kvi:])
591N/A raise MalformedActionError(
591N/A "%s %s %s" % (type, p1, p2), len(p1) + 1,
591N/A "attribute '%s'" % kv)
57N/A
305N/A # This is by far the common case-- an attribute with
305N/A # a single value.
305N/A if a not in attrs:
305N/A attrs[a] = v
305N/A else:
305N/A av = attrs[a]
305N/A if isinstance(av, list):
305N/A attrs[a].append(v)
305N/A else:
305N/A attrs[a] = [ av, v ]
591N/A except ValueError:
305N/A # We're only here if the for: statement above throws a
591N/A # MalformedActionError. That can happen if split yields a
591N/A # single element, which is possible if e.g. an attribute lacks
591N/A # an =.
591N/A kvi = args.index(kv) + 1
591N/A p1 = " ".join(args[:kvi])
591N/A p2 = " ".join(args[kvi:])
591N/A raise MalformedActionError("%s %s %s" % (type, p1, p2),
591N/A len(p1) + 2, "attribute '%s'" % kv)
51N/A
873N/A action = types[type](data=data, **attrs)
873N/A
873N/A ka = action.key_attr
873N/A if ka is not None and (ka not in action.attrs or
873N/A action.attrs[ka] is None):
873N/A raise InvalidActionError(("%s %s" % (type,
873N/A " ".join(args))).strip(), _("required attribute, "
873N/A "'%s', was not provided.") % ka)
873N/A
131N/A if hash:
51N/A action.hash = hash
51N/A
51N/A return action