3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-07 23:17:32 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Change check_preset_settings.py to UNIX EOLs

Browse source 
CURA-3710
This commit is contained in:
Lipu Fei 2018-02-01 13:57:24 +01:00
parent 367e50669d
commit caeb6c65ea
1 changed files with 126 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

252
tools/check_preset_settings.py
View file

@ -1,126 +1,126 @@
#!/usr/bin/env python #!/usr/bin/env python
import configparser import configparser
import json import json
import os import os
import sys import sys
class PresetSettingsValidator: class PresetSettingsValidator:
def __init__(self, cura_dir: str): def __init__(self, cura_dir: str):
self._cura_dir = os.path.abspath(cura_dir) self._cura_dir = os.path.abspath(cura_dir)
self._resource_dir = os.path.join(self._cura_dir, "resources") self._resource_dir = os.path.join(self._cura_dir, "resources")
self._definitions_dir = os.path.join(self._resource_dir, "definitions") self._definitions_dir = os.path.join(self._resource_dir, "definitions")
self._preset_settings_dir = os.path.join(self._resource_dir, "preset_setting_visibility_groups") self._preset_settings_dir = os.path.join(self._resource_dir, "preset_setting_visibility_groups")
self._fdmprinter_def_path = os.path.join(self._definitions_dir, "fdmprinter.def.json") self._fdmprinter_def_path = os.path.join(self._definitions_dir, "fdmprinter.def.json")
def validate(self) -> bool: def validate(self) -> bool:
""" """
Validates the preset settings files and returns True or False indicating whether there are invalid files. Validates the preset settings files and returns True or False indicating whether there are invalid files.
""" """
if not os.path.isfile(self._fdmprinter_def_path): if not os.path.isfile(self._fdmprinter_def_path):
raise FileNotFoundError("[%s] is not a file or doesn't exist, please make sure you have specified the correct cura directory [%s]." % (self._fdmprinter_def_path, self._cura_dir)) raise FileNotFoundError("[%s] is not a file or doesn't exist, please make sure you have specified the correct cura directory [%s]." % (self._fdmprinter_def_path, self._cura_dir))
if not os.path.isdir(self._preset_settings_dir): if not os.path.isdir(self._preset_settings_dir):
raise FileNotFoundError("[%s] is not a directory or doesn't exist, please make sure you have specified the correct cura directory [%s]." % (self._preset_settings_dir, self._cura_dir)) raise FileNotFoundError("[%s] is not a directory or doesn't exist, please make sure you have specified the correct cura directory [%s]." % (self._preset_settings_dir, self._cura_dir))
# parse the definition file # parse the definition file
setting_tree_dict = self._parse_definition_file(self._fdmprinter_def_path) setting_tree_dict = self._parse_definition_file(self._fdmprinter_def_path)
has_invalid_files = False has_invalid_files = False
# go through all the preset settings files # go through all the preset settings files
for root_dir, _, filenames in os.walk(self._preset_settings_dir): for root_dir, _, filenames in os.walk(self._preset_settings_dir):
for filename in filenames: for filename in filenames:
file_path = os.path.join(root_dir, filename) file_path = os.path.join(root_dir, filename)
print("Validating [%s] ..." % file_path) print("Validating [%s] ..." % file_path)
incorrect_sections = [] incorrect_sections = []
incorrect_settings = {} incorrect_settings = {}
parser = configparser.ConfigParser(allow_no_value = True) parser = configparser.ConfigParser(allow_no_value = True)
with open(file_path, "r", encoding = "utf-8") as f: with open(file_path, "r", encoding = "utf-8") as f:
parser.read_file(f) parser.read_file(f)
for key in parser: for key in parser:
# skip general # skip general
if key in ("general", configparser.DEFAULTSECT): if key in ("general", configparser.DEFAULTSECT):
continue continue
if key not in setting_tree_dict: if key not in setting_tree_dict:
incorrect_sections.append(key) incorrect_sections.append(key)
continue continue
for setting_key in parser[key]: for setting_key in parser[key]:
if setting_key not in setting_tree_dict[key]: if setting_key not in setting_tree_dict[key]:
if setting_key not in incorrect_settings: if setting_key not in incorrect_settings:
incorrect_settings[setting_key] = {"seen_in": [], incorrect_settings[setting_key] = {"seen_in": [],
"should_be_in": self._should_setting_be_in(setting_tree_dict, setting_key)} "should_be_in": self._should_setting_be_in(setting_tree_dict, setting_key)}
incorrect_settings[setting_key]["seen_in"].append(key) incorrect_settings[setting_key]["seen_in"].append(key)
# show results # show results
print("==========================================") print("==========================================")
if incorrect_settings or incorrect_settings: if incorrect_settings or incorrect_settings:
has_invalid_files = True has_invalid_files = True
print("[INVALID] [%s] is invalid, details below" % file_path) print("[INVALID] [%s] is invalid, details below" % file_path)
# show details # show details
for section_name in sorted(incorrect_sections): for section_name in sorted(incorrect_sections):
print(" -- section name [%s] is incorrect, please check fdmprinter.def.json." % section_name) print(" -- section name [%s] is incorrect, please check fdmprinter.def.json." % section_name)
for setting_name in sorted(incorrect_settings.keys()): for setting_name in sorted(incorrect_settings.keys()):
details_dict = incorrect_settings[setting_name] details_dict = incorrect_settings[setting_name]
msg = " -- setting [%s] is found in sections [%s], " % (setting_name, ", ".join(details_dict["seen_in"])) msg = " -- setting [%s] is found in sections [%s], " % (setting_name, ", ".join(details_dict["seen_in"]))
if details_dict["should_be_in"] is not None: if details_dict["should_be_in"] is not None:
msg += "but should be in section [%s] only." % details_dict["should_be_in"] msg += "but should be in section [%s] only." % details_dict["should_be_in"]
else: else:
msg += "but it cannot be found in fdmprinter.def.json" msg += "but it cannot be found in fdmprinter.def.json"
print(msg) print(msg)
else: else:
print("[%s] is valid" % file_path) print("[%s] is valid" % file_path)
print("==========================================") print("==========================================")
return not has_invalid_files return not has_invalid_files
def _parse_definition_file(self, file_path: str): def _parse_definition_file(self, file_path: str):
with open(file_path, "r", encoding = "utf-8") as f: with open(file_path, "r", encoding = "utf-8") as f:
def_dict = json.load(f, encoding = "utf-8") def_dict = json.load(f, encoding = "utf-8")
tree_dict = {} tree_dict = {}
for key, item in def_dict.get("settings", {}).items(): for key, item in def_dict.get("settings", {}).items():
setting_list = [] setting_list = []
self._generate_tree(setting_list, item.get("children", {})) self._generate_tree(setting_list, item.get("children", {}))
tree_dict[key] = setting_list tree_dict[key] = setting_list
return tree_dict return tree_dict
def _generate_tree(self, setting_list: list, setting_dict: dict): def _generate_tree(self, setting_list: list, setting_dict: dict):
for key, item in setting_dict.items(): for key, item in setting_dict.items():
setting_list.append(key) setting_list.append(key)
if "children" in item: if "children" in item:
self._generate_tree(setting_list, item["children"]) self._generate_tree(setting_list, item["children"])
def _should_setting_be_in(self, setting_dict: dict, setting_name: str) -> str: def _should_setting_be_in(self, setting_dict: dict, setting_name: str) -> str:
""" """
Check which section the given setting belongs to. Returns None if the setting cannot be found. Check which section the given setting belongs to. Returns None if the setting cannot be found.
""" """
section_name = None section_name = None
for key, setting_list in setting_dict.items(): for key, setting_list in setting_dict.items():
if setting_name in setting_list: if setting_name in setting_list:
section_name = key section_name = key
break break
return section_name return section_name
if __name__ == "__main__": if __name__ == "__main__":
script_dir = os.path.dirname(os.path.realpath(__file__)) script_dir = os.path.dirname(os.path.realpath(__file__))
cura_dir = os.path.abspath(os.path.join(script_dir, "..")) cura_dir = os.path.abspath(os.path.join(script_dir, ".."))
validator = PresetSettingsValidator(cura_dir) validator = PresetSettingsValidator(cura_dir)
is_everything_validate = validator.validate() is_everything_validate = validator.validate()
ret_code = 0 if is_everything_validate else 1 ret_code = 0 if is_everything_validate else 1
sys.exit(ret_code) sys.exit(ret_code)