Add support for Python 3.10 (#246)

* Add support for Python 3.10

* Fix CI

* Fix CI

* Pass tests

Author: nathanjmcdougall

.github/workflows/ci.yml

@@ -42,13 +42,23 @@ jobs:
 
       - name: Run benchmarks
         uses: CodSpeedHQ/action@513a19673a831f139e8717bf45ead67e47f00044 # v3.2.0
-        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' && matrix.resolution == 'highest'
+        if: matrix.codspeed
         with:
           token: ${{ secrets.CODSPEED_TOKEN }}
           run: pytest --codspeed
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.11, 3.12, 3.13]
-        resolution: [highest, lowest-direct]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        resolution: ["highest"]
+        codspeed: [false]
+        include:
+          - os: "ubuntu-latest"
+            python-version: "3.10"
+            resolution: "lowest-direct"
+            codspeed: false
+          - os: "ubuntu-latest"
+            python-version: "3.13"
+            resolution: "highest"
+            codspeed: true

.python-version

@@ -1 +1 @@
-3.11.11
+3.10.14

pyproject.toml

@@ -12,14 +12,15 @@ license = { file = "LICENSE" }
 authors = [
   { name = "Nathan McDougall", email = "nathan.j.mcdougall@gmail.com" },
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Environment :: Console",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
@@ -41,17 +42,18 @@ dependencies = [
   "ruamel-yaml>=0.18.6",
   "tomlkit>=0.13.2",
   "typer>=0.12.5",
+  "typing-extensions>=4.12.2",
 ]
 scripts.usethis = "usethis.__main__:app"
 
 [dependency-groups]
 dev = [
   "datamodel-code-generator[http]>=0.26.2",
-  "deptry>=0.20.0",
+  "deptry>=0.23.0",
   "import-linter>=2.1",
   "pre-commit>=4.0.1",
   "pyright>=1.1.391",
-  "ruff>=0.7.1",
+  "ruff>=0.9.4",
 ]
 test = [
   "coverage[toml]>=7.6.3",

src/usethis/_core/badge.py

@@ -1,9 +1,9 @@
 import re
 import sys
 from pathlib import Path
-from typing import Self
 
 from pydantic import BaseModel
+from typing_extensions import Self
 
 from usethis._console import err_print, tick_print, warn_print
 from usethis._core.readme import add_readme, get_readme_path

src/usethis/_integrations/bitbucket/cache.py

@@ -1,6 +1,6 @@
 from usethis._console import tick_print
 from usethis._integrations.bitbucket.dump import bitbucket_fancy_dump
-from usethis._integrations.bitbucket.io import (
+from usethis._integrations.bitbucket.io_ import (
     BitbucketPipelinesYAMLDocument,
     edit_bitbucket_pipelines_yaml,
 )
@@ -43,7 +43,7 @@ def _add_caches_via_doc(
     for name, cache in cache_by_name.items():
         if not _cache_exists(name, doc=doc):
             tick_print(
-                f"Adding cache '{name}' definition to " f"'bitbucket-pipelines.yml'."
+                f"Adding cache '{name}' definition to 'bitbucket-pipelines.yml'."
             )
             config.definitions.caches[name] = cache
 

src/usethis/_integrations/bitbucket/io.py renamed to src/usethis/_integrations/bitbucket/io_.py

@@ -8,7 +8,7 @@
 
 from usethis._console import tick_print
 from usethis._integrations.bitbucket.schema import PipelinesConfiguration
-from usethis._integrations.yaml.io import YAMLLiteral, edit_yaml
+from usethis._integrations.yaml.io_ import YAMLLiteral, edit_yaml
 
 
 class BitbucketPipelinesYAMLConfigError(Exception):
@@ -29,9 +29,9 @@ class BitbucketPipelinesYAMLDocument:
 
 
 @contextmanager
-def edit_bitbucket_pipelines_yaml() -> (
-    Generator[BitbucketPipelinesYAMLDocument, None, None]
-):
+def edit_bitbucket_pipelines_yaml() -> Generator[
+    BitbucketPipelinesYAMLDocument, None, None
+]:
     """A context manager to modify 'bitbucket-pipelines.yml' in-place."""
     name = "bitbucket-pipelines.yml"
     path = Path.cwd() / name

src/usethis/_integrations/bitbucket/pipeweld.py

@@ -1,11 +1,12 @@
 from functools import singledispatch
-from typing import assert_never
 from uuid import uuid4
 
+from typing_extensions import assert_never
+
 import usethis._pipeweld.containers
 from usethis._integrations.bitbucket.dump import bitbucket_fancy_dump
 from usethis._integrations.bitbucket.errors import UnexpectedImportPipelineError
-from usethis._integrations.bitbucket.io import (
+from usethis._integrations.bitbucket.io_ import (
     BitbucketPipelinesYAMLDocument,
     edit_bitbucket_pipelines_yaml,
 )

src/usethis/_integrations/bitbucket/schema.py

@@ -2,7 +2,7 @@
 #   filename:  schema.json
 #   timestamp: 2025-01-13T20:41:41+00:00
 # using the command:
-#   datamodel-codegen --input tests\usethis\_integrations\bitbucket\schema.json --input-file-type jsonschema --output src\usethis\_integrations\bitbucket\schema.py --enum-field-as-literal all --field-constraints --use-double-quotes --use-union-operator --use-standard-collections --use-default-kwarg --output-model-type pydantic_v2.BaseModel --target-python-version 3.11
+#   datamodel-codegen --input tests\usethis\_integrations\bitbucket\schema.json --input-file-type jsonschema --output src\usethis\_integrations\bitbucket\schema.py --enum-field-as-literal all --field-constraints --use-double-quotes --use-union-operator --use-standard-collections --use-default-kwarg --output-model-type pydantic_v2.BaseModel --target-python-version 3.10
 # ruff: noqa: ERA001
 # pyright: reportGeneralTypeIssues=false
 # plus manually add Definitions.scripts for type hinting

src/usethis/_integrations/bitbucket/steps.py

@@ -1,18 +1,18 @@
 from functools import singledispatch
 from pathlib import Path
-from typing import assert_never
 
 from ruamel.yaml.anchor import Anchor
 from ruamel.yaml.comments import CommentedSeq
 from ruamel.yaml.scalarstring import LiteralScalarString
+from typing_extensions import assert_never
 
 import usethis._pipeweld.func
 from usethis._console import box_print, tick_print
 from usethis._integrations.bitbucket.anchor import ScriptItemAnchor, ScriptItemName
 from usethis._integrations.bitbucket.cache import _add_caches_via_doc, remove_cache
 from usethis._integrations.bitbucket.dump import bitbucket_fancy_dump
 from usethis._integrations.bitbucket.errors import UnexpectedImportPipelineError
-from usethis._integrations.bitbucket.io import (
+from usethis._integrations.bitbucket.io_ import (
     BitbucketPipelinesYAMLDocument,
     edit_bitbucket_pipelines_yaml,
 )
@@ -101,8 +101,7 @@ def _add_step_in_default_via_doc(
         # It's not always notable that the placeholder is being added.
     else:
         tick_print(
-            f"Adding '{step.name}' to default pipeline in "
-            f"'bitbucket-pipelines.yml'."
+            f"Adding '{step.name}' to default pipeline in 'bitbucket-pipelines.yml'."
         )
 
     config = doc.model

src/usethis/_integrations/pre_commit/hooks.py

@@ -3,7 +3,7 @@
 
 from usethis._console import box_print, tick_print
 from usethis._integrations.pre_commit.dump import pre_commit_fancy_dump
-from usethis._integrations.pre_commit.io import edit_pre_commit_config_yaml
+from usethis._integrations.pre_commit.io_ import edit_pre_commit_config_yaml
 from usethis._integrations.pre_commit.schema import (
     HookDefinition,
     JsonSchemaForPreCommitConfigYaml,

src/usethis/_integrations/pre_commit/io.py renamed to src/usethis/_integrations/pre_commit/io_.py

@@ -8,7 +8,7 @@
 
 from usethis._console import tick_print
 from usethis._integrations.pre_commit.schema import JsonSchemaForPreCommitConfigYaml
-from usethis._integrations.yaml.io import YAMLLiteral, edit_yaml
+from usethis._integrations.yaml.io_ import YAMLLiteral, edit_yaml
 
 
 class PreCommitConfigYAMLConfigError(Exception):

src/usethis/_integrations/pre_commit/schema.py

@@ -2,7 +2,7 @@
 #   filename:  schema.json
 #   timestamp: 2024-12-13T02:06:43+00:00
 # using the command:
-#   datamodel-codegen --input tests\usethis\_integrations\pre_commit\schema.json --input-file-type jsonschema --output src\usethis\_integrations\pre_commit\schema.py --enum-field-as-literal all --field-constraints --use-double-quotes --use-union-operator --use-standard-collections --use-default-kwarg --output-model-type pydantic_v2.BaseModel --target-python-version 3.11
+#   datamodel-codegen --input tests\usethis\_integrations\pre_commit\schema.json --input-file-type jsonschema --output src\usethis\_integrations\pre_commit\schema.py --enum-field-as-literal all --field-constraints --use-double-quotes --use-union-operator --use-standard-collections --use-default-kwarg --output-model-type pydantic_v2.BaseModel --target-python-version 3.10
 # ruff: noqa: ERA001
 # pyright: reportGeneralTypeIssues=false
 # plus manually remove default for LocalRepo.repo

src/usethis/_integrations/pydantic/dump.py

@@ -99,7 +99,39 @@ def _(
     return d
 
 
-@fancy_model_dump.register(bool | int | float | str)
+# N.B. when Python 3.10 support is dropped, we can register unions of types, rather than
+# having these separate identical implementations for each type.
+@fancy_model_dump.register(bool)
+def _(
+    model: ModelLiteral,
+    *,
+    reference: ModelRepresentation | None = None,
+    order_by_cls: dict[type[BaseModel], list[str]] | None = None,
+) -> ModelLiteral:
+    return model
+
+
+@fancy_model_dump.register(int)
+def _(
+    model: ModelLiteral,
+    *,
+    reference: ModelRepresentation | None = None,
+    order_by_cls: dict[type[BaseModel], list[str]] | None = None,
+) -> ModelLiteral:
+    return model
+
+
+@fancy_model_dump.register(float)
+def _(
+    model: ModelLiteral,
+    *,
+    reference: ModelRepresentation | None = None,
+    order_by_cls: dict[type[BaseModel], list[str]] | None = None,
+) -> ModelLiteral:
+    return model
+
+
+@fancy_model_dump.register(str)
 def _(
     model: ModelLiteral,
     *,

src/usethis/_integrations/pyproject/core.py

@@ -8,7 +8,7 @@
     PyProjectTOMLValueAlreadySetError,
     PyProjectTOMLValueMissingError,
 )
-from usethis._integrations.pyproject.io import (
+from usethis._integrations.pyproject.io_ import (
     read_pyproject_toml,
     write_pyproject_toml,
 )

src/usethis/_integrations/pyproject/io.py renamed to src/usethis/_integrations/pyproject/io_.py

@@ -1,9 +1,8 @@
-import tomllib
 from functools import cache
 from pathlib import Path
-from typing import Any
 
 import tomlkit
+from tomlkit.exceptions import TOMLKitError
 
 from usethis._integrations.pyproject.errors import (
     PyProjectTOMLDecodeError,
@@ -22,20 +21,9 @@ def read_pyproject_toml_from_path(path: Path) -> tomlkit.TOMLDocument:
     except FileNotFoundError:
         msg = "'pyproject.toml' not found in the current directory."
         raise PyProjectTOMLNotFoundError(msg)
-
-
-def read_pyproject_dict() -> dict[str, Any]:
-    try:
-        with Path("pyproject.toml").open("rb") as f:
-            try:
-                return tomllib.load(f)
-            except tomllib.TOMLDecodeError as err:
-                msg = f"Error decoding 'pyproject.toml': {err}"
-                raise PyProjectTOMLDecodeError(msg)
-
-    except FileNotFoundError:
-        msg = "'pyproject.toml' not found in the current directory."
-        raise PyProjectTOMLNotFoundError(msg)
+    except TOMLKitError as err:
+        msg = f"Failed to decode 'pyproject.toml': {err}"
+        raise PyProjectTOMLDecodeError(msg) from None
 
 
 def write_pyproject_toml(toml_document: tomlkit.TOMLDocument) -> None:

src/usethis/_integrations/pyproject/project.py

@@ -3,11 +3,11 @@
 from pydantic import TypeAdapter, ValidationError
 
 from usethis._integrations.pyproject.errors import PyProjectTOMLProjectSectionError
-from usethis._integrations.pyproject.io import read_pyproject_dict
+from usethis._integrations.pyproject.io_ import read_pyproject_toml
 
 
 def get_project_dict() -> dict[str, Any]:
-    pyproject = read_pyproject_dict()
+    pyproject = read_pyproject_toml().value
 
     try:
         project = TypeAdapter(dict).validate_python(pyproject["project"])

src/usethis/_integrations/pyproject/requires_python.py

@@ -1,7 +1,7 @@
 from packaging.specifiers import SpecifierSet
 from pydantic import TypeAdapter
 
-from usethis._integrations.pyproject.io import read_pyproject_toml
+from usethis._integrations.pyproject.io_ import read_pyproject_toml
 
 
 class MissingRequiresPythonError(Exception):

src/usethis/_integrations/sonarqube/config.py

@@ -68,7 +68,7 @@ def get_sonar_project_properties() -> str:
 sonar.sources=./src
 sonar.tests=./tests
 sonar.python.coverage.reportPaths={coverage_output}
-sonar.verbose={'true' if verbose else 'false'}
+sonar.verbose={"true" if verbose else "false"}
 """
     if exclusions:
         text += "sonar.exclusions=" + ", ".join(exclusions) + "\n"

src/usethis/_integrations/uv/call.py

@@ -1,4 +1,4 @@
-from usethis._integrations.pyproject.io import read_pyproject_toml_from_path
+from usethis._integrations.pyproject.io_ import read_pyproject_toml_from_path
 from usethis._integrations.uv.errors import UVSubprocessFailedError
 from usethis._subprocess import SubprocessFailedError, call_subprocess
 

src/usethis/_integrations/uv/deps.py

@@ -3,7 +3,7 @@
 
 from usethis._config import usethis_config
 from usethis._console import tick_print
-from usethis._integrations.pyproject.io import read_pyproject_toml
+from usethis._integrations.pyproject.io_ import read_pyproject_toml
 from usethis._integrations.uv.call import call_uv_subprocess
 from usethis._integrations.uv.errors import UVDepGroupError, UVSubprocessFailedError
 

src/usethis/_integrations/yaml/io.py renamed to src/usethis/_integrations/yaml/io_.py

@@ -5,7 +5,7 @@
     CommentedMap,
 )
 
-from usethis._integrations.yaml.io import YAMLLiteral
+from usethis._integrations.yaml.io_ import YAMLLiteral
 
 
 def update_ruamel_yaml_map(

src/usethis/_integrations/yaml/update.py

@@ -1,8 +1,8 @@
 import contextlib
 from functools import reduce, singledispatch, singledispatchmethod
-from typing import assert_never
 
 from pydantic import BaseModel
+from typing_extensions import assert_never
 
 from usethis._pipeweld.containers import (
     DepGroup,

src/usethis/_pipeweld/func.py

@@ -80,16 +80,13 @@ def test_mentioned_in_file(
                 assert "pre-commit" in contents
                 out, err = capfd.readouterr()
                 assert not err
-                assert (
-                    out
-                    == (
-                        "✔ Writing 'bitbucket-pipelines.yml'.\n"
-                        "✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.\n"
-                        "✔ Adding cache 'pre-commit' definition to 'bitbucket-pipelines.yml'.\n"
-                        "✔ Adding 'Run pre-commit' to default pipeline in 'bitbucket-pipelines.yml'.\n"
-                        "ℹ Consider `usethis tool pytest` to test your code for the pipeline.\n"  # noqa: RUF001
-                        "☐ Run your pipeline via the Bitbucket website.\n"
-                    )
+                assert out == (
+                    "✔ Writing 'bitbucket-pipelines.yml'.\n"
+                    "✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.\n"
+                    "✔ Adding cache 'pre-commit' definition to 'bitbucket-pipelines.yml'.\n"
+                    "✔ Adding 'Run pre-commit' to default pipeline in 'bitbucket-pipelines.yml'.\n"
+                    "ℹ Consider `usethis tool pytest` to test your code for the pipeline.\n"  # noqa: RUF001
+                    "☐ Run your pipeline via the Bitbucket website.\n"
                 )
 
             def test_not_mentioned_if_not_used(self, uv_init_dir: Path):