This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3572

state: don't have a dict like interface for cmdstate class
ClosedPublic

Authored by pulkit on May 17 2018, 8:06 AM.

Details

Reviewers
martinvonz
Group Reviewers
hg-reviewers
Commits
rHG36a5a1239a15: state: don't have a dict like interface for cmdstate class
Summary

This patch changes the cmdstate class to stop having a dict like interface and
delete the nonzero function. After this patch, the save fuction takes a dict
to store the data and read function returns a dict of the data stored.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

pulkit created this revision.May 17 2018, 8:06 AM
martinvonz added a subscriber: martinvonz.May 17 2018, 12:47 PM
martinvonz added inline comments.
mercurial/state.py
59–63

Is this a direct consequence of removing the dict interface or could it be split out into a separate patch?

pulkit added inline comments.May 17 2018, 2:28 PM
mercurial/state.py
59–63

I will split it into a separate patch.

martinvonz accepted this revision.May 21 2018, 11:59 AM
This revision is now accepted and ready to land.May 21 2018, 11:59 AM
Closed by commit rHG36a5a1239a15: state: don't have a dict like interface for cmdstate class (authored by pulkit). · Explain WhyMay 21 2018, 1:40 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/state.py (39 lines)

Diff 8721

mercurial/state.py

def __init__(self, repo, fname, opts=None): def __init__(self, repo, fname, opts=None):
""" repo is the repo object """ repo is the repo object
fname is the file name in which data should be stored in .hg directory fname is the file name in which data should be stored in .hg directory
opts is a dictionary of data of the statefile opts is a dictionary of data of the statefile
""" """
self._repo = repo self._repo = repo
self.fname = fname self.fname = fname
if not opts:
self.opts = {}
else:
self.opts = opts
def __nonzero__(self):
return self.exists()
def __getitem__(self, key):
return self.opts[key]
def __setitem__(self, key, value):
updates = {key: value}
self.opts.update(updates)
def load(self):
"""load the existing state file into the class object"""
op = self._read()
self.opts.update(op)
def addopts(self, opts):
"""add more key-value pairs to the data stored by the object"""
self.opts.update(opts)
def save(self): def read(self):
"""read the existing state file and return a dict of data stored"""
return self._read()
def save(self, version, data):
"""write all the state data stored to .hg/<filename> file """write all the state data stored to .hg/<filename> file
we use third-party library cbor to serialize data to write in the file. we use third-party library cbor to serialize data to write in the file.
""" """
try:
iv = int(version)
except ValueError:
raise error.ProgrammingError("version of state file should be"
" an integer")
martinvonzUnsubmitted
Not Done

Is this a direct consequence of removing the dict interface or could it be split out into a separate patch?

martinvonz: Is this a direct consequence of removing the dict interface or could it be split out into a…
pulkitAuthorUnsubmitted
Not Done

I will split it into a separate patch.

pulkit: I will split it into a separate patch.
with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp: with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp:
fp.write('%d\n' % iv)
cbor.dump(self.opts, fp) cbor.dump(self.opts, fp)
def _read(self): def _read(self):
"""reads the state file and returns a dictionary which contain """reads the state file and returns a dictionary which contain
data in the same format as it was before storing""" data in the same format as it was before storing"""
with self._repo.vfs(self.fname, 'rb') as fp: with self._repo.vfs(self.fname, 'rb') as fp:
try:
version = int(fp.readline())
except ValueError:
raise error.ProgrammingError("unknown version of state file"
" found")
return cbor.load(fp) return cbor.load(fp)
def delete(self): def delete(self):
"""drop the state file if exists""" """drop the state file if exists"""
util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True) util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True)
def exists(self): def exists(self):
"""check whether the state file exists or not""" """check whether the state file exists or not"""
return self._repo.vfs.exists(self.fname) return self._repo.vfs.exists(self.fname)