Merge pull request #45 from goanpeca/typing

.github/workflows/make_bundle_conda.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - main
+    paths:
+      - 'build_installers.py'
   workflow_call:
     inputs:
       event_name:

.github/workflows/typing.yml

@@ -0,0 +1,46 @@
+name: typing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'constructor-manager/**'
+      - 'constructor-manager-cli/**'
+      - 'constructor-manager-ui/**'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: ${{ matrix.platform }} py${{ matrix.python-version }}
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: ['3.10']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          cd constructor-manager-ui
+          pip install -e ".[typing]"
+          pip install -e ".[testing]"
+          pip list
+
+      - name: Typing
+        run: |
+          cd constructor-manager-ui
+          pip install -e ".[pyqt5]"
+          cd src
+          mypy constructor_manager_ui --always-true=PYQT5 --always-false=PYSIDE2 --always-false=PYQT6 --always-false=PYSIDE6

.pre-commit-config.yaml

@@ -3,29 +3,37 @@ repos:
     rev: v4.4.0
     hooks:
       - id: check-docstring-first
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
       - id: end-of-file-fixer
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
       - id: trailing-whitespace
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.2.2
     hooks:
       - id: pyupgrade
         args: [--py38-plus, --keep-runtime-typing]
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
   - repo: https://github.com/myint/autoflake
     rev: v2.0.0
     hooks:
       - id: autoflake
         args: ["--in-place", "--remove-all-unused-imports"]
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
   - repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:
       - id: black
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
   - repo: https://github.com/PyCQA/flake8
     rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies: [flake8-typing-imports>=1.9.0]
         args: ["-j8", "--ignore=TYP001,E501,W503"]
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: v0.0.143
     hooks:
       - id: ruff
+        exclude: ^constructor-manager-ui/src/constructor_manager_ui/style/images.py

constructor-manager-ui/README.md

@@ -25,8 +25,24 @@ Install testing dependencies:
 pip install -e .[testing]
 ```
 
+Install typing dependencies:
+
+```bash
+pip install -e .[typing]
+```
+
 Run the application:
 
 ```bash
 constructor-manager-ui napari
 ```
+
+Generate resources file:
+
+Once installed, run the command below to generate the resource file:
+
+```bash
+constructor-manager-ui-qrc
+```
+
+You need to have pyqt5 installed.

constructor-manager-ui/pyproject.toml

@@ -5,6 +5,13 @@ build-backend = "setuptools.build_meta"
 [tool.black]
 line-length = 79
 
-[tool.isort]
-profile = "black"
-line_length = 79
+[tool.mypy]
+ignore_missing_imports = true
+exclude = [
+  "tests",
+]
+show_error_codes = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true

constructor-manager-ui/setup.cfg

@@ -40,6 +40,7 @@ where = src
 [options.entry_points]
 console_scripts =
     constructor-manager-ui = constructor_manager_ui.cli:run
+    constructor-manager-ui-qrc = constructor_manager_ui.style.utils:generate_resource_file
 
 [options.extras_require]
 testing =
@@ -53,9 +54,11 @@ pyqt5 =
     pyqt5
 pyside2 =
     pyside2
-
-[mypy]
-exclude = venv|tests
-
-[mypy-packaging.*]
-ignore_missing_imports = True
+typing =
+    mypy
+    typing-extensions
+    types-requests
+    types-urllib3
+    typing-inspect
+    mypy-extensions
+    types-PyYAML

constructor-manager-ui/src/constructor_manager_ui/__init__.py

@@ -0,0 +1 @@
+"""Constructor manager."""

constructor-manager-ui/src/constructor_manager_ui/data.py

@@ -1,7 +1,20 @@
 """Mock data for the installation manager dialog UI."""
+from typing import Dict, Optional, List, NamedTuple
 
-PACKAGE_NAME = "napari"
-INSTALL_INFORMATION = {
+# Types
+VersionInfo = Dict[str, str]
+
+
+class PackageData(NamedTuple):
+    name: str
+    version: str
+    source: str
+    build: Optional[str]
+    plugin: bool
+
+
+PACKAGE_NAME: str = "napari"
+INSTALL_INFORMATION: Dict[str, VersionInfo] = {
     "current_version": {
         "version": "v0.4.16",
         "last_modified": "July 27, 2022",
@@ -11,22 +24,22 @@
         "last_modified": "April 5, 2022",
     },
 }
-UPDATE_AVAILABLE_VERSION = "v0.4.17"
-PACKAGES = [
+UPDATE_AVAILABLE_VERSION: str = "v0.4.17"
+PACKAGES: List[PackageData] = [
     # Package:
     # Name - Version - Source - Build - Related package (plugin or package itself)
-    ("napari", "0.4.16", "pip", None, True),
-    ("napari-console", "0.1.6", "pip", None, True),
-    (
+    PackageData("napari", "0.4.16", "pip", None, True),
+    PackageData("napari-console", "0.1.6", "pip", None, True),
+    PackageData(
         "napari-live-recording",
         "0.1.6rc",
         "conda/conda-forge",
         "pyhd3eb1b0_0",
         True,
     ),
-    ("napari-microscope", "0.7", "pip", None, True),
-    ("alabaster", "0.7.12", "conda/conda-forge", "pyhd3eb1b0_0", False),
-    ("aom", "3.5.0", "conda/conda-forge", "pyhd3eb1b0_0", False),
-    ("appdirs", "1.4.4", "conda/conda-forge", "pyhd3eb1b0_0", False),
-    ("appnope", "0.1.2", "conda/conda-forge", "pyhd3eb1b0_0", False),
+    PackageData("napari-microscope", "0.7", "pip", None, True),
+    PackageData("alabaster", "0.7.12", "conda/conda-forge", "pyhd3eb1b0_0", False),
+    PackageData("aom", "3.5.0", "conda/conda-forge", "pyhd3eb1b0_0", False),
+    PackageData("appdirs", "1.4.4", "conda/conda-forge", "pyhd3eb1b0_0", False),
+    PackageData("appnope", "0.1.2", "conda/conda-forge", "pyhd3eb1b0_0", False),
 ]

constructor-manager-ui/src/constructor_manager_ui/main.py

@@ -1,6 +1,7 @@
 """Constructor manager main interface."""
 
 import sys
+from typing import Optional
 
 from qtpy.QtCore import QSize, Qt, QTimer, Signal
 from qtpy.QtGui import QBrush, QMovie
@@ -23,11 +24,15 @@
     QWidget,
 )
 
+# To get mock data
 from constructor_manager_ui.data import (
     INSTALL_INFORMATION,
     PACKAGES,
     UPDATE_AVAILABLE_VERSION,
 )
+
+# To setup image resources for .qss file
+from constructor_manager_ui.style import images  # noqa
 from constructor_manager_ui.style.utils import update_styles
 
 # Packages table constants
@@ -36,8 +41,9 @@
 
 
 class SpinnerWidget(QWidget):
-    def __init__(self, text, parent=None):
+    def __init__(self, text: str, parent: Optional[QWidget] = None):
         super().__init__(parent=parent)
+
         # Widgets for text and loading gif
         self.text_label = QLabel(text)
         spinner_label = QLabel()
@@ -54,7 +60,7 @@ def __init__(self, text, parent=None):
         self.setLayout(layout)
         self.spinner_movie.start()
 
-    def set_text(self, text):
+    def set_text(self, text: str):
         self.text_label.setText(text)
 
     def show(self):
@@ -71,7 +77,7 @@ class UpdateWidget(QWidget):
     install_version = Signal(str)
     skip_version = Signal(str)
 
-    def __init__(self, package_name, parent=None):
+    def __init__(self, package_name: str, parent: Optional[QWidget] = None):
         super().__init__(parent=parent)
         self.package_name = package_name
         self.update_available_version = None
@@ -157,15 +163,15 @@ def __init__(self, packages, visible_packages=RELATED_PACKAGES, parent=None):
         self.visible_packages = visible_packages
         self.setup()
 
-    def _create_item(self, text, related_package):
+    def _create_item(self, text: str, related_package: bool):
         item = QTableWidgetItem(text)
         if related_package:
-            background_brush = QBrush(Qt.black)
+            background_brush = QBrush(Qt.GlobalColor.black)
         else:
-            background_brush = QBrush(Qt.darkGray)
+            background_brush = QBrush(Qt.GlobalColor.darkGray)
         item.setBackground(background_brush)
         if not related_package:
-            foreground_brush = QBrush(Qt.black)
+            foreground_brush = QBrush(Qt.GlobalColor.black)
             item.setForeground(foreground_brush)
         return item
 
@@ -228,9 +234,9 @@ def change_detailed_info_visibility(self, state):
 class InstallationManagerDialog(QDialog):
     def __init__(
         self,
-        package_name,
+        package_name: str,
         install_information,
-        parent=None,
+        parent: Optional[QWidget] = None,
     ):
         super().__init__(parent=parent)
         self.package_name = package_name
@@ -422,7 +428,7 @@ def uninstall(self):
         print("Uninstall")
 
 
-def main(package_name):
+def main(package_name: str):
     """Run the main interface.
 
     Parameters

constructor-manager-ui/src/constructor_manager_ui/style/__init__.py

@@ -0,0 +1 @@
+"""Constructor manager."""