From f49f8b3cb89245eaf96a266a5a237de57f5d0493 Mon Sep 17 00:00:00 2001 From: Joey de l'Arago Date: Wed, 23 Nov 2022 15:10:55 +0100 Subject: [PATCH] Add some documentation to factory and format file. --- printer-linter/src/printerlinter/factory.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/printer-linter/src/printerlinter/factory.py b/printer-linter/src/printerlinter/factory.py index 3e76456af9..c573507db9 100644 --- a/printer-linter/src/printerlinter/factory.py +++ b/printer-linter/src/printerlinter/factory.py @@ -1,3 +1,4 @@ +from pathlib import Path from typing import Optional from .linters.profile import Profile @@ -6,15 +7,17 @@ from .linters.diagnostic_generator import DiagnosticGenerator from .linters.meshes import Meshes -def create(file, settings) -> Optional[DiagnosticGenerator]: +def create(file: Path, settings) -> Optional[DiagnosticGenerator]: + """ Returns a DiagnosticGenerator depending on the file format """ if not file.exists(): return None - if ".inst" in file.suffixes and ".cfg" in file.suffixes: + elif ".inst" in file.suffixes and ".cfg" in file.suffixes: return Profile(file, settings) - if ".def" in file.suffixes and ".json" in file.suffixes: + elif ".def" in file.suffixes and ".json" in file.suffixes: if file.stem in ("fdmprinter.def", "fdmextruder.def"): return None return Definition(file, settings) - if file.parent.stem == "meshes": + elif file.parent.stem == "meshes": return Meshes(file, settings) - return None \ No newline at end of file + + return None