Add typing for all version upgrade plug-ins

Hopefully we'll take this typing along when we next copy-paste the stuffs.

Contributes to issue CURA-5936.

5 files changed, 62 insertions, 55 deletions

diff --git a/plugins/VersionUpgrade/VersionUpgrade21to22/MachineInstance.py b/plugins/VersionUpgrade/VersionUpgrade21to22/MachineInstance.py
index 37b6989add..a947114595 100644
--- a/plugins/VersionUpgrade/VersionUpgrade21to22/MachineInstance.py
+++ b/plugins/VersionUpgrade/VersionUpgrade21to22/MachineInstance.py
@@ -1,15 +1,16 @@
-# Copyright (c) 2016 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
-import UM.VersionUpgrade #To indicate that a file is of incorrect format.
-import UM.VersionUpgradeManager #To schedule more files to be upgraded.
-from UM.Resources import Resources #To get the config storage path.
-
 import configparser #To read config files.
 import io #To write config files to strings as if they were files.
 import os.path #To get the path to write new user profiles to.
+from typing import List, Optional, Tuple
 import urllib #To serialise the user container file name properly.
 
+import UM.VersionUpgrade #To indicate that a file is of incorrect format.
+import UM.VersionUpgradeManager #To schedule more files to be upgraded.
+from UM.Resources import Resources #To get the config storage path.
+
 ##  Creates a new machine instance instance by parsing a serialised machine
 #   instance in version 1 of the file format.
 #
@@ -18,7 +19,7 @@ import urllib #To serialise the user container file name properly.
 #   extension.
 #   \return A machine instance instance, or None if the file format is
 #   incorrect.
-def importFrom(serialised, filename):
+def importFrom(serialised: str, filename: str) -> Optional["MachineInstance"]:
     try:
         return MachineInstance(serialised, filename)
     except (configparser.Error, UM.VersionUpgrade.FormatException, UM.VersionUpgrade.InvalidVersionException):
@@ -32,7 +33,7 @@ class MachineInstance:
     #   \param serialised A string with the contents of a machine instance file,
     #   without extension.
     #   \param filename The supposed file name of this machine instance.
-    def __init__(self, serialised, filename):
+    def __init__(self, serialised: str, filename: str) -> str:
         self._filename = filename
 
         config = configparser.ConfigParser(interpolation = None)
@@ -67,7 +68,7 @@ class MachineInstance:
     #
     #   \return A tuple containing the new filename and a serialised form of
     #   this machine instance, serialised in version 2 of the file format.
-    def export(self):
+    def export(self) -> Tuple[List[str], List[str]]:
         config = configparser.ConfigParser(interpolation = None) # Build a config file in the form of version 2.
 
         config.add_section("general")
diff --git a/plugins/VersionUpgrade/VersionUpgrade21to22/Preferences.py b/plugins/VersionUpgrade/VersionUpgrade21to22/Preferences.py
index 842499da86..51e4b617e8 100644
--- a/plugins/VersionUpgrade/VersionUpgrade21to22/Preferences.py
+++ b/plugins/VersionUpgrade/VersionUpgrade21to22/Preferences.py
@@ -1,8 +1,9 @@
-# Copyright (c) 2016 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
 import configparser #To read config files.
 import io #To output config files to string.
+from typing import List, Optional, Tuple
 
 import UM.VersionUpgrade #To indicate that a file is of the wrong format.
 
@@ -14,7 +15,7 @@ import UM.VersionUpgrade #To indicate that a file is of the wrong format.
 #   extension.
 #   \return A representation of those preferences, or None if the file format is
 #   incorrect.
-def importFrom(serialised, filename):
+def importFrom(serialised: str, filename: str) -> Optional["Preferences"]:
     try:
         return Preferences(serialised, filename)
     except (configparser.Error, UM.VersionUpgrade.FormatException, UM.VersionUpgrade.InvalidVersionException):
@@ -28,7 +29,7 @@ class Preferences:
     #   \param serialised A serialised version 2 preferences file.
     #   \param filename The supposed filename of the preferences file, without
     #   extension.
-    def __init__(self, serialised, filename):
+    def __init__(self, serialised: str, filename: str) -> None:
         self._filename = filename
 
         self._config = configparser.ConfigParser(interpolation = None)
@@ -50,7 +51,7 @@ class Preferences:
     #
     #   \return A tuple containing the new filename and a serialised version of
     #   a preferences file in version 3.
-    def export(self):
+    def export(self) -> Tuple[List[str], List[str]]:
         #Reset the cura/categories_expanded property since it works differently now.
         if self._config.has_section("cura") and self._config.has_option("cura", "categories_expanded"):
             self._config.remove_option("cura", "categories_expanded")
diff --git a/plugins/VersionUpgrade/VersionUpgrade21to22/Profile.py b/plugins/VersionUpgrade/VersionUpgrade21to22/Profile.py
index 161edcb67c..af9635d384 100644
--- a/plugins/VersionUpgrade/VersionUpgrade21to22/Profile.py
+++ b/plugins/VersionUpgrade/VersionUpgrade21to22/Profile.py
@@ -1,10 +1,9 @@
-# Copyright (c) 2016 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
 import configparser #To read config files.
 import io #To write config files to strings as if they were files.
-from typing import Dict
-from typing import List
+from typing import Dict, List, Optional, Tuple
 
 import UM.VersionUpgrade
 from UM.Logger import Logger
@@ -15,7 +14,7 @@ from UM.Logger import Logger
 #   \param serialised The serialised form of a profile in version 1.
 #   \param filename The supposed filename of the profile, without extension.
 #   \return A profile instance, or None if the file format is incorrect.
-def importFrom(serialised, filename):
+def importFrom(serialised: str, filename: str) -> Optional["Profile"]:
     try:
         return Profile(serialised, filename)
     except (configparser.Error, UM.VersionUpgrade.FormatException, UM.VersionUpgrade.InvalidVersionException):
@@ -77,11 +76,11 @@ class Profile:
     #
     #   \return A tuple containing the new filename and a serialised form of
     #   this profile, serialised in version 2 of the file format.
-    def export(self):
+    def export(self) -> Optional[Tuple[List[str], List[str]]]:
         import VersionUpgrade21to22 # Import here to prevent circular dependencies.
 
         if self._name == "Current settings":
-            return None, None #Can't upgrade these, because the new current profile needs to specify the definition ID and the old file only had the machine instance, not the definition.
+            return None #Can't upgrade these, because the new current profile needs to specify the definition ID and the old file only had the machine instance, not the definition.
 
         config = configparser.ConfigParser(interpolation = None)
 
diff --git a/plugins/VersionUpgrade/VersionUpgrade21to22/VersionUpgrade21to22.py b/plugins/VersionUpgrade/VersionUpgrade21to22/VersionUpgrade21to22.py
index d8036491bf..89c847e606 100644
--- a/plugins/VersionUpgrade/VersionUpgrade21to22/VersionUpgrade21to22.py
+++ b/plugins/VersionUpgrade/VersionUpgrade21to22/VersionUpgrade21to22.py
@@ -1,7 +1,8 @@
-# Copyright (c) 2017 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
 import configparser #To get version numbers from config files.
+from typing import Dict, Iterable, List, Optional, Set, Tuple
 
 from UM.VersionUpgrade import VersionUpgrade # Superclass of the plugin.
 
@@ -30,7 +31,7 @@ _machines_with_machine_quality = {
         "materials": { "generic_abs", "generic_cpe", "generic_pla", "generic_pva", "generic_cpe_plus", "generic_nylon", "generic_pc", "generic_tpu" },
         "variants": { "0.25 mm", "0.4 mm", "0.6 mm", "0.8 mm" }
     }
-}
+} # type: Dict[str, Dict[str, Set[str]]]
 
 ##  How to translate material names from the old version to the new.
 _material_translations = {
@@ -41,7 +42,7 @@ _material_translations = {
     "Nylon": "generic_nylon",
     "PC": "generic_pc",
     "TPU": "generic_tpu",
-}
+} # type: Dict[str, str]
 
 ##  How to translate material names for in the profile names.
 _material_translations_profiles = {
@@ -52,17 +53,17 @@ _material_translations_profiles = {
     "Nylon": "nylon",
     "PC": "pc",
     "TPU": "tpu",
-}
+} # type: Dict[str, str]
 
 ##  How to translate printer names from the old version to the new.
 _printer_translations = {
     "ultimaker2plus": "ultimaker2_plus"
-}
+} # type: Dict[str, str]
 
 _printer_translations_profiles = {
     "ultimaker2plus": "um2p", #Does NOT get included in PLA profiles!
     "ultimaker2_extended_plus": "um2ep" #Has no profiles for CPE+, Nylon, PC and TPU!
-}
+} # type: Dict[str, str]
 
 ##  How to translate profile names from the old version to the new.
 #
@@ -116,13 +117,13 @@ _profile_translations = {
     "tpu_0.25_high": "um2p_tpu_0.25_high",
     "tpu_0.4_normal": "um2p_tpu_0.4_normal",
     "tpu_0.6_fast": "um2p_tpu_0.6_fast"
-}
+} # type: Dict[str, str]
 
 ##  Settings that are no longer in the new version.
 _removed_settings = {
     "fill_perimeter_gaps",
     "support_area_smoothing"
-}
+} # type: Set[str]
 
 ##  How to translate setting names from the old version to the new.
 _setting_name_translations = {
@@ -142,7 +143,7 @@ _setting_name_translations = {
     "support_roof_line_distance": "support_interface_line_distance",
     "support_roof_line_width": "support_interface_line_width",
     "support_roof_pattern": "support_interface_pattern"
-}
+} # type: Dict[str, str]
 
 ##  Custom profiles become quality_changes. This dictates which quality to base
 #   the quality_changes profile on.
@@ -190,7 +191,7 @@ _quality_fallbacks = {
             #No TPU.
         }
     }
-}
+} # type: Dict[str, Dict[str, Dict[str, str]]]
 
 ##  How to translate variants of specific machines from the old version to the
 #   new.
@@ -207,7 +208,7 @@ _variant_translations = {
         "0.6 mm": "ultimaker2_extended_plus_0.6",
         "0.8 mm": "ultimaker2_extended_plus_0.8"
     }
-}
+} # type: Dict[str, Dict[str, str]]
 
 ##  How to translate variant names for in the profile names.
 _variant_translations_profiles = {
@@ -215,7 +216,7 @@ _variant_translations_profiles = {
     "0.4 mm": "0.4",
     "0.6 mm": "0.6",
     "0.8 mm": "0.8"
-}
+} # type: Dict[str, str]
 
 ##  Cura 2.2's material profiles use a different naming scheme for variants.
 #
@@ -233,7 +234,7 @@ _variant_translations_materials = {
         "0.6 mm": "ultimaker2_plus_0.6_mm",
         "0.8 mm": "ultimaker2_plus_0.8_mm"
     }
-}
+} # type: Dict[str, Dict[str, str]]
 
 ##  Converts configuration from Cura 2.1's file formats to Cura 2.2's.
 #
@@ -245,8 +246,8 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   number is stored in general/version, so get the data from that key.
     #
     #   \param serialised The contents of a config file.
-    #   \return \type{int} The version number of that config file.
-    def getCfgVersion(self, serialised):
+    #   \return The version number of that config file.
+    def getCfgVersion(self, serialised: str) -> int:
         parser = configparser.ConfigParser(interpolation = None)
         parser.read_string(serialised)
         format_version = int(parser.get("general", "version")) #Explicitly give an exception when this fails. That means that the file format is not recognised.
@@ -263,7 +264,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param variant The variant ID of the user's configuration in 2.2.
     #   \param material The material ID of the user's configuration in 2.2.
     @staticmethod
-    def getQualityFallback(machine, variant, material):
+    def getQualityFallback(machine: str, variant: str, material: str) -> str:
         if machine not in _quality_fallbacks:
             return "normal"
         if variant not in _quality_fallbacks[machine]:
@@ -277,14 +278,14 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   This is required to test if profiles should be converted to a quality
     #   profile or a quality-changes profile.
     @staticmethod
-    def builtInProfiles():
+    def builtInProfiles() -> Iterable[str]:
         return _profile_translations.keys()
 
     ##  Gets a set of the machines which now have per-material quality profiles.
     #
     #   \return A set of machine identifiers.
     @staticmethod
-    def machinesWithMachineQuality():
+    def machinesWithMachineQuality() -> Dict[str, Dict[str, Set[str]]]:
         return _machines_with_machine_quality
 
     ##  Converts machine instances from format version 1 to version 2.
@@ -295,10 +296,10 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \return A tuple containing the new filename and the serialised machine
     #   instance in version 2, or None if the input was not of the correct
     #   format.
-    def upgradeMachineInstance(self, serialised, filename):
+    def upgradeMachineInstance(self, serialised: str, filename: str) -> Optional[Tuple[List[str], List[str]]]:
         machine_instance = MachineInstance.importFrom(serialised, filename)
         if not machine_instance: #Invalid file format.
-            return filename, None
+            return None
         return machine_instance.export()
 
     ##  Converts preferences from format version 2 to version 3.
@@ -309,10 +310,10 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \return A tuple containing the new filename and the serialised
     #   preferences in version 3, or None if the input was not of the correct
     #   format.
-    def upgradePreferences(self, serialised, filename):
+    def upgradePreferences(self, serialised: str, filename: str) -> Optional[Tuple[List[str], List[str]]]:
         preferences = Preferences.importFrom(serialised, filename)
         if not preferences: #Invalid file format.
-            return filename, None
+            return None
         return preferences.export()
 
     ##  Converts profiles from format version 1 to version 2.
@@ -322,10 +323,10 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   extension.
     #   \return A tuple containing the new filename and the serialised profile
     #   in version 2, or None if the input was not of the correct format.
-    def upgradeProfile(self, serialised, filename):
+    def upgradeProfile(self, serialised: str, filename: str) -> Optional[Tuple[List[str], List[str]]]:
         profile = Profile.importFrom(serialised, filename)
         if not profile: # Invalid file format.
-            return filename, None
+            return None
         return profile.export()
 
     ##  Translates a material name for the change from Cura 2.1 to 2.2.
@@ -333,7 +334,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param material A material name in Cura 2.1.
     #   \return The name of the corresponding material in Cura 2.2.
     @staticmethod
-    def translateMaterial(material):
+    def translateMaterial(material: str) -> str:
         if material in _material_translations:
             return _material_translations[material]
         return material
@@ -345,7 +346,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \return The name of the corresponding material in the quality profiles
     #   in Cura 2.2.
     @staticmethod
-    def translateMaterialForProfiles(material):
+    def translateMaterialForProfiles(material: str) -> str:
         if material in _material_translations_profiles:
             return _material_translations_profiles[material]
         return material
@@ -356,7 +357,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param printer A printer name in Cura 2.1.
     #   \return The name of the corresponding printer in Cura 2.2.
     @staticmethod
-    def translatePrinter(printer):
+    def translatePrinter(printer: str) -> str:
         if printer in _printer_translations:
             return _printer_translations[printer]
         return printer #Doesn't need to be translated.
@@ -367,7 +368,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param printer A printer name in 2.1.
     #   \return The name of the corresponding printer in Cura 2.2.
     @staticmethod
-    def translatePrinterForProfile(printer):
+    def translatePrinterForProfile(printer: str) -> str:
         if printer in _printer_translations_profiles:
             return _printer_translations_profiles[printer]
         return printer
@@ -378,7 +379,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param profile A profile name in the old version.
     #   \return The corresponding profile name in the new version.
     @staticmethod
-    def translateProfile(profile):
+    def translateProfile(profile: str) -> str:
         if profile in _profile_translations:
             return _profile_translations[profile]
         return profile #Doesn't need to be translated.
@@ -392,7 +393,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param settings A dictionary of settings (as key-value pairs) to update.
     #   \return The same dictionary.
     @staticmethod
-    def translateSettings(settings):
+    def translateSettings(settings: Dict[str, str]) -> Dict[str, str]:
         new_settings = {}
         for key, value in settings.items():
             if key in _removed_settings:
@@ -414,7 +415,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \param setting The name of a setting in Cura 2.1.
     #   \return The name of the corresponding setting in Cura 2.2.
     @staticmethod
-    def translateSettingName(setting):
+    def translateSettingName(setting: str) -> str:
         if setting in _setting_name_translations:
             return _setting_name_translations[setting]
         return setting #Doesn't need to be translated.
@@ -426,7 +427,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   2.2's naming.
     #   \return The name of the corresponding variant in Cura 2.2.
     @staticmethod
-    def translateVariant(variant, machine):
+    def translateVariant(variant: str, machine: str) -> str:
         if machine in _variant_translations and variant in _variant_translations[machine]:
             return _variant_translations[machine][variant]
         return variant
@@ -440,7 +441,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \return The name of the corresponding variant for in material profiles
     #   in Cura 2.2.
     @staticmethod
-    def translateVariantForMaterials(variant, machine):
+    def translateVariantForMaterials(variant: str, machine: str) -> str:
         if machine in _variant_translations_materials and variant in _variant_translations_materials[machine]:
             return _variant_translations_materials[machine][variant]
         return variant
@@ -452,7 +453,7 @@ class VersionUpgrade21to22(VersionUpgrade):
     #   \return The name of the corresponding variant for in quality profiles in
     #   Cura 2.2.
     @staticmethod
-    def translateVariantForProfiles(variant):
+    def translateVariantForProfiles(variant: str) -> str:
         if variant in _variant_translations_profiles:
             return _variant_translations_profiles[variant]
         return variant
\ No newline at end of file
diff --git a/plugins/VersionUpgrade/VersionUpgrade21to22/__init__.py b/plugins/VersionUpgrade/VersionUpgrade21to22/__init__.py
index 609781ebfe..67530b9d45 100644
--- a/plugins/VersionUpgrade/VersionUpgrade21to22/__init__.py
+++ b/plugins/VersionUpgrade/VersionUpgrade21to22/__init__.py
@@ -1,11 +1,16 @@
-# Copyright (c) 2016 Ultimaker B.V.
+# Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
 
+from typing import Any, Dict, TYPE_CHECKING
+
 from . import VersionUpgrade21to22
 
+if TYPE_CHECKING:
+    from UM.Application import Application
+
 upgrade = VersionUpgrade21to22.VersionUpgrade21to22()
 
-def getMetaData():
+def getMetaData() -> Dict[str, Any]:
     return {
         "version_upgrade": {
             # From                         To                         Upgrade function
@@ -33,5 +38,5 @@ def getMetaData():
         }
     }
 
-def register(app):
+def register(app: "Application") -> Dict[str, Any]:
     return { "version_upgrade": upgrade }