~launchpad-pqm/launchpad/devel

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
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

# pylint: disable-msg=E0211,E0213

"""Section interfaces."""

__metaclass__ = type

__all__ = [
    'ISection',
    'ISectionSelection',
    'ISectionSet',
    ]


from zope.interface import (
    Attribute,
    Interface,
    )


class ISection(Interface):
    """Represents the Section table.

    A distribution section represents a tag that groups related
    packages. Examples in Ubuntu include 'editors', 'x11' and 'net'.
    """

    id = Attribute("The section ID")
    name = Attribute("The section name")


class ISectionSelection(Interface):
    """Represents the allowed section within a DistroSeries."""
    id = Attribute("The ID")
    distroseries = Attribute("Target DistroSeries")
    section = Attribute("Selected Section")


class ISectionSet(Interface):
    """Represents a set of Sections."""

    def __iter__():
        """Iterate over section."""

    def __getitem__(name):
        """Retrieve a section by name"""

    def get(section_id):
        """Return the ISection with the given section_id."""

    def ensure(name):
        """Ensure the existence of a section with a given name."""

    def new(name):
        """Create a new section."""