python public_零基础学习Python_小波浪

Python学习笔记

公众号搜索--树莓派OpenCV学舍

Python的小波浪_书写规范

在Python的IDE中经常会出现一些波浪线，还带不同颜色的。虽然看着别扭，但对于初学者的我来说也算一种善意的提醒--提示格式不正确或者语法错误。对于拥有强迫症的我来说，必须在此记一笔。同时也是规范自己代码的书写规范，有百利而无一害。

代码编排
1 缩进。4个空格的缩进(编辑器都可以完成此功能)，不要使用Tab，更不能混合使用Tab和空格。Tab 在不同的操作系统平台、不同的应用里缩进的空格数是不同的，为了在便于共同维护，不建议使用Tab来缩进代码
2 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。
3 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

文档编排
1 模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
2 不要在一句import中多个库，比如import os, sys不推荐。
3 如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX。

空格的使用    总体原则，避免不必要的空格。
1 各种右括号前不要加空格。
2 逗号、冒号、分号前不要加空格。
3 函数的左括号前不要加空格。如Func(1)。
4 序列的左括号前不要加空格。如list[2]。
5 操作符左右各加一个空格，不要为了对齐增加空格。
6 函数默认参数使用的赋值符左右省略空格。
7 不要将多句语句写在同一行，尽管使用‘；’允许。
8 if/for/while语句中，即使执行语句只有一句，也必须另起一行。

注释    总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。虽然python3中支持中文，但不推荐。
1 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。

2 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x
但是这种方式尽量少使用。
3 避免无谓的注释。

文档描述    为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释(在def的下一行)。命名规范    总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。
1 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。
2 模块命名尽量短小，使用全部小写的方式，可以使用下划线。
3 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
4 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。
5 异常命名使用CapWords+Error后缀的方式。
6 全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是__all__机制;二是前缀一个下划线。
7 函数命名使用全部小写的方式，可以使用下划线。
8 常量命名使用全部大写的方式，可以使用下划线。
9 类的属性(方法和变量)命名使用全部小写的方式，可以使用下划线。10 类的属性有3种作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。
11 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。
12 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明__a,访问时，只能通过Foo._Foo__a，避免歧义。如果子类也叫Foo，那就无能为力了。
13 类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

编码建议
1 编码中考虑到其他python实现的效率等问题，比如运算符‘+’在CPython(Python)中效率很高，但是Jython中却非常低，所以应该采用.join()的方式。
2 尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。
3 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。
4 异常中不要使用裸露的except，except后跟具体的exceptions。
5 异常中try的代码尽可能少。

6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。例如：

if foo.startswith(‘bar’):优于 if foo[:3] == ‘bar’:
7 使用isinstance()比较对象的类型。比如
if isinstance(obj, int): 优于 if type(obj) is type(1):
8 判断序列空或不空，有如下规则
if not seq:
if seq:
优于
if len(seq)
not len(seq)
9 字符串不要以空格收尾。
10 二进制数据判断使用 if boolvalue的方式。

Python开头注释

#!/usr/bin/env python

# -*- coding:utf-8 -*-

# Author:XXX 

1. #!/usr/bin/env python 与 #!/usr/bin/python 的区别

这些注释并不仅仅是写给读者看的注释，它也写给操作系统看的，这些注释决定了系统将如何运行这些文件。linux自带python解释器。在编写.py文件时，只要写上了#!/usr/bin/python这行注释，用户就可以直接在命令行用文件名来执行py文件，例如：testmode.py它的意义就类似于在window命令行中，你必须得写python testmode.py来运行文件，你要通过文件名前面的关键字才能去启动对应的解释器。而有了这行注释，Linux系统就知道了你要用什么来执行这个文件，你就可以直接用文件名去跑它了。

#!/usr/bin/python 注释的问题在于，Linux只系统默认的py解释器(也就是自带的那个)来运行文件。这样用户就无法使用自己的python版本了，不同的py版本之间语法有些差异，尤其是变动比较大的py2和py3，这些差异会使得整个程序无法正常运行。而#!/usr/bin/env python 的出现可以让用户自行选择python版本，用户可以在环境变量中配置自己的py解释器(ps：用户安装的版本默认定位在linux的local文件夹中)。#!/usr/bin/env python 这行注释，会使linux在解析文件时，知道要去使用环境变量中的py解释器而非系统自带的那个。所以如果你要使用该注释，推荐使用#!/usr/bin/env python 的注释，而非 #!/usr/bin/python。 

如果是在windows环境中执行文件的话，这行注释就无所谓了，因为你在cmd中，需要先定位到你py文件所在的文件夹后，再使用 python testmode.py 这样的语句来执行文件。window系统也不会去看这行注释.

2.# -*- coding:utf-8 -*-

   它的作用：在Linux下指定文件的编码方式,用于支持中文。

   python2需要在首行写-*- coding:utf-8 -*-才能支持中文，python3开始默认支持中文了，就可以省去这行注释。

3.所以如果是在windows的Python3下运行你的程序，你完全可以不去写前两行注释的，但是出于好习惯，也为了方便跨平台以及兼容，写一写还是好的。

4.如何在pyCharm中设置文件默认的开头的注释格式。如下：

　　1.view中勾选Toolbar 工具条,点击设置,也可使用ctrl+alt+S进入

　　2.选择editor下的file and code templates, 在右侧file中选择python script ,右侧输入注释