🔨 Simplify scripts with pathlib (#24574)

Marlin/src/HAL/LPC1768/upload_extra_script.py

@@ -12,7 +12,7 @@
 	target_filename = "FIRMWARE.CUR"
 	target_drive = "REARM"
 
-	import os,getpass,platform
+	import platform
 
 	current_OS = platform.system()
 	Import("env")
@@ -26,7 +26,8 @@ def print_error(e):
 
 	def before_upload(source, target, env):
 		try:
-			#
+			from pathlib import Path
+  			#
 			# Find a disk for upload
 			#
 			upload_disk = 'Disk not found'
@@ -38,6 +39,7 @@ def before_upload(source, target, env):
 				#   Windows - doesn't care about the disk's name, only cares about the drive letter
 				import subprocess,string
 				from ctypes import windll
+				from pathlib import PureWindowsPath
 
 				# getting list of drives
 				# https://stackoverflow.com/questions/827371/is-there-a-way-to-list-all-the-available-drive-letters-in-python
@@ -49,7 +51,7 @@ def before_upload(source, target, env):
 					bitmask >>= 1
 
 				for drive in drives:
-					final_drive_name = drive + ':\\'
+					final_drive_name = drive + ':'
 					# print ('disc check: {}'.format(final_drive_name))
 					try:
 						volume_info = str(subprocess.check_output('cmd /C dir ' + final_drive_name, stderr=subprocess.STDOUT))
@@ -59,29 +61,33 @@ def before_upload(source, target, env):
 					else:
 						if target_drive in volume_info and not target_file_found:  # set upload if not found target file yet
 							target_drive_found = True
-							upload_disk = final_drive_name
+							upload_disk = PureWindowsPath(final_drive_name)
 						if target_filename in volume_info:
 							if not target_file_found:
-								upload_disk = final_drive_name
+								upload_disk = PureWindowsPath(final_drive_name)
 							target_file_found = True
 
 			elif current_OS == 'Linux':
 				#
 				# platformio.ini will accept this for a Linux upload port designation: 'upload_port = /media/media_name/drive'
 				#
-				drives = os.listdir(os.path.join(os.sep, 'media', getpass.getuser()))
+				import getpass
+				user = getpass.getuser()
+				mpath = Path('media', user)
+				drives = [ x for x in mpath.iterdir() if x.is_dir() ]
 				if target_drive in drives:  # If target drive is found, use it.
 					target_drive_found = True
-					upload_disk = os.path.join(os.sep, 'media', getpass.getuser(), target_drive) + os.sep
+					upload_disk = mpath / target_drive
 				else:
 					for drive in drives:
 						try:
-							files = os.listdir(os.path.join(os.sep, 'media', getpass.getuser(), drive))
+							fpath = mpath / drive
+							files = [ x for x in fpath.iterdir() if x.is_file() ]
 						except:
 							continue
 						else:
 							if target_filename in files:
-								upload_disk = os.path.join(os.sep, 'media', getpass.getuser(), drive) + os.sep
+								upload_disk = mpath / drive
 								target_file_found = True
 								break
 				#
@@ -97,26 +103,28 @@ def before_upload(source, target, env):
 				#
 				# platformio.ini will accept this for a OSX upload port designation: 'upload_port = /media/media_name/drive'
 				#
-				drives = os.listdir('/Volumes')  # human readable names
+				dpath = Path('/Volumes')  # human readable names
+				drives = [ x for x in dpath.iterdir() ]
 				if target_drive in drives and not target_file_found:  # set upload if not found target file yet
 					target_drive_found = True
-					upload_disk = '/Volumes/' + target_drive + '/'
+					upload_disk = dpath / target_drive
 				for drive in drives:
 					try:
-						filenames = os.listdir('/Volumes/' + drive + '/')   # will get an error if the drive is protected
+						fpath = dpath / drive   # will get an error if the drive is protected
+						files = [ x for x in fpath.iterdir() ]
 					except:
 						continue
 					else:
-						if target_filename in filenames:
+						if target_filename in files:
 							if not target_file_found:
-								upload_disk = '/Volumes/' + drive + '/'
+								upload_disk = dpath / drive
 							target_file_found = True
 
 			#
 			# Set upload_port to drive if found
 			#
 			if target_file_found or target_drive_found:
-				env.Replace(UPLOAD_PORT=upload_disk)
+				env.Replace(UPLOAD_PORT=str(upload_disk))
 				print('\nUpload disk: ', upload_disk, '\n')
 			else:
 				print_error('Autodetect Error')

buildroot/share/PlatformIO/scripts/STM32F1_create_variant.py

@@ -3,30 +3,29 @@
 #
 import pioutil
 if pioutil.is_pio_build():
-	import os,shutil,marlin
-	from SCons.Script import DefaultEnvironment
-	from platformio import util
+	import shutil,marlin
+	from pathlib import Path
 
-	env = DefaultEnvironment()
+	Import("env")
 	platform = env.PioPlatform()
 	board = env.BoardConfig()
 
-	FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoststm32-maple")
-	assert os.path.isdir(FRAMEWORK_DIR)
+	FRAMEWORK_DIR = Path(platform.get_package_dir("framework-arduinoststm32-maple"))
+	assert FRAMEWORK_DIR.is_dir()
 
-	source_root = os.path.join("buildroot", "share", "PlatformIO", "variants")
-	assert os.path.isdir(source_root)
+	source_root = Path("buildroot/share/PlatformIO/variants")
+	assert source_root.is_dir()
 
 	variant = board.get("build.variant")
-	variant_dir = os.path.join(FRAMEWORK_DIR, "STM32F1", "variants", variant)
+	variant_dir = FRAMEWORK_DIR / "STM32F1/variants" / variant
 
-	source_dir = os.path.join(source_root, variant)
-	assert os.path.isdir(source_dir)
+	source_dir = source_root / variant
+	assert source_dir.is_dir()
 
-	if os.path.isdir(variant_dir):
+	if variant_dir.is_dir():
 		shutil.rmtree(variant_dir)
 
-	if not os.path.isdir(variant_dir):
-		os.mkdir(variant_dir)
+	if not variant_dir.is_dir():
+		variant_dir.mkdir()
 
 	marlin.copytree(source_dir, variant_dir)

buildroot/share/PlatformIO/scripts/chitu_crypt.py

@@ -4,9 +4,7 @@
 #
 import pioutil
 if pioutil.is_pio_build():
-	import os,random,struct,uuid,marlin
-	# Relocate firmware from 0x08000000 to 0x08008800
-	marlin.relocate_firmware("0x08008800")
+	import struct,uuid
 
 	def calculate_crc(contents, seed):
 		accumulating_xor_value = seed;
@@ -105,13 +103,13 @@ def encrypt_file(input, output_file, file_length):
 
 	# Encrypt ${PROGNAME}.bin and save it as 'update.cbd'
 	def encrypt(source, target, env):
-		firmware = open(target[0].path, "rb")
-		update = open(target[0].dir.path + '/update.cbd', "wb")
-		length = os.path.getsize(target[0].path)
-
-		encrypt_file(firmware, update, length)
-
-		firmware.close()
-		update.close()
-
+		from pathlib import Path
+		fwpath = Path(target[0].path)
+		fwsize = fwpath.stat().st_size
+		fwfile = fwpath.open("rb")
+		upfile = Path(target[0].dir.path, 'update.cbd').open("wb")
+		encrypt_file(fwfile, upfile, fwsize)
+
+	import marlin
+	marlin.relocate_firmware("0x08008800")
 	marlin.add_post_action(encrypt);

buildroot/share/PlatformIO/scripts/download_mks_assets.py

@@ -5,45 +5,49 @@
 import pioutil
 if pioutil.is_pio_build():
 	Import("env")
-	import os,requests,zipfile,tempfile,shutil
+	import requests,zipfile,tempfile,shutil
+	from pathlib import Path
 
 	url = "https://github.com/makerbase-mks/Mks-Robin-Nano-Marlin2.0-Firmware/archive/0263cdaccf.zip"
-	deps_path = env.Dictionary("PROJECT_LIBDEPS_DIR")
-	zip_path = os.path.join(deps_path, "mks-assets.zip")
-	assets_path = os.path.join(env.Dictionary("PROJECT_BUILD_DIR"), env.Dictionary("PIOENV"), "assets")
+	deps_path = Path(env.Dictionary("PROJECT_LIBDEPS_DIR"))
+	zip_path = deps_path / "mks-assets.zip"
+	assets_path = Path(env.Dictionary("PROJECT_BUILD_DIR"), env.Dictionary("PIOENV"), "assets")
 
 	def download_mks_assets():
 		print("Downloading MKS Assets")
 		r = requests.get(url, stream=True)
 		# the user may have a very clean workspace,
 		# so create the PROJECT_LIBDEPS_DIR directory if not exits
-		if os.path.exists(deps_path) == False:
-			os.mkdir(deps_path)
-		with open(zip_path, 'wb') as fd:
+		if not deps_path.exists():
+			deps_path.mkdir()
+		with zip_path.open('wb') as fd:
 			for chunk in r.iter_content(chunk_size=128):
 				fd.write(chunk)
 
 	def copy_mks_assets():
 		print("Copying MKS Assets")
-		output_path = tempfile.mkdtemp()
+		output_path = Path(tempfile.mkdtemp())
 		zip_obj = zipfile.ZipFile(zip_path, 'r')
 		zip_obj.extractall(output_path)
 		zip_obj.close()
-		if os.path.exists(assets_path) == True and os.path.isdir(assets_path) == False:
-			os.unlink(assets_path)
-		if os.path.exists(assets_path) == False:
-			os.mkdir(assets_path)
+		if assets_path.exists() and not assets_path.is_dir():
+			assets_path.unlink()
+		if not assets_path.exists():
+			assets_path.mkdir()
 		base_path = ''
-		for filename in os.listdir(output_path):
+		for filename in output_path.iterdir():
 			base_path = filename
-		for filename in os.listdir(os.path.join(output_path, base_path, 'Firmware', 'mks_font')):
-			shutil.copy(os.path.join(output_path, base_path, 'Firmware', 'mks_font', filename), assets_path)
-		for filename in os.listdir(os.path.join(output_path, base_path, 'Firmware', 'mks_pic')):
-			shutil.copy(os.path.join(output_path, base_path, 'Firmware', 'mks_pic', filename), assets_path)
+		fw_path = (output_path / base_path / 'Firmware')
+		font_path = fw_path / 'mks_font'
+		for filename in font_path.iterdir():
+			shutil.copy(font_path / filename, assets_path)
+		pic_path = fw_path / 'mks_pic'
+		for filename in pic_path.iterdir():
+			shutil.copy(pic_path / filename, assets_path)
 		shutil.rmtree(output_path, ignore_errors=True)
 
-	if os.path.exists(zip_path) == False:
+	if not zip_path.exists():
 		download_mks_assets()
 
-	if os.path.exists(assets_path) == False:
+	if not assets_path.exists():
 		copy_mks_assets()

buildroot/share/PlatformIO/scripts/generic_create_variant.py

@@ -7,16 +7,14 @@
 #
 import pioutil
 if pioutil.is_pio_build():
-	import os,shutil,marlin
-	from SCons.Script import DefaultEnvironment
-	from platformio import util
-
-	env = DefaultEnvironment()
+	import shutil,marlin
+	from pathlib import Path
 
 	#
 	# Get the platform name from the 'platform_packages' option,
 	# or look it up by the platform.class.name.
 	#
+	env = marlin.env
 	platform = env.PioPlatform()
 
 	from platformio.package.meta import PackageSpec
@@ -37,8 +35,8 @@
 	if platform_name in [ "usb-host-msc", "usb-host-msc-cdc-msc", "usb-host-msc-cdc-msc-2", "usb-host-msc-cdc-msc-3", "tool-stm32duino", "biqu-bx-workaround", "main" ]:
 		platform_name = "framework-arduinoststm32"
 
-	FRAMEWORK_DIR = platform.get_package_dir(platform_name)
-	assert os.path.isdir(FRAMEWORK_DIR)
+	FRAMEWORK_DIR = Path(platform.get_package_dir(platform_name))
+	assert FRAMEWORK_DIR.is_dir()
 
 	board = env.BoardConfig()
 
@@ -47,14 +45,14 @@
 	#series = mcu_type[:7].upper() + "xx"
 
 	# Prepare a new empty folder at the destination
-	variant_dir = os.path.join(FRAMEWORK_DIR, "variants", variant)
-	if os.path.isdir(variant_dir):
+	variant_dir = FRAMEWORK_DIR / "variants" / variant
+	if variant_dir.is_dir():
 		shutil.rmtree(variant_dir)
-	if not os.path.isdir(variant_dir):
-		os.mkdir(variant_dir)
+	if not variant_dir.is_dir():
+		variant_dir.mkdir()
 
 	# Source dir is a local variant sub-folder
-	source_dir = os.path.join("buildroot/share/PlatformIO/variants", variant)
-	assert os.path.isdir(source_dir)
+	source_dir = Path("buildroot/share/PlatformIO/variants", variant)
+	assert source_dir.is_dir()
 
 	marlin.copytree(source_dir, variant_dir)

buildroot/share/PlatformIO/scripts/jgaurora_a5s_a1_with_bootloader.py

@@ -4,37 +4,32 @@
 #
 import pioutil
 if pioutil.is_pio_build():
-	import os,marlin
+
 	# Append ${PROGNAME}.bin firmware after bootloader and save it as 'jgaurora_firmware.bin'
 	def addboot(source, target, env):
-		firmware = open(target[0].path, "rb")
-		lengthfirmware = os.path.getsize(target[0].path)
-		bootloader_bin = "buildroot/share/PlatformIO/scripts/" + "jgaurora_bootloader.bin"
-		bootloader = open(bootloader_bin, "rb")
-		lengthbootloader = os.path.getsize(bootloader_bin)
+		from pathlib import Path
+
+		fw_path = Path(target[0].path)
+		fwb_path = fw_path.parent / 'firmware_with_bootloader.bin'
+		with fwb_path.open("wb") as fwb_file:
+			bl_path = Path("buildroot/share/PlatformIO/scripts/jgaurora_bootloader.bin")
+			bl_file = bl_path.open("rb")
+			while True:
+				b = bl_file.read(1)
+				if b == b'': break
+				else: fwb_file.write(b)
+
+			with fw_path.open("rb") as fw_file:
+				while True:
+					b = fw_file.read(1)
+					if b == b'': break
+					else: fwb_file.write(b)
 
-		firmware_with_boothloader_bin = target[0].dir.path + '/firmware_with_bootloader.bin'
-		if os.path.exists(firmware_with_boothloader_bin):
-			os.remove(firmware_with_boothloader_bin)
-		firmwareimage = open(firmware_with_boothloader_bin, "wb")
-		position = 0
-		while position < lengthbootloader:
-			byte = bootloader.read(1)
-			firmwareimage.write(byte)
-			position += 1
-		position = 0
-		while position < lengthfirmware:
-			byte = firmware.read(1)
-			firmwareimage.write(byte)
-			position += 1
-		bootloader.close()
-		firmware.close()
-		firmwareimage.close()
+		fws_path = Path(target[0].dir.path, 'firmware_for_sd_upload.bin')
+		if fws_path.exists():
+			fws_path.unlink()
 
-		firmware_without_bootloader_bin = target[0].dir.path + '/firmware_for_sd_upload.bin'
-		if os.path.exists(firmware_without_bootloader_bin):
-			os.remove(firmware_without_bootloader_bin)
-		os.rename(target[0].path, firmware_without_bootloader_bin)
-		#os.rename(target[0].dir.path+'/firmware_with_bootloader.bin', target[0].dir.path+'/firmware.bin')
+		fw_path.rename(fws_path)
 
+	import marlin
 	marlin.add_post_action(addboot);

buildroot/share/PlatformIO/scripts/lerdge.py

@@ -8,10 +8,8 @@
 import pioutil
 if pioutil.is_pio_build():
 	import os,marlin
-	Import("env")
 
-	from SCons.Script import DefaultEnvironment
-	board = DefaultEnvironment().BoardConfig()
+	board = marlin.env.BoardConfig()
 
 	def encryptByte(byte):
 		byte = 0xFF & ((byte << 6) | (byte >> 2))