pv2web_ro Package: utils Module

pv2web_ro.utils

pv2web_ro.utils.copyToWebServer(local_file, web_site_path)

copy local file to web server directory (on a local file system)

This copy routine assumes that it is not necessary to use scp to copy the file.

pv2web_ro.utils.getTime()

simple wrapper for common timenow() function

pv2web_ro.utils.logException(troublemaker)

write an exception report to the log file

Parameters:troublemaker (obj) – instance of Exception

pv2web_ro.utils.logMessage(message)

log a message or report from pv2web_ro

Parameters:message (str) – words to be logged

pv2web_ro.utils.validate(xml_tree, xml_schema_file)

validate an XML document tree against an XML Schema file

Parameters:

• xml_tree (obj) – instance of etree._ElementTree
• xml_schema_file (str) – name of XML Schema file (local to package directory)

pv2web_ro.utils.writeFile(output_file, contents)

write contents to file

Parameters:

• output_file (str) – file to be written (path is optional)
• contents (str) – text to write in output_file

pv2web_ro.utils.xslt_transformation(xslt_file, src_xml_file, result_xml_file)

transform an XML file using an XSLT

Parameters:

• xslt_file (str) – name of XSLT file
• src_xml_file (str) – name of XML file
• result_xml_file (str) – name of output XML file