Show More
@@ -1,85 +1,85 b'' | |||||
1 | # state.py - writing and reading state files in Mercurial |
|
1 | # state.py - writing and reading state files in Mercurial | |
2 | # |
|
2 | # | |
3 | # Copyright 2018 Pulkit Goyal <pulkitmgoyal@gmail.com> |
|
3 | # Copyright 2018 Pulkit Goyal <pulkitmgoyal@gmail.com> | |
4 | # |
|
4 | # | |
5 | # This software may be used and distributed according to the terms of the |
|
5 | # This software may be used and distributed according to the terms of the | |
6 | # GNU General Public License version 2 or any later version. |
|
6 | # GNU General Public License version 2 or any later version. | |
7 |
|
7 | |||
8 | """ |
|
8 | """ | |
9 | This file contains class to wrap the state for commands and other |
|
9 | This file contains class to wrap the state for commands and other | |
10 | related logic. |
|
10 | related logic. | |
11 |
|
11 | |||
12 | All the data related to the command state is stored as dictionary in the object. |
|
12 | All the data related to the command state is stored as dictionary in the object. | |
13 | The class has methods using which the data can be stored to disk in a file under |
|
13 | The class has methods using which the data can be stored to disk in a file under | |
14 | .hg/ directory. |
|
14 | .hg/ directory. | |
15 |
|
15 | |||
16 | We store the data on disk in cbor, for which we use the third party cbor library |
|
16 | We store the data on disk in cbor, for which we use the third party cbor library | |
17 | to serialize and deserialize data. |
|
17 | to serialize and deserialize data. | |
18 | """ |
|
18 | """ | |
19 |
|
19 | |||
20 | from __future__ import absolute_import |
|
20 | from __future__ import absolute_import | |
21 |
|
21 | |||
22 | from .thirdparty import cbor |
|
22 | from .thirdparty import cbor | |
23 |
|
23 | |||
24 | from . import ( |
|
24 | from . import ( | |
25 | error, |
|
25 | error, | |
26 | util, |
|
26 | util, | |
27 | ) |
|
27 | ) | |
28 |
|
28 | |||
29 | class cmdstate(object): |
|
29 | class cmdstate(object): | |
30 | """a wrapper class to store the state of commands like `rebase`, `graft`, |
|
30 | """a wrapper class to store the state of commands like `rebase`, `graft`, | |
31 | `histedit`, `shelve` etc. Extensions can also use this to write state files. |
|
31 | `histedit`, `shelve` etc. Extensions can also use this to write state files. | |
32 |
|
32 | |||
33 | All the data for the state is stored in the form of key-value pairs in a |
|
33 | All the data for the state is stored in the form of key-value pairs in a | |
34 | dictionary. |
|
34 | dictionary. | |
35 |
|
35 | |||
36 | The class object can write all the data to a file in .hg/ directory and |
|
36 | The class object can write all the data to a file in .hg/ directory and | |
37 | can populate the object data reading that file. |
|
37 | can populate the object data reading that file. | |
38 |
|
38 | |||
39 | Uses cbor to serialize and deserialize data while writing and reading from |
|
39 | Uses cbor to serialize and deserialize data while writing and reading from | |
40 | disk. |
|
40 | disk. | |
41 | """ |
|
41 | """ | |
42 |
|
42 | |||
43 | def __init__(self, repo, fname, opts=None): |
|
43 | def __init__(self, repo, fname, opts=None): | |
44 | """ repo is the repo object |
|
44 | """ repo is the repo object | |
45 | fname is the file name in which data should be stored in .hg directory |
|
45 | fname is the file name in which data should be stored in .hg directory | |
46 | opts is a dictionary of data of the statefile |
|
46 | opts is a dictionary of data of the statefile | |
47 | """ |
|
47 | """ | |
48 | self._repo = repo |
|
48 | self._repo = repo | |
49 | self.fname = fname |
|
49 | self.fname = fname | |
50 |
|
50 | |||
51 | def read(self): |
|
51 | def read(self): | |
52 | """read the existing state file and return a dict of data stored""" |
|
52 | """read the existing state file and return a dict of data stored""" | |
53 | return self._read() |
|
53 | return self._read() | |
54 |
|
54 | |||
55 | def save(self, version, data): |
|
55 | def save(self, version, data): | |
56 | """write all the state data stored to .hg/<filename> file |
|
56 | """write all the state data stored to .hg/<filename> file | |
57 |
|
57 | |||
58 | we use third-party library cbor to serialize data to write in the file. |
|
58 | we use third-party library cbor to serialize data to write in the file. | |
59 | """ |
|
59 | """ | |
60 | if not isinstance(version, int): |
|
60 | if not isinstance(version, int): | |
61 | raise error.ProgrammingError("version of state file should be" |
|
61 | raise error.ProgrammingError("version of state file should be" | |
62 | " an integer") |
|
62 | " an integer") | |
63 |
|
63 | |||
64 | with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp: |
|
64 | with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp: | |
65 |
fp.write('%d\n' % |
|
65 | fp.write('%d\n' % version) | |
66 | cbor.dump(self.opts, fp, canonical=True) |
|
66 | cbor.dump(self.opts, fp, canonical=True) | |
67 |
|
67 | |||
68 | def _read(self): |
|
68 | def _read(self): | |
69 | """reads the state file and returns a dictionary which contain |
|
69 | """reads the state file and returns a dictionary which contain | |
70 | data in the same format as it was before storing""" |
|
70 | data in the same format as it was before storing""" | |
71 | with self._repo.vfs(self.fname, 'rb') as fp: |
|
71 | with self._repo.vfs(self.fname, 'rb') as fp: | |
72 | try: |
|
72 | try: | |
73 | version = int(fp.readline()) |
|
73 | version = int(fp.readline()) | |
74 | except ValueError: |
|
74 | except ValueError: | |
75 | raise error.ProgrammingError("unknown version of state file" |
|
75 | raise error.ProgrammingError("unknown version of state file" | |
76 | " found") |
|
76 | " found") | |
77 | return cbor.load(fp) |
|
77 | return cbor.load(fp) | |
78 |
|
78 | |||
79 | def delete(self): |
|
79 | def delete(self): | |
80 | """drop the state file if exists""" |
|
80 | """drop the state file if exists""" | |
81 | util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True) |
|
81 | util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True) | |
82 |
|
82 | |||
83 | def exists(self): |
|
83 | def exists(self): | |
84 | """check whether the state file exists or not""" |
|
84 | """check whether the state file exists or not""" | |
85 | return self._repo.vfs.exists(self.fname) |
|
85 | return self._repo.vfs.exists(self.fname) |
General Comments 0
You need to be logged in to leave comments.
Login now