1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
|
from __future__ import annotations
import os
from typing import TYPE_CHECKING, Any
from docutils.parsers.rst import directives
if TYPE_CHECKING:
from sphinx_needs.data import GraphvizStyleType
DEFAULT_DIAGRAM_TEMPLATE = """
{%- if is_need -%}
<size:12>{{type_name}}</size>\\n**{{title|wordwrap(15, wrapstring='**\\\\n**')}}**\\n<size:10>{{id}}</size>
{%- else -%}
<size:12>{{type_name}} (part)</size>\\n**{{content|wordwrap(15, wrapstring='**\\\\n**')}}**\\n<size:10>{{id_parent}}.**{{id}}**</size>
{%- endif -%}
"""
LAYOUT_COMMON_SIDE = {
"side": ['<<image("field:image", align="center")>>'],
"head": [
'<<meta("type_name")>>: **<<meta("title")>>** <<meta_id()>> '
'<<collapse_button("meta", collapsed="icon:arrow-down-circle", visible="icon:arrow-right-circle", initial=False)>> '
],
"meta": ["<<meta_all(no_links=True)>>", "<<meta_links_all()>>"],
}
LAYOUTS = {
"test": {
"grid": "simple",
"layout": {
"head": [
'<<meta("type_name")>>: **<<meta("title")>>** <<meta_id()>> <<collapse_button("meta", '
'collapsed="icon:arrow-down-circle", visible="icon:arrow-right-circle", initial=False)>> '
],
"meta": ["<<meta_all(no_links=True)>>", "<<meta_links_all()>>"],
},
},
"clean": {
"grid": "simple",
"layout": {
"head": [
'<<meta("type_name")>>: **<<meta("title")>>** <<meta_id()>> <<collapse_button("meta", '
'collapsed="icon:arrow-down-circle", visible="icon:arrow-right-circle", initial=False)>> '
],
"meta": ["<<meta_all(no_links=True)>>", "<<meta_links_all()>>"],
},
},
"clean_l": {"grid": "simple_side_left", "layout": LAYOUT_COMMON_SIDE},
"clean_lp": {"grid": "simple_side_left_partial", "layout": LAYOUT_COMMON_SIDE},
"clean_r": {"grid": "simple_side_right", "layout": LAYOUT_COMMON_SIDE},
"clean_rp": {"grid": "simple_side_right_partial", "layout": LAYOUT_COMMON_SIDE},
"complete": {
"grid": "complex",
"layout": {
"head_left": [
"<<meta_id()>>",
],
"head": [
'<<meta("title")>>',
],
"head_right": ['<<meta("type_name")>>'],
"meta_left": ['<<meta_all(no_links=True, exclude=["layout","style"])>>'],
"meta_right": ["<<meta_links_all()>>"],
"footer_left": [
'layout: <<meta("layout")>>',
],
"footer": [],
"footer_right": ['style: <<meta("style")>>'],
},
},
"focus": {"grid": "content", "layout": {}},
"focus_f": {"grid": "content_footer", "layout": {"footer": ["<<meta_id()>>"]}},
"focus_l": {"grid": "content_side_left", "layout": {"side": ["<<meta_id()>>"]}},
"focus_r": {"grid": "content_side_right", "layout": {"side": ["<<meta_id()>>"]}},
"debug": {
"grid": "simple",
"layout": {
"head": [
'<<meta_id()>> **<<meta("title")>>**',
'**<<collapse_button("meta", collapsed="Debug view on", visible="Debug view off", initial=True)>>**',
],
"meta": ["<<meta_all(exclude=[], defaults=False, show_empty=True)>>"],
},
},
}
NEEDFLOW_CONFIG_DEFAULTS = {
"mixing": """
allowmixing
""",
"monochrome": """
skinparam monochrome true
""",
"handwritten": """
skinparam handwritten true
""",
"lefttoright": """
left to right direction
""",
"toptobottom": """
top to bottom direction
""",
"transparent": """
skinparam backgroundcolor transparent
""",
"tne": """
' Based on "Tomorrow night eighties" color theme (see https://github.com/chriskempson/tomorrow-theme)
' Provided by gabrieljoelc (https://github.com/gabrieljoelc/plantuml-themes)
!define Background #2d2d2d
!define CurrentLine #393939
!define Selection #515151
!define Foregound #cccccc
!define Comment #999999
!define Red #f2777a
!define Orange #f99157
!define Yellow #ffcc66
!define Green #99cc99
!define Aqua #66cccc
!define Blue #6699cc
!define Purple #cc99cc
skinparam Shadowing false
skinparam backgroundColor #2d2d2d
skinparam Arrow {
Color Foregound
FontColor Foregound
FontStyle Bold
}
skinparam Default {
FontName Menlo
FontColor #fdfdfd
}
skinparam package {
FontColor Purple
BackgroundColor CurrentLine
BorderColor Selection
}
skinparam node {
FontColor Yellow
BackgroundColor CurrentLine
BorderColor Selection
}
skinparam component {
BackgroundColor Selection
BorderColor Blue
FontColor Blue
Style uml2
}
skinparam database {
BackgroundColor CurrentLine
BorderColor Selection
FontColor Orange
}
skinparam cloud {
BackgroundColor CurrentLine
BorderColor Selection
}
skinparam interface {
BackgroundColor CurrentLine
BorderColor Selection
FontColor Green
}
""",
"cplant": """
' CPLANT by AOKI (https://github.com/aoki/cplant)
!define BLACK #363D5D
!define RED #F6363F
!define PINK #F6216E
!define MAGENTA #A54FBD
!define GREEN #37A77C
!define YELLOW #F97A00
!define BLUE #1E98F2
!define CYAN #25AFCA
!define WHITE #FEF2DC
' Base Setting
skinparam Shadowing false
skinparam BackgroundColor transparent
skinparam ComponentStyle uml2
skinparam Default {
FontName 'Hiragino Sans'
FontColor BLACK
FontSize 10
FontStyle plain
}
skinparam Sequence {
ArrowThickness 1
ArrowColor RED
ActorBorderThickness 1
LifeLineBorderColor GREEN
ParticipantBorderThickness 0
}
skinparam Participant {
BackgroundColor BLACK
BorderColor BLACK
FontColor #FFFFFF
}
skinparam Actor {
BackgroundColor BLACK
BorderColor BLACK
}
""",
}
GRAPHVIZ_STYLE_DEFAULTS: dict[str, GraphvizStyleType] = {
"default": {
"node": {
"margin": "0.21,0.11",
},
"edge": {
"minlen": "2",
},
},
"lefttoright": {
"graph": {
"rankdir": "LR",
}
},
"toptobottom": {
"graph": {
"rankdir": "TB",
}
},
"transparent": {
"graph": {
"bgcolor": "transparent",
}
},
}
TITLE_REGEX = r'([^\s]+) as "([^"]+)"'
def string_to_boolean(argument: str | None) -> bool | None:
"""Convert a string (from a directive option) to a boolean.
The value can be one of case-insensitive "true"/"false" or "yes"/"no",
or the empty string also evaluates to True.
:raises ValueError: If the value is not a valid flag or case-insensitive true/false/yes/no.
"""
if argument is None:
return True
if argument.upper() in ["", "TRUE", "YES"]:
return True
if argument.upper() in ["FALSE", "NO"]:
return False
raise ValueError("not a flag or case-insensitive true/false/yes/no")
NEED_DEFAULT_OPTIONS: dict[str, Any] = {
"id": directives.unchanged_required,
"status": directives.unchanged_required,
"tags": directives.unchanged_required,
"links": directives.unchanged_required,
"collapse": string_to_boolean,
"delete": string_to_boolean,
"jinja_content": string_to_boolean,
"hide": directives.flag,
"title_from_content": directives.flag,
"style": directives.unchanged_required,
"layout": directives.unchanged_required,
"template": directives.unchanged_required,
"pre_template": directives.unchanged_required,
"post_template": directives.unchanged_required,
"constraints": directives.unchanged_required,
}
NEEDS_PROFILING = [x.upper() for x in os.environ.get("NEEDS_PROFILING", "").split(",")]
|