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

fix!: stubs breaking mypy #319

Merged
merged 5 commits into from
Jan 31, 2025
Merged

fix!: stubs breaking mypy #319

merged 5 commits into from
Jan 31, 2025

Conversation

alex-liang3
Copy link
Contributor

@alex-liang3 alex-liang3 commented Jan 30, 2025

For context, see

  1. fix: syntax errors in stubs open-space-toolkit-core#185
  2. fix: remove py.typed file open-space-toolkit-core#186
  3. fix: remove py.typed, fix other mypy issues open-space-toolkit-mathematics#169

⚠️ Additionally, this introduces a (minor) breaking change to ostk.physics.Unit - namely, the "None unit type" entry in the Type enum has been changed: Unit.Type.None -> Unit.Type.None_
This isn't expect to affect anything, as the former definition isn't valid in Python anyway.

Summary by CodeRabbit

Release Notes

  • Bug Fixes

    • Corrected Python stub file syntax generation
    • Updated unit type naming from "None" to "None_"
  • Refactor

    • Streamlined import statements in Python test files
    • Enhanced type annotations for CSSI Space Weather test methods
  • Chores

    • Improved Python package build process
    • Refined module import specificity

@alex-liang3 alex-liang3 self-assigned this Jan 30, 2025
Copy link

coderabbitai bot commented Jan 30, 2025

Walkthrough

The pull request introduces several modifications across Python bindings and test files. The changes primarily focus on refining import statements, updating type annotations, and improving stub file generation. In the CMakeLists.txt, a new command is added to process Python stub files, while in the Unit.cpp file, an enum value is renamed from "None" to "None_". Test files see more precise import statements and more specific type annotations, particularly in the CSSISpaceWeather test module.

Changes

File Change Summary
bindings/python/CMakeLists.txt Added command to find and modify Python stub files, removing previous py.typed file copy
bindings/python/src/OpenSpaceToolkitPhysicsPy/Unit.cpp Changed enum value from "None" to "None_"
bindings/python/test/coordinate/frame/provider/iers/conftest.py Updated imports to directly import BulletinA and Finals2000A
bindings/python/test/coordinate/frame/provider/iers/test_bulletin_a.py Updated import to directly import BulletinA
bindings/python/test/coordinate/frame/provider/iers/test_finals_2000a.py Updated import to directly import Finals2000A
bindings/python/test/environment/atmospheric/earth/test_cssi_space_weather.py Updated type annotations for variables to use CSSISpaceWeather.Reading

Poem

🐰 A rabbit's code review delight,
Imports now precise and tight,
Stubs transformed with gentle care,
Enum names now crystal clear,
Type annotations shine so bright! 🔍


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2dc4dcb and 23a5da3.

📒 Files selected for processing (1)
  • bindings/python/src/OpenSpaceToolkitPhysicsPy/Unit.cpp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • bindings/python/src/OpenSpaceToolkitPhysicsPy/Unit.cpp

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.89%. Comparing base (466d896) to head (23a5da3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #319   +/-   ##
=======================================
  Coverage   82.89%   82.89%           
=======================================
  Files         102      102           
  Lines        8033     8033           
=======================================
  Hits         6659     6659           
  Misses       1374     1374           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alex-liang3 alex-liang3 merged commit c5a2c3d into main Jan 31, 2025
19 checks passed
@alex-liang3 alex-liang3 deleted the fix/broken-stubs branch January 31, 2025 10:10
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.

2 participants