pyDiffTools 0.1.7__tar.gz → 0.1.10__tar.gz

{pydifftools-0.1.7/pyDiffTools.egg-info → pydifftools-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.7
+Version: 0.1.10
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.7 → pydifftools-0.1.10/pyDiffTools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.7
+Version: 0.1.10
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.7 → pydifftools-0.1.10}/pyDiffTools.egg-info/SOURCES.txt

@@ -64,6 +64,7 @@ pydifftools/searchacro.py
 pydifftools/separate_comments.py
 pydifftools/split_conflict.py
 pydifftools/unseparate_comments.py
+pydifftools/update_check.py
 pydifftools/wrap_sentences.py
 pydifftools/xml2xlsx.vbs
 pydifftools/flowchart/__init__.py
@@ -73,4 +74,6 @@ pydifftools/flowchart/watch_graph.py
 pydifftools/notebook/__init__.py
 pydifftools/notebook/fast_build.py
 pydifftools/notebook/tex_to_qmd.py
-tests/test_rrng.py
+tests/test_rrng.py
+tests/test_tex_to_qmd.py
+tests/test_update_check.py

{pydifftools-0.1.7 → pydifftools-0.1.10}/pydifftools/__init__.py

@@ -7,4 +7,5 @@ __all__ = [
     "wrap_sentences",
     "rearrange_tex",
     "outline",
+    "update_check",
 ]

{pydifftools-0.1.7 → pydifftools-0.1.10}/pydifftools/command_line.py

@@ -10,11 +10,13 @@ import re
 import nbformat
 import difflib
 import shutil
+import importlib.util
 from pathlib import Path
 from . import (
     match_spaces,
     split_conflict,
     outline,
+    update_check,
 )
 from .continuous import cpb
 from .wrap_sentences import wr as wrap_sentences_wr  # registers wrap command
@@ -25,12 +27,31 @@ from .copy_files import copy_image_files
 from .searchacro import replace_acros
 from .rearrange_tex import run as rearrange_tex_run
 from .flowchart.watch_graph import wgrph
+from .flowchart.graph import load_graph_yaml
 from .notebook.tex_to_qmd import tex2qmd
 from .notebook.fast_build import qmdb, qmdinit
 
-
 from .command_registry import _COMMAND_SPECS, register_command
 
+_ARGCOMPLETE_SPEC = importlib.util.find_spec("argcomplete")
+if (
+    _ARGCOMPLETE_SPEC is not None
+    and _ARGCOMPLETE_SPEC.submodule_search_locations is not None
+):
+    _ARGCOMPLETE_COMPLETERS_SPEC = importlib.util.find_spec(
+        "argcomplete.completers"
+    )
+else:
+    _ARGCOMPLETE_COMPLETERS_SPEC = None
+if _ARGCOMPLETE_SPEC is not None:
+    import argcomplete
+else:
+    argcomplete = None
+if _ARGCOMPLETE_COMPLETERS_SPEC is not None:
+    from argcomplete.completers import FilesCompleter
+else:
+    FilesCompleter = None
+
 
 def printed_exec(cmd):
     print("about to execute:\n", cmd)
@@ -57,6 +78,37 @@ def get_data(path):
     return os.path.join(_ROOT, path)
 
 
+def wgrph_task_completer(prefix, parsed_args, **kwargs):
+    # Provide case-insensitive task name completions for wgrph -t.
+    if parsed_args is None or not hasattr(parsed_args, "yaml"):
+        return []
+    yaml_path = Path(parsed_args.yaml)
+    if not yaml_path.exists():
+        return []
+    try:
+        data = load_graph_yaml(str(yaml_path))
+    except Exception:
+        return []
+    if "nodes" not in data:
+        return []
+    prefix_lower = prefix.lower()
+    matches = []
+    for name in data["nodes"]:
+        if (
+            "style" in data["nodes"][name]
+            and data["nodes"][name]["style"] == "completed"
+        ):
+            continue
+        if name.lower().startswith(prefix_lower):
+            # Preserve case-insensitive matches even when the typed prefix
+            # doesn't match case so argcomplete still accepts the suggestion.
+            if name.startswith(prefix):
+                matches.append(name)
+            else:
+                matches.append(prefix + name[len(prefix) :])
+    return matches
+
+
 def recursive_include_search(directory, basename, does_it_input):
     with open(
         os.path.join(directory, basename + ".tex"), "r", encoding="utf-8"
@@ -119,7 +171,8 @@ def look_for_pdf(directory, origbasename):
 def nb2py(arguments):
     assert arguments[0].endswith(".ipynb"), (
         "this is supposed to be called with a .ipynb file argument! (arguments"
-        " are %s)" % repr(arguments)
+        " are %s)"
+        % repr(arguments)
     )
     nb = nbformat.read(arguments[0], nbformat.NO_CONVERT)
     last_was_markdown = False
@@ -176,7 +229,8 @@ def py2nb(arguments):
     assert len(arguments) == 1, "py2nb should only be called with one argument"
     assert arguments[0].endswith(".py"), (
         "this is supposed to be called with a .py file argument! (arguments"
-        " are %s)" % repr(arguments)
+        " are %s)"
+        % repr(arguments)
     )
     with open(arguments[0], encoding="utf-8") as fpin:
         text = fpin.read()
@@ -232,15 +286,13 @@ def py2nb(arguments):
     nbook = nbformat.v3.reads_py(text)
 
     nbook = nbformat.v4.upgrade(nbook)  # Upgrade nbformat.v3 to nbformat.v4
-    nbook.metadata.update(
-        {
-            "kernelspec": {
-                "name": "Python [Anaconda2]",
-                "display_name": "Python [Anaconda2]",
-                "language": "python",
-            }
+    nbook.metadata.update({
+        "kernelspec": {
+            "name": "Python [Anaconda2]",
+            "display_name": "Python [Anaconda2]",
+            "language": "python",
         }
-    )
+    })
 
     jsonform = nbformat.v4.writes(nbook) + "\n"
     with open(
@@ -687,15 +739,6 @@ def pmd(arguments):
     p1.wait()
 
 
-@register_command(
-    "Save tex file as outline, with filename_outline.pickle storing content"
-    " and filename_outline.md giving outline."
-)
-def xo(arguments):
-    assert len(arguments) == 1
-    outline.extract_outline(arguments[0])
-
-
 def build_parser():
     parser = argparse.ArgumentParser()
     subparsers = parser.add_subparsers(dest="command")
@@ -713,7 +756,19 @@ def build_parser():
         for argument in arguments:
             flags = argument["flags"]
             kwargs = dict(argument["kwargs"])
-            subparser.add_argument(*flags, **kwargs)
+            action = subparser.add_argument(*flags, **kwargs)
+            if (
+                FilesCompleter is not None
+                and name == "wgrph"
+                and action.dest == "yaml"
+            ):
+                # Provide YAML-only completions for the flowchart watcher.
+                action.completer = FilesCompleter(
+                    allowednames=["*.yaml", "*.yml"]
+                )
+            if name == "wgrph" and action.dest == "t":
+                # Offer case-insensitive completions for incomplete task names.
+                action.completer = wgrph_task_completer
         subparser.set_defaults(_handler=spec["handler"])
     return parser
 
@@ -721,7 +776,29 @@ def build_parser():
 def main(argv=None):
     if argv is None:
         argv = sys.argv[1:]
+    # Run the PyPI update check once per UTC day so users see a notice but
+    # startup stays fast when offline. The date is stored in the
+    # PYDIFFTOOLS_UPDATE_CHECK_LAST_RAN_UTC_DATE environment variable.
+    today = time.strftime("%Y-%m-%d", time.gmtime())
+    already_checked_today = (
+        "PYDIFFTOOLS_UPDATE_CHECK_LAST_RAN_UTC_DATE" in os.environ
+        and os.environ["PYDIFFTOOLS_UPDATE_CHECK_LAST_RAN_UTC_DATE"] == today
+    )
+    if not already_checked_today:
+        os.environ["PYDIFFTOOLS_UPDATE_CHECK_LAST_RAN_UTC_DATE"] = today
+        current_version, latest_version, is_outdated = (
+            update_check.check_update("pyDiffTools")
+        )
+        if is_outdated and latest_version is not None:
+            print(
+                "A new pyDiffTools version is available "
+                f"(installed {current_version}, latest {latest_version}).",
+                file=sys.stderr,
+            )
     parser = build_parser()
+    if argcomplete is not None:
+        # Enable argcomplete integration when the dependency is available.
+        argcomplete.autocomplete(parser)
     if not argv:
         parser.print_help()
         return

{pydifftools-0.1.7 → pydifftools-0.1.10}/pydifftools/continuous.py

@@ -5,14 +5,25 @@ import subprocess
 import sys
 import os
 import re
-import selenium
-from selenium import webdriver
+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:
@@ -34,7 +45,8 @@ def run_pandoc(filename, html_file):
         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])
+                " Get rid of all but one! of "
+                + "and".join(localfiles[k])
             )
     command = [
         "pandoc",
@@ -71,6 +83,21 @@ def run_pandoc(filename, html_file):
         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
 
 
@@ -82,6 +109,10 @@ class Handler(FileSystemEventHandler):
         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):
@@ -90,6 +121,8 @@ class Handler(FileSystemEventHandler):
         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)):
@@ -97,7 +130,7 @@ class Handler(FileSystemEventHandler):
             self.append_autorefresh()
             try:
                 self.firefox.refresh()
-            except selenium.common.exceptions.WebDriverException:
+            except WebDriverException:
                 print(
                     "I'm quitting!! You probably suspended the computer, which"
                     " seems to freak selenium out.  Just restart"
@@ -136,7 +169,11 @@ position
             fp.write(all_data)
 
 
-def watch(filename):
+@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)
@@ -151,15 +188,7 @@ def watch(filename):
     observer.join()
 
 
-@register_command(
-    "continuous pandoc build.  Like latexmk, but for markdown!",
-    help={"filename": "Markdown or TeX file to watch for changes"},
-)
-def cpb(filename):
-    watch(filename)
-
-
 if __name__ == "__main__":
     filename = sys.argv[1]
-    watch(filename)
+    cpb(filename)
     # Open the HTML file in the default web browser

{pydifftools-0.1.7 → pydifftools-0.1.10}/pydifftools/doc_contents.py

@@ -3,21 +3,41 @@ from fuzzywuzzy import process
 
 
 class doc_contents_class(object):
-    prefix = {
-        "section": "",
-        "subsection": "\t",
-        "subsubsection": 2 * "\t",
-        "paragraph": 3 * "\t",
-    }
-    inv_prefix = {v: k for k, v in prefix.items()}
-
-    def __init__(self):
+    def __init__(self, format_type="latex"):
         self.contents = OrderedDict()
         self.contents["header"] = ""
         self.types = {}
         self.types["header"] = "header"
         self._reordering_started = False
         self._aliases = {}
+        self._processed_titles = []
+        self.set_format(format_type)
+
+    def set_format(self, format_type):
+        if format_type == "markdown":
+            # markdown levels go deeper, so include subparagraph mapping
+            self.level_numbers = {
+                "section": 1,
+                "subsection": 2,
+                "subsubsection": 3,
+                "paragraph": 4,
+                "subparagraph": 5,
+            }
+        else:
+            # default to latex behavior
+            self.level_numbers = {
+                "section": 1,
+                "subsection": 2,
+                "subsubsection": 3,
+                "paragraph": 4,
+                "subparagraph": 5,
+            }
+        # map indentation back to section type for outline parsing
+        self.inv_prefix = {
+            (level - 1) * "\t": section
+            for section, level in self.level_numbers.items()
+        }
+        self.format_type = format_type
 
     def start_sec(self, thistype, thistitle):
         assert thistitle not in self.contents.keys(), (
@@ -31,8 +51,13 @@ class doc_contents_class(object):
         "set the info from a pickle"
         self.contents = d["contents"]
         self.types = d["types"]
-        self._aliases = {} # doesn't exist, but still needed
+        self._aliases = {}  # doesn't exist, but still needed
         self._reordering_started = False
+        self._processed_titles = []
+        if "format_type" in d:
+            self.set_format(d["format_type"])
+        else:
+            self.set_format("latex")
         return
 
     def __getstate__(self):
@@ -40,6 +65,7 @@ class doc_contents_class(object):
         return {
             "contents": self.contents,
             "types": self.types,
+            "format_type": self.format_type,
         }
 
     def __iadd__(self, value):
@@ -48,16 +74,23 @@ class doc_contents_class(object):
 
     def __str__(self):
         if len(self._processed_titles) > 0:
-            raise ValueError("the following section"
-            " titles were not utilized -- this program is"
-            " for reordering, not dropping!:\n"+str(self._processed_titles))
+            raise ValueError(
+                "the following section"
+                " titles were not utilized -- this program is"
+                " for reordering, not dropping!:\n"
+                + str(self._processed_titles)
+            )
         retval = ""
         for j in self.contents.keys():
             if self.types[j] != "header":
                 new_name = j
                 if j in self._aliases.keys():
                     new_name = self._aliases[j]
-                retval += f"\\{self.types[j]}{{{new_name}}}"
+                if self.format_type == "markdown":
+                    retval += "#" * self.level_numbers[self.types[j]]
+                    retval += f" {new_name}\n\n"
+                else:
+                    retval += f"\\{self.types[j]}{{{new_name}}}"
             retval += f"{self.contents[j]}"
         return retval
 
@@ -66,15 +99,17 @@ class doc_contents_class(object):
         retval = []
         for j in self.contents.keys():
             if self.types[j] != "header":
-                thistitle = (self.prefix[self.types[j]] + "\t").join(j.split("\n"))
-                retval.append(self.prefix[self.types[j]] + "*\t" + thistitle)
+                indent = (self.level_numbers[self.types[j]] - 1) * "\t"
+                thistitle = (indent + "\t").join(j.split("\n"))
+                retval.append(indent + "*\t" + thistitle)
         self._reordering_started = False
         return "\n".join(retval)
 
     def outline_in_order(self, thisline):
         if not self._reordering_started:
-            self._processed_titles = [j for j in self.contents.keys()
-                    if self.types[j] != 'header']
+            self._processed_titles = [
+                j for j in self.contents.keys() if self.types[j] != "header"
+            ]
             self._reordering_started = True
         ilevel = 0
         spacelevel = 0
@@ -95,10 +130,15 @@ class doc_contents_class(object):
         if not hitmarker:
             raise ValueError("somehow, there wasn't a * marker!")
         if title not in self.contents.keys():
-            best_match, match_quality = process.extractOne(title, self.contents.keys())
-            yesorno = input(f"didn't find\n\t{title}\nin keys, maybe you want\n\t{best_match}\nsay y or n")
-            if yesorno == 'y':
-                self._aliases[best_match] = title # will be replaced later
+            best_match, match_quality = process.extractOne(
+                title, self.contents.keys()
+            )
+            yesorno = input(
+                f"didn't find\n\t{title}\nin keys, maybe you"
+                f" want\n\t{best_match}\nsay y or n"
+            )
+            if yesorno == "y":
+                self._aliases[best_match] = title  # will be replaced later
                 title = best_match
             else:
                 raise ValueError("problem with replacement")