| pulkit | |
| durin42 |
| hg-reviewers |
Follow-up on refactorings 3d6d4b12128e and 5d98674df18a of the original
changeset 7e3001b74ab3 by updating the docstrings of dirnode class and tersedir
function:
| Lint Skipped |
| Unit Tests Skipped |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/cmdutil.py (44 lines) |
| # extracted at module level as it's required each time a file will be added | # extracted at module level as it's required each time a file will be added | ||||
| # to dirnode class object below | # to dirnode class object below | ||||
| pathsep = pycompat.ossep | pathsep = pycompat.ossep | ||||
| class dirnode(object): | class dirnode(object): | ||||
| """ | """ | ||||
| represents a directory in user working copy | Represent a directory in user working copy with information required for | ||||
| the purpose of tersing its status. | |||||
| stores information which is required for purpose of tersing the status | |||||
| path is the path to the directory | path is the path to the directory | ||||
| statuses is a set of statuses of all files in this directory (this includes | statuses is a set of statuses of all files in this directory (this includes | ||||
| all the files in all the subdirectories too) | all the files in all the subdirectories too) | ||||
| files is a list of files which are direct child of this directory | files is a list of files which are direct child of this directory | ||||
| subdirs is a dictionary of sub-directory name as the key and it's own | subdirs is a dictionary of sub-directory name as the key and it's own | ||||
| dirnode object as the value | dirnode object as the value | ||||
| """ | """ | ||||
| def __init__(self, dirpath): | def __init__(self, dirpath): | ||||
| self.path = dirpath | self.path = dirpath | ||||
| self.statuses = set([]) | self.statuses = set([]) | ||||
| self.files = [] | self.files = [] | ||||
| self.subdirs = {} | self.subdirs = {} | ||||
| def _addfileindir(self, filename, status): | def _addfileindir(self, filename, status): | ||||
| """ adds a file in this directory as the direct child """ | """Add a file in this directory as a direct child.""" | ||||
| self.files.append((filename, status)) | self.files.append((filename, status)) | ||||
| def addfile(self, filename, status): | def addfile(self, filename, status): | ||||
| """ | """ | ||||
| adds a file which is present in this directory to its direct parent | Add a file to this directory or to its direct parent directory. | ||||
| dirnode object | |||||
| if the file is not direct child of this directory, we traverse to the | If the file is not direct child of this directory, we traverse to the | ||||
| directory of which this file is a direct child of and add the file there | directory of which this file is a direct child of and add the file | ||||
| there. | |||||
| """ | """ | ||||
| # the filename contains a path separator, it means it's not the direct | # the filename contains a path separator, it means it's not the direct | ||||
| # child of this directory | # child of this directory | ||||
| if pathsep in filename: | if pathsep in filename: | ||||
| subdir, filep = filename.split(pathsep, 1) | subdir, filep = filename.split(pathsep, 1) | ||||
| # does the dirnode object for subdir exists | # does the dirnode object for subdir exists | ||||
| if subdir not in self.subdirs: | if subdir not in self.subdirs: | ||||
| subdirpath = os.path.join(self.path, subdir) | subdirpath = os.path.join(self.path, subdir) | ||||
| self.subdirs[subdir] = dirnode(subdirpath) | self.subdirs[subdir] = dirnode(subdirpath) | ||||
| # try adding the file in subdir | # try adding the file in subdir | ||||
| self.subdirs[subdir].addfile(filep, status) | self.subdirs[subdir].addfile(filep, status) | ||||
| else: | else: | ||||
| self._addfileindir(filename, status) | self._addfileindir(filename, status) | ||||
| if status not in self.statuses: | if status not in self.statuses: | ||||
| self.statuses.add(status) | self.statuses.add(status) | ||||
| def iterfilepaths(self): | def iterfilepaths(self): | ||||
| """ | """Yield (status, path) for files directly under this directory.""" | ||||
| adds files to the their respective status list in the final tersed list | |||||
| path is the path of parent directory of the file | |||||
| files is a list of tuple where each tuple is (filename, status) | |||||
| """ | |||||
| for f, st in self.files: | for f, st in self.files: | ||||
| yield st, os.path.join(self.path, f) | yield st, os.path.join(self.path, f) | ||||
| def tersewalk(self, terseargs): | def tersewalk(self, terseargs): | ||||
| """ | """ | ||||
| a recursive function which process status for a certain directory. | Yield (status, path) obtained by processing the status of this | ||||
| dirnode. | |||||
| self is an oject of dirnode class defined below. each object of dirnode | |||||
| class has a set of statuses which files in that directory has. This ease | |||||
| our check whether we can terse that directory or not. | |||||
| tersedict is a dictonary which contains each status abbreviation as key | |||||
| and list of files and tersed dirs in that status as value. In each | |||||
| function call we are passing the same dict and adding files and dirs | |||||
| to it. | |||||
| terseargs is the string of arguments passed by the user with `--terse` | terseargs is the string of arguments passed by the user with `--terse` | ||||
| flag. | flag. | ||||
| Following are the cases which can happen: | Following are the cases which can happen: | ||||
| 1) All the files in the directory (including all the files in its | 1) All the files in the directory (including all the files in its | ||||
| subdirectories) share the same status and the user has asked us to terse | subdirectories) share the same status and the user has asked us to terse | ||||
| that status. -> yield (status, dirpath) | that status. -> yield (status, dirpath) | ||||
| 2) If '1)' does not happen, we do following: | 2) Otherwise, we do following: | ||||
| a) Yield (status, filepath) for all the files which are in this | a) Yield (status, filepath) for all the files which are in this | ||||
| directory (only the ones in this directory, not the subdirs) | directory (only the ones in this directory, not the subdirs) | ||||
| b) Recurse the function on all the subdirectories of this | b) Recurse the function on all the subdirectories of this | ||||
| directory | directory | ||||
| """ | """ | ||||
| #recurse on the subdirs | #recurse on the subdirs | ||||
| for dirobj in self.subdirs.values(): | for dirobj in self.subdirs.values(): | ||||
| for st, fpath in dirobj.tersewalk(terseargs): | for st, fpath in dirobj.tersewalk(terseargs): | ||||
| yield st, fpath | yield st, fpath | ||||
| def tersedir(statuslist, terseargs): | def tersedir(statuslist, terseargs): | ||||
| """ | """ | ||||
| terses the status if all the files in a directory shares the same status | Terse the status if all the files in a directory shares the same status. | ||||
| statuslist is scmutil.status() object which contains a list of files for | statuslist is scmutil.status() object which contains a list of files for | ||||
| each status. | each status. | ||||
| terseargs is string which is passed by the user as the argument to `--terse` | terseargs is string which is passed by the user as the argument to `--terse` | ||||
| flag. | flag. | ||||
| The function makes a tree of objects of dirnode class, and at each node it | The function makes a tree of objects of dirnode class, and at each node it | ||||
| stores the information required to know whether we can terse a certain | stores the information required to know whether we can terse a certain | ||||
| directory or not. | directory or not. | ||||
| tersedict (defined in the function) is a dictionary which has one word key | |||||
| for each status and a list of files and dir in that status as the respective | |||||
| value. | |||||
| """ | """ | ||||
| # the order matters here as that is used to produce final list | # the order matters here as that is used to produce final list | ||||
| allst = ('m', 'a', 'r', 'd', 'u', 'i', 'c') | allst = ('m', 'a', 'r', 'd', 'u', 'i', 'c') | ||||
| # checking the argument validity | # checking the argument validity | ||||
| for s in terseargs: | for s in terseargs: | ||||
| if s not in allst: | if s not in allst: | ||||
| raise error.Abort(_("'%s' not recognized") % s) | raise error.Abort(_("'%s' not recognized") % s) | ||||