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.

Sign up for GitHub

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

Jump to bottom

Add Pyright type checking #2059

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add Pyright type checking #2059

wants to merge 7 commits into from
+42 −0

Conversation

marco-carvalho
Copy link
Contributor

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
Copy link
Collaborator

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

@marco-carvalho
Copy link
Contributor Author

@ValueRaider fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marco-carvalho @ValueRaider