Source code for stalker.models.note

# -*- coding: utf-8 -*-
# Stalker a Production Asset Management System
# Copyright (C) 2009-2013 Erkan Ozgur Yilmaz
# 
# This file is part of Stalker.
# 
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation;
# version 2.1 of the License.
# 
# This library 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.  See the GNU
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA

from sqlalchemy import Column, Integer, ForeignKey, String
from sqlalchemy.orm import validates
from stalker.models.entity import SimpleEntity

from stalker.log import logging_level
import logging
logger = logging.getLogger(__name__)
logger.setLevel(logging_level)

[docs]class Note(SimpleEntity): """Notes for any of the SOM objects. To leave notes in Stalker use the Note class. :param content: the content of the note :param attached_to: The object that this note is attached to. """ __auto_name__ = True __tablename__ = "Notes" __mapper_args__ = {"polymorphic_identity": "Note"} note_id = Column( "id", Integer, ForeignKey("SimpleEntities.id"), primary_key=True ) entity_id = Column( "entity_id", Integer, ForeignKey("Entities.id") ) content = Column( String, doc="""The content of this :class:`~stalker.models.note.Note` instance. Content is a string representing the content of this Note, can be given as an empty string or can be even None, but anything other than None or string or unicode will raise a TypeError. """ )
[docs] def __init__(self, content="", **kwargs): super(Note, self).__init__(**kwargs) self.content = content
@validates("content") def _validate_content(self, key, content_in): """validates the given content """ if content_in is not None and\ not isinstance(content_in, (str, unicode)): raise TypeError("%s.content should be an instance of string or " "unicode not %s" % (self.__class__.__name__, content_in.__class__.__name__)) return content_in def __eq__(self, other): """the equality operator """ return super(Note, self).__eq__(other) and\ isinstance(other, Note) and\ self.content == other.content