diff --git a/printer-linter/src/printerlinter/factory.py b/printer-linter/src/printerlinter/factory.py index c573507db9..24f1b504cf 100644 --- a/printer-linter/src/printerlinter/factory.py +++ b/printer-linter/src/printerlinter/factory.py @@ -7,7 +7,7 @@ from .linters.diagnostic_generator import DiagnosticGenerator from .linters.meshes import Meshes -def create(file: Path, settings) -> Optional[DiagnosticGenerator]: +def create(file: Path, settings: dict) -> Optional[DiagnosticGenerator]: """ Returns a DiagnosticGenerator depending on the file format """ if not file.exists(): return None diff --git a/printer-linter/src/printerlinter/linters/defintion.py b/printer-linter/src/printerlinter/linters/defintion.py index c5202f76eb..2f50f2542c 100644 --- a/printer-linter/src/printerlinter/linters/defintion.py +++ b/printer-linter/src/printerlinter/linters/defintion.py @@ -9,7 +9,7 @@ from ..replacement import Replacement class Definition(DiagnosticGenerator): - def __init__(self, file, settings) -> None: + def __init__(self, file: Path, settings: dict) -> None: super().__init__(file, settings) self._defs = {} self._getDefs(file) diff --git a/printer-linter/src/printerlinter/linters/diagnostic_generator.py b/printer-linter/src/printerlinter/linters/diagnostic_generator.py index 17fccd51f6..52f132a3c8 100644 --- a/printer-linter/src/printerlinter/linters/diagnostic_generator.py +++ b/printer-linter/src/printerlinter/linters/diagnostic_generator.py @@ -1,11 +1,17 @@ from abc import ABC, abstractmethod +from pathlib import Path from typing import Iterator from ..diagnostic import Diagnostic class DiagnosticGenerator(ABC): - def __init__(self, file, settings) -> None: + def __init__(self, file: Path, settings: dict) -> None: + """ Yields Diagnostics for file, these are suggested text replacements based on formatting rules in settings. + + @param file: A file to generate diagnostics for + @param settings: A list of settings containing rules for creating diagnostics + """ self._settings = settings self._file = file diff --git a/printer-linter/src/printerlinter/linters/meshes.py b/printer-linter/src/printerlinter/linters/meshes.py index 908f405072..c7ee058086 100644 --- a/printer-linter/src/printerlinter/linters/meshes.py +++ b/printer-linter/src/printerlinter/linters/meshes.py @@ -1,3 +1,4 @@ +from pathlib import Path from typing import Iterator from ..diagnostic import Diagnostic @@ -5,7 +6,7 @@ from .diagnostic_generator import DiagnosticGenerator class Meshes(DiagnosticGenerator): - def __init__(self, file, settings) -> None: + def __init__(self, file: Path, settings: dict) -> None: super().__init__(file, settings) self._max_file_size = self._settings.get("diagnostic-mesh-file-size", 1e6)