Commit d0cf386
Document: fbsource/py/fbcode/later.unittest.case.TestCase
Summary:
## Instructions about RACER Diffs:
**Commandeer this diff (recommended) or land with accept2ship tag.**
**This diff was generated by Racer AI agent on behalf of [Brian Johnson](https://www.internalfb.com/profile/view/8646079) for T246558534. If the diff quality is poor, consider contacting the user to provide clearer instructions on the task.**
- If you are happy with the changes, commandeer it if minor edits are needed. (**we encourage commandeer to get the diff credit**)
- If you are not happy with the changes, please comment on the diff with clear actions and send it back to the author. Racer will pick it up and re-generate.
- If you really feel the Racer is not helping with this change (alas, some complex changes are hard for AI) feel free to abandon this diff.
- **For M10N reviewers:** as you review AI-generated diffs, we ask you to give them the same priority as human-generated diffs, and take action in a timely manner by either accepting, rejecting, or resigning as a reviewer. For diffs that don't meet the quality bar (e.g. code doesn't compile, not readable or introduces functionality regressions), we ask that you use the following hashtags to provide clear signals to improve our tools - `#monlowqualitydiff` `#monwrongreviewerdiff`
## Summary:
Added comprehensive docstring to the `later.unittest.case.TestCase` class to document its purpose, functionality, and usage patterns. The TestCase class is an enhanced async test case that extends `IsolatedAsyncioTestCase` to provide automatic tracking of asyncio tasks and monitoring of asyncio errors. The docstring includes:
- Overview of the class's core functionality (task leak detection and asyncio error monitoring)
- Key features: automatic detection of un-awaited tasks, monitoring of asyncio logger errors, custom task factory, and isolated event loops
- Usage guidance for the `ignoreTaskLeaks` and `ignoreAsyncioErrors` decorators
- Example code demonstrating typical usage patterns
This documentation helps developers understand how to properly use this specialized test case for async testing while ensuring tasks are properly managed.
---
> Generated by [RACER](https://www.internalfb.com/wiki/RACER_(Risk-Aware_Code_Editing_and_Refactoring)/), powered by [Confucius](https://www.internalfb.com/wiki/Confucius/Analect/Shared_Analects/Confucius_Code_Assist_(CCA)/)
[Session](https://www.internalfb.com/confucius?session_id=d497aab8-cadc-11f0-9aa2-0f6362700475&tab=Chat), [Trace](https://www.internalfb.com/confucius?session_id=d497aab8-cadc-11f0-9aa2-0f6362700475&tab=Trace)
Reviewed By: fried
Differential Revision: D87928508
fbshipit-source-id: 79ab5085735c9c9f8bb048b6a6f5c37b266c739c1 parent a179231 commit d0cf386
1 file changed
+23
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
95 | 118 | | |
96 | 119 | | |
97 | 120 | | |
| |||
0 commit comments