mirror of
https://github.com/triqs/dft_tools
synced 2024-12-25 13:53:40 +01:00
880f30b086
This is to avoid keeping code snippets that do not work in the doc. At least there will be an error message.
105 lines
3.0 KiB
Python
105 lines
3.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinxcontirb.autorun
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Run the code and insert stdout after the code block.
|
|
|
|
|
|
"""
|
|
import os
|
|
from subprocess import Popen,PIPE
|
|
|
|
from docutils import nodes
|
|
from sphinx.util.compat import Directive
|
|
from docutils.parsers.rst import directives
|
|
from sphinx.errors import SphinxError
|
|
from pygments import highlight
|
|
from pygments.lexers import PythonLexer
|
|
from pygments.formatters import HtmlFormatter
|
|
|
|
class RunBlockError(SphinxError):
|
|
category = 'runblock error'
|
|
|
|
class AutoRun(object):
|
|
here = os.path.abspath(__file__)
|
|
pycon = os.path.join(os.path.dirname(here),'pycon.py')
|
|
config = dict(
|
|
pycon = 'python ' + pycon,
|
|
pycon_prefix_chars = 4,
|
|
pycon_show_source = False,
|
|
console = 'bash',
|
|
console_prefix_chars = 1 ,
|
|
)
|
|
@classmethod
|
|
def builder_init(cls,app):
|
|
cls.config.update(app.builder.config.autorun_languages)
|
|
|
|
|
|
|
|
class RunBlock(Directive):
|
|
has_content = True
|
|
required_arguments = 1
|
|
optional_arguments = 0
|
|
final_argument_whitespace = False
|
|
option_spec = {
|
|
'linenos': directives.flag,
|
|
}
|
|
|
|
|
|
def run(self):
|
|
config = AutoRun.config
|
|
language = self.arguments[0]
|
|
|
|
if language not in config:
|
|
raise RunBlockError('Unknown language %s' % language)
|
|
|
|
|
|
# Get configuration values for the language
|
|
args = config[language].split()
|
|
#input_encoding = config.get(language+'_input_encoding','ascii')
|
|
input_encoding = 'ascii'
|
|
output_encoding = 'ascii'
|
|
#output_encoding = config.get(language+'_output_encoding','ascii')
|
|
prefix_chars = config.get(language+'_prefix_chars',0)
|
|
show_source = config.get(language+'_show_source',True)
|
|
|
|
|
|
# Build the code text
|
|
proc = Popen(args,bufsize=1,stdin=PIPE,stdout=PIPE,stderr=PIPE)
|
|
codelines = (line[prefix_chars:] for line in self.content)
|
|
code = u'\n'.join(codelines).encode(input_encoding)
|
|
|
|
# Run the code
|
|
stdout,stderr = proc.communicate(code)
|
|
|
|
# Process output
|
|
out =''
|
|
if stdout:
|
|
out += ''.join(stdout).decode(output_encoding)
|
|
if stderr:
|
|
out += ''.join(stderr).decode(output_encoding)
|
|
|
|
# Get the original code with prefixes
|
|
if show_source:
|
|
code = u'\n'.join(self.content)
|
|
else:
|
|
code = ''
|
|
#code_out = u'\n\n ---Output:---\n'.join((highlight(code, PythonLexer(), HtmlFormatter()),out))
|
|
code_out = u'\n\n ---Output:---\n'.join((code,out))
|
|
|
|
literal = nodes.literal_block(code_out,code_out)
|
|
#literal['language'] = language
|
|
literal['language'] = 'python'
|
|
literal['linenos'] = 'linenos' in self.options
|
|
return [literal]
|
|
|
|
|
|
|
|
def setup(app):
|
|
app.add_directive('runblock', RunBlock)
|
|
app.connect('builder-inited',AutoRun.builder_init)
|
|
app.add_config_value('autorun_languages', AutoRun.config, 'env')
|
|
|
|
# vim: set expandtab shiftwidth=4 softtabstop=4 :
|