utilities.py

Management utilities for Yet Another Photon Classifier (YAPC)

Source code

General Methods

yapc.utilities.build_logger(name, **kwargs)[source]

Builds a logging instance with the specified name

Parameters
name: str

name of the logger

format: str

event description message format

level: int or obj, default logging.CRITICAL

lowest-severity log message logger will handle

propagate: bool, default False

events logged will be passed to higher level handlers

stream: obj or NoneType, default None

specified stream to initialize StreamHandler

yapc.utilities.get_git_revision_hash(refname='HEAD', short=False)[source]

Get the git hash value for a particular reference

Parameters
refname: str, default HEAD

Symbolic reference name

short: bool, default False

Return the shorted hash value

yapc.utilities.get_git_status()[source]

Get the status of a git repository as a boolean value

yapc.utilities.convert_arg_line_to_args(arg_line)[source]

Convert file lines to arguments

Parameters
arg_line: str

line string containing a single argument and/or comments

yapc.utilities.copy(source, destination, move=False)[source]

Copy or move a file with all system information

Parameters
source: str

source file

destination: str

copied destination file

move: bool, default False

remove the source file