pep8 等工具可以检查源代码样式，但他们不检查文档字符串是否根据 pep257 , pep287 .有这样的工具吗？
更新
我决定自己实现这样一个静态分析工具，见:
最佳答案
我不知道任何用于 python 文档字符串的静态分析工具。实际上，我在开始使用 PyLint 后不久就开始构建一个，但很快就放弃了。
PyLint 有一个插件系统和一个文档字符串插件是可行的，如果你想把工作放入使 PEP 可执行。
PyLint“插件”被称为检查器，有两种形式:将源文件作为原始文本文档使用，以及将源文件作为 AST 使用。我从 AST 开始尝试。回想起来，这可能是一个错误。
这是我所拥有的:
class DocStringChecker(BaseChecker):
"""
PyLint AST based checker to eval compliance with PEP 257-ish conventions.
"""
__implements__ = IASTNGChecker
name = 'doc_string_checker'
priority = -1
msgs = {'W9001': ('One line doc string on >1 lines',
('Used when a short doc string is on multiple lines')),
'W9002': ('Doc string does not end with "." period',
('Used when a doc string does not end with a period')),
'W9003': ('Not all args mentioned in doc string',
('Used when not all arguments are in the doc string ')),
'W9004': ('triple quotes',
('Used when doc string does not use """')),
}
options = ()
def visit_function(self, node):
if node.doc: self._check_doc_string(node)
def visit_module(self, node):
if node.doc: self._check_doc_string(node)
def visit_class(self, node):
if node.doc: self._check_doc_string(node)
def _check_doc_string(self, node):
self.one_line_one_one_line(node)
self.has_period(node)
self.all_args_in_doc(node)
def one_line_one_one_line(self,node):
"""One line docs (len < 80) are on one line"""
doc = node.doc
if len(doc) > 80: return True
elif sum(doc.find(nl) for nl in ('\n', '\r', '\n\r')) == -3: return True
else:
self.add_message('W9001', node=node, line=node.tolineno)
def has_period(self,node):
"""Doc ends in a period"""
if not node.doc.strip().endswith('.'):
self.add_message('W9002', node=node, line=node.tolineno)
def all_args_in_doc(self,node):
"""All function arguments are mentioned in doc"""
if not hasattr(node, 'argnames'): return True
for arg in node.argnames:
if arg != 'self' and arg in node.doc: continue
else: break
else: return True
self.add_message('W9003', node=node, line=node.tolineno)
def triple_quotes(self,node): #This would need a raw checker to work b/c the AST doesn't use """
"""Doc string uses tripple quotes"""
doc = node.doc.strip()
if doc.endswith('"""') and doc.startswith('"""'): return True
else: self.add_message('W9004', node=node, line=node.tolineno)
def register(linter):
"""required method to auto register this checker"""
linter.register_checker(DocStringChecker(linter))
我记得这个系统没有很好的文档(过去一年可能发生了变化)。这至少给了你一些东西来开始使用/非常简单的代码来代替文档。
关于python - 根据 PEP257 自动检查文档字符串样式的工具，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8724851/
总的来说，我对ruby还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用
我有一个字符串input="maybe(thisis|thatwas)some((nice|ugly)(day|night)|(strange(weather|time)))"Ruby中解析该字符串的最佳方法是什么？我的意思是脚本应该能够像这样构建句子:maybethisissomeuglynightmaybethatwassomenicenightmaybethiswassomestrangetime等等，你明白了......我应该一个字符一个字符地读取字符串并构建一个带有堆栈的状态机来存储括号值以供以后计算，还是有更好的方法？也许为此目的准备了一个开箱即用的库？
我的目标是转换表单输入，例如“100兆字节”或“1GB”，并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前，我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效，但前提是输入是倍数(“gigabytes”，而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以，功能正常，
在我的Rails(2.3，Ruby1.8.7)应用程序中，我需要将字符串截断到一定长度。该字符串是unicode，在控制台中运行测试时，例如'א'.length，我意识到返回了双倍长度。我想要一个与编码无关的长度，以便对unicode字符串或latin1编码字符串进行相同的截断。我已经了解了Ruby的大部分unicode资料，但仍然有些一头雾水。应该如何解决这个问题？ 最佳答案 Rails有一个返回多字节字符的mb_chars方法。试试unicode_string.mb_chars.slice(0,50)
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。
对于具有离线功能的智能手机应用程序，我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl
大约一年前，我决定确保每个包含非唯一文本的Flash通知都将从模块中的方法中获取文本。我这样做的最初原因是为了避免一遍又一遍地输入相同的字符串。如果我想更改措辞，我可以在一个地方轻松完成，而且一遍又一遍地重复同一件事而出现拼写错误的可能性也会降低。我最终得到的是这样的:moduleMessagesdefformat_error_messages(errors)errors.map{|attribute,message|"Error:#{attribute.to_s.titleize}#{message}."}enddeferror_message_could_not_find(obje
我试图获取一个长度在1到10之间的字符串，并输出将字符串分解为大小为1、2或3的连续子字符串的所有可能方式。例如:输入:123456将整数分割成单个字符，然后继续查找组合。该代码将返回以下所有数组。[1,2,3,4,5,6][12,3,4,5,6][1,23,4,5,6][1,2,34,5,6][1,2,3,45,6][1,2,3,4,56][12,34,5,6][12,3,45,6][12,3,4,56][1,23,45,6][1,2,34,56][1,23,4,56][12,34,56][123,4,5,6][1,234,5,6][1,2,345,6][1,2,3,456][123
我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%
我有一大串格式化数据(例如JSON)，我想使用Psychinruby同时保留格式转储到YAML。基本上，我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是，当我使用YAML.dump时，它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量？解