Source code for aiida.orm.implementation.sqlalchemy.comments
# -*- coding: utf-8 -*-
###########################################################################
# Copyright (c), The AiiDA team. All rights reserved. #
# This file is part of the AiiDA code. #
# #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida_core #
# For further information on the license, see the LICENSE.txt file #
# For further information please visit http://www.aiida.net #
###########################################################################
"""Sqla implementations for the Comment entity and collection."""
from __future__ import division
from __future__ import print_function
from __future__ import absolute_import
# pylint: disable=import-error,no-name-in-module,fixme
from datetime import datetime
from aiida.backends.sqlalchemy import get_scoped_session
from aiida.backends.sqlalchemy.models import comment as models
from aiida.common import exceptions
from aiida.common import lang
from ..comments import BackendComment, BackendCommentCollection
from . import entities
from . import users
from . import utils
[docs]class SqlaComment(entities.SqlaModelEntity[models.DbComment], BackendComment):
"""Comment implementation for Sqla."""
MODEL_CLASS = models.DbComment
# pylint: disable=too-many-arguments
[docs] def __init__(self, backend, node, user, content=None, ctime=None, mtime=None):
"""
Construct a SqlaComment.
:param node: a Node instance
:param user: a User instance
:param content: the comment content
:param ctime: The creation time as datetime object
:param mtime: The modification time as datetime object
:return: a Comment object associated to the given node and user
"""
super(SqlaComment, self).__init__(backend)
lang.type_check(user, users.SqlaUser) # pylint: disable=no-member
arguments = {
'dbnode': node.dbmodel,
'user': user.dbmodel,
'content': content,
}
if ctime:
lang.type_check(ctime, datetime, 'the given ctime is of type {}'.format(type(ctime)))
arguments['ctime'] = ctime
if mtime:
lang.type_check(mtime, datetime, 'the given mtime is of type {}'.format(type(mtime)))
arguments['mtime'] = mtime
self._dbmodel = utils.ModelWrapper(models.DbComment(**arguments))
[docs] def store(self):
"""Can only store if both the node and user are stored as well."""
if self._dbmodel.dbnode.id is None or self._dbmodel.user.id is None:
self._dbmodel.dbnode = None
raise exceptions.ModificationNotAllowed('The corresponding node and/or user are not stored')
super(SqlaComment, self).store()
@property
def ctime(self):
return self._dbmodel.ctime
@property
def mtime(self):
return self._dbmodel.mtime
@property
def node(self):
return self.backend.nodes.from_dbmodel(self.dbmodel.dbnode)
@property
def user(self):
return self.backend.users.from_dbmodel(self.dbmodel.user)
@property
def content(self):
return self._dbmodel.content
[docs]class SqlaCommentCollection(BackendCommentCollection):
"""SqlAlchemy implementation for the CommentCollection."""
[docs] def create(self, node, user, content=None, **kwargs):
"""
Create a Comment for a given node and user
:param node: a Node instance
:param user: a User instance
:param content: the comment content
:return: a Comment object associated to the given node and user
"""
return SqlaComment(self.backend, node, user, content, **kwargs)
[docs] def delete(self, comment):
"""
Remove a Comment from the collection with the given id
:param comment: the id of the comment to delete
"""
# pylint: disable=no-name-in-module,import-error
from sqlalchemy.orm.exc import NoResultFound
session = get_scoped_session()
try:
session.query(models.DbComment).filter_by(id=comment).one().delete()
session.commit()
except NoResultFound:
raise exceptions.NotExistent("Comment with id '{}' not found".format(comment))