This will help us in adding more validators which can aggregate data from
transaction and prompt user whether to commit the transaction or not.
The current target is to use this to implement pull --confirm.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/transaction.py (25 lines) |
| vfsmap[b''] = opener # set default value | vfsmap[b''] = opener # set default value | ||||
| self._vfsmap = vfsmap | self._vfsmap = vfsmap | ||||
| self._after = after | self._after = after | ||||
| self._entries = [] | self._entries = [] | ||||
| self._map = {} | self._map = {} | ||||
| self._journal = journalname | self._journal = journalname | ||||
| self._undoname = undoname | self._undoname = undoname | ||||
| self._queue = [] | self._queue = [] | ||||
| # A callback to validate transaction content before closing it. | |||||
| # should raise exception is anything is wrong. | |||||
| # target user is repository hooks. | |||||
| if validator is None: | |||||
| validator = lambda tr: None | |||||
| self._validator = validator | |||||
| # A callback to do something just after releasing transaction. | # A callback to do something just after releasing transaction. | ||||
| if releasefn is None: | if releasefn is None: | ||||
| releasefn = lambda tr, success: None | releasefn = lambda tr, success: None | ||||
| self._releasefn = releasefn | self._releasefn = releasefn | ||||
| self._checkambigfiles = set() | self._checkambigfiles = set() | ||||
| if checkambigfiles: | if checkambigfiles: | ||||
| self._checkambigfiles.update(checkambigfiles) | self._checkambigfiles.update(checkambigfiles) | ||||
| # hold file generations to be performed on commit | # hold file generations to be performed on commit | ||||
| self._filegenerators = {} | self._filegenerators = {} | ||||
| # hold callback to write pending data for hooks | # hold callback to write pending data for hooks | ||||
| self._pendingcallback = {} | self._pendingcallback = {} | ||||
| # True is any pending data have been written ever | # True is any pending data have been written ever | ||||
| self._anypending = False | self._anypending = False | ||||
| # holds callback to call when writing the transaction | # holds callback to call when writing the transaction | ||||
| self._finalizecallback = {} | self._finalizecallback = {} | ||||
| # holds callback to call when validating the transaction | |||||
| # should raise exception if anything is wrong | |||||
| self._validatecallback = {} | |||||
| if validator is not None: | |||||
| self._validatecallback['001-userhooks'] = validator | |||||
| # hold callback for post transaction close | # hold callback for post transaction close | ||||
| self._postclosecallback = {} | self._postclosecallback = {} | ||||
| # holds callbacks to call during abort | # holds callbacks to call during abort | ||||
| self._abortcallback = {} | self._abortcallback = {} | ||||
| def __repr__(self): | def __repr__(self): | ||||
| name = '/'.join(self._names) | name = '/'.join(self._names) | ||||
| return '<transaction name=%s, count=%d, usages=%d>' % ( | return '<transaction name=%s, count=%d, usages=%d>' % ( | ||||
| The transaction will be given as the first argument to the callback. | The transaction will be given as the first argument to the callback. | ||||
| Category is a unique identifier to allow overwriting an old callback | Category is a unique identifier to allow overwriting an old callback | ||||
| with a newer callback. | with a newer callback. | ||||
| """ | """ | ||||
| self._abortcallback[category] = callback | self._abortcallback[category] = callback | ||||
| @active | @active | ||||
| def addvalidator(self, category, callback): | |||||
| """ adds a callback to be called when validating the transaction. | |||||
| The transaction will be given as the first argument to the callback. | |||||
| callback should raise exception if to abort transaction """ | |||||
| self._validatecallback[category] = callback | |||||
| @active | |||||
| def close(self): | def close(self): | ||||
| '''commit the transaction''' | '''commit the transaction''' | ||||
| if self._count == 1: | if self._count == 1: | ||||
| self._validator(self) # will raise exception if needed | for category in sorted(self._validatecallback): | ||||
| self._validator = None # Help prevent cycles. | self._validatecallback[category](self) | ||||
| self._validatecallback = None # Help prevent cycles. | |||||
| self._generatefiles(group=GEN_GROUP_PRE_FINALIZE) | self._generatefiles(group=GEN_GROUP_PRE_FINALIZE) | ||||
| while self._finalizecallback: | while self._finalizecallback: | ||||
| callbacks = self._finalizecallback | callbacks = self._finalizecallback | ||||
| self._finalizecallback = {} | self._finalizecallback = {} | ||||
| categories = sorted(callbacks) | categories = sorted(callbacks) | ||||
| for cat in categories: | for cat in categories: | ||||
| callbacks[cat](self) | callbacks[cat](self) | ||||
| # Prevent double usage and help clear cycles. | # Prevent double usage and help clear cycles. | ||||