Python 编码风格指南

Published on 2019 / 10 / 23 , Updated on 2019 / 11 / 20

总则

除非项目有自己的约定，默认应该遵循 PEP8 和 Google Python 风格指南的要求。在开始编写代码前，请阅读并了解这两个文档。

项目约定

代码布局

风格

list，tuple，dict 多行定义的时候，每行结尾增加,，用于减少 git diff 时候的变动。

行长度

最大行长度180，推荐不超过120。

推荐在 PyCharm 内设置 Wrapping and braces，Visual guides设置为 120, 180。

格式化

使用 format 函数进行格式化，不使用 % 的方式。

导入格式

导入超过一行的情况下，使用括号包住引入模块。左括号后直接换行，右括号前不加内容。如下：

1
2
3

from package_name import (
    module_1, module_2, module_3, module_4, module_5
)

嵌套函数（Nested function）

嵌套函数声明在使用的代码之前的地方
嵌套函数必须以_前缀开头

函数命名

判断检查类型逻辑的函数以 is_ 或 has_ 前缀开头，返回值应该是 bool 类型
验证校验类型逻辑的函数以 check_ 或 validate_ 前缀开头，返回值可以包括相关的对象
进行操作的函数应该以动词开头，如 set_、get_、process_、enable_、disable_ 等

缺失模块。
1、请确保node版本大于6.2
2、在博客根目录（注意不是yilia根目录）执行以下命令：
npm i hexo-generator-json-content --save

3、在根目录_config.yml里添加配置：

  jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

一个人的命运啊，当然要靠自我奋斗，但是也要考虑到历史的行程。

很惭愧，就做了一点微小的工作，谢谢大家。