Executable.generate_version_file Namespace Reference

Functions
None	generate_version_file (str s_filename, str s_workpath)
	Generate version file.

Variables
str	filename = "version_info.txt"
	log = logging.getLogger("GenerateVersionFile")
	versionInfo
	workpath = sys.argv[1]

Detailed Description

---

Function Documentation

generate_version_file()

None generate_version_file	(	str	s_filename,
		str	s_workpath )

Generate version file.

Parameters

s_filename	: version file name
s_workpath	: workpath

Definition at line 59 of file generate_version_file.py.

def generate_version_file(s_filename: str, s_workpath: str) -> None:
    """!
    @brief Generate version file
    @param s_filename : version file name
    @param s_workpath : workpath
    """
    s_version_file = os.path.join(s_workpath, s_filename)
    log.info("Generate version file %s (Version: %s)", s_version_file, __version__)
    if not os.path.exists(s_workpath):
        os.mkdir(s_workpath)
    else:
        log.info("Directory %s already exists", s_workpath)
    with open(s_version_file, mode="w", encoding="utf-8") as version_file:
        version_file.write(str(versionInfo))
 
 

Variable Documentation

filename

str filename = "version_info.txt"

Definition at line 77 of file generate_version_file.py.

log

log = logging.getLogger("GenerateVersionFile")

Definition at line 19 of file generate_version_file.py.

versionInfo

versionInfo

Definition at line 22 of file generate_version_file.py.

workpath

workpath = sys.argv[1]

Definition at line 76 of file generate_version_file.py.