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

Add pyright ci annotations #36510

Merged
merged 6 commits into from
Oct 31, 2023
Merged

Add pyright ci annotations #36510

merged 6 commits into from
Oct 31, 2023

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Oct 23, 2023

We use the pyright-action to install and run pyright in the ci. This action is also used by https://github.com/python/typeshed (among others) and has the advantage that we can easily add annotations to surface typing errors. Due to the limited typing info currently in the sage repo, we only add these annotations for errors and not warnings.

image

Also fix one import that was complained about by the new pyright version.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@github-actions
Copy link

Documentation preview for this PR (built with commit 01eed98; changes) is ready! 🎉

Copy link
Member

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to work well.

@tobiasdiez
Copy link
Contributor Author

Thanks for the review!

vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 28, 2023
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->
We use the [pyright-action](https://github.com/jakebailey/pyright-
action) to install and run pyright in the ci. This action is also used
by https://github.com/python/typeshed (among others) and has the
advantage that we can easily add annotations to surface typing errors.
Due to the limited typing info currently in the sage repo, we only add
these annotations for errors and not warnings.

![image](https://github.com/sagemath/sage/assets/5037600/12ed6be1-68d5-
496d-b77b-0eff750ef530)

Also fix one import that was complained about by the new pyright
version.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36510
Reported by: Tobias Diez
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 29, 2023
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->
We use the [pyright-action](https://github.com/jakebailey/pyright-
action) to install and run pyright in the ci. This action is also used
by https://github.com/python/typeshed (among others) and has the
advantage that we can easily add annotations to surface typing errors.
Due to the limited typing info currently in the sage repo, we only add
these annotations for errors and not warnings.

![image](https://github.com/sagemath/sage/assets/5037600/12ed6be1-68d5-
496d-b77b-0eff750ef530)

Also fix one import that was complained about by the new pyright
version.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36510
Reported by: Tobias Diez
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit 0a0f141 into sagemath:develop Oct 31, 2023
31 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants