webdiff 1.0.0__tar.gz → 1.1.0__tar.gz

{webdiff-1.0.0/webdiff.egg-info → webdiff-1.1.0}/PKG-INFO

@@ -1,26 +1,29 @@
 Metadata-Version: 2.1
 Name: webdiff
-Version: 1.0.0
+Version: 1.1.0
 Summary: Two-column web-based git difftool
 Home-page: https://github.com/danvk/webdiff/
+License: Apache-2.0
+Keywords: git,difftool,web
 Author: Dan Vanderkam
 Author-email: danvdk@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
-Classifier: Framework :: Flask
-Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Version Control
-Description-Content-Type: text/markdown
-License-File: LICENSE
+Requires-Dist: PyGithub (==2.3.0)
 Requires-Dist: binaryornot
-Requires-Dist: flask==2.2.2
 Requires-Dist: pillow
-Requires-Dist: requests
-Requires-Dist: PyGithub==1.55
-Requires-Dist: unidiff==0.7.4
-Requires-Dist: Werkzeug==2.2.2
+Requires-Dist: unidiff (==0.7.4)
+Project-URL: Repository, https://github.com/danvk/webdiff/
+Description-Content-Type: text/markdown
 
 # git webdiff
 
@@ -41,11 +44,12 @@ Features include:
 * Step back and forth through multiple files in a single diff
 * Rich support for image diffs
 
+<!-- These are absolute URLs so that they display on pypi.org -->
 <!-- This is `git webdiff 05157bba^..05157bba`, in this repo -->
-![Screenshot of webdiff in action](/images/webdiff.png)
+![Screenshot of webdiff in action](https://raw.githubusercontent.com/danvk/webdiff/master/images/webdiff.png)
 
 <!-- This is `git webdiff c80f969^..c80f969` in the dygraphs-dpxdt repo -->
-![Screenshot of image diffs](/images/webdiff-images.png)
+![Screenshot of image diffs](https://raw.githubusercontent.com/danvk/webdiff/master/images/webdiff-images.png)
 
 ## Installation
 
@@ -78,7 +82,7 @@ You can pass all the same arguments that you would to `git diff`, e.g.
 You can also use `webdiff` to view GitHub pull requests:
 
     webdiff https://github.com/owner/repo/pull/123
-    webdiff '#123'  # if you're in a git repo with a github remote
+    webdiff '#150'  # if you're in a git repo with a github remote
 
 This will download the files relevant to the Pull Request and run `webdiff`.
 
@@ -122,9 +126,7 @@ Options are:
 
 ## Development
 
-    python3 -m venv venv
-    source venv/bin/activate
-    pip install -r requirements.txt
+    poetry install
     cd ts
     yarn
     # see https://github.com/webpack/webpack/issues/14532
@@ -132,7 +134,7 @@ Options are:
 
 Then from the root directory:
 
-    PYTHONPATH=. ./webdiff/app.py testdata/dygraphsjs/{left,right}
+    poetry run webdiff/app.py testdata/dygraphsjs/{left,right}
 
 or to launch in debug mode:
 
@@ -142,43 +144,42 @@ or to launch in debug mode:
 
 To run the Python tests:
 
-    pytest
+    poetry run pytest
 
 To format the code, run:
 
-    ./scripts/black.sh
+    poetry run ruff format
     cd ts
     yarn prettier
 
 To debug `git webdiff`, run:
 
-    WEBDIFF_CONFIG=$(pwd)/testing.cfg ./webdiff/gitwebdiff.py
+    ./test-gitwebdiff.sh
+
+## Publishing
 
 To iterate on the PyPI package, run:
 
-    # from outside the webdiff virtualenv:
     pip3 uninstall webdiff
-
-    # from inside the webdiff virtualenv, adjust for current version
-    python setup.py sdist
-    mkdir /tmp/webdiff-test
-    cp dist/webdiff-?.?.?.tar.gz /tmp/webdiff-test
-
-    deactivate
-    cd /tmp/webdiff-test
-    pip3 install webdiff-?.?.?.tar.gz
+    poetry build
+    pip3 install dist/webdiff-?.?.?.tar.gz
 
 To publish to pypitest:
 
-    pip install --upgrade wheel setuptools twine
-    python setup.py sdist bdist_wheel
-    twine upload -r testpypi dist/*
+    poetry build
+    poetry publish -r testpypi
 
 And to the real pypi:
 
-    twine upload dist/*
+    poetry publish
+
+See [pypirc][] and [poetry][] docs for details on setting up tokens for pypi.
 
-See [pypirc][] docs for details on setting up `~/.pypirc`.
+Publication checklist. Do these from _outside_ the webdiff directory:
+
+- Run `webdiff webdiff/testdata/.../{left,right}`
+- Run `git webdiff 52aa15f^..52aa15f` in the codediff.js repo
+- Run `webdiff https://github.com/danvk/webdiff/pull/160`
 
 ## Implementation notes
 
@@ -207,3 +208,5 @@ There's one complication involving symlinks. `git difftool -d` may fill one of t
 [ImageMagick]: https://imagemagick.org/index.php
 [git config]: https://git-scm.com/docs/git-config
 [themes]: http://example.com
+[poetry]: https://python-poetry.org/docs/repositories/#publishable-repositories
+

{webdiff-1.0.0 → webdiff-1.1.0}/README.md

@@ -17,11 +17,12 @@ Features include:
 * Step back and forth through multiple files in a single diff
 * Rich support for image diffs
 
+<!-- These are absolute URLs so that they display on pypi.org -->
 <!-- This is `git webdiff 05157bba^..05157bba`, in this repo -->
-![Screenshot of webdiff in action](/images/webdiff.png)
+![Screenshot of webdiff in action](https://raw.githubusercontent.com/danvk/webdiff/master/images/webdiff.png)
 
 <!-- This is `git webdiff c80f969^..c80f969` in the dygraphs-dpxdt repo -->
-![Screenshot of image diffs](/images/webdiff-images.png)
+![Screenshot of image diffs](https://raw.githubusercontent.com/danvk/webdiff/master/images/webdiff-images.png)
 
 ## Installation
 
@@ -54,7 +55,7 @@ You can pass all the same arguments that you would to `git diff`, e.g.
 You can also use `webdiff` to view GitHub pull requests:
 
     webdiff https://github.com/owner/repo/pull/123
-    webdiff '#123'  # if you're in a git repo with a github remote
+    webdiff '#150'  # if you're in a git repo with a github remote
 
 This will download the files relevant to the Pull Request and run `webdiff`.
 
@@ -98,9 +99,7 @@ Options are:
 
 ## Development
 
-    python3 -m venv venv
-    source venv/bin/activate
-    pip install -r requirements.txt
+    poetry install
     cd ts
     yarn
     # see https://github.com/webpack/webpack/issues/14532
@@ -108,7 +107,7 @@ Options are:
 
 Then from the root directory:
 
-    PYTHONPATH=. ./webdiff/app.py testdata/dygraphsjs/{left,right}
+    poetry run webdiff/app.py testdata/dygraphsjs/{left,right}
 
 or to launch in debug mode:
 
@@ -118,43 +117,42 @@ or to launch in debug mode:
 
 To run the Python tests:
 
-    pytest
+    poetry run pytest
 
 To format the code, run:
 
-    ./scripts/black.sh
+    poetry run ruff format
     cd ts
     yarn prettier
 
 To debug `git webdiff`, run:
 
-    WEBDIFF_CONFIG=$(pwd)/testing.cfg ./webdiff/gitwebdiff.py
+    ./test-gitwebdiff.sh
+
+## Publishing
 
 To iterate on the PyPI package, run:
 
-    # from outside the webdiff virtualenv:
     pip3 uninstall webdiff
-
-    # from inside the webdiff virtualenv, adjust for current version
-    python setup.py sdist
-    mkdir /tmp/webdiff-test
-    cp dist/webdiff-?.?.?.tar.gz /tmp/webdiff-test
-
-    deactivate
-    cd /tmp/webdiff-test
-    pip3 install webdiff-?.?.?.tar.gz
+    poetry build
+    pip3 install dist/webdiff-?.?.?.tar.gz
 
 To publish to pypitest:
 
-    pip install --upgrade wheel setuptools twine
-    python setup.py sdist bdist_wheel
-    twine upload -r testpypi dist/*
+    poetry build
+    poetry publish -r testpypi
 
 And to the real pypi:
 
-    twine upload dist/*
+    poetry publish
+
+See [pypirc][] and [poetry][] docs for details on setting up tokens for pypi.
+
+Publication checklist. Do these from _outside_ the webdiff directory:
 
-See [pypirc][] docs for details on setting up `~/.pypirc`.
+- Run `webdiff webdiff/testdata/.../{left,right}`
+- Run `git webdiff 52aa15f^..52aa15f` in the codediff.js repo
+- Run `webdiff https://github.com/danvk/webdiff/pull/160`
 
 ## Implementation notes
 
@@ -183,3 +181,4 @@ There's one complication involving symlinks. `git difftool -d` may fill one of t
 [ImageMagick]: https://imagemagick.org/index.php
 [git config]: https://git-scm.com/docs/git-config
 [themes]: http://example.com
+[poetry]: https://python-poetry.org/docs/repositories/#publishable-repositories

webdiff-1.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "webdiff"
+version = "1.1.0"
+description = "Two-column web-based git difftool"
+license = "Apache-2.0"
+readme = "README.md"
+authors = [ "Dan Vanderkam <danvdk@gmail.com>" ]
+homepage = "https://github.com/danvk/webdiff/"
+repository = "https://github.com/danvk/webdiff/"
+keywords = [ "git", "difftool", "web" ]
+exclude = ["tests*"]
+classifiers = [
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Software Development :: Version Control"
+]
+# This is generated, so it's in .gitignore. But we need to package it.
+include = ["webdiff/static/js/file_diff.js"]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+binaryornot = "*"
+pillow = "*"
+PyGithub = "2.3.0"
+unidiff = "==0.7.4"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.1.3"
+ruff = "^0.4.6"
+
+[tool.poetry.scripts]
+webdiff = "webdiff.app:run"
+git-webdiff = "webdiff.gitwebdiff:run"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-format = true

webdiff-1.1.0/webdiff/app.py

@@ -0,0 +1,347 @@
+#!/usr/bin/env python
+"""Web-based file differ.
+
+For usage, see README.md.
+"""
+
+import dataclasses
+import json
+import logging
+import importlib.metadata
+import mimetypes
+import os
+import re
+import platform
+import socket
+import sys
+import threading
+import time
+import webbrowser
+from binaryornot.check import is_binary
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from urllib.parse import urlparse, parse_qs
+
+from webdiff import diff, util, argparser, options
+
+VERSION = importlib.metadata.version('webdiff')
+
+
+def determine_path():
+    """Borrowed from wxglade.py"""
+    try:
+        root = __file__
+        if os.path.islink(root):
+            root = os.path.realpath(root)
+        return os.path.dirname(os.path.abspath(root))
+    except Exception as e:
+        print(f"I'm sorry, but something is wrong. Error: {e}")
+        print('There is no __file__ variable. Please contact the author.')
+        sys.exit()
+
+
+GIT_CONFIG = {}
+DIFF = None
+PORT = None
+HOSTNAME = 'localhost'
+DEBUG = os.environ.get('DEBUG')
+WEBDIFF_DIR = determine_path()
+
+if DEBUG:
+    handler = logging.StreamHandler()
+    handler.setLevel(logging.DEBUG)
+    formatter = logging.Formatter(
+        '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    )
+    handler.setFormatter(formatter)
+
+    for logname in ['']:
+        log = logging.getLogger(logname)
+        log.setLevel(logging.DEBUG)
+        log.addHandler(handler)
+    logging.getLogger('github').setLevel(logging.ERROR)
+
+# GPT's alternative:
+# logging.basicConfig(level=logging.DEBUG if 'DEBUG' in os.environ else logging.INFO)
+# logger = logging.getLogger(__name__)
+
+
+class CustomHTTPRequestHandler(BaseHTTPRequestHandler):
+    def do_GET(self):
+        note_request_time()
+        path = urlparse(self.path).path.removesuffix('/') or '/'
+
+        if path == '/':
+            self.handle_index(0)
+        elif m := re.match(r'/(?P<idx>\d+)$', path):
+            self.handle_index(int(m['idx']))
+        elif path == '/favicon.ico':
+            self.handle_favicon()
+        elif path == '/theme.css':
+            self.handle_theme()
+        elif path.startswith('/static/'):
+            self.handle_static(path[1:])
+        elif m := re.match(r'/thick/(?P<idx>\d+)', path):
+            self.handle_thick(int(m['idx']))
+        elif m := re.match(r'/(?P<side>a|b)/image/(?P<path>.*)', path):
+            self.handle_image(m['side'], m['path'])
+        elif m := re.match(r'/pdiff/(?P<idx>\d+)', path):
+            self.handle_pdiff(int(m['idx']))
+        elif m := re.match(r'/pdiffbbox/(?P<idx>\d+)', path):
+            self.handle_pdiff_bbox(int(m['idx']))
+        else:
+            self.send_error(404, 'File not found')
+
+    def do_POST(self):
+        note_request_time()
+        path = urlparse(self.path).path.removesuffix('/') or '/'
+
+        content_length = int(self.headers['Content-Length'])
+        post_data = self.rfile.read(content_length)
+
+        if m := re.match(r'/(?P<side>a|b)/get_contents', path):
+            form_data = parse_qs(post_data.decode('utf-8'))
+            self.handle_get_contents(m['side'], form_data)
+        elif m := re.match(r'/diff/(?P<idx>\d+)', path):
+            payload = json.loads(post_data.decode('utf-8'))
+            self.handle_diff_ops(int(m['idx']), payload)
+        elif path == '/kill':
+            self.handle_kill()
+        else:
+            self.send_error(404, 'File not found')
+
+    def handle_index(self, idx: int):
+        pairs = diff.get_thin_list(DIFF)
+        self.send_response(200)
+        self.send_header('Content-Type', 'text/html; charset=utf-8')
+        self.end_headers()
+        with open(os.path.join(WEBDIFF_DIR, 'templates/file_diff.html'), 'r') as file:
+            html = file.read()
+            html = html.replace(
+                '{{data}}',
+                json.dumps(
+                    {
+                        'idx': idx,
+                        'has_magick': util.is_imagemagick_available(),
+                        'pairs': pairs,
+                        'git_config': GIT_CONFIG,
+                    },
+                    indent=2,
+                ),
+            )
+            self.wfile.write(html.encode('utf-8'))
+
+    def handle_thick(self, idx: int):
+        self.send_response_with_json(200, diff.get_thick_dict(DIFF[idx]))
+
+    def handle_favicon(self):
+        self.serve_static_file('static/img/favicon.ico', 'image/vnd.microsoft.icon')
+
+    def handle_theme(self):
+        theme = GIT_CONFIG['webdiff']['theme']
+        theme_dir = os.path.dirname(theme)
+        theme_file = os.path.basename(theme)
+        theme_path = os.path.join('static/css/themes', theme_dir, theme_file + '.css')
+        self.serve_static_file(theme_path, 'text/css')
+
+    def handle_static(self, path: str):
+        mime_type, _ = mimetypes.guess_type(path)
+        self.serve_static_file(path, mime_type)
+
+    def handle_image(self, side, path):
+        mime_type, _ = mimetypes.guess_type(path)
+        if not mime_type or not mime_type.startswith('image/'):
+            return self.send_response_with_json(400, {'error': 'wrong type'})
+
+        idx = diff.find_diff_index(DIFF, side, path)
+        if idx is None:
+            return self.send_response_with_json(400, {'error': 'not found'})
+
+        d = DIFF[idx]
+        abs_path = d.a_path if side == 'a' else d.b_path
+        self.serve_file(abs_path, mime_type)
+
+    def handle_pdiff(self, idx):
+        d = DIFF[idx]
+        try:
+            _, pdiff_image = util.generate_pdiff_image(d.a_path, d.b_path)
+            dilated_image_path = util.generate_dilated_pdiff_image(pdiff_image)
+            self.serve_static_file(dilated_image_path, 'image/png')
+        except util.ImageMagickNotAvailableError:
+            self.send_error(501, 'ImageMagick is not available')
+        except util.ImageMagickError as e:
+            self.send_error(501, f'ImageMagick error {e}')
+
+    def handle_pdiff_bbox(self, idx):
+        d = DIFF[idx]
+        try:
+            _, pdiff_image = util.generate_pdiff_image(d.a_path, d.b_path)
+            bbox = util.get_pdiff_bbox(pdiff_image)
+            self.send_response_with_json(200, bbox)
+        except util.ImageMagickNotAvailableError:
+            self.send_error(501, 'ImageMagick is not available')
+        except util.ImageMagickError as e:
+            self.send_error(501, f'ImageMagick error {e}')
+
+    def handle_get_contents(self, side: str, form_data: dict[str, list[str]]):
+        path = form_data.get('path', [''])[0]
+        if not path:
+            return self.send_response_with_json(400, {'error': 'incomplete'})
+
+        idx = diff.find_diff_index(DIFF, side, path)
+        if idx is None:
+            return self.send_response_with_json(400, {'error': 'not found'})
+
+        d = DIFF[idx]
+        abs_path = d.a_path if side == 'a' else d.b_path
+
+        try:
+            if is_binary(abs_path):
+                size = os.path.getsize(abs_path)
+                contents = f'Binary file ({size} bytes)'
+            else:
+                with open(abs_path, 'r') as file:
+                    contents = file.read()
+            self.send_response(200)
+            self.send_header('Content-Type', 'text/plain')
+            self.end_headers()
+            self.wfile.write(contents.encode('utf-8'))
+        except Exception as e:
+            self.send_response_with_json(500, {'error': str(e)})
+
+    def handle_diff_ops(self, idx: int, payload):
+        options = payload.get('options') or []
+        extra_args = GIT_CONFIG['webdiff']['extraFileDiffArgs']
+        if extra_args:
+            options += extra_args.split(' ')
+        diff_ops = [
+            dataclasses.asdict(op) for op in diff.get_diff_ops(DIFF[idx], options)
+        ]
+        self.send_response_with_json(200, diff_ops)
+
+    def handle_kill(self):
+        last_ms = LAST_REQUEST_MS
+
+        def shutdown():
+            if LAST_REQUEST_MS <= last_ms:  # subsequent requests abort shutdown
+                # See https://stackoverflow.com/a/19040484/388951
+                # and https://stackoverflow.com/q/4330111/388951
+                sys.stderr.write('Shutting down...\n')
+                threading.Thread(target=self.server.shutdown, daemon=True).start()
+            else:
+                logging.debug('Received subsequent request; canceling shutdown')
+
+        logging.debug('Received request to shut down; waiting 500ms for subsequent requests...')
+        threading.Timer(0.5, shutdown).start()
+        self.send_response(200)
+        self.send_header('Content-Type', 'text/plain')
+        self.end_headers()
+        self.wfile.write(b'Shutting down...')
+
+    def send_response_with_json(self, code, payload):
+        self.send_response(code)
+        self.send_header('Content-Type', 'application/json')
+        self.end_headers()
+        self.wfile.write(json.dumps(payload).encode('utf-8'))
+
+    def serve_static_file(self, file_path, mime_type):
+        self.serve_file(os.path.join(WEBDIFF_DIR, file_path), mime_type)
+
+    def serve_file(self, file_path, mime_type):
+        try:
+            with open(file_path, 'rb') as file:
+                contents = file.read()
+            self.send_response(200)
+            self.send_header('Content-Type', mime_type)
+            self.end_headers()
+            self.wfile.write(contents)
+        except Exception as e:
+            self.send_response_with_json(500, {'error': str(e)})
+
+    def log_request(self, *args):
+        if DEBUG:
+            super().log_request(*args)
+
+
+def note_request_time():
+    global LAST_REQUEST_MS
+    LAST_REQUEST_MS = time.time() * 1000
+
+
+def open_browser():
+    global PORT
+    global HOSTNAME
+    global GIT_CONFIG
+    if not os.environ.get('WEBDIFF_NO_OPEN') and GIT_CONFIG['webdiff']['openBrowser']:
+        webbrowser.open_new_tab('http://%s:%s' % (HOSTNAME, PORT))
+
+
+def usage_and_die():
+    sys.stderr.write(argparser.USAGE)
+    sys.exit(1)
+
+
+def pick_a_port(args, webdiff_config):
+    if 'port' in args:
+        return args['port']
+
+    env_port = os.environ.get('WEBDIFF_PORT')
+    if env_port:
+        return int(env_port)
+
+    # gitconfig
+    if webdiff_config['port'] != -1:
+        return webdiff_config['port']
+
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    sock.bind(('localhost', 0))
+    port = sock.getsockname()[1]
+    sock.close()
+    return port
+
+
+def run():
+    global DIFF, PORT, HOSTNAME, GIT_CONFIG
+    try:
+        parsed_args = argparser.parse(sys.argv[1:], VERSION)
+    except argparser.UsageError as e:
+        sys.stderr.write('Error: %s\n\n' % e)
+        usage_and_die()
+
+    GIT_CONFIG = options.get_config()
+    WEBDIFF_CONFIG = GIT_CONFIG['webdiff']
+    DIFF = argparser.diff_for_args(parsed_args, WEBDIFF_CONFIG)
+
+    if DEBUG:
+        sys.stderr.write('Invoked as: %s\n' % sys.argv)
+        sys.stderr.write('Args: %s\n' % parsed_args)
+        sys.stderr.write('Diff: %s\n' % DIFF)
+        sys.stderr.write('GitConfig: %s\n' % GIT_CONFIG)
+
+    PORT = pick_a_port(parsed_args, WEBDIFF_CONFIG)
+    HOSTNAME = (
+        parsed_args.get('host')
+        or os.environ.get('WEBDIFF_HOST')
+        or WEBDIFF_CONFIG['host']
+    )
+    if HOSTNAME == '<hostname>':
+        _hostname = platform.node()
+        # platform.node will return empty string if it can't find the hostname
+        if not _hostname:
+            sys.stderr.write('Warning: hostname could not be determined\n')
+        else:
+            HOSTNAME = _hostname
+
+    sys.stderr.write(
+        """Serving diffs on http://%s:%s
+Close the browser tab or hit Ctrl-C when you're done.
+"""
+        % (HOSTNAME, PORT)
+    )
+    threading.Timer(0.1, open_browser).start()
+
+    server = HTTPServer((HOSTNAME, PORT), CustomHTTPRequestHandler)
+    server.serve_forever()
+
+
+if __name__ == '__main__':
+    run()