summaryrefslogtreecommitdiff
path: root/portato/eix/__init__.py
blob: ed86ec5504cdfe5d79d70a3fe6ef0413a32c1386 (plain)
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
# -*- coding: utf-8 -*-
#
# File: portato/eix/__init__.py
# This file is part of the Portato-Project, a graphical portage-frontend.
#
# Copyright (C) 2006-2010 René 'Necoro' Neumann
# This is free software.  You may redistribute copies of it under the terms of
# the GNU General Public License version 2.
# There is NO WARRANTY, to the extent permitted by law.
#
# Written by René 'Necoro' Neumann <necoro@necoro.net>

"""
A module to parse the eix-cache files.
"""

__docformat__ = "restructuredtext"

from . import parser
from .exceptions import UnsupportedVersionError

from ..helper import debug

class EixReader(object):
    """
    The main class to use to have access to the eix-cache.

    Note that the file used internally stays open during the whole operation.
    So please call `close()` when you are finished.

    The ``EixReader`` supports the context manager protocol, so you can the ``with ... as ...``.

    :CVariables:

        supported_versions : int[]
            The list of versions of the eix-cache, which are supported by this reader.

    :IVariables:

        file : file
            The eix cache file.

        header : `parser.header`
            The header of the eix cache.

        categories : `parser.category` []
            The list of categories.
    """

    supported_versions = (28,)
        
    def __init__ (self, filename):
        """
        :param filename: Path to the cache file
        :type filename: string
        """

        self.file = open(filename, "r")
        
        try:
            version = parser.number(self.file)

            if version not in self.supported_versions:
                raise UnsupportedVersionError(self.version)

            debug("Started EixReader for version %s.", version)

            self.file.seek(0)

            self.header = parser.header(self.file)
            self.categories = parser.vector(self.file, parser.category, nelems = self.header.ncats)
        except:
            self.close()
            raise

    def __enter__ (self):
        return self

    def __exit__ (self, exc_type, exc_val, exc_tb):
        self.close()

    def close (self):
        """
        Closes the cache file.
        """
        self.file.close()
        debug("EixReader closed.")