5

我想从重构文本字符串中的代码指令中逐字提取源代码。

接下来是我第一次尝试这样做,但我想知道是否有更好的(即更强大,或更通用,或更直接)的方式来做这件事。

假设我在 python 中有以下第一个文本作为字符串:

s = '''

My title
========

Use this to square a number.

.. code:: python

   def square(x):
       return x**2

and here is some javascript too.

.. code:: javascript

    foo = function() {
        console.log('foo');
    }

'''

要获得这两个代码块,我可以这样做

from docutils.core import publish_doctree

doctree = publish_doctree(s)
source_code = [child.astext() for child in doctree.children 
if 'code' in child.attributes['classes']]

现在source_code是一个列表,其中仅包含来自两个代码块的逐字源代码。如有必要,我也可以使用child的attributes属性来找出代码类型。

它可以完成工作,但是有更好的方法吗?

4

2 回答 2

5

您的解决方案只会在文档的顶层找到代码块,如果在其他元素上使用类“代码”(不太可能,但可能),它可能会返回误报。我还将检查元素/节点的类型,在其 .tagname 属性中指定。

节点上有一个“遍历”方法(文档/文档树只是一个特殊的节点),它可以完全遍历文档树。它将查看文档中的所有元素并仅返回与用户指定条件匹配的元素(返回布尔值的函数)。就是这样:

def is_code_block(node):
    return (node.tagname == 'literal_block'
            and 'code' in node.attributes['classes'])

code_blocks = doctree.traverse(condition=is_code_block)
source_code = [block.astext() for block in code_blocks]
于 2015-05-01T22:15:24.573 回答
1

这可以进一步简化为:

source_code = [block.astext() for block in doctree.traverse(nodes.literal_block)
               if 'code' in block.attributes['classes']]
于 2019-09-19T14:39:09.740 回答