drawlib 0.2.3.dev7__tar.gz → 0.2.4.dev3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3}/PKG-INFO +8 -13
  2. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3}/pyproject.toml +36 -28
  3. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/__init__.py +1 -1
  4. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/apis.py +1 -0
  5. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/base.py +1 -5
  6. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/canvas.py +20 -0
  7. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/boxlist.py +7 -11
  8. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/gridlayout.py +27 -2
  9. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/pyramid.py +23 -4
  10. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/tree.py +32 -2
  11. drawlib-0.2.3.dev7/LICENSE.txt +0 -202
  12. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3}/pypi.md +0 -0
  13. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/__main__.py +0 -0
  14. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/apis.py +0 -0
  15. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/assets/__init__.py +0 -0
  16. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/assets/v0_2/__init__.py +0 -0
  17. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/assets/v0_2/fonticons/__init__.py +0 -0
  18. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/assets/v0_2/fonts/__init__.py +0 -0
  19. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/py.typed +0 -0
  20. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/__init__.py +0 -0
  21. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/__main__.py +0 -0
  22. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/__init__.py +0 -0
  23. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/command.py +0 -0
  24. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/__init__.py +0 -0
  25. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/colors.py +0 -0
  26. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/dimage.py +0 -0
  27. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/fonts.py +0 -0
  28. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/model.py +0 -0
  29. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/model_system_default.py +0 -0
  30. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/theme.py +0 -0
  31. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/theme_officials.py +0 -0
  32. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/theme_style_caches.py +0 -0
  33. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core/util.py +0 -0
  34. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/__init__.py +0 -0
  35. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/image.py +0 -0
  36. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/line.py +0 -0
  37. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/original_arrow.py +0 -0
  38. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/original_polygon.py +0 -0
  39. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/patches.py +0 -0
  40. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/core_canvas/text.py +0 -0
  41. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/download.py +0 -0
  42. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/dutil/__init__.py +0 -0
  43. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/dutil/dutil_canvas.py +0 -0
  44. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/dutil/dutil_color.py +0 -0
  45. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/dutil/dutil_script.py +0 -0
  46. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/dutil/settings.py +0 -0
  47. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/icons/__init__.py +0 -0
  48. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/icons/phosphor.py +0 -0
  49. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/icons/util.py +0 -0
  50. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/logging.py +0 -0
  51. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/__init__.py +0 -0
  52. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/boxtree.py +0 -0
  53. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/bubblespeech.py +0 -0
  54. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/bulletpoints.py +0 -0
  55. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/dsart.py +0 -0
  56. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/sourcecode.py +0 -0
  57. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/smartarts/table.py +0 -0
  58. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/activity.py +0 -0
  59. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/class_.py +0 -0
  60. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/communication.py +0 -0
  61. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/component.py +0 -0
  62. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/deployment.py +0 -0
  63. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/duml.py +0 -0
  64. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/object.py +0 -0
  65. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/package.py +0 -0
  66. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/sequence.py +0 -0
  67. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/state_machine.py +0 -0
  68. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/umls/usecase.py +0 -0
  69. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/util.py +0 -0
  70. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/__init__.py +0 -0
  71. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/args.py +0 -0
  72. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/color.py +0 -0
  73. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/coordinate.py +0 -0
  74. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/icon.py +0 -0
  75. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/image.py +0 -0
  76. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/line.py +0 -0
  77. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/shape.py +0 -0
  78. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/smartarts.py +0 -0
  79. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/style.py +0 -0
  80. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/text.py +0 -0
  81. {drawlib-0.2.3.dev7 → drawlib-0.2.4.dev3/src}/drawlib/v0_2/private/validators/types.py +0 -0
@@ -1,18 +1,14 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.3
2
2
  Name: drawlib
3
- Version: 0.2.3.dev7
3
+ Version: 0.2.4.dev3
4
4
  Summary: Python drawing library. Illustration as Code.
5
- Home-page: https://www.drawlib.com
6
5
  Author: Yuichi Ito
7
- Author-email: yuichi@yuichi.com
8
- Requires-Python: >=3.9,<4.0
9
- Classifier: Programming Language :: Python :: 3
10
- Classifier: Programming Language :: Python :: 3.9
11
- Classifier: Programming Language :: Python :: 3.10
12
- Classifier: Programming Language :: Python :: 3.11
13
- Classifier: Programming Language :: Python :: 3.12
14
- Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
15
- Requires-Dist: pygments (>=2.17.2,<3.0.0)
6
+ Author-email: Yuichi Ito <yuichi@yuichi.com>
7
+ License: MIT
8
+ Requires-Dist: matplotlib>=3.10.9
9
+ Requires-Dist: pygments>=2.19.1
10
+ Requires-Python: >=3.12
11
+ Project-URL: Homepage, https://www.drawlib.com
16
12
  Project-URL: Repository, https://github.com/yuichi110/drawlib
17
13
  Description-Content-Type: text/markdown
18
14
 
@@ -93,4 +89,3 @@ If you create your documentation using markdown or a similar format, you can eas
93
89
  - [Code repository](https://github.com/yuichi110/drawlib)
94
90
  - [Docs repository](https://github.com/yuichi110/drawlib_docs)
95
91
  - [Assets repository](https://github.com/yuichi110/drawlib_assets)
96
-
@@ -1,38 +1,36 @@
1
1
  [build-system]
2
- requires = [ "poetry-core",]
3
- build-backend = "poetry.core.masonry.api"
2
+ requires = ["uv-build<0.12"]
3
+ build-backend = "uv_build"
4
4
 
5
- # GENERATED CODE: START
6
- # from drawlib.__init__.py
7
-
8
- [tool.poetry]
5
+ [project]
9
6
  name = "drawlib"
10
- version = "0.2.3.dev7"
7
+ version = "0.2.4.dev3"
11
8
  description = "Python drawing library. Illustration as Code."
12
- homepage = "https://www.drawlib.com"
13
- repository = "https://github.com/yuichi110/drawlib"
14
- authors = [
15
- "Yuichi Ito <yuichi@yuichi.com>",
16
- ]
17
9
  readme = "pypi.md"
10
+ requires-python = ">=3.12"
11
+ license = { text = "MIT" }
12
+ authors = [{name = "Yuichi Ito", email = "yuichi@yuichi.com"}]
13
+ dependencies = [
14
+ "matplotlib>=3.10.9",
15
+ "pygments>=2.19.1",
16
+ ]
18
17
 
19
- # GENERATED CODE: END
18
+ [project.urls]
19
+ Homepage = "https://www.drawlib.com"
20
+ Repository = "https://github.com/yuichi110/drawlib"
20
21
 
21
- [tool.poetry.scripts]
22
+ [project.scripts]
22
23
  drawlib = "drawlib.__main__:main"
23
24
 
24
- # minimum python version is 3.9 as of 2024 Jun due to lib dependency
25
- [tool.poetry.dependencies]
26
- python = "^3.9"
27
- matplotlib = "^3.8.3"
28
- pygments = "^2.17.2"
29
-
30
- [tool.poetry.group.dev.dependencies]
31
- types-pillow = "^10.2.0.20240311"
32
- ruff = "^0.5.0"
33
- pyright = "^1.1.369"
34
- pytest = "^8.1.1"
35
- pytest-cov = "^5.0.0"
25
+ [dependency-groups]
26
+ dev = [
27
+ "types-pillow>=10.2.0.20240311",
28
+ "ruff>=0.9.0",
29
+ "pyright>=1.1.390",
30
+ "pytest>=8.3.0",
31
+ "pytest-cov>=6.0.0",
32
+ "tomlkit>=0.14.0",
33
+ ]
36
34
 
37
35
  [tool.ruff]
38
36
  preview = true
@@ -60,7 +58,7 @@ ignore = [
60
58
  "D212", # Multi-line docstring summary should start at the first line
61
59
  "D415", # First line should end with a period, question mark, or exclamation point
62
60
  "F401", # imported but unused
63
- "ANN101", # Missing type annotation for self in method
61
+ "ANN101", # Missing type annotation for self in method (deprecated in newer ruff)
64
62
  "PLC0414", # Import alias does not rename original package
65
63
  "PLC1901", # compare-to-empty-string
66
64
  "PLR0904", # Too many public methods
@@ -96,4 +94,14 @@ ignore = [
96
94
  ]
97
95
 
98
96
  [tool.ruff.lint.pydocstyle]
99
- convention = "google"
97
+ convention = "google"
98
+
99
+ [tool.pyright]
100
+ include = ["src/drawlib", "tasks/scripts"]
101
+ extraPaths = ["tasks/scripts"]
102
+ typeCheckingMode = "basic"
103
+ reportMissingTypeArgument = "warning"
104
+ reportUnknownParameterType = "warning"
105
+ reportUnknownVariableType = "warning"
106
+ reportUnknownMemberType = "warning"
107
+ reportUnknownArgumentType = "warning"
@@ -14,7 +14,7 @@ import sys
14
14
  from typing import Final, List
15
15
 
16
16
  # please update here when you release new version
17
- LIB_VERSION: Final[str] = "0.2.3.dev7"
17
+ LIB_VERSION: Final[str] = "0.2.4.dev3"
18
18
 
19
19
  # please list active main committers (1+ commits per month)
20
20
  AUTHORS: Final[List[str]] = [
@@ -85,6 +85,7 @@ from drawlib.v0_2.private.core_canvas.canvas import (
85
85
  # canvas
86
86
  save,
87
87
  shape,
88
+ show,
88
89
  star,
89
90
  # text
90
91
  text,
@@ -166,11 +166,7 @@ class CanvasBase:
166
166
  validator.validate_canvas_args(locals())
167
167
 
168
168
  if len(self._artists) != 0:
169
- raise RuntimeError(
170
- "config() must be called before drawing. "
171
- "Please call clear() first if you want to "
172
- "initialize drawing configs and states."
173
- )
169
+ self._artists = []
174
170
 
175
171
  def config_size_dpi() -> None:
176
172
  if width is not None:
@@ -56,6 +56,25 @@ class Canvas(
56
56
  """
57
57
  super().__init__()
58
58
 
59
+ @error_handler
60
+ def show(self) -> None:
61
+ """Show canvas illustration."""
62
+ self._set_background()
63
+ zorder = self._draw_items()
64
+ self._remove_margin()
65
+
66
+ if not self._grid:
67
+ pyplot.show()
68
+ return
69
+
70
+ temp_artists = self._artists
71
+ self._artists = []
72
+ self._draw_grid(zorder)
73
+ pyplot.show()
74
+ self._remove_artists_from_ax() # remove grid
75
+ self._artists = temp_artists
76
+ self._remove_artists_from_ax() # remove drawing items
77
+
59
78
  @error_handler
60
79
  def save(
61
80
  self,
@@ -256,6 +275,7 @@ canvas = Canvas()
256
275
  clear = canvas.clear
257
276
  config = canvas.config
258
277
  save = canvas.save
278
+ show = canvas.show
259
279
  shape = canvas.shape
260
280
 
261
281
  # image
@@ -24,10 +24,9 @@ class BoxList:
24
24
  """A class to draw a list of boxes with text, supporting highlighting of certain boxes.
25
25
 
26
26
  Args:
27
- box_style (Union[str, ShapeStyle, None]): The style for the boxes.
28
- text_style (Union[str, ShapeTextStyle, None]): The style for the text inside the boxes.
29
- box_highlight_style (Union[str, ShapeStyle, None]): The style for the highlighted boxes.
30
- text_highlight_style (Union[str, ShapeTextStyle, None]): The style for the text inside the highlighted boxes.
27
+ default_box_style (Union[str, ShapeStyle, None]): The style for the boxes.
28
+ default_text_style (Union[str, ShapeTextStyle, None]): The style for the text inside the boxes.
29
+
31
30
  """
32
31
 
33
32
  @error_handler
@@ -41,9 +40,7 @@ class BoxList:
41
40
  Args:
42
41
  default_box_style (Union[str, ShapeStyle, None]): The style for the boxes.
43
42
  default_text_style (Union[str, ShapeTextStyle, None]): The style for the text inside the boxes.
44
- box_highlight_style (Union[str, ShapeStyle, None]): The style for the highlighted boxes.
45
- text_highlight_style (Union[str, ShapeTextStyle, None]):
46
- The style for the text inside the highlighted boxes.
43
+
47
44
  """
48
45
  if isinstance(default_box_style, str):
49
46
  default_box_style = dtheme.rectanglestyles.get(default_box_style)
@@ -79,6 +76,7 @@ class BoxList:
79
76
  text_style (Union[str, ShapeTextStyle, None], optional):
80
77
  The style for the text inside the box. Can be a style name, a ShapeTextStyle object, or None.
81
78
  If None, the default text style is used.
79
+
82
80
  """
83
81
  self.extend([text], box_style=box_style, text_style=text_style)
84
82
 
@@ -102,6 +100,7 @@ class BoxList:
102
100
  text_style (Union[str, ShapeTextStyle, None], optional):
103
101
  The style for the text inside the box. Can be a style name, a ShapeTextStyle object, or None.
104
102
  If None, the default text style is used.
103
+
105
104
  """
106
105
  is_custom_style = box_style is not None or text_style is not None
107
106
 
@@ -141,6 +140,7 @@ class BoxList:
141
140
  text_style (Union[str, ShapeTextStyle, None], optional):
142
141
  The style for the text inside the boxes. Can be a style name, a ShapeTextStyle object, or None.
143
142
  If None, the default text style is used.
143
+
144
144
  """
145
145
  is_custom_style = box_style is not None or text_style is not None
146
146
 
@@ -177,10 +177,6 @@ class BoxList:
177
177
  xy (Tuple[float, float]): The starting point (x, y) to draw the list of boxes.
178
178
  box_width (float): The width of each box.
179
179
  box_height (float): The height of each box.
180
- items (List[Any]): The list of items to be displayed inside the boxes.
181
- highlight_indexs (Optional[List[int]]):
182
- The list of indices of the boxes to be highlighted.
183
- length (Optional[int]): The total number of boxes to be drawn.
184
180
  align (Literal["left", "right", "bottom", "top"]):
185
181
  The alignment of the boxes relative to the starting point.
186
182
 
@@ -20,7 +20,19 @@ from drawlib.v0_2.private.util import error_handler
20
20
 
21
21
 
22
22
  class GridLayout:
23
- """Class for rendering multiple rectangles which fit to grid."""
23
+ """Class for rendering multiple rectangles which fit to grid.
24
+
25
+ Args:
26
+ num_column (int): The number of columns in the grid.
27
+ num_row (int): The number of rows in the grid.
28
+ default_r (int, optional): The default radius for the rectangles. Defaults to 0.
29
+ default_style (Union[str, ShapeStyle, None], optional): The default style for the rectangles.
30
+ Can be a string key, a ShapeStyle object, or None. Defaults to None.
31
+ default_textstyle (Union[str, ShapeTextStyle, None], optional): The default text style for the rectangles.
32
+ Can be a string key, a ShapeTextStyle object, or None. Defaults to None.
33
+ default_textangle (Optional[float], optional): The default angle for the text inside the rectangles.
34
+ If None, no angle is applied. Defaults to None.
35
+ """
24
36
 
25
37
  @error_handler
26
38
  def __init__(
@@ -32,7 +44,20 @@ class GridLayout:
32
44
  default_textstyle: Union[str, ShapeTextStyle, None] = None,
33
45
  default_textangle: Optional[float] = None,
34
46
  ) -> None:
35
- """Initialize class."""
47
+ """Initializes a GridLayout instance.
48
+
49
+ Args:
50
+ num_column (int): The number of columns in the grid.
51
+ num_row (int): The number of rows in the grid.
52
+ default_r (int, optional): The default radius for the rectangles. Defaults to 0.
53
+ default_style (Union[str, ShapeStyle, None], optional): The default style for the rectangles.
54
+ Can be a string key, a ShapeStyle object, or None. Defaults to None.
55
+ default_textstyle (Union[str, ShapeTextStyle, None], optional): The default text style for the rectangles.
56
+ Can be a string key, a ShapeTextStyle object, or None. Defaults to None.
57
+ default_textangle (Optional[float], optional): The default angle for the text inside the rectangles.
58
+ If None, no angle is applied. Defaults to None.
59
+
60
+ """
36
61
  self._num_column = num_column
37
62
  self._num_row = num_row
38
63
  self._default_r = default_r
@@ -27,7 +27,12 @@ class _PyramidItem:
27
27
 
28
28
 
29
29
  class Pyramid:
30
- """Class for rendering smart art pyramid."""
30
+ """Class for rendering smart art pyramids.
31
+
32
+ This class provides methods to create and manipulate pyramid-shaped smart art
33
+ diagrams. It supports custom styles, text styles, text angles, and text position
34
+ adjustments.
35
+ """
31
36
 
32
37
  @error_handler
33
38
  def __init__(
@@ -37,7 +42,21 @@ class Pyramid:
37
42
  default_textangle: Optional[float] = None,
38
43
  default_text_xy_shift: Optional[Tuple[float, float]] = None,
39
44
  ) -> None:
40
- """Initialize class."""
45
+ """Initializes a Pyramid instance with optional default styles and settings.
46
+
47
+ Args:
48
+ default_style (Union[str, ShapeStyle, None], optional): The default
49
+ style for the pyramid shapes. It can be a string that maps to a
50
+ `ShapeStyle` or a `ShapeStyle` instance. Defaults to None.
51
+ default_textstyle (Union[str, ShapeTextStyle, None], optional): The
52
+ default text style for the pyramid shapes. It can be a string that
53
+ maps to a `ShapeTextStyle` or a `ShapeTextStyle` instance. Defaults to None.
54
+ default_textangle (Optional[float], optional): The default rotation
55
+ angle for the text within the pyramid shapes. Defaults to None.
56
+ default_text_xy_shift (Optional[Tuple[float, float]], optional): The
57
+ default x and y shift for the text within the pyramid shapes.
58
+ Defaults to None.
59
+ """
41
60
  if isinstance(default_style, str):
42
61
  default_style = dtheme.rectanglestyles.get(default_style)
43
62
  self._default_style = default_style
@@ -52,8 +71,8 @@ class Pyramid:
52
71
  @error_handler
53
72
  def add( # noqa: C901
54
73
  self,
74
+ text: str,
55
75
  style: Union[str, ShapeStyle, None] = None,
56
- text: str = "",
57
76
  textstyle: Union[str, ShapeTextStyle, None] = None,
58
77
  textangle: Optional[float] = None,
59
78
  text_xy_shift: Optional[Tuple[float, float]] = None,
@@ -62,11 +81,11 @@ class Pyramid:
62
81
  Add an item to the pyramid.
63
82
 
64
83
  Args:
84
+ text (str): The text associated with the item.
65
85
  style (Union[str, ShapeStyle, None], optional):
66
86
  The style of the item.
67
87
  Can be a string key for a predefined style, a ShapeStyle object,
68
88
  or None to use the default style.
69
- text (str, optional): The text associated with the item. Default is an empty string.
70
89
  textstyle (Union[str, ShapeTextStyle, None], optional):
71
90
  The text style of the item. Can be a string key for a predefined text style,
72
91
  a ShapeTextStyle object, or None to use the default text style.
@@ -22,7 +22,12 @@ from drawlib.v0_2.private.util import error_handler
22
22
 
23
23
 
24
24
  class TreeNode:
25
- """Class for rendering smart art Tree."""
25
+ """Class for rendering smart art trees.
26
+
27
+ This class provides methods to create and manipulate tree-like smart art
28
+ diagrams, supporting custom text styles, line styles, and margins for
29
+ horizontal and vertical lines.
30
+ """
26
31
 
27
32
  _drawing_item_map: Dict[str, _TreeNodeDrawingItem] = {}
28
33
 
@@ -42,7 +47,32 @@ class TreeNode:
42
47
  default_line_horizontal_length: Optional[float] = None,
43
48
  default_line_vertical_margin: Optional[float] = None,
44
49
  ) -> None:
45
- """Initialize class."""
50
+ """Initializes a TreeNode instance with specific text, styles, and optional children.
51
+
52
+ Styles are mandatory for root node. Optional for child nodes.
53
+
54
+ Args:
55
+ text (str): The text content for the tree node.
56
+ textstyle (Union[str, TextStyle, None], optional): The text style for the node.
57
+ It can be a string that maps to a `TextStyle` or a `TextStyle` instance. Defaults to None.
58
+ linestyle (Union[str, LineStyle, None], optional): The line style for the node.
59
+ It can be a string that maps to a `LineStyle` or a `LineStyle` instance. Defaults to None.
60
+ line_horizontal_margin (Optional[float], optional): The margin for horizontal lines. Defaults to None.
61
+ line_horizontal_length (Optional[float], optional): The length of horizontal lines. Defaults to None.
62
+ line_vertical_margin (Optional[float], optional): The margin for vertical lines. Defaults to None.
63
+ children (Optional[List[TreeNode]], optional):
64
+ A list of child nodes connected to this node. Defaults to None.
65
+ default_textstyle (Union[str, TextStyle, None], optional):
66
+ The default text style for child nodes. Defaults to None.
67
+ default_linestyle (Union[str, LineStyle, None], optional):
68
+ The default line style for child nodes. Defaults to None.
69
+ default_line_horizontal_margin (Optional[float], optional):
70
+ The default horizontal margin for lines of child nodes. Defaults to None.
71
+ default_line_horizontal_length (Optional[float], optional):
72
+ The default horizontal length for lines of child nodes. Defaults to None.
73
+ default_line_vertical_margin (Optional[float], optional):
74
+ The default vertical margin for lines of child nodes. Defaults to None.
75
+ """
46
76
  self._text = text
47
77
 
48
78
  if isinstance(textstyle, str):
@@ -1,202 +0,0 @@
1
-
2
- Apache License
3
- Version 2.0, January 2004
4
- http://www.apache.org/licenses/
5
-
6
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
-
8
- 1. Definitions.
9
-
10
- "License" shall mean the terms and conditions for use, reproduction,
11
- and distribution as defined by Sections 1 through 9 of this document.
12
-
13
- "Licensor" shall mean the copyright owner or entity authorized by
14
- the copyright owner that is granting the License.
15
-
16
- "Legal Entity" shall mean the union of the acting entity and all
17
- other entities that control, are controlled by, or are under common
18
- control with that entity. For the purposes of this definition,
19
- "control" means (i) the power, direct or indirect, to cause the
20
- direction or management of such entity, whether by contract or
21
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
- outstanding shares, or (iii) beneficial ownership of such entity.
23
-
24
- "You" (or "Your") shall mean an individual or Legal Entity
25
- exercising permissions granted by this License.
26
-
27
- "Source" form shall mean the preferred form for making modifications,
28
- including but not limited to software source code, documentation
29
- source, and configuration files.
30
-
31
- "Object" form shall mean any form resulting from mechanical
32
- transformation or translation of a Source form, including but
33
- not limited to compiled object code, generated documentation,
34
- and conversions to other media types.
35
-
36
- "Work" shall mean the work of authorship, whether in Source or
37
- Object form, made available under the License, as indicated by a
38
- copyright notice that is included in or attached to the work
39
- (an example is provided in the Appendix below).
40
-
41
- "Derivative Works" shall mean any work, whether in Source or Object
42
- form, that is based on (or derived from) the Work and for which the
43
- editorial revisions, annotations, elaborations, or other modifications
44
- represent, as a whole, an original work of authorship. For the purposes
45
- of this License, Derivative Works shall not include works that remain
46
- separable from, or merely link (or bind by name) to the interfaces of,
47
- the Work and Derivative Works thereof.
48
-
49
- "Contribution" shall mean any work of authorship, including
50
- the original version of the Work and any modifications or additions
51
- to that Work or Derivative Works thereof, that is intentionally
52
- submitted to Licensor for inclusion in the Work by the copyright owner
53
- or by an individual or Legal Entity authorized to submit on behalf of
54
- the copyright owner. For the purposes of this definition, "submitted"
55
- means any form of electronic, verbal, or written communication sent
56
- to the Licensor or its representatives, including but not limited to
57
- communication on electronic mailing lists, source code control systems,
58
- and issue tracking systems that are managed by, or on behalf of, the
59
- Licensor for the purpose of discussing and improving the Work, but
60
- excluding communication that is conspicuously marked or otherwise
61
- designated in writing by the copyright owner as "Not a Contribution."
62
-
63
- "Contributor" shall mean Licensor and any individual or Legal Entity
64
- on behalf of whom a Contribution has been received by Licensor and
65
- subsequently incorporated within the Work.
66
-
67
- 2. Grant of Copyright License. Subject to the terms and conditions of
68
- this License, each Contributor hereby grants to You a perpetual,
69
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
- copyright license to reproduce, prepare Derivative Works of,
71
- publicly display, publicly perform, sublicense, and distribute the
72
- Work and such Derivative Works in Source or Object form.
73
-
74
- 3. Grant of Patent License. Subject to the terms and conditions of
75
- this License, each Contributor hereby grants to You a perpetual,
76
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
- (except as stated in this section) patent license to make, have made,
78
- use, offer to sell, sell, import, and otherwise transfer the Work,
79
- where such license applies only to those patent claims licensable
80
- by such Contributor that are necessarily infringed by their
81
- Contribution(s) alone or by combination of their Contribution(s)
82
- with the Work to which such Contribution(s) was submitted. If You
83
- institute patent litigation against any entity (including a
84
- cross-claim or counterclaim in a lawsuit) alleging that the Work
85
- or a Contribution incorporated within the Work constitutes direct
86
- or contributory patent infringement, then any patent licenses
87
- granted to You under this License for that Work shall terminate
88
- as of the date such litigation is filed.
89
-
90
- 4. Redistribution. You may reproduce and distribute copies of the
91
- Work or Derivative Works thereof in any medium, with or without
92
- modifications, and in Source or Object form, provided that You
93
- meet the following conditions:
94
-
95
- (a) You must give any other recipients of the Work or
96
- Derivative Works a copy of this License; and
97
-
98
- (b) You must cause any modified files to carry prominent notices
99
- stating that You changed the files; and
100
-
101
- (c) You must retain, in the Source form of any Derivative Works
102
- that You distribute, all copyright, patent, trademark, and
103
- attribution notices from the Source form of the Work,
104
- excluding those notices that do not pertain to any part of
105
- the Derivative Works; and
106
-
107
- (d) If the Work includes a "NOTICE" text file as part of its
108
- distribution, then any Derivative Works that You distribute must
109
- include a readable copy of the attribution notices contained
110
- within such NOTICE file, excluding those notices that do not
111
- pertain to any part of the Derivative Works, in at least one
112
- of the following places: within a NOTICE text file distributed
113
- as part of the Derivative Works; within the Source form or
114
- documentation, if provided along with the Derivative Works; or,
115
- within a display generated by the Derivative Works, if and
116
- wherever such third-party notices normally appear. The contents
117
- of the NOTICE file are for informational purposes only and
118
- do not modify the License. You may add Your own attribution
119
- notices within Derivative Works that You distribute, alongside
120
- or as an addendum to the NOTICE text from the Work, provided
121
- that such additional attribution notices cannot be construed
122
- as modifying the License.
123
-
124
- You may add Your own copyright statement to Your modifications and
125
- may provide additional or different license terms and conditions
126
- for use, reproduction, or distribution of Your modifications, or
127
- for any such Derivative Works as a whole, provided Your use,
128
- reproduction, and distribution of the Work otherwise complies with
129
- the conditions stated in this License.
130
-
131
- 5. Submission of Contributions. Unless You explicitly state otherwise,
132
- any Contribution intentionally submitted for inclusion in the Work
133
- by You to the Licensor shall be under the terms and conditions of
134
- this License, without any additional terms or conditions.
135
- Notwithstanding the above, nothing herein shall supersede or modify
136
- the terms of any separate license agreement you may have executed
137
- with Licensor regarding such Contributions.
138
-
139
- 6. Trademarks. This License does not grant permission to use the trade
140
- names, trademarks, service marks, or product names of the Licensor,
141
- except as required for reasonable and customary use in describing the
142
- origin of the Work and reproducing the content of the NOTICE file.
143
-
144
- 7. Disclaimer of Warranty. Unless required by applicable law or
145
- agreed to in writing, Licensor provides the Work (and each
146
- Contributor provides its Contributions) on an "AS IS" BASIS,
147
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
- implied, including, without limitation, any warranties or conditions
149
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
- PARTICULAR PURPOSE. You are solely responsible for determining the
151
- appropriateness of using or redistributing the Work and assume any
152
- risks associated with Your exercise of permissions under this License.
153
-
154
- 8. Limitation of Liability. In no event and under no legal theory,
155
- whether in tort (including negligence), contract, or otherwise,
156
- unless required by applicable law (such as deliberate and grossly
157
- negligent acts) or agreed to in writing, shall any Contributor be
158
- liable to You for damages, including any direct, indirect, special,
159
- incidental, or consequential damages of any character arising as a
160
- result of this License or out of the use or inability to use the
161
- Work (including but not limited to damages for loss of goodwill,
162
- work stoppage, computer failure or malfunction, or any and all
163
- other commercial damages or losses), even if such Contributor
164
- has been advised of the possibility of such damages.
165
-
166
- 9. Accepting Warranty or Additional Liability. While redistributing
167
- the Work or Derivative Works thereof, You may choose to offer,
168
- and charge a fee for, acceptance of support, warranty, indemnity,
169
- or other liability obligations and/or rights consistent with this
170
- License. However, in accepting such obligations, You may act only
171
- on Your own behalf and on Your sole responsibility, not on behalf
172
- of any other Contributor, and only if You agree to indemnify,
173
- defend, and hold each Contributor harmless for any liability
174
- incurred by, or claims asserted against, such Contributor by reason
175
- of your accepting any such warranty or additional liability.
176
-
177
- END OF TERMS AND CONDITIONS
178
-
179
- APPENDIX: How to apply the Apache License to your work.
180
-
181
- To apply the Apache License to your work, attach the following
182
- boilerplate notice, with the fields enclosed by brackets "[]"
183
- replaced with your own identifying information. (Don't include
184
- the brackets!) The text should be enclosed in the appropriate
185
- comment syntax for the file format. We also recommend that a
186
- file or class name and description of purpose be included on the
187
- same "printed page" as the copyright notice for easier
188
- identification within third-party archives.
189
-
190
- Copyright [2024] [Yuichi Ito]
191
-
192
- Licensed under the Apache License, Version 2.0 (the "License");
193
- you may not use this file except in compliance with the License.
194
- You may obtain a copy of the License at
195
-
196
- http://www.apache.org/licenses/LICENSE-2.0
197
-
198
- Unless required by applicable law or agreed to in writing, software
199
- distributed under the License is distributed on an "AS IS" BASIS,
200
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
- See the License for the specific language governing permissions and
202
- limitations under the License.
File without changes