Bugfixes, progressbar.

Author: mfitzp

README.md

@@ -1,6 +1,9 @@
-# DiffCast
+<p style="text-align:center">
+  <img src="diffcast/images/icon.png" />
+</p>
 
-Auto-generate coding demos & screencasts from Python files.
+
+**Auto-generate coding demos & screencasts from Python files.**
 
 Provided with a series of Python files, DiffCast automatically generates coding
 demos/screencasts using human-like edits. Designed for creating reproducible
@@ -10,6 +13,7 @@ tutoring examples, library demos or demonstrating code to a class.
 
 ## What?
 
+If you make programming screencasts
 
 
 
@@ -29,10 +33,10 @@ tutoring examples, library demos or demonstrating code to a class.
 
 Below are some examples of screencasts created using DiffCast. These are short examples, to keep things readable but there is no limit to the number of transition files you can use, or how long the resulting DiffCast can be.
 
-_Short demo, using the 4 demoN.py files in /demos. Demonstrates the block indenting behavior_  
+_Short demo, using the 4 demoN.py files in /demos. Demonstrates the block indenting behavior_
 <video src="https://user-images.githubusercontent.com/126239/151127893-5c98ba8d-c431-4a25-bb1f-e0b33645a2b6.mp4"></video>
 
-_Longer demo, using the 6 windows_N.py files in /demos. Demonstrates more complex edits, whitespace padding._  
+_Longer demo, using the 6 windows_N.py files in /demos. Demonstrates more complex edits, whitespace padding._
 <video src="https://user-images.githubusercontent.com/126239/151128026-531c46db-30cb-466a-a836-8818718a2b13.mp4"></video>
 
 
@@ -75,7 +79,7 @@ When you edit a file you *generally* go from top to bottom, but you don't enter
 
 * If you're adding a block of code which is followed by a blank line, a trailing blank line will be added first (adding space around the new code).
 * Changes to the middle of lines will be edited in the middle of the line, leaving leading and trailing parts intact during editing.
-* Whitespace is added using in blocks of 4 (emulating tab indent) where possible.
+* Whitespace is added in blocks of 4 (emulating tab indent) where possible.
 * Blocks are indented as a whole, where possible.
 
 This is a work in progress and new edits may be added.

demos/windows_1.py

@@ -0,0 +1,35 @@
+import sys
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window")
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.show_new_window)
+        self.setCentralWidget(self.button)
+
+    def show_new_window(self, checked):
+        w = AnotherWindow()
+        w.show()
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

demos/windows_2.py

@@ -0,0 +1,36 @@
+import sys
+from random import randint
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window % d" % randint(0, 100))
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.show_new_window)
+        self.setCentralWidget(self.button)
+
+    def show_new_window(self, checked):
+        self.w = AnotherWindow()
+        self.w.show()
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

demos/windows_3.py

@@ -0,0 +1,38 @@
+import sys
+from random import randint
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window % d" % randint(0, 100))
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.w = None  # No external window yet.
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.show_new_window)
+        self.setCentralWidget(self.button)
+
+    def show_new_window(self, checked):
+        if self.w is None:
+            self.w = AnotherWindow()
+            self.w.show()
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

demos/windows_4.py

@@ -0,0 +1,41 @@
+import sys
+from random import randint
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window % d" % randint(0, 100))
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.w = None  # No external window yet.
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.show_new_window)
+        self.setCentralWidget(self.button)
+
+    def show_new_window(self, checked):
+        if self.w is None:
+            self.w = AnotherWindow()
+            self.w.show()
+
+        else:
+            self.w = None  # Discard reference, close window.
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

demos/windows_5.py

@@ -0,0 +1,36 @@
+import sys
+from random import randint
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window % d" % randint(0, 100))
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.w = AnotherWindow()
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.show_new_window)
+        self.setCentralWidget(self.button)
+
+    def show_new_window(self, checked):
+        self.w.show()
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

demos/windows_6.py

@@ -0,0 +1,40 @@
+import sys
+from random import randint
+
+from PyQt5.QtWidgets import QApplication, QLabel, QMainWindow, QPushButton, QVBoxLayout, QWidget
+
+
+class AnotherWindow(QWidget):
+    """
+    This "window" is a QWidget. If it has no parent, it
+    will appear as a free-floating window.
+    """
+
+    def __init__(self):
+        super().__init__()
+        layout = QVBoxLayout()
+        self.label = QLabel("Another Window % d" % randint(0, 100))
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.w = AnotherWindow()
+        self.button = QPushButton("Push for Window")
+        self.button.clicked.connect(self.toggle_window)
+        self.setCentralWidget(self.button)
+
+    def toggle_window(self, checked):
+        if self.w.isVisible():
+            self.w.hide()
+
+        else:
+            self.w.show()
+
+
+app = QApplication(sys.argv)
+w = MainWindow()
+w.show()
+app.exec_()

diffcast/app.py

@@ -4,22 +4,11 @@
 
 from PyQt6.QtCore import QSettings, QSize, Qt, QThreadPool
 from PyQt6.QtGui import QColor, QIcon, QPalette
-from PyQt6.QtWidgets import (
-    QAbstractItemView,
-    QApplication,
-    QCheckBox,
-    QComboBox,
-    QFileDialog,
-    QHBoxLayout,
-    QLineEdit,
-    QListWidget,
-    QListWidgetItem,
-    QMainWindow,
-    QMessageBox,
-    QPushButton,
-    QVBoxLayout,
-    QWidget,
-)
+from PyQt6.QtWidgets import (QAbstractItemView, QApplication, QCheckBox,
+                             QComboBox, QFileDialog, QHBoxLayout, QLineEdit,
+                             QListWidget, QListWidgetItem, QMainWindow,
+                             QMessageBox, QProgressBar, QPushButton,
+                             QVBoxLayout, QWidget)
 
 from diffrunner import DiffRunner
 from viewer import DISPLAY_MODES, CodeViewer
@@ -75,6 +64,12 @@ def __init__(self):
 
         vl.addWidget(self.difflist)
 
+        self.progress = QProgressBar()
+        self.progress.setMaximumHeight(5)
+        self.progress.setRange(0, 100)
+        self.progress.setTextVisible(False)
+        vl.addWidget(self.progress)
+
         controls = QHBoxLayout()
         self.start_btn = QPushButton("Start")
         self.start_btn.pressed.connect(self.start)
@@ -217,6 +212,7 @@ def diff(self, files):
             self.runner.signals.file_changed.connect(self.diff_file_changed)
             self.runner.signals.file_complete.connect(self.differ_file_complete)
             self.runner.signals.completed.connect(self.differ_complete)
+            self.runner.signals.progress.connect(self.progress.setValue)
 
             self.stop_btn.pressed.connect(self.runner.quit)
 
@@ -230,7 +226,7 @@ def open_file_dialog(self):
         if not paths:
             return
 
-        # Sort alphanumerically before adding.
+        #  Sort alphanumerically before adding.
         # FIXME: Split numeric suffix, something smarter?
         paths.sort()
 

diffcast/diffrunner.py

@@ -36,6 +36,7 @@ class Signals(QObject):
     file_changed = pyqtSignal(str)
     file_complete = pyqtSignal(str, list)
     completed = pyqtSignal()
+    progress = pyqtSignal(int)
 
 
 class DiffRunner(QRunnable):
@@ -169,6 +170,7 @@ def run(self):
         with open(initial_file, 'r') as f1:
             self.current = f1.readlines()
 
+        self.signals.progress.emit(0)
         self.signals.file_changed.emit(initial_file)
         self.signals.file_complete.emit(initial_file, self.current)
 
@@ -179,12 +181,14 @@ def run(self):
         self.signals.updated.emit(last_line, last_char, self.current)
         time.sleep(INITIAL_SPEED)
 
-        for file in files:
+        n_files = len(self.files)  # So we don't hit 100% until last file is complete.
+        for file_n, file in enumerate(files, 1):
 
             if self._quit_requested:
                 break
 
             self.signals.file_changed.emit(file)
+            self.signals.progress.emit(int(file_n / n_files * 100))
 
             with open(file, 'r') as f2:
                 target = f2.readlines()
@@ -293,4 +297,5 @@ def run(self):
             self.signals.file_complete.emit(file, self.current)
 
         # We're finished.
+        self.signals.progress.emit(100)
         self.signals.completed.emit()

diffcast/viewer.py

@@ -49,13 +49,6 @@ def __init__(self, parent=None):
         lexer.setDefaultColor(QColor('#d4d4d4'))
         lexer.setHighlightSubidentifiers(False)
 
-        self.SendScintilla(
-            QsciScintilla.SCI_SETKEYWORDS,
-            0,
-            b"False None True and as assert break class continue def del elif else except finally for from global if import in is lambda nonlocal not or pass raise return try while with yield",
-        )
-        self.SendScintilla(QsciScintilla.SCI_SETKEYWORDS, 1, b"self")
-
         """
         0 Default
         1 Comment
@@ -115,6 +108,14 @@ def __init__(self, parent=None):
         # Hide horizontal scrollbar.
         self.SendScintilla(QsciScintilla.SCI_SETHSCROLLBAR, 0)
 
+        # Tweak lexer.
+        self.SendScintilla(
+            QsciScintilla.SCI_SETKEYWORDS,
+            0,
+            b"False None True and as assert break class continue def del elif else except finally for from global if import in is lambda nonlocal not or pass raise return try while with yield",
+        )
+        self.SendScintilla(QsciScintilla.SCI_SETKEYWORDS, 1, b"self")
+
 
 class NoMouseListView(QListView):
     def mousePressEvent(self, e):