pre-commit: Find and fix typos with codespell

Author: cclauss

.github/workflows/build-manylinux.yml

@@ -46,7 +46,7 @@ jobs:
           # The * here essentially tells cibuildwheel to follow its default behaviour 
           # of building all possible build configurations the particular cibuildwheel
           # version supports. Unless cibuildwheel itself is bumped to the next version,
-          # this will stay constant and do the same set of builds everytime.
+          # this will stay constant and do the same set of builds every time.
           - { image: manylinux2014, arch: x86_64, pyversions: "*" }
           - { image: manylinux2014, arch: i686, pyversions: "*" }
 

.pre-commit-config.yaml

@@ -36,6 +36,14 @@ repos:
                 | src_c/sdlmain_osx.m
             )$
 
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+    - id: codespell
+      args: ["--skip=docs/es/*,src_c/*,setup.py,*.json"]
+      additional_dependencies:
+        - tomli
+
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: v0.3.7
     hooks:

buildconfig/manylinux-build/docker_base/pkg-config/build-pkg-config.sh

@@ -9,7 +9,7 @@ set -e -x
 cd $(dirname `readlink -f "$0"`)
 
 # We save the compiled-in PKG_CONFIG_PATH of the pre-existing pkg-config, and
-# re-use it with the new pkg-config
+# reuse it with the new pkg-config
 COMPILED_PKGCONFIG_DIRS=$(pkg-config --variable pc_path pkg-config)
 
 # append path(s) where other installs put .pc files

buildconfig/stubs/pygame/sprite.pyi

@@ -122,7 +122,7 @@ _TDirtySprite = TypeVar("_TDirtySprite", bound=_DirtySpriteSupportsGroup)
 # missing image and rect attributes
 # a = Group(Sprite())
 
-# typechecker should error, other Sprite attibutes are also needed for Group
+# typechecker should error, other Sprite attributes are also needed for Group
 # class MySprite:
 #     image: Surface
 #     rect: Rect
@@ -255,7 +255,7 @@ class collide_circle_ratio:
     ) -> bool: ...
 
 # argument to collide_mask must either have mask or have image attribute, in
-# addtion to mandatorily having a rect attribute
+# addition to mandatorily having a rect attribute
 _SupportsCollideMask = Union[_HasImageAndRect, _HasMaskAndRect]
 
 def collide_mask(

docs/README.md

@@ -38,15 +38,15 @@ is written in rst files, which stands for "ReStructured Text." We use Sphinx
 ([Sphinx Documentation](https://www.sphinx-doc.org/en/master/)) to convert
 these rst files into html, which are then hosted on the pygame website.
 
-Sphinx has a good ReStructed Text primer to learn the basics:
+Sphinx has a good ReStructured Text primer to learn the basics:
 https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
 
 Contributing steps:
-- Have an idea to improve the docs, perhaps create an issue on Github
+- Have an idea to improve the docs, perhaps create an issue on GitHub
 - Find the file you want to edit: it will most likely be in `docs/reST/ref`.
 OR
-- Pygame docs pages have an "Edit on Github" button, which will show you the file
-- Download the pygame source from Github locally.  
+- Pygame docs pages have an "Edit on GitHub" button, which will show you the file
+- Download the pygame source from GitHub locally.  
      ^ One way to do this is to fork and use a Git client to make that a local repository
 - Implement your idea.
 - Follow the steps in "Generating the Documentation"

docs/reST/ref/key.rst

@@ -269,7 +269,7 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:
 
    .. versionadded:: 2.2.0
       The collection of bools returned by ``get_pressed`` can not be iterated
-      over because the indexes of the internal tuple does not correpsond to the 
+      over because the indexes of the internal tuple does not correspond to the 
       keycodes.
 
    .. versionadded:: 2.5.0
@@ -352,7 +352,7 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:
    corresponding key constant exists and is unique). If the return value is
    passed to the ``key_code`` function, the original constant will be returned.
 
-   **Experimental:** ``use_compat`` paramater still in development for testing and feedback. It may change.
+   **Experimental:** ``use_compat`` parameter still in development for testing and feedback. It may change.
    `Please leave use_compat feedback with authors <https://github.com/pygame/pygame/pull/3312>`_
 
    If this argument is ``False``, the returned name may be prettier to display

docs/reST/ref/sdl2_controller.rst

@@ -225,7 +225,7 @@ events related to controllers.
 
       .. versionchanged:: 2.0.2: Return type changed from ``str`` to ``dict``
 
-      .. ## Contorller.get_mapping ##
+      .. ## Controller.get_mapping ##
 
    .. method:: set_mapping
 
@@ -255,7 +255,7 @@ events related to controllers.
       .. versionchanged:: 2.0.2: Renamed from ``add_mapping`` to ``set_mapping``
       .. versionchanged:: 2.0.2: Argument type changed from ``str`` to ``dict``
 
-      .. ## Contorller.set_mapping ##
+      .. ## Controller.set_mapping ##
 
    .. method:: rumble
 
@@ -273,7 +273,7 @@ events related to controllers.
 
       .. versionadded:: 2.0.2
 
-      .. ## Contorller.rumble ##
+      .. ## Controller.rumble ##
 
    .. method:: stop_rumble
 
@@ -285,6 +285,6 @@ events related to controllers.
 
       .. versionadded:: 2.0.2
 
-      .. ## Contorller.stop_rumble ##
+      .. ## Controller.stop_rumble ##
 
 .. ## pygame._sdl2.controller ##

docs/reST/tut/SurfarrayIntro-rest

@@ -29,7 +29,7 @@ Transparency
 
 .. comment out
    The surfarray module has several methods for accessing a Surface's alpha/colorkey
-   values. None of the alpha functions are effected by overal transparency of a
+   values. None of the alpha functions are effected by overall transparency of a
    Surface, just the pixel alpha values. Here's the list of those functions.
    <dl>
    <dt>``surfarray.pixels_alpha(surface)``</dt><dd>Creates a 2D array *(integer pixel values)* that references the original surface alpha data. This will only

setup.cfg

@@ -20,6 +20,14 @@ commands =
 pyinstaller40 =
 	hook-dirs = pygame.__pyinstaller:get_hook_dirs
 
+# ignore-words-list is a comma-separated list of lowercase words to be
+#   ignored by codespell.  Typos should be fixed but for instance Mechanim
+#   is the name of a software product so we want codespell to ignore that.
+[codespell]
+skip = ./docs/es/*,./src_c/*,setup.py,*.json
+ignore-words-list = ags,ans,appen,datas,fo,likey,mechanim,nd,nin,nnumber,paeth,pevents,rocess,statics,testin
+quiet-level = 35
+
 [isort]
 include_trailing_comma = True
 known_first_party = pygame

src_c/math.c

@@ -1533,7 +1533,7 @@ vector_slerp(pgVector *self, PyObject *args)
     tmp = (tmp < -1 ? -1 : (tmp > 1 ? 1 : tmp));
     angle = acos(tmp);
 
-    /* if t < 0 we take the long arch of the greate circle to the destiny */
+    /* if t < 0 we take the long arch of the great circle to the destiny */
     if (t < 0) {
         angle -= 2 * M_PI;
         t = -t;

test/README.rst

@@ -101,7 +101,7 @@ these module level tags.
 Class Level Tags
 ----------------
 
-If you want to override a specifig tag then you can use negation. ::
+If you want to override a specific tag then you can use negation. ::
 
     class SomeTest(unittest.TestCase):
         __tags__ = ['-interactive']

test/display_test.py

@@ -1056,7 +1056,7 @@ class DisplayUpdateInteractiveTest(DisplayUpdateTest):
     __tags__ = ["interactive"]
 
     def question(self, qstr):
-        """since this is the interactive sublcass we ask a question."""
+        """since this is the interactive subclass we ask a question."""
         question(qstr)
 
 

test/font_test.py

@@ -281,7 +281,7 @@ def test_default_parameters(self):
         f = pygame_font.Font()
 
     def test_get_ascent(self):
-        # Ckecking ascent would need a custom test font to do properly.
+        # Checking ascent would need a custom test font to do properly.
         f = pygame_font.Font(None, 20)
         ascent = f.get_ascent()
         self.assertTrue(isinstance(ascent, int))
@@ -290,14 +290,14 @@ def test_get_ascent(self):
         self.assertTrue(s.get_size()[1] > ascent)
 
     def test_get_descent(self):
-        # Ckecking descent would need a custom test font to do properly.
+        # Checking descent would need a custom test font to do properly.
         f = pygame_font.Font(None, 20)
         descent = f.get_descent()
         self.assertTrue(isinstance(descent, int))
         self.assertTrue(descent < 0)
 
     def test_get_height(self):
-        # Ckecking height would need a custom test font to do properly.
+        # Checking height would need a custom test font to do properly.
         f = pygame_font.Font(None, 20)
         height = f.get_height()
         self.assertTrue(isinstance(height, int))
@@ -306,7 +306,7 @@ def test_get_height(self):
         self.assertTrue(s.get_size()[1] == height)
 
     def test_get_linesize(self):
-        # Ckecking linesize would need a custom test font to do properly.
+        # Checking linesize would need a custom test font to do properly.
         # Questions: How do linesize, height and descent relate?
         f = pygame_font.Font(None, 20)
         linesize = f.get_linesize()

test/test_utils/buftools.py

@@ -3,8 +3,8 @@
 Export the Exporter and Importer classes.
 
 Class Exporter has configurable shape and strides. Exporter objects
-provide a convient target for unit tests on Pygame objects and functions that
-import a new buffer interface.
+provide a convenient target for unit tests on Pygame objects and functions
+that import a new buffer interface.
 
 Class Importer imports a buffer interface with the given PyBUF_* flags.
 It returns NULL Py_buffer fields as None. The shape, strides, and suboffsets

test/test_utils/png.py

@@ -799,7 +799,7 @@ def wrapmapint(f):
                     # print(len(data), len(compressed), file= >> sys.stderr)
                     write_chunk(outfile, "IDAT", compressed)
                 # Because of our very witty definition of ``extend``,
-                # above, we must re-use the same ``data`` object.  Hence
+                # above, we must reuse the same ``data`` object.  Hence
                 # we use ``del`` to empty this one, rather than create a
                 # fresh one (which would be my natural FP instinct).
                 del data[:]