Запустите epydoc и / или сборки pylint из файла scons

Question

Как бы я создал строителей, которые запускают epydoc и / или pylint из собранных scons?

Answer 1

Вот еще один метод, возможно, более переносимый для крупных проектов.

Сначала определите epydoc.py в site_scons/site_tools (или где у вас есть такие), чтобы быть:

# -*- coding: utf-8 -*-
import SCons.Builder
import SCons.Action

def complain_epydoc(target, source, env):
    print 'INFORMATION: epydoc binary was not found (see above). Documentation has not been built.'

def generate(env):
    env['EPYDOC'] = find_epydoc(env)
    if env['EPYDOC'] != None:
        opts = '--quiet --html --inheritance listed --graph all --css white --parse-only '
        env['EPYDOCCOM'] = '$EPYDOC ' + opts + '-o $TARGET  $SOURCES'
        env['BUILDERS']['epydoc'] = SCons.Builder.Builder(action=env['EPYDOCCOM'])
    else:
        env['BUILDERS']['epydoc'] = SCons.Builder.Builder(action=env.Action(complain_epydoc))

def find_epydoc(env):
    b=env.WhereIs('epydoc')
    if b == None:
        print 'Searching for epydoc: not found. Documentation will not be built'
    else:
        print 'Searching for epydoc: ', b
    return b

def exists(env):
    if find_epydoc(env) == None:
        return 0
    return 1

В основном SConstruct файл, добавьте:

import epdoc
env.Tool("epydoc")

Тогда в вашем SConstruct файл или SConscript файлы, вы можете собрать документацию так:

Alias('epydoc', env.epydoc(source=python_code_files, target=Dir('docs')))

Примечание: вы можете сделать то же самое для ctags и pylint, просто назвать несколько.

Answer 2

Вы можете использовать Command() вместо того, чтобы создавать свой собственный.

Например, вы можете выполнить epydoc следующим образом:

# SCons will substitute $SOURCE and $TARGET accordingly
# add any extra cmd line args you need to the cmd string
cmd = 'epydoc $SOURCE $TARGET'
env.Command(target = yourTarget, source = yourSourceFile_s, action = cmd)

Answer 3

Вот что я в итоге использовал, основываясь на ответе Brady.

## Create epydoc!
import os.path
if os.path.isfile('/usr/bin/epydoc'):
    sources = Split("__init__.py ook/ eek/ fubar/")
    cmd = "epydoc -q --name 'Isotek Python Module collection' " + \
          "--html --inheritance listed --graph all -o docs --css white " + \
          "--parse-only --debug $SOURCES"
    env.Command(target = Dir('docs'), source = sources, action = cmd)
else:
    print "WARNING -- Cannot run epydoc so documentation will not be generated."
    print "WARNING -- To install epydoc run 'sudo yum -y install epydoc'."

Обратите внимание, что я работаю на Fedora и мне не нужно беспокоиться о коде, выполняемом где-то еще, поэтому я могу выбрать путь и способ установки epydoc. Более общее редактирование приветствуется.