commons sub-package

Submodules

git_info module

class redata.commons.git_info.GitInfo(input_path)

Bases: object

Provides git repo information

Parameters:

input_path (str) – Full path containing the .git contents

Variables:

  • input_path – Full path containing the .git contents

  • head_path – Full path of the .git HEAD

  • branch – Active branch name

  • commit – Full hash

  • short_commit – short hash commit

get_active_branch_name()

Retrieve active branch name

Return type:

str

get_latest_commit()

Retrieve latest commit hash

Return type:

Tuple[str, str]

logger module

class redata.commons.logger.LogClass(log_dir, logfile)

Bases: object

Main class to log information to stdout and ASCII logfile

Parameters:

  • log_dir (str) – Relative path for exported logfile directory

  • logfile (str) – Filename for exported log file

Variables:

  • LOG_FILENAME – Full path of log file

  • file_log_level – File log level: DEBUG

To use: log = LogClass(log_dir, logfile).get_logger()

get_logger()

Primary method to retrieve stdout and ASCII file Logging object

class redata.commons.logger.LogCommons(log, script_name, gi, code_name='', version='0.6.1')

Bases: object

Common methods used when logging

Parameters:

  • log (Logger) – Logging object

  • script_name (str) – Name of script for log messages

  • gi (GitInfo) – Object containing git info

  • code_name (str) – Name of codebase/software (e.g., ReQUIAM, LD-Cool-P)

  • version (str) – Version of codebase/software. Default: Use redata’s

Variables:

  • log – Logging object

  • script_name – Name of script for log messages

  • gi – Object containing git info

  • code_name – Name of codebase/software (e.g., ReQUIAM, LD-Cool-P)

  • version – Version of codebase/software.

  • start_text – Text for script start

  • asterisk – Parsing of start_text as asterisks

  • sys_info – System info dict

log_permission()

Change permission for file logs

script_end()

Log end of script

script_start()

Log start of script

script_sys_info()

Log system info

redata.commons.logger.get_log_file(log_handler)

Get log file

Parameters:

log_handler – Logger object

Return log_file:

Full path of log file

Return type:

str

redata.commons.logger.get_user_hostname()

Retrieve user, hostname, IP, and OS configurations

Return type:

dict

Returns:

sys_info

redata.commons.logger.log_settings(vargs, config_dict, protected_keys, log=<Logger stdout_logger (INFO)>)

Log parsed arguments settings for scripts

Parameters:

  • vargs (dict) – Parsed arguments

  • config_dict (dict) – Contains configuration settings. See commons.dict_load

  • protected_keys (list) – list of private arguments to print unset or set status

  • log (Logger) – LogClass

Return type:

int

Returns:

Number of errors with credentials

redata.commons.logger.log_setup(log_dir, logfile_prefix)

Create Logger object (log) for stdout and file logging

Parameters:

  • log_dir (str) – Directory for logs

  • logfile_prefix (str) – Log file prefix

Return type:

Logger

Returns:

Logger object

redata.commons.logger.log_stdout()

Stdout logger

Return type:

Logger

Returns:

log

redata.commons.logger.pandas_write_buffer(df, log_filename)

Write pandas content via to_markdown() to log_filename

Parameters:

  • df (DataFrame) – DataFrame to write to buffer

  • log_filename (str) – Full path for log file

Module contents