#1106 Apply each lint and conversion.

simon-ritchie · simon-ritchie · commit 15e418a682e3 · 2024-07-25T23:11:11.000+09:00
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_const b/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_const
@@ -0,0 +1 @@
+65d889340c04bd46c01e5743007657e06bcf681b
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_icon_mixin b/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_icon_mixin
@@ -0,0 +1 @@
+4e74cc43f34ab840158207d924361311a1be0336
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_label_mixin b/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_button_label_mixin
@@ -1 +1 @@
-6ace57553b3b317177f0133ce8e90cf91df5afbe
+c4e93c409c3f0de1008f89f5ea0c427aa86ed555
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_filled_button b/.lint_and_doc_hash/.autoflake/apysc/_material_design/button/material_filled_button
@@ -1 +1 @@
-62613a1131be959b5072b536ba974a8422744157
+17b3dfac93458dc3d52726a95c8ff81b151538ba
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/geom/material_x_and_y_attributes_mixin b/.lint_and_doc_hash/.autoflake/apysc/_material_design/geom/material_x_and_y_attributes_mixin
@@ -0,0 +1 @@
+f4513247c76a8782266cd65b6f1dc6b1703b1eae
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_validation/arg_validation_decos b/.lint_and_doc_hash/.autoflake/apysc/_validation/arg_validation_decos
@@ -1 +1 @@
-0c22f8fe7eec53b41b765a8c4af247fbafb8c558
+432efcf0db7af8e825d879d20417c146c9380165
diff --git a/.lint_and_doc_hash/.autoflake/tests/_validation/test_arg_validation_decos b/.lint_and_doc_hash/.autoflake/tests/_validation/test_arg_validation_decos
@@ -1 +1 @@
-1a0e6ab134876a90d9e7d9bc13d5e2f1a563577a
+ae22583fa3cfb1972038b4f285995d21ddf06971
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_const b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_const
@@ -0,0 +1 @@
+65d889340c04bd46c01e5743007657e06bcf681b
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_icon_mixin b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_icon_mixin
@@ -0,0 +1 @@
+8d8981fa26dce8b0299847459303861d96b258b3
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_label_mixin b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_button_label_mixin
@@ -1 +1 @@
-6ace57553b3b317177f0133ce8e90cf91df5afbe
+74a21d566bd831ec29d6af67bb63c973e1c1213e
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_filled_button b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/button/material_filled_button
@@ -1 +1 @@
-62613a1131be959b5072b536ba974a8422744157
+b4755a7b99e195b411f668ba35e7063399c76544
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/geom/__init__ b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/geom/__init__
@@ -0,0 +1 @@
+da39a3ee5e6b4b0d3255bfef95601890afd80709
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/geom/material_x_and_y_attributes_mixin b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/geom/material_x_and_y_attributes_mixin
@@ -0,0 +1 @@
+b1cf26ff58f49e3fcb67afa153df10a40ad28692
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_validation/arg_validation_decos b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_validation/arg_validation_decos
@@ -1 +1 @@
-0c22f8fe7eec53b41b765a8c4af247fbafb8c558
+432efcf0db7af8e825d879d20417c146c9380165
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_const b/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_const
@@ -0,0 +1 @@
+65d889340c04bd46c01e5743007657e06bcf681b
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_icon_mixin b/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_icon_mixin
@@ -0,0 +1 @@
+4e74cc43f34ab840158207d924361311a1be0336
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_label_mixin b/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_button_label_mixin
@@ -1 +1 @@
-6ace57553b3b317177f0133ce8e90cf91df5afbe
+c4e93c409c3f0de1008f89f5ea0c427aa86ed555
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_filled_button b/.lint_and_doc_hash/.isort/apysc/_material_design/button/material_filled_button
@@ -1 +1 @@
-62613a1131be959b5072b536ba974a8422744157
+17b3dfac93458dc3d52726a95c8ff81b151538ba
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/geom/material_x_and_y_attributes_mixin b/.lint_and_doc_hash/.isort/apysc/_material_design/geom/material_x_and_y_attributes_mixin
@@ -0,0 +1 @@
+f4513247c76a8782266cd65b6f1dc6b1703b1eae
diff --git a/.lint_and_doc_hash/.isort/apysc/_validation/arg_validation_decos b/.lint_and_doc_hash/.isort/apysc/_validation/arg_validation_decos
@@ -1 +1 @@
-0c22f8fe7eec53b41b765a8c4af247fbafb8c558
+432efcf0db7af8e825d879d20417c146c9380165
diff --git a/.lint_and_doc_hash/.isort/tests/_validation/test_arg_validation_decos b/.lint_and_doc_hash/.isort/tests/_validation/test_arg_validation_decos
@@ -1 +1 @@
-1a0e6ab134876a90d9e7d9bc13d5e2f1a563577a
+ae22583fa3cfb1972038b4f285995d21ddf06971
diff --git a/apysc/_material_design/button/material_button_icon_mixin.py b/apysc/_material_design/button/material_button_icon_mixin.py
@@ -2,16 +2,18 @@
 methods.
 """
 
-
-from typing import Optional, cast
+from typing import Optional
+from typing import cast
 
 from apysc._color.color import Color
 from apysc._display.child_mixin import ChildMixIn
 from apysc._display.fixed_html_svg_icon_base import FixedHtmlSvgIconBase
 from apysc._display.x_mixin import XMixIn
 from apysc._display.y_mixin import YMixIn
 from apysc._geom.rectangle_geom import RectangleGeom
-from apysc._type.variable_name_suffix_attr_or_var_mixin import VariableNameSuffixAttrOrVarMixIn
+from apysc._type.variable_name_suffix_attr_or_var_mixin import (
+    VariableNameSuffixAttrOrVarMixIn,
+)
 from apysc._validation import arg_validation_decos
 
 
@@ -52,8 +54,12 @@ def _locate_icons(
         background_bounding_box : RectangleGeom
             A bounding box of the background.
         """
+        from apysc._material_design.button.material_button_const import (
+            ICON_OUTER_PADDING_WIDTH,
+        )
+        from apysc._material_design.button.material_button_const import ICON_SIZE
+        from apysc._material_design.button.material_button_const import ICON_Y
         from apysc._type.number import Number
-        from apysc._material_design.button.material_button_const import ICON_OUTER_PADDING_WIDTH, ICON_SIZE, ICON_Y
 
         self_instance: _InstanceStub = cast(_InstanceStub, self)
         if prefix_icon is not None:
@@ -74,9 +80,7 @@ def _locate_icons(
                 value_identifier="suffix_icon_x"
             )
             suffix_icon.x = Number(
-                background_bounding_box.width
-                - ICON_OUTER_PADDING_WIDTH
-                - ICON_SIZE,
+                background_bounding_box.width - ICON_OUTER_PADDING_WIDTH - ICON_SIZE,
                 variable_name_suffix=suffix,
             )
 
@@ -127,20 +131,16 @@ def _resize_icon_size(
         suffix_icon : Optional[FixedHtmlSvgIconBase]
             An icon to display on the right side of the label.
         """
-        from apysc._type.int import Int
         from apysc._material_design.button.material_button_const import ICON_SIZE
+        from apysc._type.int import Int
 
         if prefix_icon is not None:
-            prefix_icon.width = Int(
-                ICON_SIZE, variable_name_suffix="prefix_icon_width"
-            )
+            prefix_icon.width = Int(ICON_SIZE, variable_name_suffix="prefix_icon_width")
             prefix_icon.height = Int(
                 ICON_SIZE, variable_name_suffix="prefix_icon_height"
             )
         if suffix_icon is not None:
-            suffix_icon.width = Int(
-                ICON_SIZE, variable_name_suffix="suffix_icon_width"
-            )
+            suffix_icon.width = Int(ICON_SIZE, variable_name_suffix="suffix_icon_width")
             suffix_icon.height = Int(
                 ICON_SIZE, variable_name_suffix="suffix_icon_height"
             )
diff --git a/apysc/_material_design/button/material_button_label_mixin.py b/apysc/_material_design/button/material_button_label_mixin.py
@@ -113,11 +113,21 @@ def _locate_label_text(
         prefix_icon : Optional[FixedHtmlSvgIconBase]
             An icon to display on the left side of the label.
         """
+        from apysc._material_design.button.material_button_const import BUTTON_HEIGHT
+        from apysc._material_design.button.material_button_const import (
+            ICON_INNER_PADDING_WIDTH,
+        )
+        from apysc._material_design.button.material_button_const import (
+            ICON_OUTER_PADDING_WIDTH,
+        )
+        from apysc._material_design.button.material_button_const import ICON_SIZE
+        from apysc._material_design.button.material_button_const import (
+            NO_ICON_OUTER_PADDING,
+        )
         from apysc._type.number import Number
         from apysc._type.variable_name_suffix_utils import (
             get_attr_or_variable_name_suffix,
         )
-        from apysc._material_design.button.material_button_const import BUTTON_HEIGHT, NO_ICON_OUTER_PADDING, ICON_SIZE, ICON_OUTER_PADDING_WIDTH, ICON_INNER_PADDING_WIDTH
 
         suffix: str = get_attr_or_variable_name_suffix(
             instance=self,
@@ -130,9 +140,7 @@ def _locate_label_text(
             )
         else:
             self._label_text.x = Number(
-                ICON_OUTER_PADDING_WIDTH
-                + ICON_SIZE
-                + ICON_INNER_PADDING_WIDTH,
+                ICON_OUTER_PADDING_WIDTH + ICON_SIZE + ICON_INNER_PADDING_WIDTH,
                 variable_name_suffix=suffix,
             )
 
diff --git a/apysc/_material_design/button/material_filled_button.py b/apysc/_material_design/button/material_filled_button.py
@@ -11,17 +11,23 @@
 from apysc._display.fixed_html_svg_icon_base import FixedHtmlSvgIconBase
 from apysc._display.sprite import Sprite
 from apysc._geom.rectangle_geom import RectangleGeom
+from apysc._material_design.button.material_button_const import BUTTON_HEIGHT
+from apysc._material_design.button.material_button_const import ICON_SIZE
+from apysc._material_design.button.material_button_const import NO_ICON_OUTER_PADDING
+from apysc._material_design.button.material_button_icon_mixin import (
+    MaterialButtonIconMixIn,
+)
 from apysc._material_design.button.material_button_label_mixin import (
     MaterialButtonLabelMixIn,
 )
+from apysc._material_design.geom.material_x_and_y_attributes_mixin import (
+    MaterialXAndYAttributesMixIn,
+)
 from apysc._type.array import Array
 from apysc._type.int import Int
 from apysc._type.number import Number
 from apysc._type.string import String
 from apysc._validation import arg_validation_decos
-from apysc._material_design.button.material_button_const import BUTTON_HEIGHT, NO_ICON_OUTER_PADDING, ICON_SIZE, ICON_Y, ICON_OUTER_PADDING_WIDTH, ICON_INNER_PADDING_WIDTH
-from apysc._material_design.button.material_button_icon_mixin import MaterialButtonIconMixIn
-from apysc._material_design.geom.material_x_and_y_attributes_mixin import MaterialXAndYAttributesMixIn
 
 
 class MaterialFilledButton(
diff --git a/apysc/_material_design/geom/material_x_and_y_attributes_mixin.py b/apysc/_material_design/geom/material_x_and_y_attributes_mixin.py
@@ -1,8 +1,7 @@
 """The mix-in class implementation for the material design's x and y
-coodrinates attributes.
+coordinates attributes.
 """
 
-
 from typing import Union
 
 from apysc._type.number import Number
@@ -11,12 +10,10 @@
 class MaterialXAndYAttributesMixIn:
 
     def _set_x_and_y_coordinates(
-        self,
-        *, x:
-        Union[float, Number],
-        y: Union[float, Number]) -> None:
+        self, *, x: Union[float, Number], y: Union[float, Number]
+    ) -> None:
         """
-        Set the x and y coordinates to instance button.
+        Set the x and y coordinates to an instance button.
 
         Parameters
         ----------
diff --git a/docstring_markdowns/apysc/_material_design/button/material_button_const.md b/docstring_markdowns/apysc/_material_design/button/material_button_const.md
@@ -0,0 +1,5 @@
+# `apysc._material_design.button.material_button_const` docstrings
+
+## Module summary
+
+The definitions of the material design button constants.
diff --git a/docstring_markdowns/apysc/_material_design/button/material_button_icon_mixin.md b/docstring_markdowns/apysc/_material_design/button/material_button_icon_mixin.md
@@ -0,0 +1,59 @@
+# `apysc._material_design.button.material_button_icon_mixin` docstrings
+
+## Module summary
+
+The mix-in class implementation for the material button's icon-related methods.
+
+## `MaterialButtonIconMixIn` class docstring
+
+The mix-in class implementation for the material button's icon-related methods.
+
+### `_add_icons` method docstring
+
+Add each icon to this button.<hr>
+
+**[Parameters]**
+
+- `prefix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the left side of the label.
+- `suffix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the right side of the label.
+
+### `_locate_icons` method docstring
+
+Locate each icon.<hr>
+
+**[Parameters]**
+
+- `prefix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the left side of the label.
+- `suffix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the right side of the label.
+- `background_bounding_box`: RectangleGeom
+  - A bounding box of the background.
+
+### `_resize_icon_size` method docstring
+
+Resize the icon size if each icon is specified.<hr>
+
+**[Parameters]**
+
+- `prefix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the left side of the label.
+- `suffix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the right side of the label.
+
+### `_set_fill_color_to_icons` method docstring
+
+Set a fill-color to the icons.<hr>
+
+**[Parameters]**
+
+- `color`: Color
+  - A color to set.
+- `prefix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the left side of the label.
+- `suffix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the right side of the label.
+
+## `_InstanceStub` class docstring
diff --git a/docstring_markdowns/apysc/_material_design/button/material_button_label_mixin.md b/docstring_markdowns/apysc/_material_design/button/material_button_label_mixin.md
@@ -19,4 +19,15 @@ Initialize the label setting with the specified argument.<hr>
 - `font_family`: Optional[Union[Array[String], List[str]]]
   - A font-family setting.
 - `font_size`: Union[int, Int]
-  - A font-size setting.
+  - A font-size setting.
+
+### `_locate_label_text` method docstring
+
+Locate the label text.<hr>
+
+**[Parameters]**
+
+- `label_text_bounding_box`: RectangleGeom
+  - The bounding box of the label text.
+- `prefix_icon`: Optional[FixedHtmlSvgIconBase]
+  - An icon to display on the left side of the label.
diff --git a/docstring_markdowns/apysc/_material_design/button/material_filled_button.md b/docstring_markdowns/apysc/_material_design/button/material_filled_button.md
diff --git a/docstring_markdowns/apysc/_material_design/geom/__init__.md b/docstring_markdowns/apysc/_material_design/geom/__init__.md
diff --git a/docstring_markdowns/apysc/_material_design/geom/material_x_and_y_attributes_mixin.md b/docstring_markdowns/apysc/_material_design/geom/material_x_and_y_attributes_mixin.md
diff --git a/docstring_markdowns/apysc/_validation/arg_validation_decos.md b/docstring_markdowns/apysc/_validation/arg_validation_decos.md
diff --git a/tests/_validation/test_arg_validation_decos.py b/tests/_validation/test_arg_validation_decos.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+65d889340c04bd46c01e5743007657e06bcf681b`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+4e74cc43f34ab840158207d924361311a1be0336`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-6ace57553b3b317177f0133ce8e90cf91df5afbe`
	`1`	`+c4e93c409c3f0de1008f89f5ea0c427aa86ed555`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-62613a1131be959b5072b536ba974a8422744157`
	`1`	`+17b3dfac93458dc3d52726a95c8ff81b151538ba`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+f4513247c76a8782266cd65b6f1dc6b1703b1eae`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-0c22f8fe7eec53b41b765a8c4af247fbafb8c558`
	`1`	`+432efcf0db7af8e825d879d20417c146c9380165`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-1a0e6ab134876a90d9e7d9bc13d5e2f1a563577a`
	`1`	`+ae22583fa3cfb1972038b4f285995d21ddf06971`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+8d8981fa26dce8b0299847459303861d96b258b3`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-6ace57553b3b317177f0133ce8e90cf91df5afbe`
	`1`	`+74a21d566bd831ec29d6af67bb63c973e1c1213e`