Merge pull request #140 from MightyCreak/static-types

Convert some functions to static typing

Author: MightyCreak

.mypy.ini

@@ -1,2 +1,3 @@
 [mypy]
 warn_unused_ignores = True
+disallow_incomplete_defs = True

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Renamed application name from "Diffuse Merge Tool" to "Diffuse"
 - Linters can be run sooner (before installation)
 - Better messages when an error occurs while parsing the config file
+- Start converting the code to static types
 
 ### Fixed
 - Removed the lasting lint errors (i.e. in main.py)

src/diffuse/constants.py

@@ -18,11 +18,12 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 from gettext import gettext as _
+from typing import Final
 
-APP_NAME = 'Diffuse'
-COPYRIGHT = '''{copyright} © 2006-2019 Derrick Moser
+APP_NAME: Final[str] = 'Diffuse'
+COPYRIGHT: Final[str] = '''{copyright} © 2006-2019 Derrick Moser
 {copyright} © 2015-2021 Romain Failliot'''.format(copyright=_("Copyright"))
-WEBSITE = 'https://mightycreak.github.io/diffuse/'
+WEBSITE: Final[str] = 'https://mightycreak.github.io/diffuse/'
 
 # Constants are set in main()
-VERSION = '0.0.0'
+VERSION: str = '0.0.0'

src/diffuse/dialogs.py

@@ -32,7 +32,7 @@
 
 # the about dialog
 class AboutDialog(Gtk.AboutDialog):
-    def __init__(self):
+    def __init__(self) -> None:
         Gtk.AboutDialog.__init__(self)
         self.set_logo_icon_name('io.github.mightycreak.Diffuse')
         self.set_program_name(constants.APP_NAME)
@@ -104,13 +104,13 @@ def __init__(self, title, parent, prefs, action, accept, rev=False):
     def set_encoding(self, encoding):
         self.encoding.set_text(encoding)
 
-    def get_encoding(self):
+    def get_encoding(self) -> str:
         return self.encoding.get_text()
 
-    def get_revision(self):
+    def get_revision(self) -> str:
         return self.revision.get_text()
 
-    def get_filename(self):
+    def get_filename(self) -> str:
         # convert from UTF-8 string to unicode
         return Gtk.FileChooserDialog.get_filename(self)
 

src/diffuse/main.py

@@ -26,13 +26,15 @@
 import webbrowser
 
 from gettext import gettext as _
+from typing import Optional
 from urllib.parse import urlparse
 
 from diffuse import constants
 from diffuse import utils
 from diffuse.dialogs import AboutDialog, FileChooserDialog, NumericDialog, SearchDialog
 from diffuse.preferences import Preferences
 from diffuse.resources import theResources
+from diffuse.utils import LineEnding
 from diffuse.vcs.vcs_registry import VcsRegistry
 from diffuse.widgets import FileDiffViewerBase
 from diffuse.widgets import createMenu, LINE_MODE, CHAR_MODE, ALIGN_MODE
@@ -118,7 +120,7 @@ class Diffuse(Gtk.Window):
     class FileDiffViewer(FileDiffViewerBase):
         # pane header
         class PaneHeader(Gtk.Box):
-            def __init__(self):
+            def __init__(self) -> None:
                 Gtk.Box.__init__(self, orientation=Gtk.Orientation.HORIZONTAL, spacing=0)
                 _append_buttons(self, Gtk.IconSize.MENU, [
                     [Gtk.STOCK_OPEN, self.button_cb, 'open', _('Open File...')],
@@ -171,7 +173,7 @@ def setEdits(self, has_edits):
 
         # pane footer
         class PaneFooter(Gtk.Box):
-            def __init__(self):
+            def __init__(self) -> None:
                 Gtk.Box.__init__(self, orientation=Gtk.Orientation.HORIZONTAL, spacing=0)
                 self.cursor = label = Gtk.Label.new()
                 self.cursor.set_size_request(-1, -1)
@@ -212,11 +214,11 @@ def updateCursor(self, viewer, f):
             # set the format label
             def setFormat(self, s):
                 v = []
-                if s & utils.DOS_FORMAT:
+                if s & LineEnding.DOS_FORMAT:
                     v.append('DOS')
-                if s & utils.MAC_FORMAT:
+                if s & LineEnding.MAC_FORMAT:
                     v.append('Mac')
-                if s & utils.UNIX_FORMAT:
+                if s & LineEnding.UNIX_FORMAT:
                     v.append('Unix')
                 self.format.set_text('/'.join(v))
 
@@ -1108,7 +1110,7 @@ def remove_tab_cb(self, widget, data):
             self.quit_cb(widget, data)
 
     # convenience method to request confirmation when closing the last tab
-    def _confirm_tab_close(self):
+    def _confirm_tab_close(self) -> bool:
         dialog = utils.MessageDialog(
             self.get_toplevel(),
             Gtk.MessageType.WARNING,
@@ -1193,7 +1195,7 @@ def syntax_changed_cb(self, widget, s):
             self.setSyntax(s)
 
     # create an empty viewer with 'n' panes
-    def newFileDiffViewer(self, n):
+    def newFileDiffViewer(self, n: int) -> FileDiffViewer:
         self.viewer_count += 1
         tabname = _('File Merge %d') % (self.viewer_count, )
         tab = NotebookTab(tabname, Gtk.STOCK_FILE)
@@ -1338,13 +1340,13 @@ def createModifiedFileTabs(self, items, labels, options):
                     )
 
     # close all tabs without differences
-    def closeOnSame(self):
+    def closeOnSame(self) -> None:
         for i in range(self.notebook.get_n_pages() - 1, -1, -1):
             if not self.notebook.get_nth_page(i).hasDifferences():
                 self.notebook.remove_page(i)
 
     # returns True if the application can safely quit
-    def confirmQuit(self):
+    def confirmQuit(self) -> bool:
         nb = self.notebook
         return self.confirmCloseViewers([nb.get_nth_page(i) for i in range(nb.get_n_pages())])
 
@@ -1356,7 +1358,7 @@ def delete_cb(self, widget, event):
         return True
 
     # returns the currently focused viewer
-    def getCurrentViewer(self):
+    def getCurrentViewer(self) -> Optional[Gtk.Widget]:
         return self.notebook.get_nth_page(self.notebook.get_current_page())
 
     # callback for the open file menu item
@@ -1570,7 +1572,7 @@ def go_to_line_cb(self, widget, data):
         self.getCurrentViewer().go_to_line_cb(widget, data)
 
     # notify all viewers of changes to the preferences
-    def preferences_updated(self):
+    def preferences_updated(self) -> None:
         n = self.notebook.get_n_pages()
         self.notebook.set_show_tabs(self.prefs.getBool('tabs_always_show') or n > 1)
         for i in range(n):
@@ -1712,7 +1714,7 @@ def _append_buttons(box, size, specs):
 
 
 # constructs a full URL for the named file
-def _path2url(path, proto='file'):
+def _path2url(path: str, proto: str = 'file') -> str:
     r = [proto, ':///']
     s = os.path.abspath(path)
     i = 0

src/diffuse/preferences.py

@@ -199,7 +199,7 @@ def __init__(self, path):
         self.path = path
         if os.path.isfile(self.path):
             try:
-                with open(self.path, 'r',  encoding='utf-8') as f:
+                with open(self.path, 'r', encoding='utf-8') as f:
                     ss = utils.readconfiglines(f)
                 for j, s in enumerate(ss):
                     try:
@@ -342,7 +342,7 @@ def _buildPrefsDialog(self, parent, widgets, template):
                 if tpl[0] in ['Font', 'Integer']:
                     entry = Gtk.Box.new(Gtk.Orientation.HORIZONTAL, 0)
                     if tpl[0] == 'Font':
-                        button = _FontButton()
+                        button = Gtk.FontButton()
                         button.set_font(self.string_prefs[tpl[1]])
                     else:
                         button = Gtk.SpinButton.new(
@@ -368,28 +368,28 @@ def _buildPrefsDialog(self, parent, widgets, template):
         return table
 
     # get/set methods to manipulate the preference values
-    def getBool(self, name):
+    def getBool(self, name: str) -> bool:
         return self.bool_prefs[name]
 
-    def setBool(self, name, value):
+    def setBool(self, name: str, value: bool) -> None:
         self.bool_prefs[name] = value
 
-    def getInt(self, name):
+    def getInt(self, name: str) -> int:
         return self.int_prefs[name]
 
-    def getString(self, name):
+    def getString(self, name: str) -> str:
         return self.string_prefs[name]
 
-    def setString(self, name, value):
+    def setString(self, name: str, value: str) -> None:
         self.string_prefs[name] = value
 
     def getEncodings(self):
         return self.encodings
 
-    def _getDefaultEncodings(self):
+    def _getDefaultEncodings(self) -> list[str]:
         return self.string_prefs['encoding_auto_detect_codecs'].split()
 
-    def getDefaultEncoding(self):
+    def getDefaultEncoding(self) -> str:
         return self.string_prefs['encoding_default_codec']
 
     # attempt to convert a string to unicode from an unknown encoding
@@ -412,7 +412,7 @@ def convertToUnicode(self, s):
 
     # cygwin and native applications can be used on windows, use this method
     # to convert a path to the usual form expected on sys.platform
-    def convertToNativePath(self, s):
+    def convertToNativePath(self, s: str) -> str:
         if utils.isWindows() and s.find('/') >= 0:
             # treat as a cygwin path
             s = s.replace(os.sep, '/')
@@ -436,15 +436,6 @@ def convertToNativePath(self, s):
         return s
 
 
-# adaptor class to allow a Gtk.FontButton to be read like a Gtk.Entry
-class _FontButton(Gtk.FontButton):
-    def __init__(self):
-        Gtk.FontButton.__init__(self)
-
-    def get_text(self):
-        return self.get_font_name()
-
-
 # text entry widget with a button to help pick file names
 class _FileEntry(Gtk.Box):
     def __init__(self, parent, title):
@@ -475,8 +466,8 @@ def chooseFile(self, widget):
             self.entry.set_text(dialog.get_filename())
         dialog.destroy()
 
-    def set_text(self, s):
+    def set_text(self, s: str) -> None:
         self.entry.set_text(s)
 
-    def get_text(self):
+    def get_text(self) -> str:
         return self.entry.get_text()

src/diffuse/resources.py

@@ -31,6 +31,7 @@
 
 from distutils import util
 from gettext import gettext as _
+from typing import Final
 
 from diffuse import utils
 
@@ -529,7 +530,7 @@ def parse(self, file_name):
 
 # colour resources
 class _Colour:
-    def __init__(self, r, g, b, a=1.0):
+    def __init__(self, r: float, g: float, b: float, a: float = 1.0):
         # the individual colour components as floats in the range [0, 1]
         self.red = r
         self.green = g
@@ -601,4 +602,4 @@ def parse(self, state_name, s):
         return state_name, blocks
 
 
-theResources = Resources()
+theResources: Final[Resources] = Resources()