mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-10-04 16:56:30 +08:00
104bc585f4
printer-linter works of definitions, profiles and meshes;
It has various diagnostic checks. With possible suggestions for fixes.
It should also be able to fix certain diagnostic issues and it can be used
to format the files according to code-style.
It can output the diagnostics in a yaml file, which can then be used to comment
on PR's with suggestions to the author. Future PR.
The settings for the diagnostics and checks are defined in `.printer-linter`
and are very self explanatory.
```
checks:
diagnostic-mesh-file-extension: true
diagnostic-mesh-file-size: true
diagnostic-definition-redundant-override: true
fixes:
diagnostic-definition-redundant-override: true
format:
format-definition-bracket-newline: false
format-definition-paired-coordinate-array: true
format-definition-sort-keys: true
format-definition-indent: 4
format-profile-space-around-delimiters: true
format-profile-sort-keys: true
diagnostic-mesh-file-size: 1200000
```
97 lines
4.0 KiB
Python
97 lines
4.0 KiB
Python
import json
|
|
from pathlib import Path
|
|
|
|
from .diagnostic import Diagnostic
|
|
|
|
|
|
class Definition:
|
|
def __init__(self, file, settings):
|
|
self._settings = settings
|
|
self._file = file
|
|
self._defs = {}
|
|
self._getDefs(file)
|
|
|
|
settings = {}
|
|
for k, v in self._defs["fdmprinter"]["settings"].items():
|
|
self._getSetting(k, v, settings)
|
|
self._defs["fdmprinter"] = {"overrides": settings}
|
|
|
|
def check(self):
|
|
if self._settings["checks"].get("diagnostic-definition-redundant-override", False):
|
|
for check in self.checkRedefineOverride():
|
|
yield check
|
|
|
|
# Add other which will yield Diagnostic's
|
|
# TODO: A check to determine if the user set value is with the min and max value defined in the parent and doesn't trigger a warning
|
|
# TODO: A check if the key exist in the first place
|
|
# TODO: Check if the model platform exist
|
|
|
|
yield
|
|
|
|
def checkRedefineOverride(self):
|
|
definition_name = list(self._defs.keys())[0]
|
|
definition = self._defs[definition_name]
|
|
if "overrides" in definition and definition_name != "fdmprinter":
|
|
keys = list(definition["overrides"].keys())
|
|
for key, value_dict in definition["overrides"].items():
|
|
is_redefined, value, parent = self._isDefinedInParent(key, value_dict, definition['inherits'])
|
|
if is_redefined:
|
|
termination_key = keys.index(key) + 1
|
|
if termination_key >= len(keys):
|
|
# FIXME: find the correct end sequence for now assume it is on the same line
|
|
termination_seq = None
|
|
else:
|
|
termination_seq = keys[termination_key]
|
|
yield Diagnostic("diagnostic-definition-redundant-override",
|
|
f"Overriding **{key}** with the same value (**{value}**) as defined in parent definition: **{definition['inherits']}**",
|
|
self._file,
|
|
key,
|
|
termination_seq)
|
|
|
|
def checkValueOutOfBounds(self):
|
|
|
|
pass
|
|
|
|
def _getSetting(self, name, setting, settings):
|
|
if "children" in setting:
|
|
for childname, child in setting["children"].items():
|
|
self._getSetting(childname, child, settings)
|
|
settings |= {name: setting}
|
|
|
|
def _getDefs(self, file):
|
|
if not file.exists():
|
|
return
|
|
self._defs[Path(file.stem).stem] = json.loads(file.read_text())
|
|
if "inherits" in self._defs[Path(file.stem).stem]:
|
|
parent_file = file.parent.joinpath(f"{self._defs[Path(file.stem).stem]['inherits']}.def.json")
|
|
self._getDefs(parent_file)
|
|
|
|
def _isDefinedInParent(self, key, value_dict, inherits_from):
|
|
if "overrides" not in self._defs[inherits_from]:
|
|
return self._isDefinedInParent(key, value_dict, self._defs[inherits_from]["inherits"])
|
|
|
|
parent = self._defs[inherits_from]["overrides"]
|
|
is_number = self._defs["fdmprinter"]["overrides"][key] in ("float", "int")
|
|
for value in value_dict.values():
|
|
if key in parent:
|
|
check_values = [cv for cv in [parent[key].get("default_value", None), parent[key].get("value", None)] if cv is not None]
|
|
for check_value in check_values:
|
|
if is_number:
|
|
try:
|
|
v = str(float(value))
|
|
except:
|
|
v = value
|
|
try:
|
|
cv = str(float(check_value))
|
|
except:
|
|
cv = check_value
|
|
else:
|
|
v = value
|
|
cv = check_value
|
|
if v == cv:
|
|
return True, value, parent
|
|
|
|
if "inherits" in parent:
|
|
return self._isDefinedInParent(key, value_dict, parent["inherits"])
|
|
return False, None, None
|