diff --git a/src/caosdb/common/models.py b/src/caosdb/common/models.py index 8f7a73d85bba41fc2c07c8f675ac659180d29194..9a94bf96590cb8c7f479c2bdadfeb8dc7db3ebb7 100644 --- a/src/caosdb/common/models.py +++ b/src/caosdb/common/models.py @@ -32,8 +32,8 @@ All additional classes are either important for the entities or the transactions. """ -from __future__ import print_function, unicode_literals from __future__ import annotations # Can be removed with 3.10. +from __future__ import print_function, unicode_literals import re import sys @@ -51,8 +51,8 @@ from warnings import warn from caosdb.common.datatype import (BOOLEAN, DATETIME, DOUBLE, INTEGER, TEXT, is_list_datatype, is_reference) from caosdb.common.state import State -from caosdb.common.utils import uuid, xml2str from caosdb.common.timezone import TimeZone +from caosdb.common.utils import uuid, xml2str from caosdb.common.versioning import Version from caosdb.configuration import get_config from caosdb.connection.connection import get_connection @@ -112,7 +112,7 @@ class Entity: self.__datatype = None self.datatype = datatype self.value = value - self.messages = _Messages() + self.messages = Messages() self.properties = _Properties() self.parents = _ParentList() self.path = None @@ -419,7 +419,7 @@ class Entity: self.acl.is_permitted(permission=permission) def get_all_messages(self): - ret = _Messages() + ret = Messages() ret.append(self.messages) for p in self.properties: @@ -1056,7 +1056,7 @@ out: List[Entity] def get_messages(self): """Get all messages of this entity. - @return: _Messages(list) + @return: Messages(list) """ return self.messages @@ -1064,9 +1064,9 @@ out: List[Entity] def get_warnings(self): """Get all warning messages of this entity. - @return _Messages(list): Warning messages. + @return Messages(list): Warning messages. """ - ret = _Messages() + ret = Messages() for m in self.messages: if m.type.lower() == "warning": @@ -1077,9 +1077,9 @@ out: List[Entity] def get_errors(self): """Get all error messages of this entity. - @return _Messages(list): Error messages. + @return Messages(list): Error messages. """ - ret = _Messages() + ret = Messages() for m in self.messages: if m.type.lower() == "error": @@ -1599,7 +1599,7 @@ class QueryTemplate(): self._cuid = None self.value = None self.datatype = None - self.messages = _Messages() + self.messages = Messages() self.properties = None self.parents = None self.path = None @@ -1719,7 +1719,7 @@ class QueryTemplate(): return self.id is not None def get_errors(self): - ret = _Messages() + ret = Messages() for m in self.messages: if m.type.lower() == "error": @@ -2417,21 +2417,21 @@ class Messages(list): and the same code (or no code). Every message MUST NOT occur more than once per entity (to which the message in question belongs). - If a message m2 is added while a messages m1 is already in this _Message object m2 will + If a message m2 is added while a messages m1 is already in this Message object m2 will OVERRIDE m1. Error, warning, and info messages will be deleted before any transaction. Examples: - <<< msgs = _Messages() + <<< msgs = Messages() <<< # create Message <<< msg = Message(type="HelloWorld", code=1, description="Greeting the world", body="Hello, world!") - <<< # append it to the _Messages + <<< # append it to the Messages <<< msgs.append(msg) - <<< # use _Messages as list of Message objects + <<< # use Messages as list of Message objects <<< for m in msgs: ... assert isinstance(m,Message) @@ -2493,7 +2493,7 @@ class Messages(list): else: raise TypeError( "('type', 'code'), ('type'), or 'type' expected.") - elif isinstance(key, _Messages._msg_key): + elif isinstance(key, Messages._msg_key): type = key._type # @ReservedAssignment code = key._code else: @@ -2576,7 +2576,7 @@ class Messages(list): super().extend(messages) def append(self, msg): - if isinstance(msg, _Messages) or isinstance(msg, list): + if isinstance(msg, Messages) or isinstance(msg, list): warn("Supplying a list-like object to append is deprecated. Please use extend" " instead.", DeprecationWarning) for m in msg: @@ -2605,7 +2605,7 @@ class Messages(list): @staticmethod def get(msg): - return _Messages._msg_key(msg.type, msg.code) + return Messages._msg_key(msg.type, msg.code) def __eq__(self, obj): return self.__hash__() == obj.__hash__() @@ -2827,7 +2827,7 @@ class Container(list): list.__init__(self) self._timestamp = None self._srid = None - self.messages = _Messages() + self.messages = Messages() def extend(self, entities): """Extend this Container by appending all single entities in the given @@ -2920,11 +2920,11 @@ class Container(list): def get_errors(self): """Get all error messages of this container. - @return _Messages: Error messages. + @return Messages: Error messages. """ if self.has_errors(): - ret = _Messages() + ret = Messages() for m in self.messages: if m.type.lower() == "error": @@ -2937,11 +2937,11 @@ class Container(list): def get_warnings(self): """Get all warning messages of this container. - @return _Messages: Warning messages. + @return Messages: Warning messages. """ if self.has_warnings(): - ret = _Messages() + ret = Messages() for m in self.messages: if m.type.lower() == "warning": @@ -2952,7 +2952,7 @@ class Container(list): return None def get_all_messages(self): - ret = _Messages() + ret = Messages() for e in self: ret.extend(e.get_all_messages()) @@ -4302,7 +4302,7 @@ class Query(): The query string. flags : dict of str A dictionary of flags to be send with the query request. - messages : _Messages() + messages : Messages() A container of messages included in the last query response. cached : bool indicates whether the server used the query cache for the execution of @@ -4325,7 +4325,7 @@ class Query(): def __init__(self, q): self.flags = dict() - self.messages = _Messages() + self.messages = Messages() self.cached = None self.etag = None @@ -4496,7 +4496,7 @@ class UserInfo(): class Info(): def __init__(self): - self.messages = _Messages() + self.messages = Messages() self.sync() def sync(self):