Saleor 18: 参与我们 - 编码风格

Python

始终遵循 PEP 8 ，但请记住，一致性非常重要。

String Literals

优先使用单引号加双引号，除非字符串本身包含需要不必要地转义的单引号。

Wrapping Code

When wrapping code follow the “hanging grid” format:

some_dict = {
    'one': 1,
    'two': 2,
    'three': 3}

some_list = [
    'foo', 'bar', 'baz']

Python是一种基于缩进的语言，我们相信漂亮，可读的代码比保存一行 git diff 更重要。 即使 Django 项目似乎鼓励这种编程风格，请避免使用括号，括号，方括号或悬挂逗号。下面这种是错误的做法：

this_is_wrong = {
   'one': 1,
   'two': 2,
   'three': 3,
}

请在括号后立即打破多行代码，并避免依赖精确数量的空格进行对齐，下面这种做法也是错误的：

also_wrong('this is hard',
           'to maintain',
           'as it often needs to be realigned')

Linters

使用 isort 来维护一致的进口。

使用 pylint 与 pylint-django 插件来捕获代码中的错误。

使用 pycodestyle 确保您的代码符合 PEP 8。

使用 pycodestyle 检查您的文档字符串格式是否正确。