pyDiffTools 0.1.8__py3-none-any.whl

pydifftools/command_registry.py

@@ -0,0 +1,65 @@
+import argparse
+import inspect
+
+
+class CommandRegistrationError(Exception):
+    """Exception raised when attempting to register a duplicate subcommand."""
+
+# Registry that stores all subcommands made available to the CLI dispatcher.
+_COMMAND_SPECS = {}
+
+
+def register_command(help_text, description=None, help=None):
+    """Register a command handler for the CLI dispatcher."""
+
+    def decorator(func):
+        name = func.__name__.replace("_", "-")
+        if name in _COMMAND_SPECS:
+            raise CommandRegistrationError(
+                f"Command '{name}' already registered"
+            )
+        _COMMAND_SPECS[name] = {
+            "handler": func,
+            "help": help_text.strip(),
+            "description": (
+                description if description is not None else help_text
+            ).strip(),
+            "arguments": [],
+        }
+        signature = inspect.signature(func)
+        argument_help = help if help is not None else {}
+        for parameter in signature.parameters.values():
+            if parameter.kind in [
+                inspect.Parameter.VAR_POSITIONAL,
+                inspect.Parameter.VAR_KEYWORD,
+            ]:
+                continue
+            flags = []
+            kwargs = {}
+            if parameter.default is inspect._empty:
+                flags.append(parameter.name)
+                if parameter.name == "arguments":
+                    # Most commands accept a raw list of trailing arguments.
+                    kwargs["nargs"] = argparse.REMAINDER
+                    kwargs["help"] = argparse.SUPPRESS
+            else:
+                # Single-letter keywords use a short flag; everything else uses
+                # the long two-dash style expected by the CLI.
+                dash_prefix = "-" if len(parameter.name) == 1 else "--"
+                flags.append(dash_prefix + parameter.name.replace("_", "-"))
+                kwargs["default"] = parameter.default
+                if isinstance(parameter.default, bool):
+                    # Boolean flags toggle on or off without needing a value.
+                    kwargs["action"] = (
+                        "store_false" if parameter.default else "store_true"
+                    )
+                elif parameter.default is not None:
+                    kwargs["type"] = type(parameter.default)
+            if parameter.name in argument_help:
+                kwargs["help"] = argument_help[parameter.name].strip()
+            _COMMAND_SPECS[name]["arguments"].append(
+                {"flags": flags, "kwargs": kwargs}
+            )
+        return func
+
+    return decorator

pydifftools/comment_functions.py

@@ -0,0 +1,39 @@
+def comment_definition(commandname, name, comment_text):
+    return r"\newcommand{\%s}{%s}" % (commandname, comment_text) + "\n"
+
+
+def generate_alphabetnumber(x):
+    if x < 26:
+        return chr(ord("a") + x)
+    else:
+        higher_places = x // 26
+        return generate_alphabetnumber(
+            higher_places - 1
+        ) + generate_alphabetnumber(x - higher_places * 26)
+
+
+def matchingbrackets(content, startpoint, bracket_type):
+    if bracket_type == "(":
+        opening = "("
+        closing = ")"
+    elif bracket_type == "[":
+        opening = "["
+        closing = "]"
+    elif bracket_type == "{":
+        opening = "{"
+        closing = "}"
+    else:
+        raise ValueError("I didn't understand the type of bracket!")
+    first = (
+        False  # of course, don't want to break until we've found at least one
+    )
+    level = 0
+    for j in range(startpoint, len(content)):
+        if content[j] == opening:
+            if level == 0:
+                first = j
+            level += 1
+        if content[j] == closing:
+            level -= 1
+        if level == 0 and first:
+            return first, j

pydifftools/continuous.py

@@ -0,0 +1,194 @@
+"""Continuous Pandoc build utility that requires geckodriver."""
+
+import time
+import subprocess
+import sys
+import os
+import re
+import shutil
+from watchdog.events import FileSystemEventHandler
+from watchdog.observers import Observer
+from .command_registry import register_command
+
+
+def run_pandoc(filename, html_file):
+    # Pandoc and pandoc-crossref must be installed for HTML rendering.
+    if shutil.which("pandoc") is None:
+        raise RuntimeError(
+            "Pandoc must be installed to render HTML output. Install pandoc"
+            " so the 'pandoc' executable is available on your PATH."
+        )
+    if shutil.which("pandoc-crossref") is None:
+        raise RuntimeError(
+            "Pandoc-crossref must be installed to render HTML output. Install"
+            " pandoc-crossref so the 'pandoc-crossref' executable is available"
+            " on your PATH."
+        )
+    if os.path.exists("MathJax-3.1.2"):
+        has_local_jax = True
+    else:
+        has_local_jax = False
+        print("you don't have a local copy of mathjax.  You could get it with")
+        print(
+            "wget https://github.com/mathjax/MathJax/archive/"
+            + "refs/tags/3.1.2.zip"
+        )
+        print("and then unzip")
+    current_dir = os.getcwd()
+    localfiles = {}
+    for k in ["csl", "bib"]:
+        localfiles[k] = [
+            f for f in os.listdir(current_dir) if f.endswith("." + k)
+        ]
+        if len(localfiles[k]) == 1:
+            localfiles[k] = localfiles[k][0]
+        else:
+            raise ValueError(
+                f"You have more than one (or no) {k} file in this directory!"
+                " Get rid of all but one! of "
+                + "and".join(localfiles[k])
+            )
+    command = [
+        "pandoc",
+        "--bibliography",
+        localfiles["bib"],
+        f"--csl={localfiles['csl']}",
+        "--filter",
+        "pandoc-crossref",
+        "--citeproc",
+        "--mathjax",
+        "--number-sections",
+        "--toc",
+        "-s",
+        "-o",
+        html_file,
+        filename,
+    ]
+    # command = ['pandoc', '-s', '--mathjax', '-o', html_file, filename]
+    print("running:", " ".join(command))
+    subprocess.run(
+        command,
+    )
+    print("running:\n", command)
+    if has_local_jax:
+        # {{{ for slow internet connection, remove remote files
+        with open(html_file, encoding="utf-8") as fp:
+            text = fp.read()
+        patterns = [
+            r"<script.{0,20}?cdn\.jsdeli.{0,20}?mathjax.{0,60}?script>",
+            r"<script.{0,20}?https...polyfill.{0,60}?script>",
+        ]
+        for j in patterns:
+            text = re.sub(j, "", text, flags=re.DOTALL)
+        with open(html_file, "w", encoding="utf-8") as fp:
+            fp.write(text)
+        # }}}
+    with open(html_file, encoding="utf-8") as fp:
+        text = fp.read()
+    style_block = (
+        '\n<style id="pydifftools-hide-low-headers">\n'
+        "h5, h6 { display: none; }\n"
+        "</style>\n"
+    )
+    if style_block not in text:
+        # hide organizational headers while keeping higher levels visible
+        if "</head>" in text:
+            text = text.replace("</head>", style_block + "</head>", 1)
+        else:
+            text = style_block + text
+        with open(html_file, "w", encoding="utf-8") as fp:
+            fp.write(text)
+    return
+
+
+class Handler(FileSystemEventHandler):
+    def __init__(self, filename, observer):
+        self.observer = observer
+        self.filename = filename
+        self.html_file = filename.rsplit(".", 1)[0] + ".html"
+        self.init_firefox()
+
+    def init_firefox(self):
+        # apparently, selenium breaks stdin/out for tests, so it must be
+        # imported here
+        from selenium import webdriver
+
+        self.firefox = webdriver.Chrome()
+        run_pandoc(self.filename, self.html_file)
+        if not os.path.exists(self.html_file):
+            print("html doesn't exist")
+        self.append_autorefresh()
+        self.firefox.get("file://" + os.path.abspath(self.html_file))
+
+    def on_modified(self, event):
+        from selenium.common.exceptions import WebDriverException
+
+        if os.path.normpath(
+            os.path.abspath(event.src_path)
+        ) == os.path.normpath(os.path.abspath(self.filename)):
+            run_pandoc(self.filename, self.html_file)
+            self.append_autorefresh()
+            try:
+                self.firefox.refresh()
+            except WebDriverException:
+                print(
+                    "I'm quitting!! You probably suspended the computer, which"
+                    " seems to freak selenium out.  Just restart"
+                )
+                self.firefox.quit()
+                self.init_firefox()
+
+    def append_autorefresh(self):
+        with open(self.html_file, "r", encoding="utf-8") as fp:
+            all_data = fp.read()
+        all_data = all_data.replace(
+            "</head>",
+            """
+    <script id="MathJax-script" async src="MathJax-3.1.2/es5/tex-mml-chtml.js"\
+></script>
+    <script>
+        // When the page is about to be unloaded, save the current scroll\
+position
+        window.addEventListener('beforeunload', function() {
+            sessionStorage.setItem('scrollPosition', window.scrollY);
+        });
+
+        // When the page has loaded, scroll to the previous scroll position
+        window.addEventListener('load', function() {
+            var scrollPosition = sessionStorage.getItem('scrollPosition');
+            if (scrollPosition) {
+                window.scrollTo(0, scrollPosition);
+                sessionStorage.removeItem('scrollPosition');
+            }
+        });
+    </script>
+</head>
+    """,
+        )
+        with open(self.html_file, "w", encoding="utf-8") as fp:
+            fp.write(all_data)
+
+
+@register_command(
+    "continuous pandoc build.  Like latexmk, but for markdown!",
+    help={"filename": "Markdown or TeX file to watch for changes"},
+)
+def cpb(filename):
+    observer = Observer()
+    event_handler = Handler(filename, observer)
+    observer.schedule(event_handler, path=".", recursive=False)
+    observer.start()
+
+    try:
+        while True:
+            time.sleep(1)
+    except KeyboardInterrupt:
+        observer.stop()
+
+    observer.join()
+
+
+if __name__ == "__main__":
+    filename = sys.argv[1]
+    cpb(filename)
+    # Open the HTML file in the default web browser

pydifftools/copy_files.py

@@ -0,0 +1,75 @@
+# from https://tex.stackexchange.com/questions/24542/create-list-of-all-external-files-used-by-master-latex-document
+"""Copy figures used by document."""
+import os
+import shutil
+from pathlib import Path, PurePosixPath
+import subprocess
+import sys
+
+
+def copy_image_files(ROOT_TEX, project_name, TARGET_DIR, include_suppinfo):
+    all_files = []
+    with open(ROOT_TEX + ".tex", "r") as fp:
+        alltext = fp.read()
+    if r"\RequirePackage{snapshot}" not in alltext:
+        raise RuntimeError(
+            "You haven't called \\RequirePackage{snapshot} in the root tex file.  I can't do my thing without that!"
+        )
+    with open(ROOT_TEX + ".dep", "r") as f:
+        for line in f:
+            if "*{file}" in line:
+                value = line.split("{")[2].split("}")
+                source = value[0]
+                _, e = os.path.splitext(source)
+                if len(e) == 0 and os.path.exists(source + ".tex"):
+                    all_files.append(source + ".tex")
+                    print("found", source + ".tex")
+                elif os.path.exists(source):
+                    all_files.append(source)
+            elif "*{package}" in line:
+                value = line.split("{")[2].split("}")
+                source = value[0]
+                _, e = os.path.splitext(source)
+                if len(e) == 0 and os.path.exists(source + ".sty"):
+                    all_files.append(source + ".sty")
+                    print("found", source + ".sty")
+                elif os.path.exists(source):
+                    all_files.append(source)
+            else:
+                continue
+    os.makedirs(TARGET_DIR, exist_ok=True)
+    if include_suppinfo:
+        all_files.append("suppinfo.pdf")
+        all_files.append("suppinfo.aux")
+    for source in all_files:
+        d, f = os.path.split(source)
+        b, _ = os.path.splitext(source)
+        if b == ROOT_TEX:
+            f = f.replace(ROOT_TEX, "ms")
+        newpath = TARGET_DIR / d / f
+        print("copying", source, PurePosixPath(newpath))
+        if len(d) > 0:
+            print("going to make", newpath.parents[0])
+            os.makedirs(newpath.parents[0], exist_ok=True)
+        shutil.copy(source, PurePosixPath(newpath))
+    shutil.copy(ROOT_TEX + ".tex", os.path.join(TARGET_DIR, "ms.tex"))
+
+
+if __name__ == "__main__":
+    copy_image_files()
+    os.chdir(Path.cwd().parent)
+    output_filename = f"{project_name}_forarxiv.tgz"
+    # create tar process
+    tar = subprocess.Popen(
+        ["tar", "cf", "-", TARGET_DIR.name], stdout=subprocess.PIPE
+    )
+    # create gzip process, using tar's stdout as its stdin
+    gzip = subprocess.Popen(
+        ["gzip", "-9"], stdin=tar.stdout, stdout=subprocess.PIPE
+    )
+    # close tar's stdout so it doesn't hang around waiting for input
+    tar.stdout.close()
+    # write gzip's stdout to a file
+    with open(output_filename, "wb") as fp:
+        shutil.copyfileobj(gzip.stdout, fp)
+    gzip.stdout.close()

pydifftools/diff-doc.js

@@ -0,0 +1,193 @@
+//
+// TortoiseSVN Diff script for Word Doc files
+//
+// Copyright (C) 2004-2008 the TortoiseSVN team
+// This file is distributed under the same license as TortoiseSVN
+//
+// Last commit by:
+// $Author$
+// $Date$
+// $Rev$
+//
+// Authors:
+// Jared Silva, 2008
+// Davide Orlandi and Hans-Emil Skogh, 2005
+//
+
+var objArgs,num,sBaseDoc,sNewDoc,sTempDoc,objScript,word,destination;
+// Microsoft Office versions for Microsoft Windows OS
+var vOffice2000 = 9;
+var vOffice2002 = 10;
+var vOffice2003 = 11;
+var vOffice2007 = 12;
+// WdCompareTarget
+var wdCompareTargetSelected = 0;
+var wdCompareTargetCurrent = 1;
+var wdCompareTargetNew = 2;
+// WdViewType
+var wdMasterView = 5;
+var wdNormalView = 1;
+var wdOutlineView = 2;
+// WdSaveOptions
+var wdDoNotSaveChanges = 0;
+var wdPromptToSaveChanges = -2;
+var wdSaveChanges = -1;
+
+objArgs = WScript.Arguments;
+num = objArgs.length;
+if (num < 2)
+{
+   WScript.Echo("Usage: [CScript | WScript] diff-doc.js base.doc new.doc");
+   WScript.Quit(1);
+}
+
+sBaseDoc = objArgs(0);
+sNewDoc = objArgs(1);
+
+objScript = new ActiveXObject("Scripting.FileSystemObject");
+if ( ! objScript.FileExists(sBaseDoc))
+{
+    WScript.Echo("File " + sBaseDoc + " does not exist.  Cannot compare the documents.");
+    WScript.Quit(1);
+}
+if ( ! objScript.FileExists(sNewDoc))
+{
+    WScript.Echo("File " + sNewDoc + " does not exist.  Cannot compare the documents.");
+    WScript.Quit(1);
+}
+
+try
+{
+   word = WScript.CreateObject("Word.Application");
+}
+catch(e)
+{
+	// before giving up, try with OpenOffice
+	try
+	{
+		var OO;
+		OO = WScript.CreateObject("com.sun.star.ServiceManager");
+	}
+	catch(e)
+	{
+		WScript.Echo("You must have Microsoft Word or OpenOffice installed to perform this operation.");
+		WScript.Quit(1);
+	}
+	// yes, OO is installed - do the diff with that one instead
+	var objFile = objScript.GetFile(sNewDoc);
+	if ((objFile.Attributes & 1)==1)
+	{
+		// reset the readonly attribute
+		objFile.Attributes = objFile.Attributes & (~1);
+	}
+	//Create the DesktopSet 
+	var objDesktop = OO.createInstance("com.sun.star.frame.Desktop");
+	var objUriTranslator = OO.createInstance("com.sun.star.uri.ExternalUriReferenceTranslator");
+	//Adjust the paths for OO
+	sBaseDoc = sBaseDoc.replace(/\\/g, "/");
+	sBaseDoc = sBaseDoc.replace(/:/g, "|");
+	sBaseDoc = sBaseDoc.replace(/ /g, "%20");
+	sBaseDoc="file:///" + sBaseDoc;
+	sBaseDoc=objUriTranslator.translateToInternal(sBaseDoc);
+	sNewDoc = sNewDoc.replace(/\\/g, "/");
+	sNewDoc = sNewDoc.replace(/:/g, "|");
+	sNewDoc = sNewDoc.replace(/ /g, "%20");
+	sNewDoc="file:///" + sNewDoc;
+	sNewDoc=objUriTranslator.translateToInternal(sNewDoc);
+
+	//Open the %base document
+	var oPropertyValue = new Array();
+	oPropertyValue[0] = OO.Bridge_GetStruct("com.sun.star.beans.PropertyValue");
+	oPropertyValue[0].Name = "ShowTrackedChanges";
+	oPropertyValue[0].Value = true;
+	var objDocument=objDesktop.loadComponentFromURL(sNewDoc,"_blank", 0, oPropertyValue);
+	
+	//Set the frame
+	var Frame = objDesktop.getCurrentFrame();
+	
+	var dispatcher=OO.CreateInstance("com.sun.star.frame.DispatchHelper");
+	
+	//Execute the comparison
+	dispatcher.executeDispatch(Frame, ".uno:ShowTrackedChanges", "", 0, oPropertyValue);
+	oPropertyValue[0].Name = "URL";
+	oPropertyValue[0].Value = sBaseDoc;
+	dispatcher.executeDispatch(Frame, ".uno:CompareDocuments", "", 0, oPropertyValue);
+	WScript.Quit(0);
+}
+
+if (parseInt(word.Version) >= vOffice2007)
+{
+	sTempDoc = sNewDoc;
+	sNewDoc = sBaseDoc;
+	sBaseDoc = sTempDoc;
+}
+
+objScript = null;
+
+word.visible = true;
+
+// Open the new document
+try
+{
+    destination = word.Documents.Open(sNewDoc, true, true);
+}
+catch(e)
+{
+    WScript.Echo("Error opening " + sNewDoc);
+    // Quit
+    WScript.Quit(1);
+}
+
+// If the Type property returns either wdOutlineView or wdMasterView and the Count property returns zero, the current document is an outline.
+if (((destination.ActiveWindow.View.Type == wdOutlineView) || (destination.ActiveWindow.View.Type == wdMasterView)) && (destination.Subdocuments.Count == 0))
+{
+    // Change the Type property of the current document to normal
+    destination.ActiveWindow.View.Type = wdNormalView;
+}
+
+// Compare to the base document
+if (parseInt(word.Version) <= vOffice2000)
+{
+    // Compare for Office 2000 and earlier
+    try
+    {
+        destination.Compare(sBaseDoc);
+    }
+    catch(e)
+    {
+        WScript.Echo("Error comparing " + sBaseDoc + " and " + sNewDoc);
+        // Quit
+        WScript.Quit(1);
+    }
+}
+else
+{
+    // Compare for Office XP (2002) and later
+    try
+    {
+        destination.Compare(sBaseDoc, "Comparison", wdCompareTargetNew, true, true);
+    }
+    catch(e)
+    {
+        WScript.Echo("Error comparing " + sBaseDoc + " and " + sNewDoc);
+        // Close the first document and quit
+        destination.Close(wdDoNotSaveChanges);
+        WScript.Quit(1);
+    }
+}
+    
+// Show the comparison result
+if (parseInt(word.Version) < vOffice2007)
+{
+	word.ActiveDocument.Windows(1).Visible = 1;
+}
+    
+// Mark the comparison document as saved to prevent the annoying
+// "Save as" dialog from appearing.
+word.ActiveDocument.Saved = 1;
+    
+// Close the first document
+if (parseInt(word.Version) >= vOffice2002)
+{
+    destination.Close(wdDoNotSaveChanges);
+}