This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4471

state: use our CBOR module
ClosedPublic

Authored by indygreg on Sep 4 2018, 2:28 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG5bfab9400daf: state: use our CBOR module
Summary

This was the last consumer of the vendored CBOR package in
core.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Sep 4 2018, 2:28 PM
pulkit accepted this revision.Sep 5 2018, 8:00 AM
Closed by commit rHG5bfab9400daf: state: use our CBOR module (authored by indygreg). · Explain WhySep 5 2018, 8:23 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/state.py (11 lines)

Diff 10788

mercurial/state.py

.hg/ directory. .hg/ directory.
We store the data on disk in cbor, for which we use the third party cbor library We store the data on disk in cbor, for which we use the third party cbor library
to serialize and deserialize data. to serialize and deserialize data.
""" """
from __future__ import absolute_import from __future__ import absolute_import
from .thirdparty import cbor
from . import ( from . import (
error, error,
util, util,
) )
from .utils import (
cborutil,
)
class cmdstate(object): class cmdstate(object):
"""a wrapper class to store the state of commands like `rebase`, `graft`, """a wrapper class to store the state of commands like `rebase`, `graft`,
`histedit`, `shelve` etc. Extensions can also use this to write state files. `histedit`, `shelve` etc. Extensions can also use this to write state files.
All the data for the state is stored in the form of key-value pairs in a All the data for the state is stored in the form of key-value pairs in a
dictionary. dictionary.
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.
""" """
if not isinstance(version, int): if not isinstance(version, int):
raise error.ProgrammingError("version of state file should be" raise error.ProgrammingError("version of state file should be"
" an integer") " an integer")
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' % version) fp.write('%d\n' % version)
cbor.dump(data, fp, canonical=True) for chunk in cborutil.streamencode(data):
fp.write(chunk)
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: try:
int(fp.readline()) int(fp.readline())
except ValueError: except ValueError:
raise error.CorruptedState("unknown version of state file" raise error.CorruptedState("unknown version of state file"
" found") " found")
return cbor.load(fp)
return cborutil.decodeall(fp.read())[0]
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)