Enable Pyright type checking, and fix all reported issues.

Author: Nikratio

.github/workflows/test.yml

@@ -40,7 +40,10 @@ jobs:
 
       - name: Type check (mypy)
         run: uv run mypy .
-        
+
+      - name: Type check (pyright)
+        run: uv run pyright
+
       - name: Run tests
         run: uv run pytest -v -rs test/
 

examples/hello.py

@@ -27,10 +27,12 @@
 import os
 import stat
 from argparse import ArgumentParser
+from typing import cast
 
 import trio
 
 import pyfuse3
+from pyfuse3 import FileHandleT, FileInfo, InodeT
 
 try:
     import faulthandler
@@ -45,7 +47,7 @@ class TestFs(pyfuse3.Operations):
     def __init__(self):
         super(TestFs, self).__init__()
         self.hello_name = b"message"
-        self.hello_inode = pyfuse3.ROOT_INODE+1
+        self.hello_inode = cast(InodeT, pyfuse3.ROOT_INODE+1)
         self.hello_data = b"hello world\n"
 
     async def getattr(self, inode, ctx=None):
@@ -77,7 +79,8 @@ async def lookup(self, parent_inode, name, ctx=None):
     async def opendir(self, inode, ctx):
         if inode != pyfuse3.ROOT_INODE:
             raise pyfuse3.FUSEError(errno.ENOENT)
-        return inode
+        # For simplicity, we use the inode as file handle
+        return FileHandleT(inode)
 
     async def readdir(self, fh, start_id, token):
         assert fh == pyfuse3.ROOT_INODE
@@ -93,7 +96,8 @@ async def open(self, inode, flags, ctx):
             raise pyfuse3.FUSEError(errno.ENOENT)
         if flags & os.O_RDWR or flags & os.O_WRONLY:
             raise pyfuse3.FUSEError(errno.EACCES)
-        return pyfuse3.FileInfo(fh=inode)
+        # For simplicity, we use the inode as file handle
+        return FileInfo(fh=FileHandleT(inode))
 
     async def read(self, fh, off, size):
         assert fh == self.hello_inode

examples/hello_asyncio.py

@@ -28,9 +28,11 @@
 import os
 import stat
 from argparse import ArgumentParser
+from typing import cast
 
 import pyfuse3
 import pyfuse3.asyncio
+from pyfuse3 import FileHandleT, FileInfo, InodeT
 
 try:
     import faulthandler
@@ -46,7 +48,7 @@ class TestFs(pyfuse3.Operations):
     def __init__(self):
         super(TestFs, self).__init__()
         self.hello_name = b"message"
-        self.hello_inode = pyfuse3.ROOT_INODE+1
+        self.hello_inode = cast(InodeT, pyfuse3.ROOT_INODE+1)
         self.hello_data = b"hello world\n"
 
     async def getattr(self, inode, ctx=None):
@@ -78,7 +80,8 @@ async def lookup(self, parent_inode, name, ctx=None):
     async def opendir(self, inode, ctx):
         if inode != pyfuse3.ROOT_INODE:
             raise pyfuse3.FUSEError(errno.ENOENT)
-        return inode
+        # For simplicity, we use the inode as file handle
+        return FileHandleT(inode)
 
     async def readdir(self, fh, start_id, token):
         assert fh == pyfuse3.ROOT_INODE
@@ -103,7 +106,8 @@ async def open(self, inode, flags, ctx):
             raise pyfuse3.FUSEError(errno.ENOENT)
         if flags & os.O_RDWR or flags & os.O_WRONLY:
             raise pyfuse3.FUSEError(errno.EACCES)
-        return pyfuse3.FileInfo(fh=inode)
+        # For simplicity, we use the inode as file handle
+        return FileInfo(fh=FileHandleT(inode))
 
     async def read(self, fh, off, size):
         assert fh == self.hello_inode

examples/passthroughfs.py

@@ -130,6 +130,7 @@ def _getattr(self, path=None, fd=None):
         assert not(fd is None and path is None)
         try:
             if fd is None:
+                assert path is not None
                 stat = os.lstat(path)
             else:
                 stat = os.fstat(fd)
@@ -160,7 +161,8 @@ async def readlink(self, inode, ctx):
         return fsencode(target)
 
     async def opendir(self, inode, ctx):
-        return inode
+        # For simplicity, we use the inode as file handle
+        return FileHandleT(inode)
 
     async def readdir(self, fh, start_id, token):
         path = self._inode_to_path(fh)
@@ -231,13 +233,13 @@ async def symlink(self, parent_inode, name, target, ctx):
         path = os.path.join(parent, name)
         try:
             os.symlink(target, path)
-            os.chown(path, ctx.uid, ctx.gid, follow_symlinks=False)
+            os.lchown(path, ctx.uid, ctx.gid)
         except OSError as exc:
             assert exc.errno is not None
             raise FUSEError(exc.errno)
         stat = os.lstat(path)
         self._add_path(stat.st_ino, path)
-        return await self.getattr(stat.st_ino)
+        return await self.getattr(InodeT(stat.st_ino))
 
     async def rename(self, parent_inode_old, name_old, parent_inode_new, name_new,
                      flags, ctx):

examples/tmpfs.py

@@ -29,11 +29,12 @@
 from argparse import ArgumentParser
 from collections import defaultdict
 from time import time
+from typing import cast
 
 import trio
 
 import pyfuse3
-from pyfuse3 import FUSEError
+from pyfuse3 import FileHandleT, FileInfo, FUSEError, InodeT
 
 try:
     import faulthandler
@@ -124,9 +125,9 @@ def get_row(self, *a, **kw):
         return row
 
     async def lookup(self, parent_inode, name, ctx=None):
-        if name == '.':
+        if name == b'.':
             inode = parent_inode
-        elif name == '..':
+        elif name == b'..':
             inode = self.get_row("SELECT * FROM contents WHERE inode=?",
                                  (parent_inode,))['parent_inode']
         else:
@@ -136,7 +137,7 @@ async def lookup(self, parent_inode, name, ctx=None):
             except NoSuchRowError:
                 raise(pyfuse3.FUSEError(errno.ENOENT))
 
-        return await self.getattr(inode, ctx)
+        return await self.getattr(InodeT(inode), ctx)
 
 
     async def getattr(self, inode, ctx=None):
@@ -170,19 +171,22 @@ async def readlink(self, inode, ctx):
         return self.get_row('SELECT * FROM inodes WHERE id=?', (inode,))['target']
 
     async def opendir(self, inode, ctx):
-        return inode
+        # For simplicity, we use the inode as file handle
+        return FileHandleT(inode)
 
     async def readdir(self, fh, start_id, token):
         if start_id == 0:
-            start_id = -1
+            off = -1
+        else:
+            off = start_id
 
         cursor2 = self.db.cursor()
         cursor2.execute("SELECT * FROM contents WHERE parent_inode=? "
-                        'AND rowid > ? ORDER BY rowid', (fh, start_id))
+                        'AND rowid > ? ORDER BY rowid', (fh, off))
 
         for row in cursor2:
             pyfuse3.readdir_reply(
-                token, row['name'], await self.getattr(row['inode']), row['rowid'])
+                token, row['name'], await self.getattr(InodeT(row['inode'])), row['rowid'])
 
     async def unlink(self, parent_inode, name, ctx):
         entry = await self.lookup(parent_inode, name)
@@ -224,16 +228,14 @@ async def rename(self, parent_inode_old, name_old, parent_inode_new, name_new,
 
         entry_old = await self.lookup(parent_inode_old, name_old)
 
+        entry_new = None
         try:
-            entry_new = await self.lookup(parent_inode_new, name_new)
+            entry_new = await self.lookup(parent_inode_new, name_new if isinstance(name_new, bytes) else name_new.encode())
         except pyfuse3.FUSEError as exc:
             if exc.errno != errno.ENOENT:
                 raise
-            target_exists = False
-        else:
-            target_exists = True
 
-        if target_exists:
+        if entry_new is not None:
             self._replace(parent_inode_old, name_old, parent_inode_new, name_new,
                           entry_old, entry_new)
         else:
@@ -335,12 +337,10 @@ async def statfs(self, ctx):
         return stat_
 
     async def open(self, inode, flags, ctx):
-        # Yeah, unused arguments
-        #pylint: disable=W0613
         self.inode_open_count[inode] += 1
 
-        # Use inodes as a file handles
-        return pyfuse3.FileInfo(fh=inode)
+        # For simplicity, we use the inode as file handle
+        return FileInfo(fh=FileHandleT(inode))
 
     async def access(self, inode, mode, ctx):
         # Yeah, could be a function and has unused arguments
@@ -351,7 +351,8 @@ async def create(self, parent_inode, name, mode, flags, ctx):
         #pylint: disable=W0612
         entry = await self._create(parent_inode, name, mode, ctx)
         self.inode_open_count[entry.st_ino] += 1
-        return (pyfuse3.FileInfo(fh=entry.st_ino), entry)
+        # For simplicity, we use the inode as file handle
+        return (FileInfo(fh=FileHandleT(entry.st_ino)), entry)
 
     async def _create(self, parent_inode, name, mode, ctx, rdev=0, target=None):
         if (await self.getattr(parent_inode)).st_nlink == 0:
@@ -364,7 +365,7 @@ async def _create(self, parent_inode, name, mode, ctx, rdev=0, target=None):
                             'ctime_ns, target, rdev) VALUES(?, ?, ?, ?, ?, ?, ?, ?)',
                             (ctx.uid, ctx.gid, mode, now_ns, now_ns, now_ns, target, rdev))
 
-        inode = self.cursor.lastrowid
+        inode = cast(InodeT, self.cursor.lastrowid)
         self.db.execute("INSERT INTO contents(name, inode, parent_inode) VALUES(?,?,?)",
                         (name, inode, parent_inode))
         return await self.getattr(inode)
@@ -386,12 +387,13 @@ async def write(self, fh, off, buf):
         return len(buf)
 
     async def release(self, fh):
-        self.inode_open_count[fh] -= 1
+        inode = cast(InodeT, fh)
+        self.inode_open_count[inode] -= 1
 
-        if self.inode_open_count[fh] == 0:
-            del self.inode_open_count[fh]
-            if (await self.getattr(fh)).st_nlink == 0:
-                self.cursor.execute("DELETE FROM inodes WHERE id=?", (fh,))
+        if self.inode_open_count[inode] == 0:
+            del self.inode_open_count[inode]
+            if (await self.getattr(inode)).st_nlink == 0:
+                self.cursor.execute("DELETE FROM inodes WHERE id=?", (inode,))
 
 class NoUniqueValueError(Exception):
     def __str__(self):

pyproject.toml

@@ -32,6 +32,7 @@ Homepage = "https://github.com/libfuse/pyfuse3"
 
 [dependency-groups]
 dev = [
+    "pyright>=1.1.407",
     "mypy>=1.19.1",
     "pytest >= 3.4.0",
     "pytest-trio",
@@ -77,3 +78,14 @@ disallow_untyped_defs = false
 check_untyped_defs = true
 warn_redundant_casts = true
 warn_unused_ignores = true
+
+[tool.pyright]
+typeCheckingMode = "standard"
+exclude = [ "**/__pycache__",
+            "**/.*",
+           "util/",
+           "rst/conf.py" ]
+
+# Need for pyright to resolve tests importing tests/util.py (when pytest runs the
+# test, it adds the tests/ directory to sys.path)
+extraPaths = ['test']

src/pyfuse3/_pyfuse3.py

@@ -334,9 +334,9 @@ async def symlink(
     async def rename(
         self,
         parent_inode_old: InodeT,
-        name_old: str,
+        name_old: FileNameT,
         parent_inode_new: InodeT,
-        name_new: str,
+        name_new: FileNameT,
         flags: FlagT,
         ctx: "RequestContext"
     ) -> None:

test/test_api.py

@@ -42,6 +42,7 @@ def test_syncfs():
     pyfuse3.syncfs('.')
 
 def _getxattr_helper(path, name):
+    errno = None
     try:
         value = pyfuse3.getxattr(path, name)
     except OSError as exc:

test/test_fs.py

@@ -28,7 +28,7 @@
 import trio
 
 import pyfuse3
-from pyfuse3 import FUSEError
+from pyfuse3 import FileHandleT, FileInfo, FUSEError
 from util import cleanup, fuse_test_marker, umount, wait_for_mount
 
 pytestmark = fuse_test_marker()
@@ -212,7 +212,8 @@ async def lookup(self, parent_inode, name, ctx=None):
     async def opendir(self, inode, ctx):
         if inode != pyfuse3.ROOT_INODE:
             raise pyfuse3.FUSEError(errno.ENOENT)
-        return inode
+        # For simplicity, we use the inode as file handle
+        return FileHandleT(inode)
 
     async def readdir(self, fh, start_id, token):
         assert fh == pyfuse3.ROOT_INODE
@@ -226,7 +227,8 @@ async def open(self, inode, flags, ctx):
             raise pyfuse3.FUSEError(errno.ENOENT)
         if flags & os.O_RDWR or flags & os.O_WRONLY:
             raise pyfuse3.FUSEError(errno.EACCES)
-        return pyfuse3.FileInfo(fh=inode)
+        # For simplicity, we use the inode as file handle
+        return FileInfo(fh=FileHandleT(inode))
 
     async def read(self, fh, off, size):
         assert fh == self.hello_inode