Skip to content

add python annotation files #543

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

Merged
merged 4 commits into from
Jun 24, 2025
Merged

add python annotation files #543

merged 4 commits into from
Jun 24, 2025

Conversation

ImpleLee
Copy link
Contributor

@ImpleLee ImpleLee commented Jun 4, 2025

These files are hand-written, and should be manually maintained in the future. Be careful about potential errors!

I tried several automatic pyi generation tools available on GitHub, but none of them is usable enough, so in the end I wrote them by hand (mostly by copy-and-paste).

setup.py is not changed in this file, because these files are automatically included (see this documentation). However, this feature is experimental and may change in the future, so take your own risk.

closes #532 .

ImpleLee added 2 commits June 4, 2025 12:32
add `-> None` for functions without return type;
remove `__new__` functions
Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.54%. Comparing base (c71302d) to head (f6da61e).
Report is 58 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel     #543      +/-   ##
==========================================
- Coverage   75.88%   74.54%   -1.34%     
==========================================
  Files          43       43              
  Lines        6476     6569      +93     
  Branches     1437     1458      +21     
==========================================
- Hits         4914     4897      -17     
- Misses       1031     1143     +112     
+ Partials      531      529       -2     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

add some missing imports;
replace some C++ types with Python types;
reorganize some literals.
@Adda0 Adda0 self-assigned this Jun 12, 2025
@Adda0 Adda0 self-requested a review June 12, 2025 13:02
@Adda0 Adda0 removed their assignment Jun 12, 2025
This file was initially created because I misunderstood the meaning
of `namespace package` in the Python typing documentation (they need
separate `py.typed` files for each subpackage).
Copy link
Collaborator

@Adda0 Adda0 left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thank you for the contribution. This is a great addition.

@Adda0 Adda0 merged commit 73d3d79 into VeriFIT:devel Jun 24, 2025
16 of 17 checks passed
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.

[Suggestion] provide pyi stub files in the Python binding for better linting
3 participants