Merge pull request #132 from yarikoptic/enh-codespell

Add codespell support with configuration and fixes

Author: ThomasWaldmann

.github/workflows/codespell.yml

@@ -0,0 +1,23 @@
+# Codespell configuration is within pyproject.toml
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

pyproject.toml

@@ -91,5 +91,9 @@ exclude = [ "**/__pycache__",
 # test, it adds the tests/ directory to sys.path)
 extraPaths = ['test']
 
+[tool.codespell]
+skip = '.git,*.html,developer-notes/'
+ignore-words-list = 're-use,re-used'
+
 [tool.ruff.format]
 quote-style = "preserve"

src/pyfuse3/__init__.pyx

@@ -557,7 +557,7 @@ def syncfs(path):
     '''Sync filesystem mounted at *path*
 
     This is a Python interface to the syncfs(2) system call. There is no
-    particular relation to libfuse, it is provided by pyfuse3 as a convience.
+    particular relation to libfuse, it is provided by pyfuse3 as a convenience.
     '''
 
     cdef int ret
@@ -791,7 +791,7 @@ def terminate():
 
     When called by a thread different from the one that runs the main loop, the call must
     be wrapped with `trio.from_thread.run_sync`. The necessary *trio_token* argument can
-    (for convience) be retrieved from the `trio_token` module attribute.
+    (for convenience) be retrieved from the `trio_token` module attribute.
     '''
 
     fuse_session_exit(session)
@@ -801,7 +801,7 @@ def terminate():
 def close(unmount=True):
     '''Clean up and ensure filesystem is unmounted
 
-    If *unmount* is False, only clean up operations are peformed, but the file
+    If *unmount* is False, only clean up operations are performed, but the file
     system is not explicitly unmounted.
 
     Normally, the filesystem is unmounted by the user calling umount(8) or

src/pyfuse3/_pyfuse3.py

@@ -240,7 +240,7 @@ async def unlink(self, parent_inode: InodeT, name: FileNameT, ctx: "RequestConte
         '''Remove a (possibly special) file.
 
         This method must remove the (special or regular) file *name* from the
-        direcory with inode *parent_inode*.  *ctx* will be a `RequestContext`
+        directory with inode *parent_inode*.  *ctx* will be a `RequestContext`
         instance.
 
         If the inode associated with *file* (i.e., not the *parent_inode*) has a
@@ -260,7 +260,7 @@ async def unlink(self, parent_inode: InodeT, name: FileNameT, ctx: "RequestConte
     async def rmdir(self, parent_inode: InodeT, name: FileNameT, ctx: "RequestContext") -> None:
         '''Remove directory *name*.
 
-        This method must remove the directory *name* from the direcory with
+        This method must remove the directory *name* from the directory with
         inode *parent_inode*. *ctx* will be a `RequestContext` instance. If
         there are still entries in the directory, the method should raise
         ``FUSEError(errno.ENOTEMPTY)``.
@@ -275,7 +275,7 @@ async def rmdir(self, parent_inode: InodeT, name: FileNameT, ctx: "RequestContex
 
         (Since hard links to directories are not allowed by POSIX, this method
         is not required to check if there are still other directory entries
-        refering to the same inode. This conveniently avoids the ambigiouties
+        referring to the same inode. This conveniently avoids the ambiguities
         associated with the ``.`` and ``..`` entries).
         '''
 
@@ -350,7 +350,7 @@ async def link(
         new_name: FileNameT,
         ctx: "RequestContext",
     ) -> "EntryAttributes":
-        '''Create directory entry *name* in *parent_inode* refering to *inode*.
+        '''Create directory entry *name* in *parent_inode* referring to *inode*.
 
         *ctx* will be a `RequestContext` instance.