Merge pull request #12 from aaronkollasch/dev

Updates for 1.1.1

.github/workflows/main.yml

@@ -48,7 +48,7 @@ jobs:
         if: "contains(env.USING_COVERAGE, matrix.python-version)"
       - name: "Upload coverage to Codecov"
         if: "contains(env.USING_COVERAGE, matrix.python-version)"
-        uses: "codecov/codecov-action@v1"
+        uses: "codecov/codecov-action@v2"
         with:
           fail_ci_if_error: true
 

CHANGES.rst

@@ -1,6 +1,15 @@
 Changelog for Jupyter-O2
 ========================
 
+1.1.1 - 2021-11-24
+------------------
+
+Added
+^^^^^
+- Fix segmentation fault on ``import Quartz``
+- Fix ``try_quit_xquartz()`` in recent versions of macOS (Use the config option ``KEEP_XQUARTZ`` if quitting XQuartz is not desired.)
+- Remove check for root prompt at ``login()``
+
 1.1.0 - 2021-10-25
 ------------------
 

src/jupyter_o2/__init__.py

@@ -29,7 +29,7 @@
 )
 
 __author__ = "Aaron Kollasch"
-__date__ = "2021-10-25"
+__date__ = "2021-11-24"
 __copyright__ = "Copyright 2017-2021, Aaron Kollasch"
 __email__ = "[email protected]"
 __status__ = "Production"

src/jupyter_o2/config_manager.py

@@ -26,6 +26,7 @@
     "RUN_JUPYTER_CALL_FORMAT": "jupyter {subcommand} --port={port} --no-browser",
     "PORT_RETRIES": 10,
     "FORCE_GETPASS": False,
+    "KEEP_XQUARTZ": False,
     "USE_TWO_FACTOR_AUTHENTICATION": False,
     "TWO_FACTOR_AUTHENTICATION_CODE": "1",
     "USE_INTERNAL_INTERACTIVE_SESSION": True,
@@ -118,9 +119,9 @@ def get_base_arg_parser():
                         help="Code(s) to use with 2FA (1 for auto-push)")
     parser.add_argument("-k", "--keepalive", default=False, action='store_true',
                         help="keep interactive session alive after exiting Jupyter")
-    parser.add_argument("--kq", "--keepxquartz", dest="keepxquartz", default=False,
-                        action='store_true',
-                        help="do not quit XQuartz")
+    parser.add_argument("--kq", "--keepxquartz", dest="keepxquartz",
+                        default=JO2_DEFAULTS.get("KEEP_XQUARTZ"),
+                        action='store_true', help="do not quit XQuartz")
     parser.add_argument("--force-getpass", dest="forcegetpass", action='store_true',
                         default=JO2_DEFAULTS.get("FORCE_GETPASS"),
                         help="use getpass instead of pinentry for password entry")

src/jupyter_o2/jupyter-o2.cfg

@@ -31,6 +31,9 @@ INIT_JUPYTER_COMMANDS =
 ;FORCE_GETPASS = False
 # Force the use of getpass instead of pinentry if the pinentry is available
 
+;KEEP_XQUARTZ = False
+# Do not quit XQuartz after starting Jupyter-O2
+
 
 [Remote Environment Settings]
 # These settings can be configured to adapt Jupyter-O2 to an environment other than O2.

src/jupyter_o2/jupyter_o2.py

@@ -62,7 +62,7 @@ def login(self, server, username=None, password="", code=None, *args, **kwargs):
         new_args = dict(
             sync_original_prompt=False,
             auto_prompt_reset=False,
-            original_prompt=f"[#$]|{self.duo_pattern}",
+            original_prompt=f"[$]|{self.duo_pattern}",
         )
         if kwargs:
             kwargs.update(new_args)
@@ -95,11 +95,11 @@ def login(self, server, username=None, password="", code=None, *args, **kwargs):
                 self._buffer = self.buffer_type()
                 if code is not None:
                     self.sendline(code)
-                    i = self.expect(["[#$]", self.duo_pattern])
+                    i = self.expect(["$", self.duo_pattern])
                     logger.debug(f"Found prompt #{i}")
                     if i == 1:  # search for prompt one more time
                         self.sendline()
-                        i = self.expect(["[#$]", self.duo_pattern])
+                        i = self.expect(["$", self.duo_pattern])
                         logger.debug(f"Found prompt #{i}")
                     if i == 1:
                         self.close()

src/jupyter_o2/utils.py

@@ -2,6 +2,7 @@
 import logging
 from time import sleep
 import subprocess
+import signal
 import shlex
 import ast
 
@@ -100,11 +101,8 @@ def try_quit_xquartz():
         print("Quitting XQuartz... ", end="")
         open_windows = get_xquartz_open_windows()
         if open_windows is None:
-            logger.warning(
-                "Quitting XQuartz is not supported. "
-                "Import pyobjc-framework-Quartz with pip."
-            )
-        elif not open_windows:
+            pass
+        elif len(open_windows) < 2:
             quit_xquartz()
         else:
             print("\nXQuartz window(s) are open. Not quitting.")
@@ -135,28 +133,44 @@ def get_xquartz_open_windows():
     Requires pyobjc-framework-Quartz (install with pip)
     :return: a list of open windows as python dictionaries
     """
+    # pyobjc-framework-Quartz can segfault if the wrong version is installed
+    logger = logging.getLogger(__name__)
+    p = subprocess.Popen([sys.executable, "-c", "import Quartz"])
+    p.communicate()
+    if p.returncode == -signal.SIGSEGV:
+        logger.warning(
+            "Import of pyobjc-framework-Quartz failed due to a segmentation fault. "
+            "The installed version is incompatible with your system."
+        )
+        return None
+
     try:
         from Quartz import (
             CGWindowListCopyWindowInfo,
-            kCGWindowListOptionAll,
+            kCGWindowListExcludeDesktopElements,
             kCGNullWindowID,
         )
         from PyObjCTools import Conversion
     except ImportError:
-        return None
-    # need to use kCGWindowListOptionAll to include windows
-    # that are not currently on screen (e.g. minimized)
-    windows = CGWindowListCopyWindowInfo(kCGWindowListOptionAll, kCGNullWindowID)
+        logger.warning(
+            "Import of pyobjc-framework-Quartz failed. Try installing with pip."
+        )
+    # need to use kCGWindowListExcludeDesktopElements to include windows
+    # that are not currently on screen (e.g. minimized).
+    # kCGWindowListExcludeDesktopElements | kCGWindowListOptionOnScreenOnly
+    # will exclude minimized windows. Use KEEP_XQUARTZ if this is an issue.
+    windows = CGWindowListCopyWindowInfo(
+        kCGWindowListExcludeDesktopElements, kCGNullWindowID
+    )
 
     # then filter for XQuartz main windows
     open_windows = [
         window
         for window in windows
         if window["kCGWindowOwnerName"] == "XQuartz"
         and window["kCGWindowLayer"] == 0
-        and "kCGWindowName" in window.keys()
-        and window["kCGWindowName"]
-        not in ["", "X11 Application Menu", "X11 Preferences"]
+        and window["kCGWindowBounds"]["X"] != 0
+        and window["kCGWindowBounds"]["Y"] != 0
     ]
 
     # convert from NSDictionary to python dictionary