chore: type check using 'ty' (#120)

Author: marcelotduarte

.github/workflows/ci.yml

@@ -20,19 +20,54 @@ jobs:
         with:
           egress-policy: audit
 
-      - name: Fetch only the required files for testing
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - uses: j178/prek-action@6ad80277337ad479fe43bd70701c3f7f8aa74db3 # v2.0.3
+        with:
+          extra-args: "--all-files --skip=ty-check"
 
       - uses: pre-commit-ci/lite-action@5d6cc0eb514c891a40562a58a8e71576c5c7fb43 # v1.1.0
         if: always()
 
+  type_check:
+    runs-on: ${{ matrix.os }}-${{ matrix.os_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows]
+        os_version: [latest]
+        python-version: ["3.13", "3.14"]
+    defaults:
+      run:
+        shell: bash
+    env:
+      UV_NO_PROGRESS: true
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@a5ad31d6a139d249332a2605b85202e8c0b78450 # v2.19.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        with:
+          activate-environment: true
+          cache-dependency-glob: "pyproject.toml"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: ci/install-tools.sh --dev --tests
+
+      - name: Type check
+        run: ty check
+
   build_wheel:
     name: Build wheels
     uses: ./.github/workflows/build.yml
     needs:
       - pre_commit
+      - type_check
 
   testpypi:
     name: Publish package to TestPyPI

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
     hooks:
       - id: validate-pyproject
         additional_dependencies:
-          - validate-pyproject-schema-store[all]>=2026.05.18
+          - validate-pyproject-schema-store[all]>=2026.05.24
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 0c7b6c989466a93942def1f84baf36ddfcd60c83 # frozen: v0.15.14
@@ -58,6 +58,16 @@ repos:
     hooks:
       - id: shellcheck
 
+  - repo: local
+    hooks:
+      - id: ty-check
+        name: typecheck
+        description: Type check python files with ty
+        entry: ty check
+        language: system
+        types: [python]
+        pass_filenames: false
+
   - repo: local
     hooks:
       - id: pythoncapi

ci/install-tools.sh

@@ -23,6 +23,7 @@ elif which python &>/dev/null; then
     PY_PLATFORM=$(python -c "import sysconfig; print(sysconfig.get_platform(), end='')")
     IS_WINDOWS=$([[ $PY_PLATFORM == win* ]] && echo "1")
     IS_UV="1"
+    python ci/requirements.py
 else
     echo "error: Python is required."
     exit 1
@@ -187,7 +188,7 @@ if [ "$INSTALL_DEV" == "1" ]; then
             # prek has no dependencies (doesn't bloat the installed packages)
             if [ "$name" == "prek" ] && [ "$IS_CONDA" == "1" ]; then
                 $CONDA_EXE install -c conda-forge "$name" -S -q -y
-            elif [ "$name" == "prek" ] && [ "$IS_UV" == "1" ]; then
+            elif [ "$name" != "cibuildwheel" ] && [ "$IS_UV" == "1" ]; then
                 uv pip install --upgrade "$name"
             else
                 filename=$INSTALL_DIR/$name

pyproject.toml

@@ -48,6 +48,7 @@ Documentation = "https://docs.python.org/3.12/library/msilib.html"
 dev = [
     "cibuildwheel>=3.4.1",
     "prek>=0.4.0,<0.5.0",
+    "ty>=0.0.39",
 ]
 tests = [
     "coverage>=7.13.0",

requirements-dev.txt

@@ -1,2 +1,3 @@
 cibuildwheel>=3.4.1
 prek>=0.4.0,<0.5.0
+ty>=0.0.39

src/msilib/__init__.py

@@ -61,10 +61,11 @@
 )
 
 if TYPE_CHECKING:
-    from collections.abc import Container, Iterable, Sequence
+    from collections.abc import Container, Iterable
     from types import ModuleType
 
     from ._msi import _Database
+    from .sequence import _SequenceType
 
 __version__ = metadata.version("python-msilib")
 
@@ -187,9 +188,9 @@ def sql(self) -> str:
         fields = []
         keys = []
         self.fields.sort()
-        fields = [None] * len(self.fields)
+        # fields: list[str] = [""] * len(self.fields)
         for index, name, ftype in self.fields:
-            idx = index - 1
+            index - 1
             unk = ftype & ~knownbits
             if unk:
                 print(f"{self.name}.{name} unknown bits {unk:x}")
@@ -212,7 +213,8 @@ def sql(self) -> str:
             flags = "" if ftype & type_nullable else " NOT NULL"
             if ftype & type_localizable:
                 flags += " LOCALIZABLE"
-            fields[idx] = f"`{name}` {tname}{flags}"
+            # fields[idx] = f"`{name}` {tname}{flags}"
+            fields.append(f"`{name}` {tname}{flags}")
             if ftype & type_key:
                 keys.append(f"`{name}`")
         fields = ", ".join(fields)
@@ -225,22 +227,18 @@ def create(self, db: _Database) -> None:
         v.Close()
 
 
-class _Unspecified:
-    pass
-
-
 def change_sequence(
-    seq: Sequence[tuple[str, str | None, int]],
+    seq: _SequenceType,
     action: str,
-    seqno: int | type[_Unspecified] = _Unspecified,
-    cond: str | type[_Unspecified] = _Unspecified,
+    seqno: int | None = None,
+    cond: str | None = None,
 ) -> None:
     """Change the sequence number of an action in a sequence list."""
     for i in range(len(seq)):
         if seq[i][0] == action:
-            if cond is _Unspecified:
+            if cond is None:
                 cond = seq[i][1]
-            if seqno is _Unspecified:
+            if seqno is None:
                 seqno = seq[i][2]
             seq[i] = (action, cond, seqno)
             return
@@ -387,7 +385,7 @@ def gen_id(self, file: str) -> str:
         return logical
 
     def append(
-        self, full: str, file: str, logical: str
+        self, full: str, file: str, logical: str | None
     ) -> tuple[int, str] | None:
         if os.path.isdir(full):
             return None
@@ -415,7 +413,7 @@ def commit(self, db: _Database) -> None:
 class Directory:
     db: _Database
     cab: CAB
-    basedir: str
+    basedir: Directory
     physical: str
     logical: str
     component: str | None
@@ -429,7 +427,7 @@ def __init__(
         self,
         db: _Database,
         cab: CAB,
-        basedir: str,
+        basedir: Directory,
         physical: str,
         _logical: str,
         default: str,
@@ -485,7 +483,7 @@ def start_component(
         no keyfile is given, the KeyPath is left null in the Component table.
         """
         if flags is None:
-            flags = self.componentflags
+            flags = self.componentflags or 0
         uuid = gen_uuid() if uuid is None else uuid.upper()
         if component is None:
             component = self.logical
@@ -527,37 +525,37 @@ def make_short(self, file: str) -> str:
             and file == oldfile
             and (not suffix or len(suffix) <= 3)
         ):
-            file = f"{prefix}.{suffix}" if suffix else prefix
+            newfile = f"{prefix}.{suffix}" if suffix else prefix
         else:
-            file = None
-        if file is None or file in self.short_names:
+            newfile = None
+        if newfile is None or newfile in self.short_names:
             prefix = prefix[:6]
             if suffix:
                 suffix = suffix[:3]
             pos = 1
             while 1:
                 if suffix:
-                    file = f"{prefix}~{pos}.{suffix}"
+                    newfile = f"{prefix}~{pos}.{suffix}"
                 else:
-                    file = f"{prefix}~{pos}"
-                if file not in self.short_names:
+                    newfile = f"{prefix}~{pos}"
+                if newfile not in self.short_names:
                     break
                 pos += 1
                 assert pos < 10000
                 if pos in (10, 100, 1000):
                     prefix = prefix[:-1]
-        self.short_names.add(file)
+        self.short_names.add(newfile)
         # restrictions on short names
-        assert not re.search(r'[\?|><:/*"+,;=\[\]]', file)
-        return file
+        assert not re.search(r'[\?|><:/*"+,;=\[\]]', newfile)
+        return newfile
 
     def add_file(
         self,
         file: str,
         src: str | None = None,
         version: str | None = None,
         language: str | None = None,
-    ) -> str:
+    ) -> str | None:
         """Add a file to the current component of the directory, starting a new
         one if there is no current component. By default, the file name in the
         source and the file table will be identical. If the src file is
@@ -575,7 +573,10 @@ def add_file(
         # restrictions on long names
         assert not re.search(r'[\?|><:/*]"', file)
         logical = self.keyfiles.get(file, None)
-        sequence, logical = self.cab.append(absolute, file, logical)
+        ok = self.cab.append(absolute, file, logical)
+        if ok is None:
+            return None
+        sequence, logical = ok
         assert logical not in self.ids
         self.ids.add(logical)
         short = self.make_short(file)
@@ -655,6 +656,8 @@ def glob(
 
     def remove_pyc(self) -> None:
         """Remove .pyc files on uninstall."""
+        if not self.component:
+            self.component = self.logical
         add_data(
             self.db,
             "RemoveFile",
@@ -691,12 +694,11 @@ def __init__(
         attributes: int = 0,
     ) -> None:
         self.id = id
-        if parent:
-            parent = parent.id
+        pid = parent.id if parent else None
         add_data(
             db,
             "Feature",
-            [(id, parent, title, desc, display, level, directory, attributes)],
+            [(id, pid, title, desc, display, level, directory, attributes)],
         )
 
     def set_current(self) -> None:
@@ -886,7 +888,7 @@ def radiogroup(
         w: int,
         h: int,
         attr: int,
-        prop: str | None,
+        prop: str,
         text: str | None,
         next: str | None,
     ) -> Control:

src/msilib/_msi.c

@@ -236,7 +236,7 @@ static FNFCIGETOPENINFO(cb_getopeninfo)
 _msi.FCICreate
     cabname: str
         the name of the CAB file
-    files: object
+    files: list[tuple[str, str]]
         a list of tuples, each containing the name of the file on disk,
         and the name of the file inside the CAB file
     /

src/msilib/_msi.pyi

@@ -53,7 +53,7 @@ class _Record:
     __init__: None  # type: ignore[assignment]
 
 def UuidCreate() -> str: ...
-def FCICreate(cabname: str, files: list[str], /) -> None: ...
+def FCICreate(cabname: str, files: list[tuple[str, str]], /) -> None: ...
 def OpenDatabase(path: str, persist: int, /) -> _Database: ...
 def CreateRecord(count: int, /) -> _Record: ...
 

tests/test_msilib.py

@@ -73,8 +73,8 @@ def test_summaryinfo_getproperty_issue1104(db: _Database) -> None:
         title = sum_info.GetProperty(msilib.PID_TITLE)
         assert title == b"a" * 1001
     finally:
-        db = None
-        sum_info = None
+        del db
+        del sum_info
 
 
 def test_database_open_failed() -> None: