create_log.py

import logging as lg
import os
import sys

def create_log(rootDir, instr, utDate, doStdout=None):
    """
    Creates and returns a log file handler

    @param rootDir: top directory where processed data will be written
    @type rootDir: string
    @param instr: instrument name
    @type instr: string
    @param utDate: UT date of observation
    @type utDate: string (yyyy-mm-dd)
    """

    utDate = utDate.replace('/', '-')
    utDateDir = utDate.replace('-', '')

    # Where to create the log (rootDir/instr)

    processDir = ''.join((rootDir, '/', instr.upper()))

    # Setup logging

    log_writer = lg.getLogger("koa_dep")
    log_writer.setLevel(lg.INFO)

    # Create a file handler

    logFile = ''.join((processDir, '/dep_', instr.upper(), '_', utDateDir, '.log'))
    log_handler = lg.FileHandler(logFile)
    log_handler.setLevel(lg.INFO)

    # Create logging format

    formatter = lg.Formatter('%(asctime)s - %(name)s - %(levelname)s: %(message)s')
    log_handler.setFormatter(formatter)

    # Add handler to the logger

    log_writer.addHandler(log_handler)

    #add stdout to output so we don't need both log and print statements(>= warning only)

    if (doStdout):
        sh = lg.StreamHandler(sys.stdout)
        sh.setLevel(lg.WARNING)
        formatter = lg.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
        sh.setFormatter(formatter)
        log_writer.addHandler(sh)
    
    #init message and return

    log_writer.info('create_log.py log_writer created')
    return log_writer