snappy 3.0.3__cp38-cp38-macosx_11_0_arm64.whl → 3.2__cp38-cp38-macosx_11_0_arm64.whl

snappy/app.py

@@ -1,29 +1,28 @@
 # -*- coding: utf-8 -*-
-from __future__ import unicode_literals, print_function
-from builtins import range
-import os, sys, re, tempfile, time, png, webbrowser, time, signal
-try:
-    from collections.abc import Mapping  # Python 3.5 or newer
-except ImportError:
-    from collections import Mapping  # Python 2.7
+import os
+import sys
+import re
+import time
+from collections.abc import Mapping  # Python 3.5 or newer
 from IPython.core.displayhook import DisplayHook
+from tkinter.messagebox import askyesno
 
 from .gui import *
 from . import filedialog
 from .exceptions import SnapPeaFatalError
 from .app_menus import HelpMenu, EditMenu, WindowMenu, ListedWindow
 from .app_menus import dirichlet_menus, horoball_menus, inside_view_menus, plink_menus
-from .app_menus import add_menu, scut
+from .app_menus import add_menu, scut, open_html_docs
 from .browser import Browser
 from .horoviewer import HoroballViewer
-from .infodialog import about_snappy
+from .infowindow import about_snappy, InfoWindow
 from .polyviewer import PolyhedronViewer
 from .raytracing.inside_viewer import InsideViewer
-from .preferences import Preferences, PreferenceDialog
+from .settings import Settings, SettingsDialog
 from .phone_home import update_needed
 from .SnapPy import SnapPea_interrupt, msg_stream
 from .shell import SnapPyInteractiveShellEmbed
-from .tkterminal import TkTerm, snappy_path
+from .tkterminal import TkTerminalBase
 
 from plink import LinkEditor
 from plink.smooth import Smoother
@@ -34,7 +33,8 @@ if 'SNAPPYHOME' in os.environ:
     else:
         os.environ['HOME'] = os.environ['SNAPPYHOME']
 
-class SnapPyTerm(TkTerm, ListedWindow):
+
+class SnapPyTerm(TkTerminalBase, ListedWindow):
     """
     The main window of the SnapPy app, which runs an embedded IPython shell.
     """
@@ -47,9 +47,10 @@ class SnapPyTerm(TkTerm, ListedWindow):
         self.main_window = self
         self.menu_title = 'SnapPy Shell'
         self.register_window(self)
-        TkTerm.__init__(self, shell, name='SnapPy Command Shell')
-        self.prefs = SnapPyPreferences(self)
+        TkTerminalBase.__init__(self, shell, name='SnapPy Command Shell')
+        self.settings = SnapPySettings(self)
         self.start_interaction()
+        self.interact_prompt()
         if sys.platform == 'darwin':
             assert str(self.window) == "."
             # Under OS X, the main window shouldn't be closable.
@@ -57,28 +58,65 @@ class SnapPyTerm(TkTerm, ListedWindow):
             self.window.createcommand("::tk::mac::OpenDocument", self.OSX_open_filelist)
         else:
             self.window.tk.call('namespace', 'import', '::tk::dialog::file::')
-            self.window.tk.call('set', '::tk::dialog::file::showHiddenBtn',  '1')
-            self.window.tk.call('set', '::tk::dialog::file::showHiddenVar',  '0')
+            self.window.tk.call('set', '::tk::dialog::file::showHiddenBtn', '1')
+            self.window.tk.call('set', '::tk::dialog::file::showHiddenVar', '0')
         self.encoding = None
 
+    def start_interaction(self):
+        """
+        Display a banner and prepare to begin interaction.
+        """
+        snappy_path = os.path.abspath(os.path.dirname(__file__))
+        icon_file = os.path.join(snappy_path, 'info_icon.gif')
+        # Keep a reference to the icon.
+        self.icon = Tk_.PhotoImage(file=icon_file)
+
+        self.text.image_create(Tk_.END, image=self.icon)
+        banner_label = Tk_.Label(self.text, text=self.banner,
+                                 background='#ec0fffec0',
+                                 foreground='DarkGreen',
+                                 anchor=Tk_.W,
+                                 justify=Tk_.LEFT,
+                                 font=self.settings['font'].as_tuple())
+        self.text.window_create(Tk_.END, window=banner_label)
+        self.text.insert(Tk_.END, '\n')
+        self.text.mark_set('output_end', '2.0')
+        # Set a reasonable default directory for files to be saved to.
+        try:
+            home = os.environ['HOME']
+        except KeyError:
+            home = os.path.expanduser("~")
+        desktop = os.path.join(home, "Desktop")
+        default_save_dir = desktop if os.path.exists(desktop) else home
+        self.IP.magics_manager.magics['line']['cd']("-q " + default_save_dir)
+
     def add_bindings(self):
         self.window.bind('<<Paste>>', self.edit_paste)
 
+    def about_window(self):
+        window = self.window
+        if not hasattr(window, 'about_snappy'):
+            window.about_snappy = about_snappy(window)
+        else:
+            window.about_snappy.deiconify()
+            window.about_snappy.lift()
+            window.about_snappy.focus_force()
+
     def build_menus(self):
         window = self.window
         self.menubar = menubar = Tk_.Menu(window)
         Python_menu = Tk_.Menu(menubar, name="apple")
         Python_menu.add_command(label='About SnapPy...',
-                                command=lambda : about_snappy(window))
+                                command=self.about_window)
         if sys.platform == 'darwin':
-            window.createcommand('::tk::mac::ShowPreferences', self.edit_prefs)
+            window.createcommand('::tk::mac::ShowPreferences', self.edit_settings)
             # By default, the Quit menu command terminates the Python process.
             # That is not so friendly if cleanup is needed.
             window.createcommand('::tk::mac::Quit', self.close)
         else:
             Python_menu.add_separator()
-            Python_menu.add_command(label='Preferences...',
-                                    command=self.edit_prefs)
+            Python_menu.add_command(label='Settings...',
+                                    command=self.edit_settings)
             Python_menu.add_separator()
             Python_menu.add_command(label='Quit SnapPy', command=self.close)
         menubar.add_cascade(label='SnapPy', menu=Python_menu)
@@ -97,16 +135,28 @@ class SnapPyTerm(TkTerm, ListedWindow):
             window.createcommand('::tk::mac::ShowHelp', help_menu.show_SnapPy_help)
         menubar.add_cascade(label='Help', menu=help_menu)
 
-    def edit_prefs(self):
-        apple_menu = self.menubar.children['apple']
-        apple_menu.entryconfig(2, state='disabled')
-        dialog = PreferenceDialog(self.window, self.prefs)
+    def edit_settings(self):
+        terminal.can_quit = False
+        if sys.platform == 'darwin':
+            self.window.deletecommand('::tk::mac::ShowPreferences')
+        else:
+            apple_menu = self.menubar.children['apple']
+            apple_menu.entryconfig(2, state='disabled')
+        dialog = SettingsDialog(self.window, self.settings)
+        terminal.add_blocker(dialog,
+            'Changes to your settings will be lost if you quit SnapPy now.')
+        dialog.run()
+        terminal.remove_blocker(dialog)
         if dialog.okay:
             answer = askyesno('Save?',
                               'Do you want to save these settings?')
             if answer:
-                self.prefs.write_prefs()
-        apple_menu.entryconfig(2, state='active')
+                self.settings.write_settings()
+        if sys.platform == 'darwin':
+            self.window.createcommand('::tk::mac::ShowPreferences', self.edit_settings)
+        else:
+            apple_menu.entryconfig(2, state='active')
+        self.can_quit = True
 
     def OSX_open_filelist(self, *args):
         for arg in args:
@@ -117,7 +167,7 @@ class SnapPyTerm(TkTerm, ListedWindow):
             parent=self.window,
             title='Run Saved Transcript In Current Namespace',
             defaultextension='.py',
-            filetypes = [
+            filetypes=[
                 ("Python and text files", "*.py *.ipy *.txt", "TEXT"),
                 ("All text files", "", "TEXT"),
                 ("All files", "")])
@@ -126,26 +176,35 @@ class SnapPyTerm(TkTerm, ListedWindow):
             openfile.close()
             if re.search(r"%\s*([vV]irtual)*\s*[lL]ink\s*[Pp]rojection", lines[0]):
                 tkMessageBox.showwarning('Bad file',
-                                         'This is a SnapPea link projection file, not a session transcript.')
+                    'This is a SnapPea link projection file, '
+                    'not a session transcript.')
             elif re.search(r"%\s*[tT]riangulation", lines[0]):
                 tkMessageBox.showwarning('Bad file',
-                                         'This is a SnapPea triangulation file, not a session transcript.')
+                    'This is a SnapPea triangulation file, '
+                    'not a session transcript.')
             elif re.search(r"%\s*Generators", lines[0]):
                 tkMessageBox.showwarning('Bad file',
-                                         'This is a SnapPea generator file, not a session transcript.')
+                    'This is a SnapPea generator file, '
+                    'not a session transcript.')
             else:
+                while lines[0][0] in ('#', '\n'):
+                    lines.pop(0)
                 for line in lines:
-                    if line.startswith('#') or len(line) == 1:
+                    # Skip comments.
+                    if line.startswith('#'):
                         continue
-                    self.write(line)
-                    self.interact_handle_input(line, script=True)
-                    self.interact_prompt()
+                    # Simulate the user typing this line of code; strip off
+                    # the indentation since that has already been printed by
+                    # interact_prompt.
+                    self.write(line[:-1].lstrip(), mark=Tk_.INSERT, advance=False)
+                    # Then simulate the user pressing the Enter key.
+                    self.handle_return(event=None)
 
     def open_link_file(self, event=None):
         openfile = filedialog.askopenfile(
             title='Load Link Projection File',
             defaultextension='.lnk',
-            filetypes = [
+            filetypes=[
                 ("Link and text files", "*.lnk *.txt", "TEXT"),
                 ("All text files", "", "TEXT"),
                 ("All files", "")])
@@ -170,7 +229,7 @@ class SnapPyTerm(TkTerm, ListedWindow):
             mode='w',
             title='Save Transcript as a Python script',
             defaultextension='.py',
-            filetypes = [
+            filetypes=[
                 ("Python and text files", "*.py *.ipy *.txt", "TEXT"),
                 ("All text files", "", "TEXT"),
                 ("All files", "")])
@@ -178,11 +237,11 @@ class SnapPyTerm(TkTerm, ListedWindow):
             savefile.write("""\
 #!/usr/bin/env/python
 # This script was saved by SnapPy on %s.
-"""%time.asctime())
+""" % time.asctime())
             inputs = self.IP.history_manager.input_hist_raw
             results = self.IP.history_manager.output_hist
             for n in range(1,len(inputs)):
-                savefile.write('\n'+re.sub('\n+','\n',inputs[n]) +'\n')
+                savefile.write('\n'+re.sub('\n+','\n',inputs[n]) + '\n')
                 try:
                     output = repr(results[n]).split('\n')
                 except:
@@ -197,20 +256,45 @@ class SnapPyTerm(TkTerm, ListedWindow):
 
 # These classes assume that the global variable "terminal" exists
 
+
 class SnapPyBrowser(Browser, ListedWindow):
     def __init__(self, manifold, root=None, main_window=None):
         Browser.__init__(self, manifold, root=root, main_window=terminal)
-        self.prefs = terminal.prefs
+        self.settings = terminal.settings
         self.menu_title = self.title()
         self.register_window(self)
+        self.dirichlet_viewer.help_button.configure(command=self.dirichlet_help)
 
     def close(self, event=None):
+        terminal.window.focus_force()
         self.unregister_window(self)
-        self.destroy()
+        self.withdraw()
+        self.after(100, self.destroy)
 
-    def apply_prefs(self):
+    def apply_settings(self):
         if self.inside_view:
-            self.inside_view.apply_prefs(self.main_window.prefs)
+            self.inside_view.apply_settings(self.main_window.settings)
+
+    def dirichlet_help(self):
+        if not hasattr(self, 'polyhedron_help'):
+            self.polyhedron_help = InfoWindow(self, 'Polyhedron Viewer Help',
+                                              self.dirichlet_viewer.widget.help_text,
+                                              'polyhedron_help')
+        else:
+            self.polyhedron_help.deiconify()
+            self.polyhedron_help.lift()
+            self.polyhedron_help.focus_force()
+
+    def horoball_help(self):
+        if not hasattr(self, 'horoviewer_help'):
+            self.horoviewer_help = InfoWindow(self, 'Horoball Viewer Help',
+                                              self.horoball_viewer.widget.help_text,
+                                              'horoviewer_help')
+        else:
+            self.horoviewer_help.deiconify()
+            self.horoviewer_help.lift()
+            self.horoviewer_help.focus_force()
+
 
 class SnapPyLinkEditor(LinkEditor, ListedWindow):
     def __init__(self, root=None, no_arcs=False, callback=None, cb_menu='',
@@ -233,6 +317,15 @@ class SnapPyLinkEditor(LinkEditor, ListedWindow):
         self.register_window(self)
         self.window.deiconify()
 
+    def deiconify(self):
+        self.window.deiconify()
+
+    def lift(self):
+        self.window.lift()
+
+    def focus_force(self):
+        self.window.focus_force()
+
     def set_title(self):
         # Try to determine the variable associated to the manifold:
         title = 'Plink Editor'
@@ -244,13 +337,13 @@ class SnapPyLinkEditor(LinkEditor, ListedWindow):
                 names.sort(key=lambda x : '}'+x if x.startswith('_') else x)
                 if names[0] == '_':
                     count = self.IP.execution_count
-                    title += ' - Out[%d]'%count
+                    title += ' - Out[%d]' % count
                 else:
                     title += ' - %s' % names[0]
             else:
                 count = self.IP.execution_count
                 if ns['_'] is self.manifold:
-                    title += ' - Out[%d]'%count
+                    title += ' - Out[%d]' % count
         self.window.title(title)
         self.menu_title = title
 
@@ -262,8 +355,12 @@ class SnapPyLinkEditor(LinkEditor, ListedWindow):
     def save(self, event=None):
         LinkEditor.save(self)
 
+    def howto(self):
+        open_html_docs('plink.html')
+
     __repr__ = object.__repr__
 
+
 class SnapPyViewerWindow(ViewerWindow, ListedWindow):
     def __init__(self, *args, **kwargs):
         ViewerWindow.__init__(self, *args, **kwargs)
@@ -271,52 +368,80 @@ class SnapPyViewerWindow(ViewerWindow, ListedWindow):
         self.menu_title = self.title()
         self.register_window(self)
 
-    def apply_prefs(self):
-        # The view's apply_prefs method has a different signature.  It
-        # expects to be passed a preferences object.
-        self.view.apply_prefs(self.main_window.prefs)
+    def apply_settings(self):
+        # The view's apply_settings method has a different signature.  It
+        # expects to be passed a Settings object.
+        self.view.apply_settings(self.main_window.settings)
 
     def close(self, event=None):
         self.unregister_window(self)
         self.view = None
         self.destroy()
 
+
 class SnapPyPolyhedronViewer(PolyhedronViewer):
 
     build_menus = dirichlet_menus
 
-class SnapPyInsideViewer(InsideViewer):
+    def __init__(self, *args, **kwargs):
+        PolyhedronViewer.__init__(self, *args, **kwargs, main_window=terminal)
+        self.help_button.configure(command=self.help_window)
+
+    def help_window(self):
+        window = self.parent
+        if not hasattr(window, 'polyhedron_help'):
+            window.polyhedron_help = InfoWindow(
+                window, 'Polyhedron Viewer Help',
+                self.widget.help_text, 'polyhedron_help')
+        else:
+            window.polyhedron_help.deiconify()
+            window.polyhedron_help.lift()
+            window.polyhedron_help.focus_force()
 
-    build_menus = inside_view_menus
 
 class SnapPyHoroballViewer(HoroballViewer):
 
     build_menus = horoball_menus
 
-class SnapPyPreferences(Preferences, ListedWindow):
+    def __init__(self, *args, **kwargs):
+        HoroballViewer.__init__(self, *args, **kwargs, main_window=terminal)
+        self.main_window = terminal
+
+    def help_window(self):
+        window = self.parent
+        if not hasattr(window, 'horoball_help'):
+            window.horoball_help = InfoWindow(window,  'Horoball Viewer Help',
+                                              self.widget.help_text, 'horoball_help')
+        else:
+            window.horoball_help.deiconify()
+            window.horoball_help.lift()
+            window.horoball_help.focus_force()
+
+
+class SnapPyInsideViewer(InsideViewer):
+
+    build_menus = inside_view_menus
+
+
+class SnapPySettings(Settings, ListedWindow):
     def __init__(self, terminal):
         self.terminal = terminal
-        Preferences.__init__(self, terminal.text)
-        self.apply_prefs()
+        Settings.__init__(self)
+        self.apply_settings()
 
-    def apply_prefs(self):
+    def apply_settings(self):
         self.terminal.set_font(self['font'])
         changed = self.changed()
         IP = self.terminal.IP
         self.terminal.quiet = True
-        if 'autocall' in changed:
-            if self.prefs_dict['autocall']:
-                IP.magics_manager.magics['line']['autocall'](2)
-            else:
-                IP.magics_manager.magics['line']['autocall'](0)
-        if 'automagic' in changed:
-            if self.prefs_dict['automagic']:
-                IP.magics_manager.magics['line']['automagic']('on')
-            else:
-                IP.magics_manager.magics['line']['automagic']('off')
+        if self.setting_dict['autocall']:
+            IP.magics_manager.magics['line']['autocall']('2')
+        else:
+            IP.magics_manager.magics['line']['autocall']('0')
         self.terminal.quiet = False
         for window in self.window_list:
-            window.apply_prefs()
+            window.apply_settings()
+
 
 app_banner = """
  Hi.  It's SnapPy.
@@ -327,6 +452,7 @@ app_banner = """
 help_banner = """Type X? for help with X.
 Use the Help menu or type help() to view the SnapPy documentation."""
 
+
 class SnapPyExit:
     """
     Replacement for the IPython ExitAutocall class
@@ -340,26 +466,36 @@ class SnapPyExit:
 
 # This hack avoids an unnecessary warning from IPython saying that
 # _Helper is not included in the app2py site.py file.
-class _Helper(object):
+
+
+class _Helper():
     pass
+
+
 import site
 site._Helper = _Helper
 
 # This will be used for paging by IPython help.
+
+
 def IPython_pager(self, text, start=0, screen_lines=0):
     if isinstance(text, Mapping):
         text = text['text/plain']
     terminal.page(text)
 
+
 # This will be used for paging by pydoc help.
 import pydoc
 
+
 def pydoc_pager(text):
     terminal.page(pydoc.plain(text))
 
+
 pydoc.getpager() # this call creates the global variable pydoc.pager
 pydoc.pager = pydoc_pager
 
+
 # This sets the "system menu" icon in the title bar to be the SnapPy
 # icon (in Windows and ??KDE??)
 
@@ -367,19 +503,21 @@ def set_icon(window):
     if sys.platform == 'win32':
         try:
             import snappy
-            ico = os.path.join(os.path.dirname(snappy.__file__), 'SnapPy.ico')
+            ico = os.path.join(os.path.dirname(__file__), 'SnapPy.ico')
             window.iconbitmap(default=ico)
         except:
             pass
     if sys.platform == 'darwin':
         if not sys.executable.endswith('SnapPy.app/Contents/MacOS/python'):
+            snappy_path = os.path.abspath(os.path.dirname(__file__))
+            icon_file = os.path.join(snappy_path, 'info_icon.gif')
             image_file = os.path.join(snappy_path, 'SnapPy.png')
             if os.path.exists(image_file):
                 dock_icon = Tk_.PhotoImage(file=image_file)
-                window.eval('wm iconphoto . -default %s'%dock_icon)
+                window.eval('wm iconphoto . -default %s' % dock_icon)
 
-#from multiprocessing import Process
-class SnapPyKernelServer(object):
+# from multiprocessing import Process
+class SnapPyKernelServer():
     """
     Placeholder for a real SnapPyKernelServer which the app can use to
     asynchronously compute data about manifolds.
@@ -402,15 +540,18 @@ class SnapPyKernelServer(object):
         if self._process.is_alive():
             self._process.terminate()
 
+
 def main():
     global terminal
     import snappy
-    #kernel_server = SnapPyKernelServer()
+    # kernel_server = SnapPyKernelServer()
     terminal = SnapPyTerm()
     sys.stdout = terminal
     set_icon(terminal.window)
-    SnapPy_ns = dict([(x, getattr(snappy,x)) for x in snappy.__all__])
-    #SnapPy_ns['kernel_server'] = kernel_server
+    terminal.window.call('bind', 'TNotebook', '<Right>', '')
+    terminal.window.call('bind', 'TNotebook', '<Left>', '')
+    SnapPy_ns = {x: getattr(snappy, x) for x in snappy.__all__}
+    # SnapPy_ns['kernel_server'] = kernel_server
     SnapPy_ns['exit'] = SnapPy_ns['quit'] = SnapPyExit()
     SnapPy_ns['pager'] = None
     helper = pydoc.Helper(input=terminal, output=terminal)
@@ -426,15 +567,39 @@ def main():
     LP.PolyhedronViewer = HP.PolyhedronViewer = SnapPyPolyhedronViewer
     LP.HoroballViewer = HP.HoroballViewer = SnapPyHoroballViewer
     snappy.ViewerWindow = SnapPyViewerWindow
+    snappy.ViewerWindow.main_window = terminal
     snappy.InsideViewer = SnapPyInsideViewer
+    snappy.InsideViewer.main_window = terminal
     LP.Browser = HP.Browser = SnapPyBrowser
     LP.msg_stream.write = HP.msg_stream.write = terminal.write2
     LP.UI_callback = HP.UI_callback = terminal.SnapPea_callback
-    #if not snappy.SnapPy._within_sage:
+    # if not snappy.SnapPy._within_sage:
     #    snappy.pari.UI_callback = terminal.PARI_callback
+
+    """
+    Experimental optional Tk themes on linux.  You need to install
+    tksvg from source for Python 3.10 or newer like so::
+
+      sudo apt install cmake build-essential tcl-dev tk-dev python3-tk
+      python -m pip install scikit-build
+      git clone --recursive https://github.com/TkinterEP/python-tksvg.git
+      cd python-tksvg
+      python -m pip install .
+
+    then you can do::
+
+      python -m pip install python-awthemes
+
+    and uncomment the next four lines.
+    """
+    # terminal.window.call('tk', 'scaling', 2.0)  # Not sure this actually does anything
+    # import awthemes
+    # style = awthemes.AwthemesStyle(terminal.window)
+    # style.theme_use('awbreeze')
     terminal.window.lift()
     terminal.window.mainloop()
-    #kernel_server.stop()
+    # kernel_server.stop()
+
 
 if __name__ == "__main__":
     main()