代码标准

文档字符串

请使用Numpydoc Style。

持续集成

持续集成（CI）工具通过在每次推送新提交时运行测试并将结果报告给拉取请求，帮助您坚持质量标准。

当你提交PR请求时，你可以在网页底部的“检查”部分查看你的代码是否通过了CI测试。

  1. Qlib 将使用 black 检查代码格式。如果您的代码不符合 Qlib 的标准（例如，常见的错误是混合使用空格和制表符），PR 将引发错误。

    您可以通过在命令行中输入以下代码来修复这个错误。

pip install black
python -m black . -l 120

  1. Qlib 将检查你的代码风格 pylint。检查命令在 [github action workflow](https://github.com/microsoft/qlib/blob/0e8b94a552f1c457cfa6cd2c1bb3b87ebb3fb279/.github/workflows/test.yml#L66) 中实现。 有时 pylint 的限制并不那么合理。你可以像这样忽略特定的错误

return -ICLoss()(pred, target, index)  # pylint: disable=E1130

  1. Qlib 将检查你的代码风格 flake8。检查命令在 [github action workflow](https://github.com/microsoft/qlib/blob/0e8b94a552f1c457cfa6cd2c1bb3b87ebb3fb279/.github/workflows/test.yml#L73) 中实现。

    您可以通过在命令行中输入以下代码来修复这个错误。

flake8 --ignore E501,F541,E402,F401,W503,E741,E266,E203,E302,E731,E262,F523,F821,F811,F841,E713,E265,W291,E712,E722,W293 qlib

  1. Qlib 已经集成了 pre-commit，这将使开发者更容易格式化他们的代码。

    只需运行以下两个命令，代码将在执行 git commit 命令时自动使用 black 和 flake8 进行格式化。

pip install -e .[dev]
pre-commit install

开发指南

作为开发者，您经常希望对Qlib进行更改，并希望这些更改能直接反映在您的环境中，而无需重新安装。您可以使用以下命令以可编辑模式安装Qlib。 [dev]选项将帮助您在开发Qlib时安装一些相关的包（例如pytest, sphinx）。

pip install -e ".[dev]"