LDP
/
python-tldp
mirror of https://github.com/tLDP/python-tldp
0
1
Fork 0
Code Releases Activity

simplify function docbuild: logging by caller 

make the core docbuild function even simpler; have it determine the result
and return it, as well as the individual build success/failure vector
move all logging logic into the caller function, so that script(), publish()
and build() can log whatever they like
This commit is contained in:
Martin A. Brown 2016-03-09 10:00:25 -08:00
parent c66b325530
commit 68b16b42d8
1 changed files with 36 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
tldp/driver.py
View File

@ -197,7 +197,7 @@ def post_publish_cleanup(docs):
for d in dtworkingdirs: for d in dtworkingdirs:
if os.path.isdir(d): if os.path.isdir(d):
try: try:
logger.info("removing docbuild dir %s", d) logger.info("removing doctype build dir %s", d)
os.rmdir(d) os.rmdir(d)
except OSError as e: except OSError as e:
if e.errno != errno.ENOTEMPTY: if e.errno != errno.ENOTEMPTY:
@ -227,6 +227,7 @@ def prepare_docs_build_mode(config, docs):
def docbuild(config, docs, **kwargs): def docbuild(config, docs, **kwargs):
buildsuccess = False
result = list() result = list()
for x, source in enumerate(docs, 1): for x, source in enumerate(docs, 1):
working = source.working working = source.working
@ -235,11 +236,8 @@ def docbuild(config, docs, **kwargs):
source.stem, x, len(docs)) source.stem, x, len(docs))
result.append(runner.generate()) result.append(runner.generate())
if all(result): if all(result):
return os.EX_OK buildsuccess = True
for errcode, source in zip(result, docs): return buildsuccess, zip(result, docs)
if not errcode:
logger.error("%s build failed", source.stem)
return "Build failed, see errors logged."
def script(config, docs, **kwargs): def script(config, docs, **kwargs):
@ -248,9 +246,15 @@ def script(config, docs, **kwargs):
return error return error
file = kwargs.get('file', sys.stdout) file = kwargs.get('file', sys.stdout)
print(preamble, file=file) print(preamble, file=file)
result = docbuild(config, docs, **kwargs) buildsuccess, results = docbuild(config, docs, **kwargs)
print(postamble, file=file) print(postamble, file=file)
return result for errcode, source in results:
if not errcode:
logger.error("Could not generate script for %s", source.stem)
if buildsuccess:
return os.EX_OK
else:
return "Script generation failed."
def build(config, docs, **kwargs): def build(config, docs, **kwargs):
@ -262,25 +266,35 @@ def build(config, docs, **kwargs):
ready, error = prepare_docs_build_mode(config, docs) ready, error = prepare_docs_build_mode(config, docs)
if not ready: if not ready:
return error return error
return docbuild(config, docs, **kwargs) buildsuccess, results = docbuild(config, docs, **kwargs)
for x, (buildcode, source) in enumerate(results, 1):
if buildcode:
logger.info("success (%d of %d) available in %s",
x, len(results), source.working.dirname)
else:
logger.info("FAILURE (%d of %d) available in %s",
x, len(results), source.working.dirname)
if buildsuccess:
return os.EX_OK
else:
return "Build failed, see logging output in %s." % (config.builddir,)
def publish(config, docs, **kwargs): def publish(config, docs, **kwargs):
config.build = True config.build = True
result = build(config, docs, **kwargs) result = build(config, docs, **kwargs)
if result != os.EX_OK: if result == os.EX_OK:
return "Aborting all publication: " + result for x, source in enumerate(docs, 1):
for x, source in enumerate(docs, 1): logger.info("%s (%d of %d) publishing outputs",
logger.info("%s (%d of %d) publishing outputs", source.stem, x, len(docs))
source.stem, x, len(docs)) # -- swapdirs must raise an error if there are problems
# -- swapdirs must raise an error if there are problems #
# swapdirs(source.working.dirname, source.output.dirname)
swapdirs(source.working.dirname, source.output.dirname) if os.path.isdir(source.working.dirname):
if os.path.isdir(source.working.dirname): logger.info("%s removing old directory %s",
logger.info("%s removing old directory %s", source.stem, source.working.dirname)
source.stem, source.working.dirname) shutil.rmtree(source.working.dirname)
shutil.rmtree(source.working.dirname) post_publish_cleanup(docs)
post_publish_cleanup(docs)
return os.EX_OK return os.EX_OK