Fix mypy type checks

[abought]

Purpose

This project includes type annotations. However, pytest-mypy only inspects files specified in the pytest testpaths configuration (per pyproject.toml). (see discussion) This caused mypy to skip project code when run in CI (it was only linting test files).

If run directly (mypy esgpull/, pytest ., etc), ~30 type errors were returned.

This PR fixes mypy to run when intended, and produces clean error output.

Summary of changes

This PR has been broken down into conceptually related commits, and in cases where errors are ignored, commit messages link directly to underlying rationale.

AFAICT, the correct return type for search functions is DatasetRecord rather than Dataset, and this annotation does seem to resolve many of the warnings. Let me know if that is incorrect.

As this is my first PR to this repo, I'm happy to revise on request. I like to have a clean slate for tests before I start larger edits :)

[svenrdz]

Thanks for the thorough PR! You are correct for the DatasetRecord return type, I must have missed it when changing the way datasets are handled (Dataset used to be the name for the current DatasetRecord, but is now an sqlalchemy model).

I ran the tests locally and now that mypy runs on the full code, it complains about a few missing type stubs, could you add them to the PR to make it complete ? Running uv add --dev types-PyYAML types-aiofiles should be sufficient.

[abought]

Thanks for the review!

Fun fact: those types are installed in the existing config under pyproject.toml tool.rye -> dev-dependencies. They are thus skipped if you're using uv. (like I was at first)

I notice that the codebase is in the process of moving over to uv.

I'll make the changes here for just these two things, but it might be worth reviewing that section of pyproject.toml to see if any other dependencies need to be carried over.

[svenrdz]

Oh right, I ran pytest through uv. I'll get the pyproject.toml sorted out, thanks for pointing it out!

[abought]

Updated this PR with the dependencies needed to get mypy working in uv environments.

I'll consider your changes to be the final source of truth. I'm changing it here only so that my code will pass as-written, even if the switch to uv lands first.

[svenrdz]

I merged yours before other changes, so I'll only bother myself with potential conflicts :)

[abought]

I merged yours before other changes, so I'll only bother myself with potential conflicts :)

async def thank_you()