没有合适的资源?快使用搜索试试~ 我知道了~
Python开发规范.docx
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 138 浏览量
2023-05-20
10:32:18
上传
评论
收藏 81KB DOCX 举报
温馨提示
试读
14页
Python开发规范
资源推荐
资源详情
资源评论
Python 开发规范
总则
概况:Python 风格规范 ,包含了部分 Google 风格规范
和 PEP8 规范。包括 Django 项目目录结构的一些规范,为适
应我们实际需求,提高开发中代码更加可观性、易读性拟定
的规范。
第一章 命名规范
1.1 模块
模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单
词,且数量不多的情况)
# 正确的模块名
import decoder
import html_parser
# 不推荐的模块名
import Decoder
1.2 类名
1.3 函数
编写函数的几个原则
函数设计要尽量短小,嵌套层次不宜过深;
函数申明应做到合理、简单、易于使用,函数名应能正确反映函数大体功能,
参数设计应简洁明了,参数个数不宜过多;
函数参数设计应考虑向下兼容;
一个函数只做一件事,尽量保证函数语句粒度的一致性;
1.4 变量名
避免只用大小写来区分不同的对象;
避免使用容易引起混淆的名称,变量名应与所解决的问题域一致;
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头 class
Farm():
pass
class AnimalFarm(Farm):
pass
class _PrivateFarm(Farm):
pass
将相关的类和顶级函数放在同一个模块里. 不像 Java, 没必要限制一个类一个模块.
函数名一律小写,如有多个单词,用下划线隔开
def run():
pass
def run_with_env():
pass
私有函数在函数前加一个下划线_
class Person():
def _private_func():
pass
不要害怕过长的变量名;
1.5 常量
1.6 其他规则
1.所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.
2.用单下划线(_)开头表示模块变量或函数是 protected 的(使用 import * from
时不会包含).
3.用双下划线(__)开头的实例变量或方法表示类内私有.
4.将相关的类和顶级函数放在同一个模块里. 不像 Java, 没必要限制一个类
一个模块.
5.对类名使用大写字母开头的单词(如 CapWords, 即 Pascal 风格), 但是模块
名应该用小写加下划线的方式(如 lower_with_under.py).
1.7 应该避免的名称
1.单字符名称
2.包/模块名中使用连字符(-)而不使用下划线(_)
3.双下划线开头并结尾的名称(如__init__)
变量名尽量小写, 如有多个单词,用下划线隔开
if __name__ == '__main__':
count = 0
school_name = ''
常量采用全大写,如有多个单词,使用下划线隔开
MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600
常量使用以下划线分隔的大写命名
MAX_OVERFLOW = 100
Class FooBar:
def foo_bar(self, print_):
print(print_)
剩余13页未读,继续阅读
资源评论
智慧化智能化数字化方案
- 粉丝: 504
- 资源: 1万+
下载权益
C知道特权
VIP文章
课程特权
开通VIP
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功