| # SPDX-License-Identifier: BSD-3-Clause | |
| # Copyright (c) 2011, Thomas Paviot (tpaviot@gmail.com) | |
| # All rights reserved. | |
| # This file is part of the StepClassLibrary (SCL). | |
| # | |
| # Redistribution and use in source and binary forms, with or without | |
| # modification, are permitted provided that the following conditions are met: | |
| # | |
| # Redistributions of source code must retain the above copyright notice, | |
| # this list of conditions and the following disclaimer. | |
| # | |
| # Redistributions in binary form must reproduce the above copyright notice, | |
| # this list of conditions and the following disclaimer in the documentation | |
| # and/or other materials provided with the distribution. | |
| # | |
| # Neither the name of the <ORGANIZATION> nor the names of its contributors may | |
| # be used to endorse or promote products derived from this software without | |
| # specific prior written permission. | |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| # ARE DISCLAIMED. | |
| # IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY | |
| # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
| # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
| # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | |
| # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
| # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| class BaseEntityClass(object): | |
| """A class that allows advanced __repr__ features for entity instances""" | |
| def __repr__(self): | |
| """Displays attribute with their values""" | |
| doc_string = "# %s class description:\n%s\n# Instance attributes:\n" % ( | |
| self.__class__, | |
| self.__doc__, | |
| ) | |
| # write each argument with its value | |
| properties = dir(self) | |
| for elem in properties: | |
| if not elem.startswith("_"): | |
| doc_string += "\t%s:%s\n" % (elem, self.__getattribute__(elem)) | |
| return doc_string | |