Add Comprehensive Type Hints & Models for Enhanced IDE Support#560
Open
LifeJiggy wants to merge 6 commits intodigitalocean:mainfrom
Open
Add Comprehensive Type Hints & Models for Enhanced IDE Support#560LifeJiggy wants to merge 6 commits intodigitalocean:mainfrom
LifeJiggy wants to merge 6 commits intodigitalocean:mainfrom
Conversation
Author
|
Thank you for considering this PR! |
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
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.
📝 Add Comprehensive Type Hints & Models for Enhanced IDE Support
This PR exposes thorough type definitions for all DigitalOcean resources, greatly improving IDE support, autocomplete, and type checking for all pydo users.
🛠️ Problem Solved
Previously, users worked with generic
Dict[str, Any]types, which meant:🚀 Solution
TypedDictclasses now available viafrom pydo import typesClientmethods🌟 Key Features
TypedDictclasses for Droplet, SSHKey, Region, Size, Image, Volume, and moreDropletsResponse,SSHKeysResponse, etc.)from pydo import types🧑💻 Usage Examples
📄 Files Changed
src/pydo/_patch.py— Exposed types module and added type hintsREADME.md— Added documentation and examples for type hints💥 Impact
🧪 Testing
from pydo import typesworks correctlyFeedback and suggestions are welcome!