This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6839

idirstate: group private methods and attrs that are in the interface
ClosedPublic

Authored by durin42 on Sep 10 2019, 10:01 AM.

Details

Reviewers
indygreg
pulkit
Group Reviewers
hg-reviewers
Commits
rHG97b79354e9f0: idirstate: group private methods and attrs that are in the interface
Summary

This makes it a little more obvious at a glance what work is
left. Fortunately there's not a whole lot left. I suspect the ignore
logic is going to be the tricky bit.

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.

Revision Contents
Changeset List

PathPackages
Mmercurial/interfaces/dirstate.py (28 lines)

Diff 16539

mercurial/interfaces/dirstate.py

def __init__(opener, ui, root, validate, sparsematchfn): def __init__(opener, ui, root, validate, sparsematchfn):
'''Create a new dirstate object. '''Create a new dirstate object.
opener is an open()-like callable that can be used to open the opener is an open()-like callable that can be used to open the
dirstate file; root is the root of the directory tracked by dirstate file; root is the root of the directory tracked by
the dirstate. the dirstate.
''' '''
# TODO: all these private methods and attributes should be made
# public or removed from the interface.
_ignore = interfaceutil.Attribute('Matcher for ignored files.')
def _ignorefiles():
"""Return a list of files containing patterns to ignore."""
def _ignorefileandline(f):
"Given a file `f`, return the ignore file and line that ignores it."
_checklink = interfaceutil.Attribute('Callable for checking symlinks.')
_checkexec = interfaceutil.Attribute('Callable for checking exec bits.')
@contextlib.contextmanager @contextlib.contextmanager
def parentchange(): def parentchange():
'''Context manager for handling dirstate parents. '''Context manager for handling dirstate parents.
If an exception occurs in the scope of the context manager, If an exception occurs in the scope of the context manager,
the incoherent dirstate won't be written when wlock is the incoherent dirstate won't be written when wlock is
released. released.
''' '''
def pendingparentchange(): def pendingparentchange():
'''Returns true if the dirstate is in the middle of a set of changes '''Returns true if the dirstate is in the middle of a set of changes
that modify the dirstate parent. that modify the dirstate parent.
''' '''
def hasdir(d): def hasdir(d):
pass pass
_ignore = interfaceutil.Attribute('Matcher for ignored files.')
_checklink = interfaceutil.Attribute('Callable for checking symlinks.')
_checkexec = interfaceutil.Attribute('Callable for checking exec bits.')
def flagfunc(buildfallback): def flagfunc(buildfallback):
pass pass
def getcwd(): def getcwd():
'''Return the path from which a canonical path is calculated. '''Return the path from which a canonical path is calculated.
This path should be used to resolve file patterns or to convert This path should be used to resolve file patterns or to convert
canonical paths back to file paths for display. It shouldn't be canonical paths back to file paths for display. It shouldn't be
Callback will be called with the following arguments: Callback will be called with the following arguments:
dirstate, (oldp1, oldp2), (newp1, newp2) dirstate, (oldp1, oldp2), (newp1, newp2)
Category is a unique identifier to allow overwriting an old callback Category is a unique identifier to allow overwriting an old callback
with a newer callback. with a newer callback.
""" """
def _ignorefiles():
"""Return a list of files containing patterns to ignore.
TODO this should not be exposed."""
def _ignorefileandline(f):
"""Given a file `f`, return the ignore file and line that ignores it.
TODO this should not be exposed."""
def walk(match, subrepos, unknown, ignored, full=True): def walk(match, subrepos, unknown, ignored, full=True):
''' '''
Walk recursively through the directory tree, finding all files Walk recursively through the directory tree, finding all files
matched by match. matched by match.
If full is False, maybe skip some known-clean files. If full is False, maybe skip some known-clean files.
Return a dict mapping filename to stat-like object (either Return a dict mapping filename to stat-like object (either