Python的编码规则

Python的编码规则

1)        命名规则

l         变量名，包名，模块名

变量名通常由字母和下划线组成，包名和模块名通常用小写字母。

l         类名和对象名

类名首字母用大写，其他字母采用小写。对象名用小写字母。类的属性和方法名以对象作为前缀，对象通过操作符”.”访问属性和方法。类的私有变量，私有方法和两个下划线作为前缀。

l         函数名

函数名通常采用小写，并用下划线或单词首字母大写来增加名称的可读性，导入的函数以模块名作为前缀。

2)        代码的缩进与冒号

使用冒号或代码缩进来区分代码之间的层次。

3)        模块导入的规范

 在Python中，如果需要在程序中调用标准库或其他第三方库的类时，需要先使用import或from… import语句导入相关的模块。

l         import语句

l         from import语句

使用from…import…语句导入与import语句导入有所不同，区别是前者只是导入模块中的一部分内容，并在当前的命名空间中创建导入对象的引用；而后者在当前程序的命名空间中创建导入模块的引用，从而可以使用“类名.属性”的方式调用。

4)        使用空行分隔代码

函数之间或类的方法之间用空行分隔，表示一段新的代码的开始。类和函数入口之间也用一行空行分隔，以突出函数入口的开始。

Note：空行也是程序代码的一部分。

5)        正确的注释

注释的用法	作用
单行注释	说明一行语句的作用，使用“＃”加若干个空格开始，以回车作为注释的结束
块注释	说明一段代码的作用或整个程序文件的功能，段落之间用“＃”号分离
程序的跨平台	#! /user/bin/python
中文注释的支持	# -*- coding: UTF-8 -*-
调试程序	注释可以帮助程序员调试程序

 

6)        语句的分离

分号不是Python推荐使用的符号，Python倾向于使用换行符作为每条语句的分隔。通常一行只写一条语句，一行写多条语句，就必须使用分号分隔每个语句，如果多行写一条语句，就要使用”/”作为换行符。

例子：

# 下面两条语句是等价的

print "hello world!"

print "hello world!";

# 使用分号分隔语句

x = 1; y = 1; z = 1

# 一条语句写在多行

print /

"hello world!"

# 字符串的换行

# 写法一

sql = "select id,name /

from dept /

where name = 'A'"

print sql

# 写法二

sql = "select id,name " /

      "from dept " /

      "where name = 'A'"

print sql