plain.dev 0.18.1__tar.gz → 0.19.0__tar.gz

{plain_dev-0.18.1 → plain_dev-0.19.0}/LICENSE

@@ -51,3 +51,17 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+## This package contains code forked from github.com/ionelmc/python-remote-pdb
+
+BSD 2-Clause License
+
+Copyright (c) 2014-2022, Ionel Cristian Mărieș. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{plain_dev-0.18.1 → plain_dev-0.19.0}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.18.1
+Version: 0.19.0
 Summary: Local development tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
 License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: click>=8.0.0
-Requires-Dist: debugpy~=1.6.3
 Requires-Dist: gunicorn>20
 Requires-Dist: plain<1.0.0
 Requires-Dist: psycopg[binary]~=3.2.2

plain_dev-0.19.0/plain/dev/__init__.py

@@ -0,0 +1,4 @@
+from .cli import cli
+from .requests import RequestsMiddleware
+
+__all__ = ["cli", "RequestsMiddleware"]

{plain_dev-0.18.1 → plain_dev-0.19.0}/plain/dev/cli.py

@@ -4,6 +4,7 @@ import os
 import platform
 import subprocess
 import sys
+import time
 import tomllib
 from importlib.metadata import entry_points
 from importlib.util import find_spec
@@ -65,6 +66,32 @@ def cli(ctx, port, hostname, log_level):
         sys.exit(returncode)
 
 
+@cli.command()
+def debug():
+    """Connect to the remote debugger"""
+
+    def _connect():
+        if subprocess.run(["which", "nc"], capture_output=True).returncode == 0:
+            return subprocess.run(["nc", "-C", "localhost", "4444"])
+        else:
+            raise OSError("nc not found")
+
+    result = _connect()
+
+    # Try again once without a message
+    if result.returncode == 1:
+        time.sleep(1)
+        result = _connect()
+
+    # Keep trying...
+    while result.returncode == 1:
+        click.secho(
+            "Failed to connect. Make sure remote pdb is ready. Retrying...", fg="red"
+        )
+        result = _connect()
+        time.sleep(1)
+
+
 @cli.command()
 def services():
     """Start additional services defined in pyproject.toml"""
@@ -103,6 +130,7 @@ class Dev:
 
         self.plain_env = {
             "PYTHONUNBUFFERED": "true",
+            "PLAIN_DEV": "true",
             "PLAIN_LOG_LEVEL": self.log_level.upper(),
             "APP_LOG_LEVEL": self.log_level.upper(),
             **os.environ,
@@ -145,13 +173,13 @@ class Dev:
                 status_bar = Columns(
                     [
                         Text.from_markup(
-                            f"[bold]Tunnel URL[/bold] [underline][link={self.tunnel_url}]{self.tunnel_url}[/link][/underline]"
+                            f"[bold]Tunnel[/bold] [underline][link={self.tunnel_url}]{self.tunnel_url}[/link][/underline]"
                         ),
                         Text.from_markup(
-                            f"[dim][bold]Localhost URL[/bold] [link={self.url}]{self.url}[/link][/dim]"
+                            f"[dim][bold]Server[/bold] [link={self.url}]{self.url}[/link][/dim]"
                         ),
                         Text.from_markup(
-                            "[dim]Press [bold]Ctrl+C[/bold] to stop[/dim]",
+                            "[dim][bold]Ctrl+C[/bold] to stop[/dim]",
                             justify="right",
                         ),
                     ],
@@ -161,7 +189,7 @@ class Dev:
                 status_bar = Columns(
                     [
                         Text.from_markup(
-                            f"[bold]Localhost URL[/bold] [underline][link={self.url}]{self.url}[/link][/underline]"
+                            f"[bold]Server[/bold] [underline][link={self.url}]{self.url}[/link][/underline]"
                         ),
                         Text.from_markup(
                             "[dim][bold]Ctrl+C[/bold] to stop[/dim]", justify="right"

plain_dev-0.19.0/plain/dev/debug.py

@@ -0,0 +1,41 @@
+import os
+import platform
+import subprocess
+import sys
+from pathlib import Path
+
+from . import pdb
+
+
+def set_breakpoint_hook():
+    """
+    If a `plain dev` process is running, set a
+    breakpoint hook to trigger a remote debugger.
+    """
+
+    if not os.environ.get("PLAIN_DEV"):
+        # Only want to set the breakpoint hook if
+        # we're in a process managed by `plain dev`
+        return
+
+    def _breakpoint():
+        system = platform.system()
+
+        if system == "Darwin":
+            pwd = Path.cwd()
+            script = f"""
+            tell application "Terminal"
+                activate
+                do script "cd {pwd} && plain dev debug"
+            end tell
+            """
+            subprocess.run(["osascript", "-e", script])
+        else:
+            raise OSError("Unsupported operating system")
+
+        pdb.set_trace(
+            # Make sure the debugger starts outside of this
+            frame=sys._getframe().f_back,
+        )
+
+    sys.breakpointhook = _breakpoint

plain_dev-0.19.0/plain/dev/entrypoints.py

@@ -0,0 +1,17 @@
+import os
+
+from dotenv import load_dotenv
+
+from .debug import set_breakpoint_hook
+
+
+def setup():
+    # Try to set a new breakpoint() hook
+    # so we can connect to pdb remotely.
+    set_breakpoint_hook()
+
+    # Load environment variables from .env file
+    if plain_env := os.environ.get("PLAIN_ENV", ""):
+        load_dotenv(f".env.{plain_env}")
+    else:
+        load_dotenv(".env")

plain_dev-0.19.0/plain/dev/pdb.py

@@ -0,0 +1,129 @@
+import errno
+import logging
+import re
+import socket
+import sys
+from pdb import Pdb
+
+log = logging.getLogger(__name__)
+
+
+def cry(message, stderr=sys.__stderr__):
+    log.critical(message)
+    print(message, file=stderr)
+    stderr.flush()
+
+
+class LF2CRLF_FileWrapper:
+    def __init__(self, connection):
+        self.connection = connection
+        self.stream = fh = connection.makefile("rw")
+        self.read = fh.read
+        self.readline = fh.readline
+        self.readlines = fh.readlines
+        self.close = fh.close
+        self.flush = fh.flush
+        self.fileno = fh.fileno
+        if hasattr(fh, "encoding"):
+            self._send = lambda data: connection.sendall(data.encode(fh.encoding))
+        else:
+            self._send = connection.sendall
+
+    @property
+    def encoding(self):
+        return self.stream.encoding
+
+    def __iter__(self):
+        return self.stream.__iter__()
+
+    def write(self, data, nl_rex=re.compile("\r?\n")):
+        data = nl_rex.sub("\r\n", data)
+        self._send(data)
+
+    def writelines(self, lines, nl_rex=re.compile("\r?\n")):
+        for line in lines:
+            self.write(line, nl_rex)
+
+
+class DevPdb(Pdb):
+    """
+    This will run pdb as a ephemeral telnet service. Once you connect no one
+    else can connect. On construction this object will block execution till a
+    client has connected.
+
+    Based on https://github.com/tamentis/rpdb I think ...
+
+    To use this::
+
+        DevPdb(host='0.0.0.0', port=4444).set_trace()
+
+    Then run: telnet 127.0.0.1 4444
+    """
+
+    active_instance = None
+
+    def __init__(self, host, port, patch_stdstreams=False, quiet=False):
+        self._quiet = quiet
+        listen_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        listen_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
+        listen_socket.bind((host, port))
+        if not self._quiet:
+            cry(
+                "DevPdb session open at {}:{}, waiting for connection ...".format(
+                    *listen_socket.getsockname()
+                )
+            )
+        listen_socket.listen(1)
+        connection, address = listen_socket.accept()
+        if not self._quiet:
+            cry(f"DevPdb accepted connection from {repr(address)}.")
+        self.handle = LF2CRLF_FileWrapper(connection)
+        Pdb.__init__(self, completekey="tab", stdin=self.handle, stdout=self.handle)
+        self.backup = []
+        if patch_stdstreams:
+            for name in (
+                "stderr",
+                "stdout",
+                "__stderr__",
+                "__stdout__",
+                "stdin",
+                "__stdin__",
+            ):
+                self.backup.append((name, getattr(sys, name)))
+                setattr(sys, name, self.handle)
+        DevPdb.active_instance = self
+
+    def __restore(self):
+        if self.backup and not self._quiet:
+            cry(f"Restoring streams: {self.backup} ...")
+        for name, fh in self.backup:
+            setattr(sys, name, fh)
+        self.handle.close()
+        DevPdb.active_instance = None
+
+    def do_quit(self, arg):
+        self.__restore()
+        return Pdb.do_quit(self, arg)
+
+    do_q = do_exit = do_quit
+
+    def set_trace(self, frame=None):
+        if frame is None:
+            frame = sys._getframe().f_back
+        try:
+            Pdb.set_trace(self, frame)
+        except OSError as exc:
+            if exc.errno != errno.ECONNRESET:
+                raise
+
+
+def set_trace(
+    frame=None, host="127.0.0.1", port=4444, patch_stdstreams=False, quiet=False
+):
+    """
+    Opens a remote PDB over a host:port.
+    """
+    devpdb = DevPdb(
+        host=host, port=port, patch_stdstreams=patch_stdstreams, quiet=quiet
+    )
+    devpdb.set_trace(frame=frame)

{plain_dev-0.18.1 → plain_dev-0.19.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.dev"
-version = "0.18.1"
+version = "0.19.0"
 description = "Local development tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"
@@ -9,7 +9,6 @@ requires-python = ">=3.11"
 dependencies = [
     "plain<1.0.0",
     "click>=8.0.0",
-    "debugpy~=1.6.3",
     "python-dotenv~=1.0.0",
     "gunicorn>20",
     "requests>=2.0.0",
@@ -24,7 +23,7 @@ dependencies = [
 "contrib" = "plain.dev.contribute:cli"
 
 [project.entry-points."plain.setup"]
-"dev-dotenv" = "plain.dev.entrypoints:load_dotenv_file"
+"dev-setup" = "plain.dev.entrypoints:setup"
 
 [tool.hatch.build.targets.wheel]
 packages = ["plain"]

{plain_dev-0.18.1 → plain_dev-0.19.0}/uv.lock

@@ -79,15 +79,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335 },
 ]
 
-[[package]]
-name = "debugpy"
-version = "1.6.7.post1"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/0b/c8/b6978e56c917c2fe5096cd83d81bab8ac08ceb1f9a4b9373ad5b066a3265/debugpy-1.6.7.post1.zip", hash = "sha256:fe87ec0182ef624855d05e6ed7e0b7cb1359d2ffa2a925f8ec2d22e98b75d0ca", size = 4664667 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/81/72/cb3a101717d81ab1f97ee38a409be9740e7256bc25074e48fd634055261f/debugpy-1.6.7.post1-py2.py3-none-any.whl", hash = "sha256:1093a5c541af079c13ac8c70ab8b24d1d35c8cacb676306cf11e57f699c02926", size = 4872783 },
-]
-
 [[package]]
 name = "gunicorn"
 version = "23.0.0"
@@ -214,11 +205,10 @@ wheels = [
 
 [[package]]
 name = "plain-dev"
-version = "0.18.1"
+version = "0.19.0"
 source = { editable = "." }
 dependencies = [
     { name = "click" },
-    { name = "debugpy" },
     { name = "gunicorn" },
     { name = "plain" },
     { name = "psycopg", extra = ["binary"] },
@@ -230,7 +220,6 @@ dependencies = [
 [package.metadata]
 requires-dist = [
     { name = "click", specifier = ">=8.0.0" },
-    { name = "debugpy", specifier = "~=1.6.3" },
     { name = "gunicorn", specifier = ">20" },
     { name = "plain", specifier = "<1.0.0" },
     { name = "psycopg", extras = ["binary"], specifier = "~=3.2.2" },

plain_dev-0.18.1/plain/dev/__init__.py

@@ -1,5 +0,0 @@
-from .cli import cli
-from .debug import attach
-from .requests import RequestsMiddleware
-
-__all__ = ["cli", "RequestsMiddleware", "attach"]

plain_dev-0.18.1/plain/dev/debug.py

@@ -1,12 +0,0 @@
-import debugpy
-
-
-def attach(endpoint=("localhost", 5678)):
-    if debugpy.is_client_connected():
-        print("Debugger already attached")
-        return
-
-    debugpy.listen(endpoint)
-    print("Waiting for debugger to attach...")
-    debugpy.wait_for_client()
-    print("Debugger attached!")

plain_dev-0.18.1/plain/dev/entrypoints.py

@@ -1,10 +0,0 @@
-import os
-
-from dotenv import load_dotenv
-
-
-def load_dotenv_file():
-    if plain_env := os.environ.get("PLAIN_ENV", ""):
-        load_dotenv(f".env.{plain_env}")
-    else:
-        load_dotenv(".env")