如何编写高质量的python程序

一、如何编写高质量的python程序

写出规范的代码是写出高质量代码的第一步，并且有助于培养仔细的习惯。

为了培养规范写代码的习惯，可以安装flake8这个工具，它不仅可以检查代码风格是否符合官方建议（PEP8），而且还能找出潜在的隐患（用Pyflakes做语法分析），更逆天的是还能检测到你有些函数写的太复杂（代码圈复杂度）了，更更逆天的是可以设置git commit之前必须通过这些检查。

当然具体操作需要根据自己的项目进行一些定制，比如可以忽略E501，W293。

好的开始是成功的一半，写python代码就从pyempty开始吧。

在github上看一下那些经典的项目，web.py,flask, pep8，他们的项目目录都很规范，综合借鉴了一些项目的特点，我写了这个pyempty项目。

1.README.md这里写你项目的简介，quick start等信息，虽然distutils要求这个文件没有后缀名，但github上如果后缀是.md的话可以直接转换成html显示。

2.ChangeLog.txt该文件存放程序各版本的变更信息，也有一定的格式，参考web.py的ChangeLog.txt

3.LICENES.txt这里存放你项目使用的协议，不要编写自己的协议。

4.requirements.txt如果你的项目需要依赖其它的python第三方库，在这里一行一个写出来，可能pip install的时候能自动帮你安装

5.setup.py安装脚本，后面详细介绍

6.docs里面存放你的项目文档，如概要设计，详细设计，维护文档，pydoc自动生成的文档等，强烈推荐大家使用MarkDown格式编写文档

7.src这个目录里存放项目模块的主要代码，尽量不要把模块目录直接放到根目录，模块代码目录可以在setup.py里指定的

8.tests这个目录存放所有单元测试，性能测试脚本，单元测试的文件确保以test_做前缀，这样distutils会自动打包这些文件，并且用python-m unittest discover-s./-p'test_*.py'-v可以直接执行这些测试

Martin Fowler："在你不知道如何测试代码之前，就不该编写程序。而一旦你完成了程序，测试代码也应该完成。除非测试成功，你不能认为你编写出了可以工作的程序。"

我们有很多理由不写单元测试，归根结底是懒，虽然代码大全上说：

大部分研究都发现，检测比测试的成本更小。NASA软件工程实验室的一项研究发现，阅读代码每小时能够检测出来的缺陷要比测试高出80%左右(Basili and Selby 1987)。后来，IBM的一项研究又发现，检查发现的一个错误只需要3.5个工作时，而测试则需要花费15-25个工作时（Kaplan 1995)。

但是单元测试还是让别人相信你的代码有很高质量的最有力证据。

深入python3.0:单元测试-2.x也适用

Unit testing framework不完整中文版

敏捷开发不是提倡什么文档也不写，没有文档就没有传承和积累，轮岗或新人接手任务就会遇到很大的麻烦，所以我决定每个项目最少要写以下文档：

1.nalysis.model.md概要设计文档，不同于README.md文件，该文档应该写于项目开发之前，把项目有哪些功能，大概分几个模块等项目整体概述信息写一下。

2.design.model.md详细设计文档，不用太详细，至少把项目依赖哪些东西，谁依赖这个项目，重要算法流程描述，代码整体结构等写出来。

3.maintain.md维护文档，这个我觉得最重要，你的服务都记录哪些日志，需要监控哪些业务指标，如何重启，有哪些配置项等，没这些东西，你的项目很难运维。

上面这些文档都是项目全局性的文档，不适合写在docstring或注视里，所以要有单独的文档。

python有专门的模块打包系统distutils，你可以用这套机制把你的代码打包并分发到Pypi上，这样任何人都可以用pip或easy_install安装你的模块。

如果你开发的是内部项目，还可以用mypypi架设私有的pypi，然后把项目的大的版本更新发布到内部的pypi上，配置管理人员和运维人员可以很方便的从pypi上拉取代码安装到测试环境或生产环境。

发布大版本的时候要给版本命名及编写ChangeList，可以参考Git Pro的相关章节,主要记住以下几个命令。

git tag-a v0.1-m'my test tag'#给大版本命名，打Tag

git describe master#给小版本命名,Git将会返回一个字符串，由三部分组成：最近一次标定的版本号，加上自那次标定之后的提交次数，再加上一段SHA-1值

git shortlog--no-merges master--not v0.1#生成版本简报,ChangeList

python有自己的打包机制，所以一般不要用git archive命令。

当然大版本管理用pypi管理比较合适，小的bug fix，紧急上线等好多公司都是用git直接从生产环境拉代码更新，因为git,svn等可以很方便的撤销某次更新，回滚到某个位置。

如何管理好大版本上线和小的紧急上线，我还没理清思路，欢迎大家参与讨论。

出自：

二、如何编写第一个python程序

1、现在，了解了如何启动和退出Python的交互式环境，我们就可以正式开始编写Python代码了。

2、在写代码之前，请千万不要用“复制”-“粘贴”把代码从页面粘贴到你自己的电脑上。写程序也讲究一个感觉，你需要一个字母一个字母地把代码自己敲进去，在敲代码的过程中，初学者经常会敲错代码，所以，你需要仔细地检查、对照，才能以最快的速度掌握如何写程序。

3、在交互式环境的提示符>>>下，直接输入代码，按回车，就可以立刻得到代码执行结果。现在，试试输入100+200，看看计算结果是不是300：

4、很简单吧，任何有效的数学计算都可以算出来。

5、如果要让Python打印出指定的文字，可以用print语句，然后把希望打印的文字用单引号或者双引号括起来，但不能混用单引号和双引号：

6、>>> print'hello, world'

7、这种用单引号或者双引号括起来的文本在程序中叫字符串，今后我们还会经常遇到。

8、最后，用exit()退出Python，我们的第一个Python程序完成！唯一的缺憾是没有保存下来，下次运行时还要再输入一遍代码。

三、编写python的软件有哪些

《Python 3.9.7软件》百度网盘资源免费下载:

链接: 提取码: nhfc

Python 3.9.7最新正式版是一种面向对象、直译式计算机程序设计语言，也是一种功能强大而完善的通用型语言，已经具有十多年的发展历史，成熟且稳定。python具有非常简捷而清晰的语法特点，且几乎可以在所有的操作系统中运行，非常适合完成各种高层任务，随着不断的更新优化，逐渐被用于独立的、大型项目的开发，只为给用户更加完美的操作体验。