core, json, docutils: Rename GeneratorInfo to DriverInfo

Author: cpitclaudel

alectryon/core.py

@@ -49,7 +49,7 @@ def debug(text, prefix):
     if DEBUG:
         print(indent(text.rstrip(), prefix), flush=True)
 
-class GeneratorInfo(namedtuple("GeneratorInfo", "name version")):
+class DriverInfo(namedtuple("DriverInfo", "name version")):
     def fmt(self, include_version_info=True):
         return "{} v{}".format(self.name, self.version) if include_version_info else self.name
 
@@ -369,7 +369,7 @@ def __init__(self, args=(), fpath="-", binpath=None):
     def version_info(cls, binpath=None):
         assert cls.BIN
         bs = check_output([cls.resolve_driver(binpath or cls.BIN), *cls.VERSION_FLAGS])
-        return GeneratorInfo(cls.NAME, bs.decode('ascii', 'ignore').strip())
+        return DriverInfo(cls.NAME, bs.decode('ascii', 'ignore').strip())
 
     @property
     def metadata(self):

alectryon/docutils.py

@@ -167,7 +167,7 @@ def _try(document, fn, node, *args, **kwargs):
 # LATER: dataclass
 class AlectryonState:
     def __init__(self, document):
-        self.generators: List[core.GeneratorInfo] = []
+        self.drivers_info: List[core.DriverInfo] = []
         self.root_language: Optional[str] = None
         self.transforms_executed = set()
         self.embedded_assets = []
@@ -274,15 +274,15 @@ def parse_args(args):
                 yield "-" + arg
                 yield ",".join(vals)
 
-    def driver_info(self, lang):
+    def get_driver_class_and_args(self, lang):
         driver_name = self.language_drivers[lang]
         driver_cls = core.resolve_driver(lang, driver_name)
         driver_args = self.driver_args[driver_name]
         assert driver_name == driver_cls.ID
         return driver_cls, driver_args
 
     def init_driver(self, lang):
-        cls, args = self.driver_info(lang)
+        cls, args = self.get_driver_class_and_args(lang)
         return cls(args, fpath=self.document['source'])
 
 class OneTimeTransform(Transform):
@@ -372,7 +372,7 @@ def annotate(self, pending_nodes, lang, cache):
         driver.observer = DocutilsObserver(self.document)
         chunks = [pending.details["contents"] for pending in pending_nodes]
         annotated = cache.update(chunks, driver)
-        return cache.generator, annotated
+        return cache.driver_info, annotated
 
     def replace_node(self, pending, fragments, lang):
         directive_annots = pending.details["directive_annots"]
@@ -392,8 +392,8 @@ def apply_drivers(self):
         all_pending = self.document.traverse(alectryon_pending)
         with CacheSet(CACHE_DIRECTORY, self.document['source'], CACHE_COMPRESSION) as caches:
             for lang, pending_nodes in by_lang(all_pending).items():
-                generator, annotated = self.annotate(pending_nodes, lang, caches[lang])
-                state.generators.append(generator)
+                driver_info, annotated = self.annotate(pending_nodes, lang, caches[lang])
+                state.drivers_info.append(driver_info)
                 for node, fragments in zip(pending_nodes, annotated):
                     self._try(self.replace_node, node, fragments, lang)
 
@@ -1244,9 +1244,9 @@ def __init__(self, document):
             self.body_prefix.append('<div class="{}">'.format(cls))
 
             if self.settings.alectryon_banner:
-                generators = alectryon_state(document).generators
+                drivers_info = alectryon_state(document).drivers_info
                 include_vernums = document.settings.alectryon_vernums
-                self.body_prefix.append(html.gen_banner(generators, include_vernums))
+                self.body_prefix.append(html.gen_banner(drivers_info, include_vernums))
 
             self.body_suffix.insert(0, '</div>')
     return Translator

alectryon/html.py

@@ -64,8 +64,8 @@ def gen_css(ctx):
     '</div>'
 )
 
-def gen_banner(generators, include_version_info=True):
-    return HEADER.format(", ".join(g.fmt(include_version_info) for g in generators))
+def gen_banner(driver_info, include_version_info=True):
+    return HEADER.format(", ".join(di.fmt(include_version_info) for di in driver_info))
 
 def wrap_classes(*cls):
     return " ".join("alectryon-" + c for c in ("root", *cls))

alectryon/json.py

@@ -243,7 +243,7 @@ def normalize(obj: Any) -> Any:
         return obj
 
     def _validate(self, chunks, metadata):
-        # Not that we validate "metadata" but not "generator".  This is to prevent
+        # Note that we validate "metadata" but not "driver".  This is to prevent
         # Coq upgrades from invalidating caches.  It's easy to force invalidation
         # by hand (delete the caches), whereas automatic invalidation on Coq
         # upgrades would make it a pain to keep a collection of examples (say, a
@@ -258,11 +258,11 @@ def get(self, chunks, metadata):
         return self.serializer.decode(self.data.get("annotated"))
 
     @property
-    def generator(self):
-        return core.GeneratorInfo(*self.data.get("generator", ("Coq+SerAPI", "??")))
+    def driver_info(self):
+        return core.DriverInfo(*self.data.get("driver", ("Coq+SerAPI", "??")))
 
-    def put(self, chunks, metadata, annotated, generator):
-        self.data = {"generator": self.normalize(generator),
+    def put(self, chunks, metadata, annotated, driver):
+        self.data = {"driver": self.normalize(driver),
                      "metadata": self.normalize(metadata),
                      "chunks": list(chunks),
                      "annotated": self.serializer.encode(annotated)}
@@ -344,7 +344,7 @@ def _upgrade(cls, contents):
             metadata.pop("cache_version", None)
             return {"metadata": cls.METADATA,
                     **{cls.LANG_PREFIX + "coq":
-                       {"generator": contents.pop("generator"),
+                       {"driver": contents.pop("generator"),
                         "metadata": contents.pop("metadata"),
                         **contents}}}
         return contents

recipes/_output/caching.v.cache.xz

@@ -3,7 +3,7 @@
     "cache_version": "2"
   },
   "&coq": {
-    "generator": [
+    "driver": [
       "Coq+SerAPI",
       "8.12.0+0.12.0"
     ],

recipes/sphinx/_build/alectryon/MyST.md.cache

@@ -3,7 +3,7 @@
     "cache_version": "2"
   },
   "&coq": {
-    "generator": [
+    "driver": [
       "Coq+SerAPI",
       "8.12.0+0.12.0"
     ],

recipes/sphinx/_build/alectryon/coqchapter.v.cache

@@ -3,7 +3,7 @@
     "cache_version": "2"
   },
   "&coq": {
-    "generator": [
+    "driver": [
       "Coq+SerAPI",
       "8.12.0+0.12.0"
     ],

recipes/sphinx/_build/alectryon/index.rst.cache

@@ -3,7 +3,7 @@
     "cache_version": "2"
   },
   "&coq": {
-    "generator": [
+    "driver": [
       "Coq+SerAPI",
       "8.12.0+0.12.0"
     ],