Add Pyright type checking

marco-carvalho commented 2 months ago

Overview

This PR introduces Pyright, a static type checker for Python, into the yfinance project. The purpose is to ensure type safety and improve code quality by identifying type-related issues during development.

Benefits

Type Safety: Pyright helps in detecting type errors early in the development process, reducing runtime errors and improving reliability.
Improved Documentation: With type annotations, the code becomes more self-explanatory and easier to understand, aiding in code maintenance and collaboration.

Changes

Created a new GitHub Action pyright.yml that triggers on pull requests to the master and main branches for automatic type checking.

ValueRaider commented 2 months ago

If this runs via Github actions, why does it need to be in requirements.txt?

marco-carvalho commented 2 months ago

@ValueRaider fixed!

ValueRaider commented 1 month ago

Does this require type hints in code to be useful?

marco-carvalho commented 1 month ago

Yes, Pyright will be most useful with type hints included in the code. While it can still check basic type correctness in code without type hints, its full potential is realized when explicit type annotations are used. This enhances its ability to catch type-related issues early during development, improving overall code quality and maintainability.

ranaroussi / yfinance