Reorganizes imports and adds missing docstrings

Author: wojtryb

shortcut_composer/api_krita/actions/transform_actions.py

@@ -8,8 +8,7 @@
     QWidgetAction,
     QToolButton,
     QPushButton,
-    QWidget,
-)
+    QWidget)
 
 from ..enums import Tool, TransformMode
 from ..core_api import KritaInstance

shortcut_composer/api_krita/core_api.py

@@ -1,9 +1,9 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from krita import Krita as Api, Extension, qApp
 from typing import Callable, Protocol, Any
 
+from krita import Krita as Api, Extension, qApp
 from PyQt5.QtWidgets import (
     QMainWindow,
     QDesktopWidget,
@@ -18,8 +18,7 @@
     Version,
     Canvas,
     Cursor,
-    View,
-)
+    View)
 
 
 class KritaInstance:

shortcut_composer/api_krita/enums/__init__.py

@@ -16,5 +16,4 @@
     "NodeType",
     "Action",
     "Toggle",
-    "Tool"
-]
+    "Tool"]

shortcut_composer/api_krita/enums/action.py

@@ -2,8 +2,8 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from krita import Krita as Api
-
 from PyQt5.QtGui import QIcon
+
 from .helpers import EnumGroup, Group
 
 

shortcut_composer/api_krita/enums/blending_mode.py

@@ -234,5 +234,4 @@ def pretty_name(self) -> str:
     BlendingMode.HEAT_GLOW_FREEZE_REFLECT_HYBRID:
         "Heat-Glow & Freeze-Reflect Hybrid",
     BlendingMode.REFLECT_FREEZE: "Reflect-Freeze",
-
 }

shortcut_composer/api_krita/enums/helpers/enum_group.py

@@ -4,6 +4,7 @@
 import sys
 from typing import Tuple, TypeVar
 from enum import Enum, EnumMeta
+
 T = TypeVar("T", bound=Enum)
 
 

shortcut_composer/api_krita/enums/node_types.py

@@ -1,9 +1,9 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from krita import Krita as Api
 from enum import Enum
 
+from krita import Krita as Api
 from PyQt5.QtGui import QIcon
 
 

shortcut_composer/api_krita/enums/toggle.py

@@ -1,9 +1,10 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from krita import Krita as Api
 from enum import Enum
 
+from krita import Krita as Api
+
 
 class Toggle(Enum):
     """

shortcut_composer/api_krita/enums/tool.py

@@ -2,8 +2,8 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from krita import Krita as Api
-
 from PyQt5.QtGui import QIcon
+
 from .helpers import EnumGroup, Group
 
 

shortcut_composer/api_krita/enums/transform_mode.py

@@ -1,9 +1,9 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from krita import Krita as Api
 from enum import Enum
 
+from krita import Krita as Api
 from PyQt5.QtGui import QIcon
 
 

shortcut_composer/api_krita/pyqt/__init__.py

@@ -17,5 +17,4 @@
     "RoundButton",
     "BaseWidget",
     "Painter",
-    "Timer",
-]
+    "Timer"]

shortcut_composer/api_krita/pyqt/painter.py

@@ -74,8 +74,7 @@ def paint_pixmap(self, center: QPoint, pixmap: QPixmap) -> None:
             center.y() - pixmap.height()//2,
             pixmap.width(),
             pixmap.height(),
-            pixmap
-        )
+            pixmap)
 
     def _square(self, center: QPoint, width: int) -> QRectF:
         """Return a square of given `width` at `center` point."""

shortcut_composer/api_krita/pyqt/pixmap_transform.py

@@ -6,8 +6,7 @@
     QPainter,
     QPixmap,
     QImage,
-    QBrush,
-)
+    QBrush)
 
 
 class PixmapTransform:
@@ -39,5 +38,4 @@ def scale_pixmap(pixmap: QPixmap, size_px: int) -> QPixmap:
             size_px,
             size_px,
             Qt.KeepAspectRatio,
-            Qt.SmoothTransformation
-        )
+            Qt.SmoothTransformation)

shortcut_composer/api_krita/wrappers/__init__.py

@@ -24,5 +24,4 @@
     "Canvas",
     "Cursor",
     "Node",
-    "View",
-]
+    "View"]

shortcut_composer/api_krita/wrappers/database.py

@@ -1,10 +1,10 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from krita import Krita as Api
 import os.path
 from typing import Any
 
+from krita import Krita as Api
 from PyQt5.QtSql import QSqlDatabase, QSqlQuery
 
 

shortcut_composer/api_krita/wrappers/document.py

@@ -3,7 +3,9 @@
 
 from dataclasses import dataclass
 from typing import Protocol
+
 from PyQt5.QtCore import QByteArray
+
 from ..enums import NodeType
 from .node import Node, KritaNode
 

shortcut_composer/composer_utils/__init__.py

@@ -14,5 +14,4 @@
     "SettingsDialog",
     "ButtonsLayout",
     "CirclePoints",
-    "Config",
-]
+    "Config"]

shortcut_composer/composer_utils/buttons_layout.py

@@ -5,11 +5,7 @@
 from dataclasses import dataclass
 
 from PyQt5.QtCore import Qt
-from PyQt5.QtWidgets import (
-    QDialogButtonBox,
-    QAbstractButton,
-    QVBoxLayout,
-)
+from PyQt5.QtWidgets import QDialogButtonBox, QAbstractButton, QVBoxLayout
 
 EmptyCallback = Callable[[], None]
 

shortcut_composer/composer_utils/global_config.py

@@ -1,9 +1,10 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from config_system import FieldGroup
 from PyQt5.QtGui import QColor
+
 from api_krita import Krita
+from config_system import FieldGroup
 
 
 class GlobalConfig(FieldGroup):

shortcut_composer/composer_utils/label/__init__.py

@@ -12,5 +12,4 @@
     "LabelWidget",
     "LabelInterface",
     "LabelWidgetStyle",
-    "LabelTextColorizer"
-]
+    "LabelTextColorizer"]

shortcut_composer/composer_utils/label/complex_widgets/numeric_value_picker.py

@@ -1,6 +1,8 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
+from typing import Callable, TypeVar, Generic
+
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
     QAbstractSpinBox,
@@ -11,8 +13,6 @@
     QWidget,
     QLabel)
 
-from typing import Callable, TypeVar, Generic
-
 from composer_utils.label import LabelWidgetStyle, LabelWidget
 from composer_utils.label.label_widget_impl import dispatch_label_widget
 from ..label_interface import LabelInterface
@@ -21,6 +21,8 @@
 
 
 class NumericValuePicker(QWidget, Generic[T]):
+    """Widget that displays draggable LabelWidget with value set in SpinBox."""
+
     def __init__(
         self,
         create_label_from_integer: Callable[[int], T],
@@ -51,6 +53,12 @@ def __init__(
         self.setLayout(self._layout)
 
     def _init_layout(self) -> QHBoxLayout:
+        """
+        Return layout of the widget.
+
+        - On the left, there is a LabelWidget with set value.
+        - On the right, there is a spinbox to set a value in the label.
+        """
         right_side = QVBoxLayout()
         right_side.setAlignment(Qt.AlignTop)
         right_side.addWidget(QLabel("\nSet icon value:"))
@@ -64,6 +72,7 @@ def _init_layout(self) -> QHBoxLayout:
         return layout
 
     def _create_icon(self, value: int) -> LabelWidget[T]:
+        """Create LabelWidget with given value."""
         label = self._create_label_from_integer(value)
 
         icon = dispatch_label_widget(label)(
@@ -76,6 +85,7 @@ def _create_icon(self, value: int) -> LabelWidget[T]:
         return icon
 
     def _init_spin_box(self) -> QSpinBox:
+        """Return spinbox."""
         def update_icon(a0: int) -> None:
             self._icon = self._create_icon(a0)
             self._icon_holder.setWidget(self._icon)
@@ -91,6 +101,7 @@ def update_icon(a0: int) -> None:
         return spin_box
 
     def _init_icon_holder(self) -> QScrollArea:
+        """Return QScrollArea that can hold the LabelWidget."""
         icon_holder = QScrollArea()
         icon_holder.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
         icon_holder.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOff)

shortcut_composer/composer_utils/label/complex_widgets/scroll_area.py

@@ -6,14 +6,14 @@
 
 from PyQt5.QtCore import Qt, QTimer, pyqtSignal
 from PyQt5.QtWidgets import (
-    QWidget,
     QScrollArea,
-    QScroller,
-    QLabel,
-    QLineEdit,
     QVBoxLayout,
     QHBoxLayout,
-    QSizePolicy)
+    QSizePolicy,
+    QScroller,
+    QLineEdit,
+    QWidget,
+    QLabel)
 
 from composer_utils.label import LabelWidget, LabelWidgetStyle
 from composer_utils.label.label_widget_impl import dispatch_label_widget

shortcut_composer/composer_utils/label/label_text.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from dataclasses import dataclass, field
+
 from PyQt5.QtGui import QColor
 
 

shortcut_composer/composer_utils/label/label_widget_impl/dispatch_label_widget.py

@@ -3,10 +3,8 @@
 
 from typing import Type, TypeVar
 
-from PyQt5.QtGui import (
-    QPixmap,
-    QIcon,
-)
+from PyQt5.QtGui import QPixmap, QIcon
+
 from ..label_text import LabelText
 from ..label_widget import LabelWidget
 from ..label_interface import LabelInterface

shortcut_composer/composer_utils/label/label_widget_style.py

@@ -1,8 +1,8 @@
 # SPDX-FileCopyrightText: © 2022-2024 Wojciech Trybus <[email protected]>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from typing import Callable
 import platform
+from typing import Callable
 
 from PyQt5.QtGui import QColor
 

shortcut_composer/composer_utils/settings_dialog.py

@@ -5,8 +5,8 @@
 from PyQt5.QtCore import Qt, QSize
 from PyQt5.QtGui import QCursor
 
-from INFO import __version__, __author__, __license__
 from api_krita import Krita
+from INFO import __version__, __author__, __license__
 from config_system.ui import ConfigFormWidget, SpinBox, ColorButton, Checkbox
 from .global_config import Config
 from .buttons_layout import ButtonsLayout

shortcut_composer/config_system/common_utils/api_krita.py

@@ -3,10 +3,10 @@
 
 """Required part of api_krita package, so that no dependency is needed."""
 
-from krita import Krita as Api
 from typing import Any, Protocol
 from dataclasses import dataclass
 
+from krita import Krita as Api
 from PyQt5.QtCore import QByteArray
 
 

shortcut_composer/config_system/common_utils/save_location.py

@@ -3,6 +3,7 @@
 
 from typing import Any, Protocol
 from enum import Enum
+
 from .api_krita import Krita
 
 

shortcut_composer/config_system/field_base_impl/__init__.py

@@ -12,5 +12,4 @@
     "NonListField",
     "ListField",
     "DualField",
-    "FieldWithEditableDefault"
-]
+    "FieldWithEditableDefault"]

shortcut_composer/config_system/field_base_impl/common_utils/parsers.py

@@ -3,6 +3,7 @@
 
 from typing import Generic, TypeVar, Type, Protocol
 from enum import Enum
+
 from PyQt5.QtGui import QColor
 
 T = TypeVar("T")

shortcut_composer/config_system/field_base_impl/dual_field.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from typing import Callable, Generic, TypeVar
+
 from ..field import Field
 from ..field_group import FieldGroup
 

shortcut_composer/config_system/field_base_impl/field_with_editable_default.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from typing import Callable, Generic, TypeVar
+
 from ..field import Field
 
 T = TypeVar("T")

shortcut_composer/config_system/field_base_impl/list_field.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from typing import TypeVar, Generic
+
 from ..field_base import FieldBase
 from .common_utils import dispatch_parser
 

shortcut_composer/config_system/field_base_impl/non_list_field.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from typing import TypeVar, Generic
+
 from ..field_base import FieldBase
 from .common_utils import dispatch_parser