Walkthrough
## Walkthrough
此版本更新将`tqsdk`包的版本号从`3.6.1`提升至`3.7.0`,并引入了一些文档和功能更新,包括新增的`TqCtp`类用于直接连接到CTP交易、更新的依赖项以及文档版本信息的相应调整。此更新还包括对文档内容的增强和部分逻辑的改善。
## Changes
| 文件路径 | 更改摘要 |
|------------------------------|-------------------------------------------------------|
| `PKG-INFO` | 版本号从`3.6.1`更新至`3.7.0`。 |
| `doc/conf.py` | `version`和`release`变量均更新为`3.7.0`。 |
| `doc/reference/index.rst` | 新增`tqsdk.tqctp.rst`的参考条目。 |
| `doc/reference/tqsdk.tqctp.rst` | 新增`tqsdk.TqCtp`类的文档条目。 |
| `doc/version.rst` | 新增版本`3.7.0`及相关功能的文档更新。 |
| `setup.py` | 版本号更新至`3.7.0`,依赖项`tqsdk_zq_otg`更新至`1.1.0`。|
| `tqsdk/__version__.py` | 更新`__version__`变量为`3.7.0`。 |
| `tqsdk/api.py` | `get_kline_serial`方法文档中新增警告信息。 |
| `tqsdk/zq_otg.py` | 修改`get_addr`异步上下文管理器的进程终止逻辑。 |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant TqCtp
User->>TqCtp: 连接到CTP交易
TqCtp->>User: 提供交易功能
```
>
在此春日暖阳下,
兔子欢舞,笑声如歌。
新版本,跃然纸上,
功能丰富,文档闪亮。
跳跃着,声声祝福,
愿代码更上层楼,
兔子欢庆,乐无穷! 🐇✨
Tips
### Chat
There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai):
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- `I pushed a fix in commit .`
- `Generate unit testing code for this file.`
- `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
- `@coderabbitai generate unit testing code for this file.`
- `@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- `@coderabbitai generate interesting stats about this repository and render them as a table.`
- `@coderabbitai show all the console.log statements in this repository.`
- `@coderabbitai read src/utils.ts and generate unit testing code.`
- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`
- `@coderabbitai help me debug CodeRabbit configuration file.`
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 as PR comments)
- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai full review` to do a full review from scratch and review all the files again.
- `@coderabbitai summary` to regenerate the summary of the PR.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository.
- `@coderabbitai help` to get help.
Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
### CodeRabbit Configuration File (`.coderabbit.yaml`)
- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`
### Documentation and Community
- Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
新功能
tqsdk.TqCtp
类的支持,允许直接连接 CTP 交易。tqsdk.tqctp
的引用,提供更多详细信息。文档
get_kline_serial
方法中增加用户警告,提醒不要修改原始 K 线序列。修复
get_addr
方法的进程终止逻辑,以实现更优雅的关闭。