/usr/share/pyshared/schooltool/traverser/metadirectives.py is in python-schooltool 1:2.1.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | #
# SchoolTool - common information systems platform for school administration
# Copyright (c) 2008 Shuttleworth Foundation
#
# 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
#
"""
SchoolTool traverser metadirectives.
"""
from zope.security.zcml import Permission
from zope.schema import TextLine
from zope.interface import Interface
from zope.configuration.fields import GlobalObject, GlobalInterface
class ITraverser(Interface):
for_ = GlobalInterface(
title=u"The interface this traverser is for.",
required=True,
)
type = GlobalInterface(
title=u"Request type",
required=True,
)
factory = GlobalObject(
title=u"The pluggable traverser implementation.",
required=True,
)
permission = Permission(
title=u"Permission",
description=u"The permission needed to use the view.",
required=False,
)
provides = GlobalInterface(
title=u"Interface the component provides",
required=False,
)
class IPluggableTraverser(ITraverser):
factory = GlobalObject(
title=u"The pluggable traverser implementation.",
required=False,
)
class ITraverserPluginBase(Interface):
for_ = GlobalObject(
title=u"The interface this plugin is for.",
required=True,
)
layer = GlobalObject(
title=u"The layer the plugin is declared for",
required=False,
)
name = TextLine(
title=u"The name the traverser will be traversing into.",
required=False,
)
permission = Permission(
title=u"Permission",
required=False,
)
class ITraverserPlugin(ITraverserPluginBase):
"""Traverser plugin zcml directive."""
plugin = GlobalObject(
title=u"The plugin that does the traversal.",
required=True,
)
class INamedTraverserPlugin(ITraverserPluginBase):
"""A simple safeguard against rogue generic traversers.
Make traversal name mandatory.
"""
name = TextLine(
title=u"The name the traverser will be traversing into.",
required=True,
)
class INullTraverserPlugin(INamedTraverserPlugin):
"""Null traverser plugin zcml directive.
The traverser returns the context.
"""
class IAttributeTraverserPlugin(INamedTraverserPlugin):
"""Attribute traverser plugin zcml directive.
Traverses to an attribute of the context.
"""
class IAdapterTraverserPlugin(INamedTraverserPlugin):
"""Adapter traverser plugin zcml directive.
Adapts context to the given interface.
"""
adapter = GlobalObject(
title=u"The interface this plugin will be adapting to.",
required=True,
)
adapter_name = TextLine(
title=u"Adapter name to use when adapting to given interface.",
required=False,
)
|