# ==================================================================================================================== #
# _ _ _ #
# ___ _ __ | |__ (_)_ __ __ __ _ __ ___ _ __ ___ _ __| |_ ___ #
# / __| '_ \| '_ \| | '_ \\ \/ /____| '__/ _ \ '_ \ / _ \| '__| __/ __| #
# \__ \ |_) | | | | | | | |> <_____| | | __/ |_) | (_) | | | |_\__ \ #
# |___/ .__/|_| |_|_|_| |_/_/\_\ |_| \___| .__/ \___/|_| \__|___/ #
# |_| |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2023-2024 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
**Helper functions and derived classes from Sphinx.**
"""
from re import match as re_match
from typing import Optional as Nullable, Tuple, List, Dict
from docutils import nodes
from pyTooling.Decorators import export
from sphinx.directives import ObjectDescription
from sphinx_reports.Common import ReportExtensionError, LegendPosition
[docs]
@export
def strip(option: str) -> str:
return option.strip().lower()
[docs]
@export
class BaseDirective(ObjectDescription):
has_content: bool = False
"""
A boolean; ``True`` if content is allowed.
Client code must handle the case where content is required but not supplied (an empty content list will be supplied).
"""
required_arguments = 0
"""Number of required directive arguments."""
optional_arguments = 0
"""Number of optional arguments after the required arguments."""
final_argument_whitespace = False
"""A boolean, indicating if the final argument may contain whitespace."""
option_spec = {}
"""
Mapping of option names to validator functions.
A dictionary, mapping known option names to conversion functions such as :class:`int` or :class:`float`
(default: {}, no options). Several conversion functions are defined in the ``directives/__init__.py`` module.
Option conversion functions take a single parameter, the option argument (a string or :class:`None`), validate it
and/or convert it to the appropriate form. Conversion functions may raise :exc:`ValueError` and
:exc:`TypeError` exceptions.
"""
directiveName: str
def _ParseBooleanOption(self, optionName: str, default: Nullable[bool] = None) -> bool:
try:
option = self.options[optionName]
except KeyError as ex:
if default is not None:
return default
else:
raise ReportExtensionError(f"{self.directiveName}: Required option '{optionName}' not found for directive.") from ex
if option in ("yes", "true"):
return True
elif option in ("no", "false"):
return False
else:
raise ReportExtensionError(f"{self.directiveName}::{optionName}: '{option}' not supported for a boolean value (yes/true, no/false).")
def _ParseStringOption(self, optionName: str, default: Nullable[str] = None, regexp: str = "\\w+") -> str:
try:
option: str = self.options[optionName]
except KeyError as ex:
if default is not None:
return default
else:
raise ReportExtensionError(f"{self.directiveName}: Required option '{optionName}' not found for directive.") from ex
if re_match(regexp, option):
return option
else:
raise ReportExtensionError(f"{self.directiveName}::{optionName}: '{option}' not an accepted value for regexp '{regexp}'.")
def _ParseLegendOption(self, optionName: str, default: Nullable[LegendPosition] = None) -> LegendPosition:
try:
option = self.options[optionName].lower()
except KeyError as ex:
if default is not None:
return default
else:
raise ReportExtensionError(f"{self.directiveName}: Required option '{optionName}' not found for directive.") from ex
try:
return LegendPosition[option]
except KeyError as ex:
raise ReportExtensionError(f"{self.directiveName}::{optionName}: Value '{option}' is not a valid member of 'LegendPosition'.") from ex
def _PrepareTable(self, columns: List[Tuple[str, Nullable[List[Tuple[str, int]]], Nullable[int]]], identifier: str, classes: List[str]) -> Tuple[nodes.table, nodes.tgroup]:
table = nodes.table("", identifier=identifier, classes=classes)
hasSecondHeaderRow = False
columnCount = 0
for groupColumn in columns:
if groupColumn[1] is not None:
columnCount += len(groupColumn[1])
hasSecondHeaderRow = True
else:
columnCount += 1
tableGroup = nodes.tgroup(cols=columnCount)
table += tableGroup
# Setup column specifications
for _, more, width in columns:
if more is None:
tableGroup += nodes.colspec(colwidth=width)
else:
for _, width in more:
tableGroup += nodes.colspec(colwidth=width)
# Setup primary header row
headerRow = nodes.row()
for columnTitle, more, _ in columns:
if more is None:
headerRow += nodes.entry("", nodes.paragraph(text=columnTitle), morerows=1)
else:
morecols = len(more) - 1
headerRow += nodes.entry("", nodes.paragraph(text=columnTitle), morecols=morecols)
for i in range(morecols):
headerRow += None
tableHeader = nodes.thead("", headerRow)
tableGroup += tableHeader
# If present, setup secondary header row
if hasSecondHeaderRow:
tableRow = nodes.row()
for columnTitle, more, _ in columns:
if more is None:
tableRow += None
else:
for columnTitle, _ in more:
tableRow += nodes.entry("", nodes.paragraph(text=columnTitle))
tableHeader += tableRow
return table, tableGroup