feat: add type stubs for stats on view classes#700
Merged
Conversation
Add .pyi stub file declaring built-in stats as typed attributes on NodeView, EdgeView, DiNodeView, and DiEdgeView. This enables static analysis tools (Pylance, PyCharm, mypy) to provide autocomplete and type checking for the stats interface. Also adds py.typed marker and configures pyproject.toml to include stub files in package distributions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
4 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #700 +/- ##
=======================================
Coverage 93.59% 93.59%
=======================================
Files 66 66
Lines 5123 5123
=======================================
Hits 4795 4795
Misses 328 328 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
maximelucas
approved these changes
Apr 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.pyitype stub forxgi.core.views, declaring built-in stats as typed attributes onNodeView,EdgeView,DiNodeView, andDiEdgeView.py.typedmarker (PEP 561) so type checkers recognize XGI as a typed package.pyproject.tomlto includepy.typedand*.pyifiles in distributions.Motivation
Companion to #699. That PR makes stats discoverable at runtime (
dir(), Jupyter tab completion). This PR makes them discoverable to static analysis tools (Pylance/VS Code, PyCharm, mypy) which don't execute code.Test plan
py.typedmarker is correctly placed and detectableH.nodes.andH.edges.in VS Code🤖 Generated with Claude Code