Executable.generate_executable Namespace Reference

Functions
list[str]	get_type_list (str type_name, list[str] l_type_values)
	get type list

Variables
list	add_data
bool	b_tolerate = False
list	build_warnings = []
list	command = [r"..\.venv\Scripts\python", "-m", "PyInstaller", "--clean"]
	encoding
str	GIT_VERSION_PATH = "../Source/Util"
list	L_EXCLUDE_MODULES
list	L_HIDDEN_IMPORT
	l_not_allowed_packages = check_included_packages()
	log = logging.getLogger("GenerateExecutable")
	mode
list	possible_build_warnings = [line for line in result.stderr.split("\n") if "WARNING" in line]
str	report = "\n".join(result_report)
	result = subprocess.run(command, stderr=subprocess.PIPE, text=True, shell=True, check=False)
list	result_report = []
int	ret_value = 1
str	s_spec_file = f"{__title__}.spec"
list	TOLERATED_WARNINGS
str	VERSION_FILE_NAME = "version_info.txt"
str	WARNING_FILE = "PyInstaller_warnings.txt"
str	WORKPATH = "build"

Detailed Description

---

Function Documentation

get_type_list()

list[str] get_type_list	(	str	type_name,
		list[str]	l_type_values )

get type list

Parameters

type_name	: type name
l_type_values	: type values

Returns

type list

Definition at line 56 of file generate_executable.py.

def get_type_list(type_name: str, l_type_values: list[str]) -> list[str]:
    """!
    @brief get type list
    @param type_name : type name
    @param l_type_values : type values
    @return type list
    """
    type_list = []
    for type_value in l_type_values:
        type_list.extend([f"--{type_name}", type_value])
    return type_list
 
 

Variable Documentation

add_data

list add_data

Initial value:

=  [
    "..\\Resources\\app.ico;Resources\\"
]

Definition at line 47 of file generate_executable.py.

b_tolerate

bool b_tolerate = False

Definition at line 96 of file generate_executable.py.

build_warnings

list build_warnings = []

Definition at line 94 of file generate_executable.py.

command

list command = [r"..\.venv\Scripts\python", "-m", "PyInstaller", "--clean"]

Definition at line 72 of file generate_executable.py.

encoding

encoding

Definition at line 111 of file generate_executable.py.

GIT_VERSION_PATH

str GIT_VERSION_PATH = "../Source/Util"

Definition at line 28 of file generate_executable.py.

L_EXCLUDE_MODULES

list L_EXCLUDE_MODULES

Initial value:

=  [
    "PIL",
    "charset_normalizer",
    "numpy",
    "pkg_resources",
    "typing_extensions",
    "darkdetect._mac_detect",
    # actual not used
    "moviepy",
]

Definition at line 32 of file generate_executable.py.

L_HIDDEN_IMPORT

list L_HIDDEN_IMPORT

Initial value:

=  [
]

Definition at line 52 of file generate_executable.py.

l_not_allowed_packages

l_not_allowed_packages = check_included_packages()

Definition at line 106 of file generate_executable.py.

log

log = logging.getLogger("GenerateExecutable")

Definition at line 24 of file generate_executable.py.

mode

mode

Definition at line 111 of file generate_executable.py.

possible_build_warnings

list possible_build_warnings = [line for line in result.stderr.split("\n") if "WARNING" in line]

Definition at line 93 of file generate_executable.py.

report

str report = "\n".join(result_report)

Definition at line 112 of file generate_executable.py.

result

result = subprocess.run(command, stderr=subprocess.PIPE, text=True, shell=True, check=False)

Definition at line 88 of file generate_executable.py.

result_report

list result_report = []

Definition at line 70 of file generate_executable.py.

ret_value

int ret_value = 1

Definition at line 118 of file generate_executable.py.

s_spec_file

str s_spec_file = f"{__title__}.spec"

Definition at line 120 of file generate_executable.py.

TOLERATED_WARNINGS

list TOLERATED_WARNINGS

Initial value:

=  [
    "No backend available"  # possible on CI
]

Definition at line 43 of file generate_executable.py.

VERSION_FILE_NAME

str VERSION_FILE_NAME = "version_info.txt"

Definition at line 29 of file generate_executable.py.

WARNING_FILE

WARNING_FILE = "PyInstaller_warnings.txt"

Definition at line 30 of file generate_executable.py.

WORKPATH

str WORKPATH = "build"

Definition at line 27 of file generate_executable.py.