# =============================================================================
# ____ _ _ ____ _
# _ __ _ _ / ___| | | | _ \| |
# | '_ \| | | | | _| |_| | | | | |
# | |_) | |_| | |_| | _ | |_| | |___
# | .__/ \__, |\____|_| |_|____/|_____|
# |_| |___/
# =============================================================================
# Authors: Tristan Gingold
# Patrick Lehmann
# Unai Martinez-Corral
#
# Package package: Python binding for GHDL and high-level APIs.
#
# License:
# ============================================================================
# Copyright (C) 2019-2020 Tristan Gingold
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <gnu.org/licenses>.
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
"""
.. _python_interface:
GHDL offers two Python interfaces and a language server protocol service. All
this is provided from a ``pyGHDL`` packages with four sub-packages:
* :mod:`pyGHDL.cli` - Command line interface (CLI) applications.
* :mod:`pyGHDL.dom` - A high-level API offering a document object model (DOM).
The underlying abstract VHDL language model is provided by :doc:`pyVHDLModel <vhdlmodel:index>`.
The DOM is using ``libghdl`` for file analysis and parsing.
* :mod:`pyGHDL.libghdl` - A low-level API directly interacting with the shared library ``libghdl....so``/``libghdl....dll``.
This is a procedural and C-like interface. It comes with some Python generators for easier iterating linked lists.
* :mod:`pyGHDL.lsp` - A :wikipedia:`language server protocol <Language_Server_Protocol>` (LSP)
written in Python. The implementation offers an HTTPS service that can be used e.g. by editors and IDEs supporting LSP.
"""
__version__ = "7.0.0-dev"
__author__ = "Tristan Gingold and contributors"
__email__ = "tgingold@free.fr"
__copyright__ = "2002-2024, Tristan Gingold and contributors"
__license__ = "GNU General Public License v2"
__keywords__ = ["vhdl", "parser", "compiler", "simulator", "ghdl"]
from typing import Tuple
from pyTooling.Decorators import export, readonly
[docs]
@export
class GHDLBaseException(Exception):
"""Base exception derived from :exc:`Exception <python:Exception>` for all custom exceptions."""
_message: str
def __init__(self, message: str = "") -> None:
"""
GHDLBaseException initializer.
:param message: The exception message.
"""
super().__init__()
self._message = message
@readonly
def HasNotes(self) -> bool:
"""
Read-only property to return if the exception has attached notes.
:returns: ``True``, if the exception has attached notes.
"""
return hasattr(self, "__notes__") and self.__notes__ is not None and len(self.__notes__) > 0
@readonly
def Notes(self) -> Tuple[str, ...]:
"""
Read-only property to return the exception's attached notes.
:returns: Attached notes.
"""
return tuple(self.__notes__) if hasattr(self, "__notes__") else tuple()
@readonly
def message(self) -> str:
"""
Returns the exception's message.
:returns: Exception message.
"""
return self._message
def __str__(self) -> str:
"""
Returns the exception's message.
:returns: Exception message.
"""
return self._message
def with_traceback(self, tb) -> None:
super().with_traceback(tb)