Patchwork D8892: templater: replace templatepath() with function that also opens the file

login
register
mail settings
Submitter phabricator
Date Aug. 5, 2020, 4:27 p.m.
Message ID <differential-rev-PHID-DREV-efts66ygwct6sp3gxtfz-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/46993/
State Superseded
Headers show

Comments

phabricator - Aug. 5, 2020, 4:27 p.m.
martinvonz created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  For frozen binaries, such as those created by PyOxidizer, I plan to
  make it so the templatespec can keep an opened file/resource to read
  from instead of needing a file path. Having `templatepath()` return an
  opened file should help with that. At this point, it's just a wasteful
  extra opening of mapfiles that we'll open again later. I'll update the
  read-side next so it reads from the file-like object without opening
  the file again.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D8892

AFFECTED FILES
  mercurial/debugcommands.py
  mercurial/formatter.py
  mercurial/logcmdutil.py
  mercurial/templater.py

CHANGE DETAILS




To: martinvonz, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/mercurial/templater.py b/mercurial/templater.py
--- a/mercurial/templater.py
+++ b/mercurial/templater.py
@@ -1071,12 +1071,15 @@ 
     return path if os.path.isdir(path) else None
 
 
-def templatepath(name):
-    '''return location of template file. returns None if not found.'''
-    dir = templatedir()
-    if dir is None:
-        return None
-    f = os.path.join(templatedir(), name)
-    if f and os.path.isfile(f):
-        return f
-    return None
+def open_template(name):
+    '''returns a file-like object for the given template, and its full path'''
+    templatepath = templatedir()
+    if templatepath is not None or os.path.isabs(name):
+        f = os.path.join(templatepath, name)
+        try:
+            return f, open(f, mode='rb')
+        except EnvironmentError:
+            return None, None
+    else:
+        # TODO: read from resources here
+        return None, None
diff --git a/mercurial/logcmdutil.py b/mercurial/logcmdutil.py
--- a/mercurial/logcmdutil.py
+++ b/mercurial/logcmdutil.py
@@ -627,9 +627,9 @@ 
     if not tmpl and style:
         mapfile = style
         if not os.path.split(mapfile)[0]:
-            mapname = templater.templatepath(
+            (mapname, fp) = templater.open_template(
                 b'map-cmdline.' + mapfile
-            ) or templater.templatepath(mapfile)
+            ) or templater.open_template(mapfile)
             if mapname:
                 mapfile = mapname
         return formatter.mapfile_templatespec(b'changeset', mapfile)
diff --git a/mercurial/formatter.py b/mercurial/formatter.py
--- a/mercurial/formatter.py
+++ b/mercurial/formatter.py
@@ -599,9 +599,9 @@ 
 
     # perhaps a stock style?
     if not os.path.split(tmpl)[0]:
-        mapname = templater.templatepath(
+        (mapname, fp) = templater.open_template(
             b'map-cmdline.' + tmpl
-        ) or templater.templatepath(tmpl)
+        ) or templater.open_template(tmpl)
         if mapname:
             return mapfile_templatespec(topic, mapname)
 
diff --git a/mercurial/debugcommands.py b/mercurial/debugcommands.py
--- a/mercurial/debugcommands.py
+++ b/mercurial/debugcommands.py
@@ -1672,7 +1672,7 @@ 
     fm.write(b'templatedirs', b'checking templates (%s)...\n', p or b'')
     fm.condwrite(not p, b'', _(b" no template directories found\n"))
     if p:
-        m = templater.templatepath(b"map-cmdline.default")
+        (m, fp) = templater.open_template(b"map-cmdline.default")
         if m:
             # template found, check if it is working
             err = None