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
|
# Copyright (c) 2019 Ultimaker B.V.
# Uranium is released under the terms of the LGPLv3 or higher.
from enum import Enum
from typing import List
from UM.PluginObject import PluginObject
class FileReader(PluginObject):
class PreReadResult(Enum):
"""Used as the return value of FileReader.preRead."""
# The user has accepted the configuration dialog or there is no configuration dialog.
# The plugin should load the data.
accepted = 1
# The user has cancelled the dialog so don't load the data.
cancelled = 2
# preRead has failed and no further processing should happen.
failed = 3
def __init__(self) -> None:
super().__init__()
self._supported_extensions = [] # type: List[str]
def acceptsFile(self, file_name):
"""Returns true if file_name can be processed by this plugin.
:return: boolean indication if this plugin accepts the file specified.
"""
file_name_lower = file_name.lower()
is_supported = False
for extension in self._supported_extensions:
if file_name_lower.endswith(extension):
is_supported = True
return is_supported
def preRead(self, file_name, *args, **kwargs):
"""Executed before reading the file. This is used, for example, to display an import
configuration dialog. If a plugin displays such a dialog,
this function should block until it has been closed.
:return: indicating if the user accepted or canceled the dialog.
"""
return FileReader.PreReadResult.accepted
def read(self, file_name):
"""Read mesh data from file and returns a node that contains the data
:return: data read.
"""
raise NotImplementedError("Reader plugin was not correctly implemented, no read was specified")
def emptyFileHintSet(self):
""" Some files can be perfectly valid, but empty. It's useful to separate these cases separately (in UX).
The default result of this is false, meaning that an empty file of a plugin that doesn't override this
will result in the user getting shown a less specific error.
:return: Might be true if the file is empty but otherwise valid, but can default to false in any case.
"""
return False
|
