构造python模块的约定
是否有PEP或一般绑定约定用于结构化python模块的内容? 我现在的结构是这样的构造python模块的约定,python,module,structure,convention,pep,Python,Module,Structure,Convention,Pep,是否有PEP或一般绑定约定用于结构化python模块的内容? 我现在的结构是这样的 模块篡改 元变量(uuu all_uuu,uuu author_uuu,uuu version_uuu,…) 包括 模块方法 班级 如下所示(此处没有模块方法): “”“ 通用客户端 此包包含用于外部API交互的抽象、通用客户端。 有关实施建议,请参阅客户文档。 """ __日期:2014年7月16日 __作者=“我的名字” __all_uu=['ImportClient', “ExportClient”, “I
“”“
通用客户端
此包包含用于外部API交互的抽象、通用客户端。
有关实施建议,请参阅客户文档。
"""
__日期:2014年7月16日
__作者=“我的名字”
__all_uu=['ImportClient',
“ExportClient”,
“IEClient”,
“CRUDClient”]
from.abc import CustomerAwareConfigurableSlaveLog
from..config导入配置
将pyopenimmo作为OpenImmo导入
从abc导入法
类ImportClient(CustomerWareConfigutableSlavelog):
"""
可以导入OpenImmo数据的通用客户端
"""
@抽象方法
def导入(自我,openimmo):
"""
从API导入OpenImmo数据
"""
通过
类ExportClient(CustomerWareConfigutableSlavelog):
"""
可以导出OpenImmo数据的通用客户端
"""
@抽象方法
def导出(self,openimmo):#@UnusedVariable
"""
将OpenImmo数据导出到API
"""
返回
这对我来说似乎很可行,但我也希望其他人发现我的代码易于理解。排序与我的预期相符。。。部分原因是出于必要性,例如,您必须先导入软件包,然后才能使用它们。对于代码文件来说,在文件的顶部有一个某种类型的头也是“传统”的,这与其他书面作品——书籍(序言)、杂志(编辑的摘要)等——是很常见的。只要它是可读的和结构化的,就很容易理解。更多的评论。如果您想要更详细的答案,请询问codereview。
"""
Generic clients
This package contains abstract, generic clients for foreign-API interaction.
Please see the client's documentation for advises for implementation.
"""
__date__ = "16.07.2014"
__author__ = "My Name <me@company.com>"
__all__ = ['ImportClient',
'ExportClient',
'IEClient',
'CRUDClient']
from .abc import CustomerAwareConfigurableSlaveLog
from ..config import Config
import pyopenimmo as OpenImmo
from abc import abstractmethod
class ImportClient(CustomerAwareConfigurableSlaveLog):
"""
Generic client that can import OpenImmo data
"""
@abstractmethod
def import_(self, openimmo):
"""
Imports OpenImmo data from API
"""
pass
class ExportClient(CustomerAwareConfigurableSlaveLog):
"""
Generic client that can export OpenImmo data
"""
@abstractmethod
def export(self, openimmo): #@UnusedVariable
"""
Exports OpenImmo data to API
"""
return
<snip>