#1212 Apply each lint and conversion.

simon-ritchie · simon-ritchie · commit 2dcb2bb2df4d · 2024-06-30T22:33:24.000+09:00
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/color/material_color_scheme_samples b/.lint_and_doc_hash/.autoflake/apysc/_material_design/color/material_color_scheme_samples
@@ -1 +1 @@
-3629767832f7f8b2a8157cbfdd2dd9ad7ac330ad
+571569266737caa4a8dc7f791463eb9f0579336d
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_material_design/setting/material_settings b/.lint_and_doc_hash/.autoflake/apysc/_material_design/setting/material_settings
@@ -1 +1 @@
-a626b9bad65637804ace68fb30e24c57b43ded29
+44072ebc1e1b9a817d3fc405d741b2ed9c99ab5d
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_type/boolean b/.lint_and_doc_hash/.autoflake/apysc/_type/boolean
@@ -1 +1 @@
-bc79a1551a9855d24fa988250d65cf0248e99e94
+8bb5a411642c28c1c11261629eba2861f86678bc
diff --git a/.lint_and_doc_hash/.autoflake/apysc/_type/disable_value_modification_mixin b/.lint_and_doc_hash/.autoflake/apysc/_type/disable_value_modification_mixin
@@ -0,0 +1 @@
+5a6dd6fa008d7a10da724ff0ced621c5b859f0df
diff --git a/.lint_and_doc_hash/.autoflake/tests/_material_design/setting/test_material_settings b/.lint_and_doc_hash/.autoflake/tests/_material_design/setting/test_material_settings
@@ -1 +1 @@
-a801ed3e6641f6added13ef52a7d42e74c9096a2
+beafa6f21ca4373654188b337d451317f930d050
diff --git a/.lint_and_doc_hash/.autoflake/tests/_type/test_boolean b/.lint_and_doc_hash/.autoflake/tests/_type/test_boolean
@@ -1 +1 @@
-b6a4cb498aae8708157ec04c8cf4e3baab066e90
+2bf2ad53c6a994faf6edd0a82b03b99bc91493fe
diff --git a/.lint_and_doc_hash/.autoflake/tests/_type/test_disable_value_modification_mixin b/.lint_and_doc_hash/.autoflake/tests/_type/test_disable_value_modification_mixin
@@ -0,0 +1 @@
+4e92e88a2a3f9d16c90dd378cddbf3aaa5f8f2d7
diff --git a/.lint_and_doc_hash/.docstring_src/apysc/_type/boolean b/.lint_and_doc_hash/.docstring_src/apysc/_type/boolean
@@ -1 +1 @@
-bc79a1551a9855d24fa988250d65cf0248e99e94
+d7cda99008aba1ba75be9d5e49948595688eaa5c
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/__init__ b/.lint_and_doc_hash/.docstring_to_markdown/apysc/__init__
@@ -1 +1 @@
-196e320a0b45a7d4f9353a8811f8fdf5797eb9e6
+768d63f63d1311eacd7d29c9ce67ee5a1387a487
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/color/material_color_scheme_samples b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/color/material_color_scheme_samples
@@ -1 +1 @@
-3629767832f7f8b2a8157cbfdd2dd9ad7ac330ad
+571569266737caa4a8dc7f791463eb9f0579336d
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/setting/material_settings b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_material_design/setting/material_settings
@@ -1 +1 @@
-a626b9bad65637804ace68fb30e24c57b43ded29
+44072ebc1e1b9a817d3fc405d741b2ed9c99ab5d
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_type/boolean b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_type/boolean
@@ -1 +1 @@
-bc79a1551a9855d24fa988250d65cf0248e99e94
+d7cda99008aba1ba75be9d5e49948595688eaa5c
diff --git a/.lint_and_doc_hash/.docstring_to_markdown/apysc/_type/disable_value_modification_mixin b/.lint_and_doc_hash/.docstring_to_markdown/apysc/_type/disable_value_modification_mixin
@@ -0,0 +1 @@
+5a6dd6fa008d7a10da724ff0ced621c5b859f0df
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/color/material_color_scheme_samples b/.lint_and_doc_hash/.isort/apysc/_material_design/color/material_color_scheme_samples
@@ -1 +1 @@
-3629767832f7f8b2a8157cbfdd2dd9ad7ac330ad
+571569266737caa4a8dc7f791463eb9f0579336d
diff --git a/.lint_and_doc_hash/.isort/apysc/_material_design/setting/material_settings b/.lint_and_doc_hash/.isort/apysc/_material_design/setting/material_settings
@@ -1 +1 @@
-a626b9bad65637804ace68fb30e24c57b43ded29
+44072ebc1e1b9a817d3fc405d741b2ed9c99ab5d
diff --git a/.lint_and_doc_hash/.isort/apysc/_type/boolean b/.lint_and_doc_hash/.isort/apysc/_type/boolean
@@ -1 +1 @@
-bc79a1551a9855d24fa988250d65cf0248e99e94
+8bb5a411642c28c1c11261629eba2861f86678bc
diff --git a/.lint_and_doc_hash/.isort/apysc/_type/disable_value_modification_mixin b/.lint_and_doc_hash/.isort/apysc/_type/disable_value_modification_mixin
@@ -0,0 +1 @@
+5a6dd6fa008d7a10da724ff0ced621c5b859f0df
diff --git a/.lint_and_doc_hash/.isort/tests/_material_design/setting/test_material_settings b/.lint_and_doc_hash/.isort/tests/_material_design/setting/test_material_settings
@@ -1 +1 @@
-a801ed3e6641f6added13ef52a7d42e74c9096a2
+beafa6f21ca4373654188b337d451317f930d050
diff --git a/.lint_and_doc_hash/.isort/tests/_type/test_boolean b/.lint_and_doc_hash/.isort/tests/_type/test_boolean
@@ -1 +1 @@
-b6a4cb498aae8708157ec04c8cf4e3baab066e90
+2bf2ad53c6a994faf6edd0a82b03b99bc91493fe
diff --git a/.lint_and_doc_hash/.isort/tests/_type/test_disable_value_modification_mixin b/.lint_and_doc_hash/.isort/tests/_type/test_disable_value_modification_mixin
@@ -0,0 +1 @@
+4e92e88a2a3f9d16c90dd378cddbf3aaa5f8f2d7
diff --git a/apysc/_type/boolean.py b/apysc/_type/boolean.py
@@ -15,6 +15,7 @@
     InitializeWithBaseValueInterface,
 )
 from apysc._type.copy_mixin import CopyMixIn
+from apysc._type.disable_value_modification_mixin import DisableValueModificationMixIn
 from apysc._type.hashable_interface import HashableInterface
 from apysc._type.initial_substitution_exp_mixin import InitialSubstitutionExpMixIn
 from apysc._type.int import Int
@@ -24,7 +25,6 @@
 from apysc._type.variable_name_mixin import VariableNameMixIn
 from apysc._type.variable_name_suffix_mixin import VariableNameSuffixMixIn
 from apysc._validation import arg_validation_decos
-from apysc._type.disable_value_modification_mixin import DisableValueModificationMixIn
 
 
 class Boolean(
diff --git a/apysc/_type/disable_value_modification_mixin.py b/apysc/_type/disable_value_modification_mixin.py
@@ -11,8 +11,7 @@ def disable_value_modification(self) -> None:
         prevent the value modification (e.g., the value updating with the
         `value` property).
 
-        This is recommended to call this method at the constructor or after the
-        instantiation.
+        Calling this method after the instantiation is recommended.
         """
         self._disabled_value_modification = True
 
diff --git a/docs/en/searchindex.js b/docs/en/searchindex.js
diff --git a/docstring_markdowns/apysc/_type/disable_value_modification_mixin.md b/docstring_markdowns/apysc/_type/disable_value_modification_mixin.md
@@ -0,0 +1,19 @@
+# `apysc._type.disable_value_modification_mixin` docstrings
+
+## Module summary
+
+The mix-in class implementation to disable a value modification.
+
+## `DisableValueModificationMixIn` class docstring
+
+### `disable_value_modification` method docstring
+
+Disable a value modification. This method is useful when you want to prevent the value modification (e.g., the value updating with the `value` property). This is recommended to call this method at the constructor or after the instantiation.
+
+### `raise_if_value_modification_is_disabled` method docstring
+
+Raise an error if the value modification is disabled.<hr>
+
+**[Raises]**
+
+- ValueError: If the value modification is disabled.
diff --git a/tests/_type/test_boolean.py b/tests/_type/test_boolean.py
@@ -8,7 +8,8 @@
 from apysc._expression import expression_data_util
 from apysc._expression import var_names
 from apysc._testing import testing_helper
-from apysc._testing.testing_helper import apply_test_settings, assert_raises
+from apysc._testing.testing_helper import apply_test_settings
+from apysc._testing.testing_helper import assert_raises
 
 
 class TestBoolean:
diff --git a/tests/_type/test_disable_value_modification_mixin.py b/tests/_type/test_disable_value_modification_mixin.py
@@ -1,5 +1,6 @@
+from apysc._testing.testing_helper import apply_test_settings
+from apysc._testing.testing_helper import assert_raises
 from apysc._type.disable_value_modification_mixin import DisableValueModificationMixIn
-from apysc._testing.testing_helper import apply_test_settings, assert_raises
 
 
 class TestDisableValueModificationMixIn:
diff --git a/tests/_type/test_true.py b/tests/_type/test_true.py
@@ -1,7 +1,7 @@
 import pytest
 
 import apysc as ap
-from apysc._testing.testing_helper import apply_test_settings, assert_raises
+from apysc._testing.testing_helper import apply_test_settings
 
 
 class Test_True:

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-3629767832f7f8b2a8157cbfdd2dd9ad7ac330ad`
	`1`	`+571569266737caa4a8dc7f791463eb9f0579336d`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-a626b9bad65637804ace68fb30e24c57b43ded29`
	`1`	`+44072ebc1e1b9a817d3fc405d741b2ed9c99ab5d`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-bc79a1551a9855d24fa988250d65cf0248e99e94`
	`1`	`+8bb5a411642c28c1c11261629eba2861f86678bc`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+5a6dd6fa008d7a10da724ff0ced621c5b859f0df`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-a801ed3e6641f6added13ef52a7d42e74c9096a2`
	`1`	`+beafa6f21ca4373654188b337d451317f930d050`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-b6a4cb498aae8708157ec04c8cf4e3baab066e90`
	`1`	`+2bf2ad53c6a994faf6edd0a82b03b99bc91493fe`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+4e92e88a2a3f9d16c90dd378cddbf3aaa5f8f2d7`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-bc79a1551a9855d24fa988250d65cf0248e99e94`
	`1`	`+d7cda99008aba1ba75be9d5e49948595688eaa5c`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-196e320a0b45a7d4f9353a8811f8fdf5797eb9e6`
	`1`	`+768d63f63d1311eacd7d29c9ce67ee5a1387a487`