Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TYP] Rewrite mypy precommit hook #2145

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ibratoev
Copy link
Contributor

@ibratoev ibratoev commented May 6, 2024

The existing pre-commit/mirrors-mypy works by checking individual files and ignoring imports. This is against the whole idea of mypy and limits its benefits. Reimplement the hook to run mypy on all the files in an isolated environment. More on the topic:

Additionally:

  • Move all the mypy config to pyproject.toml.
  • Lock the version of mypy.
  • Add types-PyYAML to dev requirements.
  • Ignore all .venv* folders to support using multiple venvs for different python versions.
  • Run pre-commit mypy during PR lint CI and ignore errors as fixes are in progress.
  • Disable the mypy pre-commit hook until it is fixed.
  • Add init.py to the examples/chat_with_your_documents folder to make it a package for mypy.
  • Change mypy strict = false configuration until the non-strict issues are fixed.

Copy link

vercel bot commented May 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
chroma ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 6, 2024 9:03pm

Copy link

github-actions bot commented May 6, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

The existing `pre-commit/mirrors-mypy` works by checking individual files and ignoring imports. This is against the whole idea of mypy and limits its benefits. Reimplement the hook to run mypy on all the files in an isolated environment. More on the topic:
* python/mypy#13916
* https://jaredkhan.com/blog/mypy-pre-commit

Additionally:
* Move all the mypy config to pyproject.toml.
* Lock the version of mypy.
* Add types-PyYAML to dev requirements.
* Ignore all `.venv*` folders to support using multiple venvs for different python versions.
* Run pre-commit mypy during PR lint CI and ignore errors as fixes are in progress.
* Disable the mypy pre-commit hook until it is fixed.
* Add __init__.py to the examples/chat_with_your_documents folder to make it a package for mypy.
@ibratoev
Copy link
Contributor Author

ibratoev commented May 6, 2024

This is setting up the infrastructure to start fixing mypy issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant