373 add from future import annotations where possible (#375)

* Add `from __future__ import annotations` where possible

* Fix broken imports

* Fix pydantic model builds
Don't use schema store to validate pyproject.toml

* Remove `from __future__ import annotations` from typer files to try and avoid performance regression

Author: nathanjmcdougall

.pre-commit-config.yaml

@@ -3,7 +3,6 @@ repos:
     rev: v0.23
     hooks:
       - id: validate-pyproject
-        additional_dependencies: ["validate-pyproject-schema-store[all]"]
   - repo: https://github.com/tox-dev/pyproject-fmt
     rev: v2.5.0
     hooks:

pyproject.toml

@@ -108,6 +108,7 @@ lint.select = [
 ]
 lint.ignore = [ "D417", "PLR2004", "SIM108" ]
 lint.per-file-ignores."tests/**/*.py" = [ "D", "INP", "S101" ]
+lint.flake8-type-checking.runtime-evaluated-base-classes = [ "pydantic.BaseModel" ]
 lint.pydocstyle.convention = "google"
 
 [tool.codespell]

src/usethis/__main__.py

@@ -1,5 +1,7 @@
 """The CLI application for usethis."""
 
+from __future__ import annotations
+
 from usethis._app import app
 
 app(prog_name="usethis")

src/usethis/_ci.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 from pathlib import Path
 

src/usethis/_config.py

@@ -1,9 +1,14 @@
-from collections.abc import Generator
+from __future__ import annotations
+
 from contextlib import contextmanager
+from typing import TYPE_CHECKING
 
 import typer
 from pydantic import BaseModel
 
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
 
 class UsethisConfig(BaseModel):
     """Global-state for command options which affect low level behaviour."""

src/usethis/_console.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import codecs
 import sys
 

src/usethis/_core/badge.py

@@ -1,17 +1,20 @@
+from __future__ import annotations
+
 import re
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import typer
 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
-from usethis._integrations.pyproject_toml.errors import (
-    PyprojectTOMLError,
-)
+from usethis._integrations.pyproject_toml.errors import PyprojectTOMLError
 from usethis._integrations.pyproject_toml.name import get_name
 
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
 
 class Badge(BaseModel):
     markdown: str

src/usethis/_core/browse.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import typer
 
 from usethis._console import box_print

src/usethis/_core/ci.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from usethis._ci import update_bitbucket_pytest_steps
 from usethis._console import box_print, info_print
 from usethis._integrations.bitbucket.config import (

src/usethis/_core/readme.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 
 from usethis._console import box_print, tick_print

src/usethis/_core/show.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import typer
 
 from usethis._config import usethis_config

src/usethis/_core/tool.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 from usethis._ci import (
     is_bitbucket_used,
@@ -16,7 +19,10 @@
     remove_pre_commit_config,
     uninstall_pre_commit_hooks,
 )
-from usethis._integrations.pre_commit.hooks import add_placeholder_hook, get_hook_names
+from usethis._integrations.pre_commit.hooks import (
+    add_placeholder_hook,
+    get_hook_names,
+)
 from usethis._integrations.pyproject_toml.valid import ensure_pyproject_validity
 from usethis._integrations.pytest.core import add_pytest_dir, remove_pytest_dir
 from usethis._integrations.ruff.rules import (
@@ -37,9 +43,11 @@
     PytestTool,
     RequirementsTxtTool,
     RuffTool,
-    Tool,
 )
 
+if TYPE_CHECKING:
+    from usethis._tool import Tool
+
 
 def use_codespell(*, remove: bool = False) -> None:
     tool = CodespellTool()

src/usethis/_integrations/bitbucket/anchor.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Literal, TypeAlias
 
 from pydantic import BaseModel

src/usethis/_integrations/bitbucket/cache.py

@@ -1,12 +1,19 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from usethis._console import tick_print
 from usethis._integrations.bitbucket.dump import bitbucket_fancy_dump
 from usethis._integrations.bitbucket.io_ import (
-    BitbucketPipelinesYAMLDocument,
     edit_bitbucket_pipelines_yaml,
 )
-from usethis._integrations.bitbucket.schema import Cache, Definitions
+from usethis._integrations.bitbucket.schema import Definitions
 from usethis._integrations.yaml.update import update_ruamel_yaml_map
 
+if TYPE_CHECKING:
+    from usethis._integrations.bitbucket.io_ import BitbucketPipelinesYAMLDocument
+    from usethis._integrations.bitbucket.schema import Cache
+
 
 def get_cache_by_name() -> dict[str, Cache]:
     with edit_bitbucket_pipelines_yaml() as doc:

src/usethis/_integrations/bitbucket/config.py

@@ -1,9 +1,7 @@
 from pathlib import Path
 
 from usethis._console import tick_print
-from usethis._integrations.bitbucket.steps import (
-    add_placeholder_step_in_default,
-)
+from usethis._integrations.bitbucket.steps import add_placeholder_step_in_default
 
 
 def add_bitbucket_pipeline_config(report_placeholder: bool = True) -> None:

src/usethis/_integrations/bitbucket/dump.py

@@ -1,12 +1,19 @@
-from pydantic import BaseModel
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from usethis._integrations.bitbucket.schema import (
     PipelinesConfiguration,
     Step,
     Step2,
     StepBase,
 )
-from usethis._integrations.pydantic.dump import ModelRepresentation, fancy_model_dump
+from usethis._integrations.pydantic.dump import fancy_model_dump
+
+if TYPE_CHECKING:
+    from pydantic import BaseModel
+
+    from usethis._integrations.pydantic.dump import ModelRepresentation
 
 ORDER_BY_CLS: dict[type[BaseModel], list[str]] = {
     PipelinesConfiguration: ["image", "clone", "definitions"],

src/usethis/_integrations/bitbucket/errors.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from usethis.errors import UsethisError
 
 

src/usethis/_integrations/bitbucket/io_.py

@@ -1,14 +1,22 @@
-from collections.abc import Generator
+from __future__ import annotations
+
 from contextlib import contextmanager
 from dataclasses import dataclass
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 from pydantic import ValidationError
-from ruamel.yaml.comments import CommentedMap
 
 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 edit_yaml
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from ruamel.yaml.comments import CommentedMap
+
+    from usethis._integrations.yaml.io_ import YAMLLiteral
 
 
 class BitbucketPipelinesYAMLConfigError(Exception):

src/usethis/_integrations/bitbucket/pipeweld.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from functools import singledispatch
+from typing import TYPE_CHECKING
 from uuid import uuid4
 
 from typing_extensions import assert_never
@@ -7,7 +10,6 @@
 from usethis._integrations.bitbucket.dump import bitbucket_fancy_dump
 from usethis._integrations.bitbucket.errors import UnexpectedImportPipelineError
 from usethis._integrations.bitbucket.io_ import (
-    BitbucketPipelinesYAMLDocument,
     edit_bitbucket_pipelines_yaml,
 )
 from usethis._integrations.bitbucket.schema import (
@@ -18,15 +20,22 @@
     ParallelSteps,
     Pipeline,
     Pipelines,
-    PipelinesConfiguration,
     StageItem,
-    Step,
     StepItem,
 )
 from usethis._integrations.bitbucket.schema_utils import step1tostep
 from usethis._integrations.yaml.update import update_ruamel_yaml_map
 from usethis._pipeweld.ops import Instruction
 
+if TYPE_CHECKING:
+    from usethis._integrations.bitbucket.io_ import (
+        BitbucketPipelinesYAMLDocument,
+    )
+    from usethis._integrations.bitbucket.schema import (
+        PipelinesConfiguration,
+        Step,
+    )
+
 
 def get_pipeweld_step(step: Step) -> str:
     if step.name is not None:

src/usethis/_integrations/bitbucket/schema_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from usethis._integrations.bitbucket.schema import Step, Step1
 
 

src/usethis/_integrations/bitbucket/steps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from functools import singledispatch
 from pathlib import Path
 from typing import TYPE_CHECKING
@@ -8,14 +10,11 @@
 
 import usethis._pipeweld.func
 from usethis._console import box_print, tick_print
-from usethis._integrations.bitbucket.anchor import ScriptItemAnchor, ScriptItemName
+from usethis._integrations.bitbucket.anchor import ScriptItemAnchor
 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 (
-    BitbucketPipelinesYAMLDocument,
-    edit_bitbucket_pipelines_yaml,
-)
+from usethis._integrations.bitbucket.io_ import edit_bitbucket_pipelines_yaml
 from usethis._integrations.bitbucket.pipeweld import (
     apply_pipeweld_instruction_via_doc,
     get_pipeweld_pipeline_from_default,
@@ -29,7 +28,6 @@
     ParallelExpanded,
     ParallelItem,
     ParallelSteps,
-    Pipeline,
     Script,
     StageItem,
     Step,
@@ -42,6 +40,10 @@
 if TYPE_CHECKING:
     from ruamel.yaml.anchor import Anchor
 
+    from usethis._integrations.bitbucket.anchor import ScriptItemName
+    from usethis._integrations.bitbucket.io_ import BitbucketPipelinesYAMLDocument
+    from usethis._integrations.bitbucket.schema import Pipeline
+
 _CACHE_LOOKUP = {
     "uv": CachePath("~/.cache/uv"),
     "pre-commit": CachePath("~/.cache/pre-commit"),

src/usethis/_integrations/github/errors.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from usethis.errors import UsethisError
 
 

src/usethis/_integrations/github/tags.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import requests
 
 from usethis._integrations.github.errors import GitHubTagError, NoGitHubTagsFoundError

src/usethis/_integrations/pre_commit/core.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 
 from usethis._config import usethis_config

src/usethis/_integrations/pre_commit/dump.py

@@ -1,9 +1,14 @@
-from pydantic import BaseModel
+from __future__ import annotations
 
-from usethis._integrations.pre_commit.schema import (
-    JsonSchemaForPreCommitConfigYaml,
-)
-from usethis._integrations.pydantic.dump import ModelRepresentation, fancy_model_dump
+from typing import TYPE_CHECKING
+
+from usethis._integrations.pydantic.dump import fancy_model_dump
+
+if TYPE_CHECKING:
+    from pydantic import BaseModel
+
+    from usethis._integrations.pre_commit.schema import JsonSchemaForPreCommitConfigYaml
+    from usethis._integrations.pydantic.dump import ModelRepresentation
 
 ORDER_BY_CLS: dict[type[BaseModel], list[str]] = {}
 

src/usethis/_integrations/pre_commit/errors.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from usethis.errors import UsethisError
 
 

src/usethis/_integrations/pre_commit/hooks.py

@@ -1,19 +1,26 @@
+from __future__ import annotations
+
 from collections import Counter
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 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.schema import (
     HookDefinition,
-    JsonSchemaForPreCommitConfigYaml,
     Language,
     LocalRepo,
     MetaRepo,
-    UriRepo,
 )
 from usethis._integrations.yaml.update import update_ruamel_yaml_map
 
+if TYPE_CHECKING:
+    from usethis._integrations.pre_commit.schema import (
+        JsonSchemaForPreCommitConfigYaml,
+        UriRepo,
+    )
+
 _HOOK_ORDER = [
     "validate-pyproject",
     "uv-export",