VSCode/PyCharm debugger settings and documentation + warnings fixes #844
Conversation
This file contains 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
EugeneLightsOn
requested review from
malexw,
scottmx81,
tianjing-li and
a team
as code owners
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #844 +/- ##
==========================================
- Coverage 79.56% 79.01% -0.55%
==========================================
Files 251 252 +1
Lines 10632 10707 +75
==========================================
+ Hits 8459 8460 +1
- Misses 2173 2247 +74 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
…ion-for-debugger-settings-in-popular-ides # Conflicts: # src/backend/main.py
EugeneLightsOn
requested a deployment
to
development
GitHub Actions
Waiting
…ion-for-debugger-settings-in-popular-ides
EugeneLightsOn
temporarily deployed
to
development
GitHub Actions
Inactive
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.
Initial steps to configure debugger in popular IDEs
AI Description
This PR introduces debugging capabilities for the dockerized Toolkit API using VSCode and PyCharm. It provides a comprehensive guide on how to debug the API, allowing developers to inspect code, set breakpoints, and step through code execution to identify and fix issues.
The PR adds new sections to the
README.mdfile, detailing how to debug the dockerized Toolkit API with VSCode and PyCharm. It also includes a newdocs/debugging.mdfile, which provides a step-by-step guide for debugging with both tools.Key Changes:
docs/debugging.mdfile offers a detailed walkthrough for debugging the dockerized Toolkit API using VSCode and PyCharm. It covers setting up the project, configuring the debugger, and running the API in debug mode.vscode-debugandpycharm-debug, which facilitate debugging with VSCode and PyCharm, respectively.docker-compose.vscode.debug.ymlanddocker-compose.pycharm.debug.yml, have been added to configure the debugging environment for VSCode and PyCharm, respectively.src/backend/main.pyandsrc/backend/pycharm_debug_main.pyfiles have been modified to include theasynccontextmanagerdecorator and thelifespanfunction, enhancing the application's lifecycle management.src/backend/schemas/agent.pyfile has been updated to include themodel_configdictionary, replacing the previousConfigclass.