( )⚙ D5292 branchmap: make it easier for extensions not to break branchcache

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5292

branchmap: make it easier for extensions not to break branchcache
AbandonedPublic

Authored by mjpieters on Nov 21 2018, 9:56 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

The _branchcache global gives us a reference for super() to use even if an
extension subclasses branchmap.branchcache then replaces the class in the
module.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

mjpieters created this revision.Nov 21 2018, 9:56 AM
yuja added a subscriber: yuja.Nov 23 2018, 10:12 PM
The _branchcache global gives us a reference for super() to use even if an
extension subclasses branchmap.branchcache then replaces the class in the
module.

Can't we instead add a factory function which can be easily hooked by
extensions?

It should be discouraged to replace a class globally.

mjpieters abandoned this revision.Jan 21 2019, 1:12 PM

This would need more thought then; the evolve/topic/topicmap codebase wraps the whole branchmap.branchcache class and mucks about with a context manager to re-instate the right name in the branchmap globals so super() doesn't break, which is what led to this patch.

Revision Contents
Changeset List

PathPackages
Mmercurial/branchmap.py (7 lines)

Diff 12577

mercurial/branchmap.py

"""name of a branchcache file for a given repo or repoview""" """name of a branchcache file for a given repo or repoview"""
filename = "branch2" filename = "branch2"
if repo.filtername: if repo.filtername:
filename = '%s-%s' % (filename, repo.filtername) filename = '%s-%s' % (filename, repo.filtername)
return filename return filename
def __init__(self, entries=(), tipnode=nullid, tiprev=nullrev, def __init__(self, entries=(), tipnode=nullid, tiprev=nullrev,
filteredhash=None, closednodes=None): filteredhash=None, closednodes=None):
super(branchcache, self).__init__(entries) super(_branchcache, self).__init__(entries)
self.tipnode = tipnode self.tipnode = tipnode
self.tiprev = tiprev self.tiprev = tiprev
self.filteredhash = filteredhash self.filteredhash = filteredhash
# closednodes is a set of nodes that close their branch. If the branch # closednodes is a set of nodes that close their branch. If the branch
# cache has been updated, it may contain nodes that are no longer # cache has been updated, it may contain nodes that are no longer
# heads. # heads.
if closednodes is None: if closednodes is None:
self._closednodes = set() self._closednodes = set()
duration = util.timer() - starttime duration = util.timer() - starttime
repo.ui.log('branchcache', 'updated %s branch cache in %.4f seconds\n', repo.ui.log('branchcache', 'updated %s branch cache in %.4f seconds\n',
repo.filtername, duration) repo.filtername, duration)
self.write(repo) self.write(repo)
# keep a private reference to the class object so that subclasses that
# replace the branchcache class do not break super()
_branchcache = branchcache
class remotebranchcache(branchcache): class remotebranchcache(branchcache):
"""Branchmap info for a remote connection, should not write locally""" """Branchmap info for a remote connection, should not write locally"""
def write(self, repo): def write(self, repo):
pass pass
# Revision branch info cache # Revision branch info cache