Source code for stalker.models.note
# -*- coding: utf-8 -*-
# Stalker a Production Asset Management System
# Copyright (C) 2009-2017 Erkan Ozgur Yilmaz
#
# This file is part of Stalker.
#
# Stalker is free software: you can redistribute it and/or modify
# it under the terms of the Lesser GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License.
#
# Stalker 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
# Lesser GNU General Public License for more details.
#
# You should have received a copy of the Lesser GNU General Public License
# along with Stalker. If not, see <http://www.gnu.org/licenses/>
from sqlalchemy import Column, Integer, ForeignKey
from sqlalchemy.orm import synonym
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
)
content = synonym(
'description',
doc="""The content of this :class:`.Note` instance.
Content is a string representing the content of this Note, can be an
empty.
"""
)
def __init__(self, content="", **kwargs):
super(Note, self).__init__(**kwargs)
self.content = content
def __eq__(self, other):
"""the equality operator
"""
return super(Note, self).__eq__(other) and \
isinstance(other, Note) and \
self.content == other.content
def __hash__(self):
"""the overridden __hash__ method
"""
return super(Note, self).__hash__()