Add some doc strings

This commit is contained in:
Joey de l'Arago 2022-11-23 15:28:57 +01:00
parent 0b2e409929
commit 437b05f608

View File

@ -7,6 +7,7 @@ from .diagnostic_generator import DiagnosticGenerator
class Meshes(DiagnosticGenerator): class Meshes(DiagnosticGenerator):
def __init__(self, file: Path, settings: dict) -> None: def __init__(self, file: Path, settings: dict) -> None:
""" Finds issues in model files, such as incorrect file format or too large size """
super().__init__(file, settings) super().__init__(file, settings)
self._max_file_size = self._settings.get("diagnostic-mesh-file-size", 1e6) self._max_file_size = self._settings.get("diagnostic-mesh-file-size", 1e6)
@ -21,7 +22,8 @@ class Meshes(DiagnosticGenerator):
yield yield
def checkFileFormat(self) -> None: def checkFileFormat(self) -> Iterator[Diagnostic]:
""" Check if mesh is in supported format """
if self._file.suffix.lower() not in (".3mf", ".obj", ".stl"): if self._file.suffix.lower() not in (".3mf", ".obj", ".stl"):
yield Diagnostic( yield Diagnostic(
file = self._file, file = self._file,
@ -32,7 +34,8 @@ class Meshes(DiagnosticGenerator):
) )
yield yield
def checkFileSize(self): def checkFileSize(self) -> Iterator[Diagnostic]:
""" Check if file is within size limits for Cura """
if self._file.stat().st_size > self._max_file_size: if self._file.stat().st_size > self._max_file_size:
yield Diagnostic( yield Diagnostic(
file = self._file, file = self._file,