piecrust2: piecrust/pipelines/records.py comparison

comparison piecrust/pipelines/records.py @ 854:08e02c2a2a1a

core: Keep refactoring, this time to prepare for generator sources. - Make a few APIs simpler. - Content pipelines create their own jobs, so that generator sources can keep aborting in `getContents`, but rely on their pipeline to generate pages for baking.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sun, 04 Jun 2017 23:34:28 -0700
parents	f070a4fc033c
children	448710d84121

comparison

equal deleted inserted replaced

-:f070a4fc033c
+:08e02c2a2a1a
 logger = logging.getLogger(__name__)
+class RecordEntry:
+""" An entry in a record, for a specific content item.
+"""
+def __init__(self):
+self.item_spec = None
+self.errors = []
+@property
+def success(self):
+return len(self.errors) == 0
+def describe(self):
+return {}
+def getAllOutputPaths(self):
+return None
+def getAllErrors(self):
+return self.errors
+class Record:
+""" A class that represents a 'record' of a bake operation on a
+content source.
+"""
+def __init__(self, name):
+self.name = name
+self.deleted_out_paths = []
+self.success = True
+self._entries = {}
+def addEntry(self, entry):
+if entry.item_spec in self._entries:
+raise ValueError("Entry '%s' is already in the record." %
+entry.item_spec)
+self._entries[entry.item_spec] = entry
+def getEntries(self):
+return self._entries.values()
+def getEntry(self, item_spec):
+return self._entries[item_spec]
 class MultiRecord:
-""" A container that includes multiple `Record` instances.
+""" A container that includes multiple `Record` instances -- one for
+each content source that was baked.
 """
 RECORD_VERSION = 12
 def __init__(self):
 self.records = []
 logger.debug("Loading bake records from: %s" % path)
 with open(path, 'rb') as fp:
 return pickle.load(fp)
-class Record:
+def get_flag_descriptions(flags, flag_descriptions):
-""" A basic class that represents a 'record' of a bake operation on a
+res = []
-content source.
+for k, v in flag_descriptions.items():
-"""
+if flags & k:
-def __init__(self, name):
+res.append(v)
-self.name = name
+if res:
-self.entries = []
+return ', '.join(res)
-self.deleted_out_paths = []
+return 'none'
-self.success = True
-class RecordEntry:
-""" An entry in a record, for a specific content item.
-"""
-def __init__(self):
-self.item_spec = None
-self.out_paths = []
-self.errors = []
-@property
-def success(self):
-return len(self.errors) == 0
-def describe(self):
-return {}
 def _are_records_valid(multi_record):
 return (multi_record._app_version == APP_VERSION and
 multi_record._record_version == MultiRecord.RECORD_VERSION)
 multi_record.invalidated = was_invalid
 return multi_record
-def _build_diff_key(item_spec):
+class RecordHistory:
-return hashlib.md5(item_spec.encode('utf8')).hexdigest()
+def __init__(self, previous, current):
+if previous is None or current is None:
+raise ValueError()
+if previous.name != current.name:
+raise Exception("The two records must have the same name! "
+"Got '%s' and '%s'." %
+(previous.name, current.name))
+self._previous = previous
+self._current = current
+self._diffs = None
+@property
+def name(self):
+return self._current.name
+@property
+def current(self):
+return self._current
+@property
+def previous(self):
+return self._previous
+@property
+def diffs(self):
+if self._diffs is None:
+raise Exception("This record history hasn't been built yet.")
+return self._diffs.values()
+def getPreviousEntry(self, item_spec):
+key = _build_diff_key(item_spec)
+return self._diffs[key][0]
+def getCurrentEntry(self, item_spec):
+key = _build_diff_key(item_spec)
+return self._diffs[key][1]
+def build(self):
+if self._diffs is not None:
+raise Exception("This record history has already been built.")
+self._diffs = {}
+if self._previous is not None:
+for e in self._previous.getEntries():
+key = _build_diff_key(e.item_spec)
+self._diffs[key] = (e, None)
+if self._current is not None:
+for e in self._current.getEntries():
+key = _build_diff_key(e.item_spec)
+diff = self._diffs.get(key)
+if diff is None:
+self._diffs[key] = (None, e)
+elif diff[1] is None:
+self._diffs[key] = (diff[0], e)
+else:
+raise Exception(
+"A current record entry already exists for '%s' "
+"(%s)" % (key, diff[1].item_spec))
 class MultiRecordHistory:
 """ Tracks the differences between an 'old' and a 'new' record
 container.
 raise ValueError()
 self.previous = previous
 self.current = current
 self.histories = []
-self._buildHistories(previous, current)
+self._linkHistories(previous, current)
+def getPreviousRecord(self, record_name, auto_create=True):
+return self.previous.getRecord(record_name, auto_create=auto_create)
+def getCurrentRecord(self, record_name):
+return self.current.getRecord(record_name)
 def getHistory(self, record_name):
 for h in self.histories:
 if h.name == record_name:
 return h
 rh = RecordHistory(
 Record(record_name),
 Record(record_name))
 self.histories.append(rh)
 self.previous.records.append(rh.previous)
 self.current.records.append(rh.current)
 return rh
-def _buildHistories(self, previous, current):
+def _linkHistories(self, previous, current):
 pairs = {}
 if previous:
 for r in previous.records:
 pairs[r.name] = (r, None)
 if current:
 c = Record(name)
 current.records.append(c)
 self.histories.append(RecordHistory(p, c))
-class RecordHistory:
+def _build_diff_key(item_spec):
-def __init__(self, previous, current):
+return hashlib.md5(item_spec.encode('utf8')).hexdigest()
-if previous is None or current is None:
-raise ValueError()
-if previous.name != current.name:
-raise Exception("The two records must have the same name! "
-"Got '%s' and '%s'." %
-(previous.name, current.name))
-self._previous = previous
-self._current = current
-self._diffs = None
-@property
-def name(self):
-return self._current.name
-@property
-def current(self):
-return self._current
-@property
-def previous(self):
-return self._previous
-@property
-def diffs(self):
-if self._diffs is None:
-raise Exception("This record history hasn't been built yet.")
-return self._diffs.values()
-def build(self):
-if self._diffs is not None:
-raise Exception("This record history has already been built.")
-self._diffs = {}
-if self._previous is not None:
-for e in self._previous.entries:
-key = _build_diff_key(e.item_spec)
-self._diffs[key] = (e, None)
-if self._current is not None:
-for e in self._current.entries:
-key = _build_diff_key(e.item_spec)
-diff = self._diffs.get(key)
-if diff is None:
-self._diffs[key] = (None, e)
-elif diff[1] is None:
-self._diffs[key] = (diff[0], e)
-else:
-raise Exception(
-"A current record entry already exists for: %s" % key)

Mercurial > piecrust2

comparison piecrust/pipelines/records.py @ 854:08e02c2a2a1a