开发规范

时间 2019-11-30

标签开发规范繁體版

原文原文链接

开发规范

什么是开发规范?为何要有开发规范呢?html

你如今包括以前写的一些程序，所谓的'项目'，都是在一个py文件下完成的，代码量撑死也就几百行，你认为没问题，挺好。可是真正的后端开发的项目，系统等，少则几万行代码，多则十几万，几十万行代码，你全都放在一个py文件中行么？固然你能够说，只要能实现功能便可。我们举个例子，若是你的衣物只有三四件，那么你随便堆在橱柜里，没问题，咋都能找到，也不显得特别乱，可是若是你的衣物，有三四十件的时候，你在都堆在橱柜里，可想而知，你找你穿过三天的袜子，最终从你的大衣口袋里翻出来了，这是什么感受和心情......git

　　软件开发，规范你的项目目录结构，代码规范，遵循PEP8规范等等，让你更加清晰滴，合理滴开发。github

　　软件开发的首要规范就是从设计目录结构开始。redis

为何要设计项目目录结构？

"设计项目目录结构"，就和"代码编程风格"同样，属于我的风格问题。对于这种风格上的规范，一直都存在两种态度:编程

一类同窗认为，这种我的风格问题"可有可无"。理由是能让程序运行就好，风格问题根本不是问题。
另外一类同窗认为，规范化能更好的控制程序结构，让程序具备更高的可读性。

我是比较偏向于后者的，由于我是前一类同窗思想行为下的直接受害者。我曾经维护过一个很是很差读的项目，实现的逻辑并不复杂，可是却耗费了我很是长的时间去理解它想表达的意思。今后我我的对于提升项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，咱们设计一个层次清晰的目录结构，就是为了达到如下两点:后端

可读性高: 不熟悉这个项目代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪一个，测试目录在哪儿，配置文件在哪儿等等。从而很是快速的了解这个项目。
可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪一个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增长，项目结构不会混乱，仍然可以组织良好。

因此，我认为，保持一个层次清晰的目录结构是有必要的。更况且组织一个良好的工程目录，实际上是一件很简单的事儿。app

较好的目录结构方式（推荐）函数

具体分析：测试

关于README的内容

这个我以为是每一个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。spa

它须要说明如下几个事项:

软件定位，软件的基本功能。
运行代码的方法: 安装环境、启动命令等。
简要的使用说明。
代码目录结构说明，更详细点能够说明软件的基本原理。
常见问题说明。

我以为有以上几点是比较好的一个README。在软件开发初期，因为开发过程当中以上内容可能不明确或者发生变化，并非必定要在一开始就将全部信息都补全。可是在项目完结的时候，是须要撰写这样的一个文档的。

能够参考Redis源码中Readme的写法，这里面简洁可是清晰的描述了Redis功能和源码结构。

回到顶部

logging模块

咱们来讲一下这个logging模块,这个模块的功能是记录咱们软件的各类状态,大家如今和我一块儿找到红蜘蛛的那个图标,而后右键找一找是否是有个错误日志.其实每一个软件都是有错误日志的,开发人员能够经过错误日志中的内容

对他的程序进行修改

咱们先来看一下函数式简单配置

 
          import logging   
         
          logging.debug( 
          'debug message' 
          )   
         
          logging.info( 
          'info message' 
          )   
         
          logging.warning( 
          'warning message' 
          )   
         
          logging.error( 
          'error message' 
          )   
         
          logging.critical( 
          'critical message' 
          )

默认状况下Python的logging模块将日志打印到了标准输出中，且只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING（日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG），默认的日志格式为日志级别：Logger名称：用户输出消息。

咱们本身用函数写的这个能够正常使用可是不够灵活,咱们看看这个灵活的

灵活配置日志级别，日志格式，输出位置:

 
          import logging   
         
          logging.basicConfig(level=logging.DEBUG,   
         
          format= 
          '%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s' 
          ,   
         
          datefmt= 
          '%a, %d %b %Y %H:%M:%S' 
          ,   
         
          filename= 
          '/tmp/test.log' 
          ,   
         
          filemode= 
          'w' 
          )   
         
          logging.debug( 
          'debug message' 
          )   
         
          logging.info( 
          'info message' 
          )   
         
          logging.warning( 
          'warning message' 
          )   
         
          logging.error( 
          'error message' 
          )   
         
          logging.critical( 
          'critical message' 
          )

 
          logging.basicConfig()函数中可经过具体参数来更改logging模块默认行为，可用参数有： 
         
          filename：用指定的文件名建立FiledHandler，这样日志会被存储在指定的文件中。 
         
          filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。 
         
          format：指定handler使用的日志显示格式。 
         
          datefmt：指定日期时间格式。 
         
          level：设置rootlogger（后边会讲解具体概念）的日志级别 
         
          stream：用指定的stream建立StreamHandler。能够指定输出到sys.stderr,sys.stdout或者文件(f=open(‘test.log’,’w’))，默认为sys.stderr。若同时列出了filename和stream两个参数，则stream参数会被忽略。 
         
          format参数中可能用到的格式化串： 
         
          %(name)s Logger的名字 
         
          %(levelno)s 数字形式的日志级别 
         
          %(levelname)s 文本形式的日志级别 
         
          %(pathname)s 调用日志输出函数的模块的完整路径名，可能没有 
         
          %(filename)s 调用日志输出函数的模块的文件名 
         
          %(module)s 调用日志输出函数的模块名 
         
          %(funcName)s 调用日志输出函数的函数名 
         
          %(lineno)d 调用日志输出函数的语句所在的代码行 
         
          %(created)f 当前时间，用UNIX标准的表示时间的浮 点数表示 
         
          %(relativeCreated)d 输出日志信息时的，自Logger建立以 来的毫秒数 
         
          %(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒 
         
          %(thread)d 线程ID。可能没有 
         
          %(threadName)s 线程名。可能没有 
         
          %(process)d 进程ID。可能没有 
         
          %(message)s用户输出的消息

logger对象配置

 
          import logging 
         
          logger = logging.getLogger() 
         
          # 建立一个handler，用于写入日志文件 
         
          fh = logging.FileHandler( 
          'test.log' 
          ,encoding= 
          'utf-8' 
          )  
         
          # 再建立一个handler，用于输出到控制台  
         
          ch = logging.StreamHandler()  
         
          formatter = logging.Formatter( 
          '%(asctime)s - %(name)s - %(levelname)s - %(message)s' 
          ) 
         
          fh.setLevel(logging.DEBUG) 
         
          fh.setFormatter(formatter)  
         
          ch.setFormatter(formatter)  
         
          logger.addHandler(fh) #logger对象能够添加多个fh和ch对象  
         
          logger.addHandler(ch)  
         
          logger.debug( 
          'logger debug message' 
          )  
         
          logger.info( 
          'logger info message' 
          )  
         
          logger.warning( 
          'logger warning message' 
          )  
         
          logger.error( 
          'logger error message' 
          )  
         
          logger.critical( 
          'logger critical message' 
          )

ogging库提供了多个组件：Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口，Handler发送日志到适当的目的地，Filter提供了过滤日志信息的方法，Formatter指定日志显示格式。另外，能够经过：logger.setLevel(logging.Debug)设置级别,固然，也能够经过

fh.setLevel(logging.Debug)单对文件流设置某个级别。