assetmodel.py 7.25 KB
Newer Older
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
# vim: set fileencoding=utf-8 :
###############################################################################
#                                                                             #
# Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.editor module of the BEAT platform.           #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform 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.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################

import os

28
from enum import Enum, unique
29

30
31
32
33
34
35
from PyQt5.QtCore import pyqtSignal
from PyQt5.QtCore import pyqtSlot
from PyQt5.QtCore import pyqtProperty
from PyQt5.QtCore import QStringListModel


36
@unique
37
class AssetType(Enum):
38
39
    """All possible assets available on the BEAT platform"""

40
    (
41
42
43
44
45
46
47
48
49
        UNKNOWN,
        ALGORITHM,
        DATABASE,
        DATAFORMAT,
        EXPERIMENT,
        LIBRARY,
        PLOTTER,
        PLOTTERPARAMETERS,
        TOOLCHAIN,
50
    ) = range(9)
51
52
53

    @classmethod
    def path(cls, type_):
54
        path = "unknown"
55
        if type_ == cls.ALGORITHM:
56
            path = "algorithms"
57
        elif type_ == cls.DATABASE:
58
            path = "databases"
59
        elif type_ == cls.DATAFORMAT:
60
            path = "dataformats"
61
        elif type_ == cls.EXPERIMENT:
62
            path = "experiments"
63
        elif type_ == cls.LIBRARY:
64
            path = "libraries"
65
        elif type_ == cls.PLOTTER:
66
            path = "plotters"
67
        elif type_ == cls.PLOTTERPARAMETERS:
68
            path = "plotterparameters"
69
        elif type_ == cls.TOOLCHAIN:
70
71
72
73
            path = "toolchains"

        return path

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
    @classmethod
    def from_path(cls, path):
        if path == "algorithms":
            return cls.ALGORITHM
        elif path == "databases":
            return cls.DATABASE
        elif path == "dataformats":
            return cls.DATAFORMAT
        elif path == "experiments":
            return cls.EXPERIMENT
        elif path == "libraries":
            return cls.LIBRARY
        elif path == "plotters":
            return cls.PLOTTER
        elif path == "plotterparameters":
            return cls.PLOTTERPARAMETERS
        elif path == "toolchains":
            return cls.TOOLCHAIN
        else:
            raise RuntimeError("Unknown asset path {}".format(path))

95

96
class AssetModel(QStringListModel):
97
98
99
100
101
102
103
104
105
106
    """The asset model present a list of available asset from a given type"""

    assetTypeChanged = pyqtSignal(AssetType)
    prefixPathChanged = pyqtSignal(str)

    def __init__(self, parent=None):
        """Constructor"""

        super(QStringListModel, self).__init__(parent)

107
        self.__prefix_path = None
108
        self.__asset_type = AssetType.UNKNOWN
109
110
111
112
113

    @pyqtSlot()
    def reload(self):
        """Loads the content regarding the asset property from the prefix"""

114
        if not self.__prefix_path or self.__asset_type == AssetType.UNKNOWN:
115
116
117
118
119
120
121
122
123
124
            return

        asset_folder = os.path.join(
            self.__prefix_path, AssetType.path(self.__asset_type)
        )
        asset_users = os.scandir(asset_folder)

        latest_assets_list = []
        for asset_user in asset_users:
            for asset_folder in os.scandir(asset_user):
125
                if self.asset_type == AssetType.EXPERIMENT:
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
                    for root, dirs, files in os.walk(asset_folder, topdown=False):
                        if dirs:
                            continue
                        anchor = "experiments/"
                        position = root.index(anchor) + len(anchor)
                        experiment_path = root[position:]
                        for json_file in [
                            file for file in files if file.endswith("json")
                        ]:
                            latest_assets_list.append(
                                "{experiment_path}/{name}".format(
                                    experiment_path=experiment_path,
                                    name=json_file.split(".")[0],
                                )
                            )
                else:
                    asset_items = os.scandir(asset_folder)
                    json_files = sorted(
                        [
                            item.name
                            for item in asset_items
                            if item.is_file() and item.name.endswith("json")
                        ]
                    )
                    if json_files:
                        latest_assets_list.append(
                            "{user}/{name}/{version}".format(
                                user=asset_user.name,
                                name=asset_folder.name,
                                version=json_files[-1].split(".")[0],
                            )
                        )

        self.setStringList(sorted(latest_assets_list))

    def assetType(self):
        """Returns the asset type of this model

        :return: Asset type of this model
        """

        return self.__asset_type

    def setAssetType(self, type_):
        """Set the asset type of this model

        :param AssetType type_: Asset type this model should show
        """

        if self.__asset_type == type_:
            return

        self.__asset_type = type_
        self.reload()
        self.assetTypeChanged.emit(type_)

    asset_type = pyqtProperty(
        AssetType, fget=assetType, fset=setAssetType, notify=assetTypeChanged
    )

    def prefixPath(self):
        """Returns the prefix path use by this model

        :return: the prefix path used
        """

        return self.__prefix_path

    def setPrefixPath(self, path):
        """Set the prefix path use by this model

        :param str path: Path to prefix
        """

        if self.__prefix_path == path:
            return

        self.__prefix_path = path
        self.reload()
        self.prefixPathChanged.emit(path)

    prefix_path = pyqtProperty(
        str, fget=prefixPath, fset=setPrefixPath, notify=prefixPathChanged
    )