Merge pull request #3166 from CoolCat467/crate-ci-typos

Add spellchecking with `crate-ci/typos`

Author: CoolCat467

.pre-commit-config.yaml

@@ -34,6 +34,10 @@ repos:
     rev: v2.3.0
     hooks:
       - id: codespell
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.28.4
+    hooks:
+      - id: typos
   - repo: https://github.com/sphinx-contrib/sphinx-lint
     rev: v1.0.0
     hooks:

newsfragments/3166.breaking.rst

@@ -0,0 +1 @@
+Fixed spelling error in Windows CFFI ErrorCodes Enum ``ERROR_INVALID_PARAMETER``

pyproject.toml

@@ -84,6 +84,19 @@ force-exclude = '''
 [tool.codespell]
 ignore-words-list = 'astroid,crasher,asend'
 
+[tool.typos]
+default.extend-ignore-re = [
+    "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+]
+
+[tool.typos.default.extend-identifiers]
+IPPROTO_ND = "IPPROTO_ND"
+
+[tool.typos.default.extend-words]
+astroid = "astroid"
+crasher = "crasher"
+asend = "asend"
+
 [tool.ruff]
 respect-gitignore = true
 fix = true

src/trio/_abc.py

@@ -192,9 +192,7 @@ async def getaddrinfo(
         Any required IDNA encoding is handled before calling this function;
         your implementation can assume that it will never see U-labels like
         ``"café.com"``, and only needs to handle A-labels like
-        ``b"xn--caf-dma.com"``.
-
-        """
+        ``b"xn--caf-dma.com"``."""  # spellchecker:disable-line
 
     @abstractmethod
     async def getnameinfo(

src/trio/_core/_ki.py

@@ -136,7 +136,7 @@ def remove(
         ) -> None:
             self = selfref()
             if self is not None:
-                try:  # noqa: SIM105 # supressible-exception
+                try:  # noqa: SIM105  # suppressible-exception
                     del self._data[k]
                 except KeyError:
                     pass

src/trio/_core/_parking_lot.py

@@ -1,5 +1,5 @@
 # ParkingLot provides an abstraction for a fair waitqueue with cancellation
-# and requeueing support. Inspiration:
+# and requeuing support. Inspiration:
 #
 #    https://webkit.org/blog/6161/locking-in-webkit/
 #    https://amanieu.github.io/parking_lot/
@@ -136,7 +136,7 @@ class ParkingLotStatistics:
 @final
 @attrs.define(eq=False)
 class ParkingLot:
-    """A fair wait queue with cancellation and requeueing.
+    """A fair wait queue with cancellation and requeuing.
 
     This class encapsulates the tricky parts of implementing a wait
     queue. It's useful for implementing higher-level synchronization

src/trio/_core/_run.py

@@ -348,7 +348,7 @@ class CancelStatus:
     # become effectively cancelled when they do, unless scope.shield
     # is True.  May be None (for the outermost CancelStatus in a call
     # to trio.run(), briefly during TaskStatus.started(), or during
-    # recovery from mis-nesting of cancel scopes).
+    # recovery from misnesting of cancel scopes).
     _parent: CancelStatus | None = attrs.field(default=None, repr=False, alias="parent")
 
     # All of the CancelStatuses that have this CancelStatus as their parent.
@@ -362,7 +362,7 @@ class CancelStatus:
 
     # Set to True on still-active cancel statuses that are children
     # of a cancel status that's been closed. This is used to permit
-    # recovery from mis-nested cancel scopes (well, at least enough
+    # recovery from misnested cancel scopes (well, at least enough
     # recovery to show a useful traceback).
     abandoned_by_misnesting: bool = attrs.field(default=False, init=False, repr=False)
 
@@ -595,7 +595,7 @@ def _close(self, exc: BaseException | None) -> BaseException | None:
             return new_exc
         scope_task = current_task()
         if scope_task._cancel_status is not self._cancel_status:
-            # Cancel scope mis-nesting: this cancel scope isn't the most
+            # Cancel scope misnesting: this cancel scope isn't the most
             # recently opened by this task (that's still open). That is,
             # our assumptions about context managers forming a stack
             # have been violated. Try and make the best of it.

src/trio/_core/_windows_cffi.py

@@ -420,7 +420,7 @@ class ErrorCodes(enum.IntEnum):
     ERROR_OPERATION_ABORTED = 995
     ERROR_ABANDONED_WAIT_0 = 735
     ERROR_INVALID_HANDLE = 6
-    ERROR_INVALID_PARMETER = 87
+    ERROR_INVALID_PARAMETER = 87
     ERROR_NOT_FOUND = 1168
     ERROR_NOT_SOCKET = 10038
 

src/trio/_tests/test_threads.py

@@ -852,7 +852,7 @@ async def async_back_in_main() -> tuple[str, str]:
     assert sniffio.current_async_library() == "trio"
 
 
-def test_run_fn_as_system_task_catched_badly_typed_token() -> None:
+def test_run_fn_as_system_task_caught_badly_typed_token() -> None:
     with pytest.raises(RuntimeError):
         from_thread_run_sync(
             _core.current_time,

src/trio/_util.py

@@ -234,7 +234,7 @@ def fix_one(qualname: str, name: str, obj: object) -> None:
 # so don't bother.
 class generic_function(Generic[RetT]):
     """Decorator that makes a function indexable, to communicate
-    non-inferrable generic type parameters to a static type checker.
+    non-inferable generic type parameters to a static type checker.
 
     If you write::