python高级编程之选择好名称:完2

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

# python:2.x

__author__ = 'Administrator'

#分解代码

#小就是美，这也适用所有级别的代码，当一个函数，类或者一个代码太大时，应该对其进行分解

#一个函数或者一个方法的内容不应该起过一个屏幕，也就是大约25到30行，否则它将很难跟踪和理解

#关于代码生可以参看eric raymond所著的art of unix programming(中文版<unix编码艺术>)中章节

#类的方法数量应该有一定的限制，当方法超过10个时，即使创建者对其也很难做出完整描绘，一个常见的方法是分离功能并且在该类之外创建多个类

#一个模块的大小也应该有一定的限制，当它超过500行时，应该被分解为多个模块

#这个工作将会影响API，并且意味着在包级别上需要付出被额外的工作来确保代码分解和组织的方式不会使API难以使

#换句话说，API应该问题是从用户角度来测试，以确保它可用，易于记忆和简明.

#使用Egg

"""

当应用程序不断成长时，主文件夹下面的包数量也会变大，例如，像ZOPE这样的框架在根包zope命名空间中就有超过50个包

为了避免使整个代码言库都在同一个文件夹里面，并能单独发布每个包，可以使用python eggs:http://peak.telecommnuity.com/devcenter/pythoneggs

来解决，它们提供了一个构建命名空间的包的简单方法，就像JAVA中提供的JAR一样

例如，如果希望将 acme.templates作为单独的包分发，可以使用setuptools(用于建立的python egg程序库)来构建一个基于egg的包，在acme文件夹中的特殊方法__init__.py里面添加以下内容

http://peak.telecommunity.com/devcenter/setuptools#namespace-packages

try:

__import__('pkg_resources').declare_namespace(__name__)

except ImportError:

from pkgutil import extend_path

__path__==extend._path(__path__,__name__)

然后，acme文件夹可以保存templates文件夹，并使其能够位于acme.templates命名空间之下，acme.pdf甚至可以从独立蝗acme文件夹中被分离出来

遵循相同规则，来自相同组织的包可以通过egg收集在相同命名空间中，即使它们互不相关，所有来自ingeniweb包都使用iw命名空间，并且可以使用前缀

http://pypi.python.org/pypi?%Aaction=search&term=iw/&submit=search,在cheeseshop上找到

除了命名空间之外，以egg形式分发应该程序也对模块化有帮助，因为可以视每个egg为一个独立组件

"""

#使用deprecation过程

#当包已经被发布被第三方代码使用时，对API修改就必须小心进行了，处理这种修改最简单的方法是遵循一个deprecation过程，在此是2个版本中间发行版本

#例如

class S(object):#版本1

def run_script(self,s1,s2):

print 'work'

import warnings

class S1(object):#版本1.5

def run_script(self,s1,s2):

print 'work'

warnings.warn(('run_scriptwill'),DeprecationWarning)

return self.run(s1,s2)

def run(self,s1,s2=None):

print 'word'

class S3(object):#版本2

def run(self,s1,s2=None):

pass

#warnings模块将在第一次调用时警告用户，并且魅力下一个调用，这个模块的另一个功能是创建过滤器，用来管理影响应用程序警告信息。

#docs.python.org/lib/warning-filter.html

#有用工具

#pylint:一个非常灵活的元代码分析器

#除了一些质量保证方便试题之外，它还能够检查指定源代码是否遵循某种命名约定，默认设置对应pep8,一个pylint脚本提供了一个shell报告输出

#要安装pylint,可以通过easy_install来使用logiab.installer egg，如下

#图片

#注意,pylint总会在某些情况下给出不好的评级或者抱怨，例如一个被模块本身的代码使用import语句在某些情况下也是很好的（使其在命名空间中可用）

#如果调用采用混合大小写的方法命名程序库，那么它也可能降低评级，在任何情况下，全局评估不像c中的lint那么重要，它只是一个指出潜在改进的工作，

# 调优它第一件要做事情就是，使用-generate-rcfile选项在原始目录下创建一个.pylinrc配置文件，如下

#图片

#在windows下面，~文件夹必须替换成用户文件夹，一般位于documents and settings文件夹中（环境变量）

#配置文件中首先需要修改的是，在reports小节中将reports变量设置为no,以避免生成冗长的报告，在例子中，只需要 用这个工作侦测名称，当完成这个修改之后，这个工具将只会显示警告，如下

#图片

#clonedigger:http://clonedigger.sourceforge.net是一个很好的工具，它尝试访问代码树以侦测代码中相似之处，它基于网站上所说明相当复杂算法，有效地补充了pylint.

#要安装它，可以使用 easy_install,如下

#easy_install CloneDigger

#将得到一个可被用于侦测重复代码的clondigger命令，命令选项可以在http://clonedigger.sourceforge.net/documentation.html上找到

#output.html是它生成的一个html输入，其中包含了clonedigger一个工作报告