codespell 2.2.6__tar.gz → 2.4.0__tar.gz

codespell-2.4.0/.devcontainer/devcontainer.json

@@ -0,0 +1,14 @@
+{
+  "name": "Codespell Development Environment",
+  "image": "mcr.microsoft.com/devcontainers/python:1-3",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "github.vscode-github-actions",
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
+    }
+  },
+  "postCreateCommand": "bash .devcontainer/post_create.sh"
+}

{codespell-2.2.6 → codespell-2.4.0}/.devcontainer/post_create.sh

@@ -1,3 +1,5 @@
+git config --global --add safe.directory /workspaces/codespell
+
 sudo apt-get update
 sudo apt-get install -y libaspell-dev
 

codespell-2.4.0/.github/release.yml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

{codespell-2.2.6 → codespell-2.4.0}/.github/workflows/codespell-private.yml

@@ -12,31 +12,35 @@ jobs:
   test:
     env:
       REQUIRE_ASPELL: true
-      RUFF_FORMAT: github
+      RUFF_OUTPUT_FORMAT: github
     # Make sure we're using the latest aspell dictionary
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04-arm
+    timeout-minutes: 10
     strategy:
       fail-fast: false
       matrix:
         python-version:
-          - '3.8'
-          - '3.9'
-          - '3.10'
-          - '3.11'
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
         no-toml:
-          - ''
+          - ""
         include:
-          - python-version: '3.10'
-            no-toml: 'no-toml'
+          - python-version: "3.10"
+            no-toml: "no-toml"
     name: ${{ matrix.python-version }} ${{ matrix.no-toml }}
     steps:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Setup python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - run: sudo apt-get install libaspell-dev aspell-en
       - name: Install dependencies
         run: |
@@ -48,20 +52,22 @@ jobs:
       - run: codespell --help
       - run: codespell --version
       - run: make check
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
       # tomli should not be required for the next two steps (and make sure it's not)
       - run: pip uninstall -yq tomli
         if: ${{ matrix.no-toml == 'no-toml' }}
-      - run: codespell --check-filenames --skip="./.git/*,*.pyc,./codespell_lib/tests/test_basic.py,./codespell_lib/data/*,./example/code.c,./build/lib/codespell_lib/tests/test_basic.py,./build/lib/codespell_lib/data/*,README.rst,*.egg-info/*,pyproject-codespell.precommit-toml,./.mypy_cache"
+      - run: codespell --check-filenames --skip="./.git/*,./.pytest_cache/*,./junit-results.xml,*.pyc,./codespell_lib/tests/test_basic.py,./codespell_lib/data/*,./example/code.c,./build/lib/codespell_lib/tests/test_basic.py,./build/lib/codespell_lib/data/*,README.rst,*.egg-info/*,pyproject-codespell.precommit-toml,./.mypy_cache"
       # this file has an error
       - run: "! codespell codespell_lib/tests/test_basic.py"
 
-
   make-check-dictionaries:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - uses: actions/checkout@v4

{codespell-2.2.6 → codespell-2.4.0}/.github/workflows/codespell-windows.yml

@@ -7,14 +7,15 @@ jobs:
   test-windows:
     name: Test Windows
     runs-on: windows-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Setup python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
+          python-version: "3.8"
       - name: Install dependencies
         run: |
           python --version
@@ -24,4 +25,6 @@ jobs:
       - run: codespell --help
       - run: codespell --version
       - run: pytest codespell_lib
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

{codespell-2.2.6 → codespell-2.4.0}/.github/workflows/codespell.yml

@@ -16,4 +16,4 @@ jobs:
         with:
           check_filenames: true
           # When using this Action in other repos, the --skip option below can be removed
-          skip: "./.git,./codespell_lib/data,./example/code.c,test_basic.py,*.pyc,README.rst,pyproject-codespell.precommit-toml"
+          skip: "./.git,./codespell_lib/data,./example/code.c,test_basic.py,./codespell_lib/tests/data,*.pyc,README.rst,pyproject-codespell.precommit-toml"

codespell-2.4.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# Upload a Python Package using Twine when a release is created
+
+name: Build
+on:
+  release:
+    types: [published]
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build package
+        run: python -m build
+      - name: Check package
+        run: twine check --strict dist/*
+      - name: Check env vars
+        run: |
+          echo "Triggered by: ${{ github.event_name }}"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+  # PyPI on release
+  pypi:
+    needs: package
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

{codespell-2.2.6 → codespell-2.4.0}/.gitignore

@@ -1,4 +1,5 @@
 .coverage
+.venv
 build
 dist
 ld
@@ -6,8 +7,10 @@ codespell.egg-info
 *.pyc
 *.orig
 .cache/
+.coverage.*
 .mypy_cache/
 .pytest_cache/
+.ruff_cache/
 codespell_lib/_version.py
 junit-results.xml
 *.egg-info/

codespell-2.4.0/.mailmap

@@ -0,0 +1,2 @@
+Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com>
+luzpaz <luzpaz@@users.noreply.github.com> <luzpaz@users.noreply.github.com>

{codespell-2.2.6 → codespell-2.4.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: codespell
-Version: 2.2.6
-Summary: Codespell
+Version: 2.4.0
+Summary: Fix common misspellings in text files
 Author-email: Lucas De Marchi <lucas.de.marchi@gmail.com>
-License: GPL v2
+License: GPL-2.0-only
 Project-URL: homepage, https://github.com/codespell-project/codespell
 Project-URL: repository, https://github.com/codespell-project/codespell
 Classifier: Intended Audience :: Developers
@@ -21,6 +21,8 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: COPYING
@@ -164,10 +166,10 @@ Want to know if a word you're proposing exists in codespell already? It is possi
 
 You can select the optional dictionaries with the ``--builtin`` option.
 
-Ignoring Words
+Ignoring words
 --------------
 
-When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``wrod``.
+When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``Wrod``.
 
 The words to ignore can be passed in two ways:
 
@@ -183,12 +185,34 @@ The words to ignore can be passed in two ways:
 
        codespell -L word1,word2,word3,word4
 
+Inline ignore
+-------------
+
+Some situation might require ignoring a specific word in a specific location. This can be achieved by adding a comment in the source code.
+You can either ignore a single word or a list of words. The comment should be in the format of ``codespell:ignore <words>``.
+Words should be separated by a comma.
+
+1. ignore specific word:
+
+   .. code-block:: python
+
+       def wrod() # codespell:ignore wrod
+           pass
+
+2. ignore multiple words:
+
+   .. code-block:: python
+
+       def wrod(wrods) # codespell:ignore
+           pass
+
 Using a config file
 -------------------
 
 Command line options can also be specified in a config file.
 
-When running ``codespell``, it will check in the current directory for a file
+When running ``codespell``, it will check in the current directory for an
+`INI file <https://en.wikipedia.org/wiki/INI_file>`_
 named ``setup.cfg`` or ``.codespellrc`` (or a file specified via ``--config``),
 containing an entry named ``[codespell]``. Each command line argument can
 be specified in this file (without the preceding dashes), for example:
@@ -200,44 +224,65 @@ be specified in this file (without the preceding dashes), for example:
     count =
     quiet-level = 3
 
+Python's
+`configparser <https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
+module defines the exact format of INI config files. For example,
+comments are possible using ``;`` or ``#`` as the first character.
+
 Codespell will also check in the current directory for a ``pyproject.toml``
-(or a path can be specified via ``--toml <filename>``) file, and the
-``[tool.codespell]`` entry will be used, but only if the tomli_ package
-is installed for versions of Python prior to 3.11. For example:
+file (or a file specified via ``--toml``), and the ``[tool.codespell]``
+entry will be used. For versions of Python prior to 3.11, this requires
+the tomli_ package. For example, here is the TOML equivalent of the
+previous config file:
 
 .. code-block:: toml
 
     [tool.codespell]
     skip = '*.po,*.ts,./src/3rdParty,./src/Test'
-    count = ''
+    count = true
     quiet-level = 3
 
-These are both equivalent to running:
+The above INI and TOML files are equivalent to running:
 
 .. code-block:: sh
 
-    codespell --quiet-level 3 --count --skip "*.po,*.ts,./src/3rdParty,./src/Test"
+    codespell --skip "*.po,*.ts,./src/3rdParty,./src/Test" --count --quiet-level 3
 
 If several config files are present, they are read in the following order:
 
-#. ``pyproject.toml`` (only if the ``tomli`` library is available)
+#. ``pyproject.toml`` (only if the ``tomli`` library is available for Python < 3.11)
 #. ``setup.cfg``
 #. ``.codespellrc``
 #. any additional file supplied via ``--config``
 
 If a codespell configuration is supplied in several of these files,
 the configuration from the most recently read file overwrites previously
-specified configurations.
+specified configurations. Any options specified in the command line will
+*override* options from the config files.
 
-Any options specified in the command line will *override* options from the
-config files.
+Values in a config file entry cannot start with a ``-`` character, so if
+you need to do this, structure your entries like this:
+
+.. code-block:: ini
+
+    [codespell]
+    dictionary = mydict,-
+    ignore-words-list = bar,-foo
+
+instead of these invalid entries:
+
+.. code-block:: ini
+
+    [codespell]
+    dictionary = -,mydict
+    ignore-words-list = -foo,bar
 
 .. _tomli: https://pypi.org/project/tomli/
 
-`pre-commit <https://pre-commit.com/>`_ hook
---------------------------------------------
+pre-commit hook
+---------------
 
-codespell also works with `pre-commit`, using
+codespell also works with `pre-commit <https://pre-commit.com/>`_, using
 
 .. code-block:: yaml
 
@@ -291,7 +336,7 @@ applied directly, but should instead be manually inspected. E.g.:
 
        clas->class, clash, disabled because of name clash in c++
 
-Development Setup
+Development setup
 -----------------
 
 As suggested in the `Python Packaging User Guide`_, ensure ``pip``, ``setuptools``, and ``wheel`` are up to date before installing from source. Specifically you will need recent versions of ``setuptools`` and ``setuptools_scm``:
@@ -314,7 +359,7 @@ To run tests against the codebase run:
 
 .. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages
 
-Sending Pull Requests
+Sending pull requests
 ---------------------
 
 If you have a suggested typo that you'd like to see merged please follow these steps:
@@ -369,13 +414,13 @@ In the scenario where the user prefers not to follow the development version of
 
 .. code-block:: sh
 
-    wget https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
+    wget https://raw.githubusercontent.com/codespell-project/codespell/main/codespell_lib/data/dictionary.txt
     codespell -D dictionary.txt
 
 The above simply downloads the latest ``dictionary.txt`` file and then by utilizing the ``-D`` flag allows the user to specify the freshly downloaded ``dictionary.txt`` as the custom dictionary instead of the default one.
 
 You can also do the same thing for the other dictionaries listed here:
-    https://github.com/codespell-project/codespell/tree/master/codespell_lib/data
+    https://github.com/codespell-project/codespell/tree/main/codespell_lib/data
 
 License
 -------

{codespell-2.2.6 → codespell-2.4.0}/README.rst

@@ -116,10 +116,10 @@ Want to know if a word you're proposing exists in codespell already? It is possi
 
 You can select the optional dictionaries with the ``--builtin`` option.
 
-Ignoring Words
+Ignoring words
 --------------
 
-When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``wrod``.
+When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``Wrod``.
 
 The words to ignore can be passed in two ways:
 
@@ -135,12 +135,34 @@ The words to ignore can be passed in two ways:
 
        codespell -L word1,word2,word3,word4
 
+Inline ignore
+-------------
+
+Some situation might require ignoring a specific word in a specific location. This can be achieved by adding a comment in the source code.
+You can either ignore a single word or a list of words. The comment should be in the format of ``codespell:ignore <words>``.
+Words should be separated by a comma.
+
+1. ignore specific word:
+
+   .. code-block:: python
+
+       def wrod() # codespell:ignore wrod
+           pass
+
+2. ignore multiple words:
+
+   .. code-block:: python
+
+       def wrod(wrods) # codespell:ignore
+           pass
+
 Using a config file
 -------------------
 
 Command line options can also be specified in a config file.
 
-When running ``codespell``, it will check in the current directory for a file
+When running ``codespell``, it will check in the current directory for an
+`INI file <https://en.wikipedia.org/wiki/INI_file>`_
 named ``setup.cfg`` or ``.codespellrc`` (or a file specified via ``--config``),
 containing an entry named ``[codespell]``. Each command line argument can
 be specified in this file (without the preceding dashes), for example:
@@ -152,44 +174,65 @@ be specified in this file (without the preceding dashes), for example:
     count =
     quiet-level = 3
 
+Python's
+`configparser <https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
+module defines the exact format of INI config files. For example,
+comments are possible using ``;`` or ``#`` as the first character.
+
 Codespell will also check in the current directory for a ``pyproject.toml``
-(or a path can be specified via ``--toml <filename>``) file, and the
-``[tool.codespell]`` entry will be used, but only if the tomli_ package
-is installed for versions of Python prior to 3.11. For example:
+file (or a file specified via ``--toml``), and the ``[tool.codespell]``
+entry will be used. For versions of Python prior to 3.11, this requires
+the tomli_ package. For example, here is the TOML equivalent of the
+previous config file:
 
 .. code-block:: toml
 
     [tool.codespell]
     skip = '*.po,*.ts,./src/3rdParty,./src/Test'
-    count = ''
+    count = true
     quiet-level = 3
 
-These are both equivalent to running:
+The above INI and TOML files are equivalent to running:
 
 .. code-block:: sh
 
-    codespell --quiet-level 3 --count --skip "*.po,*.ts,./src/3rdParty,./src/Test"
+    codespell --skip "*.po,*.ts,./src/3rdParty,./src/Test" --count --quiet-level 3
 
 If several config files are present, they are read in the following order:
 
-#. ``pyproject.toml`` (only if the ``tomli`` library is available)
+#. ``pyproject.toml`` (only if the ``tomli`` library is available for Python < 3.11)
 #. ``setup.cfg``
 #. ``.codespellrc``
 #. any additional file supplied via ``--config``
 
 If a codespell configuration is supplied in several of these files,
 the configuration from the most recently read file overwrites previously
-specified configurations.
+specified configurations. Any options specified in the command line will
+*override* options from the config files.
 
-Any options specified in the command line will *override* options from the
-config files.
+Values in a config file entry cannot start with a ``-`` character, so if
+you need to do this, structure your entries like this:
+
+.. code-block:: ini
+
+    [codespell]
+    dictionary = mydict,-
+    ignore-words-list = bar,-foo
+
+instead of these invalid entries:
+
+.. code-block:: ini
+
+    [codespell]
+    dictionary = -,mydict
+    ignore-words-list = -foo,bar
 
 .. _tomli: https://pypi.org/project/tomli/
 
-`pre-commit <https://pre-commit.com/>`_ hook
---------------------------------------------
+pre-commit hook
+---------------
 
-codespell also works with `pre-commit`, using
+codespell also works with `pre-commit <https://pre-commit.com/>`_, using
 
 .. code-block:: yaml
 
@@ -243,7 +286,7 @@ applied directly, but should instead be manually inspected. E.g.:
 
        clas->class, clash, disabled because of name clash in c++
 
-Development Setup
+Development setup
 -----------------
 
 As suggested in the `Python Packaging User Guide`_, ensure ``pip``, ``setuptools``, and ``wheel`` are up to date before installing from source. Specifically you will need recent versions of ``setuptools`` and ``setuptools_scm``:
@@ -266,7 +309,7 @@ To run tests against the codebase run:
 
 .. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages
 
-Sending Pull Requests
+Sending pull requests
 ---------------------
 
 If you have a suggested typo that you'd like to see merged please follow these steps:
@@ -321,13 +364,13 @@ In the scenario where the user prefers not to follow the development version of
 
 .. code-block:: sh
 
-    wget https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
+    wget https://raw.githubusercontent.com/codespell-project/codespell/main/codespell_lib/data/dictionary.txt
     codespell -D dictionary.txt
 
 The above simply downloads the latest ``dictionary.txt`` file and then by utilizing the ``-D`` flag allows the user to specify the freshly downloaded ``dictionary.txt`` as the custom dictionary instead of the default one.
 
 You can also do the same thing for the other dictionaries listed here:
-    https://github.com/codespell-project/codespell/tree/master/codespell_lib/data
+    https://github.com/codespell-project/codespell/tree/main/codespell_lib/data
 
 License
 -------