Help us learn about your current experience with the documentation. Take the survey.

Python 开发指南

本文档描述了我们在 GitLab 开发 Python 代码时采用的约定和实践。虽然 GitLab 主要基于 Ruby on Rails 构建,但我们在需要时会使用 Python 来利用其生态系统。

我们代码库中的一些 Python 示例:

本文档不涵盖数据科学项目中 Python 使用的指南。有关内容,请参考 数据团队平台指南

设计原则

  • 工具应该帮助贡献者实现短期和长期的目标。
  • 熟悉 GitLab 中 Python 代码库的开发者应该对 GitLab 中的任何其他 Python 代码库感到熟悉。
  • 本文档应该支持所有贡献者,无论他们的目标和动机如何:从 Python 专家到临时贡献者。
  • 我们努力遵循外部指南,但如果需要,我们会选择更好地支持 GitLab 贡献者的约定。

何时应该考虑使用 Python 进行开发

在 GitLab 开发中,Ruby 应该始终是首选,因为我们有更大的社区、更好的支持和更简单的部署。然而,在某些情况下,使用 Python 是值得打破常规的。例如,在处理 AI 和 ML 时,大多数开源项目都使用 Python,而使用 Ruby 将需要构建和维护大型代码库。

学习 Python

入门资源、示例和提示。

创建新的 Python 应用程序

为新代码库搭建库和流水线

约定和风格指南

编写一致的代码库

代码审查和维护者指南

关于创建和审查 MR 的指南

部署 Python 代码库

部署库、工具和服务。

作为 Monorepo 一部分的 Python

关于 Monorepo 中使用 Python 的库的指南