chore: update readme import error #202
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe import paths for Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❌ Your project status has failed because the head coverage (70.68%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #202 +/- ##
=======================================
Coverage 70.68% 70.68%
=======================================
Files 134 134
Lines 10870 10870
=======================================
Hits 7683 7683
Misses 3187 3187 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
README.md
Outdated
| from openfga_sdk.client.models.list_users_request import ClientListUsersRequest, ClientTuple | ||
|
|
There was a problem hiding this comment.
Incorrect module referenced for ClientTuple
ClientTuple is defined in its own module (client_tuple.py) and is re-exported by openfga_sdk.client.models, but it is not part of list_users_request.py.
The new import therefore fails at runtime / copy-paste:
>>> from openfga_sdk.client.models.list_users_request import ClientTuple
ImportError: cannot import name 'ClientTuple' ...Fix the example to import each symbol from its correct module (or from the package init that already re-exports both):
-from openfga_sdk.client.models.list_users_request import ClientListUsersRequest, ClientTuple
+from openfga_sdk.client.models.list_users_request import ClientListUsersRequest
+from openfga_sdk.client.models import ClientTupleThis keeps ClientListUsersRequest narrowed to its own file while maintaining the valid path for ClientTuple.
Please adjust before merging to avoid propagating a faulty README example.
🤖 Prompt for AI Agents
In README.md around lines 1063 to 1064, the import statement incorrectly imports
ClientTuple from list_users_request.py where it is not defined, causing runtime
import errors. Update the import to get ClientTuple from its correct module
client_tuple.py or from the package init that re-exports both
ClientListUsersRequest and ClientTuple, ensuring each symbol is imported from
its proper source to fix the import error.
Fixing outdated README import
Description
What problem is being solved?
Update README
How is it being solved?
Adding correct import location
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit