##// END OF EJS Templates
fix: update documentation to reflect preference for --source over --rev...
fix: update documentation to reflect preference for --source over --rev I should have updated the documentation in 5205b46bd887 (fix: add a -s option to format a revision and its descendants, 2020-03-13) and/or a6ef1e8e2f6d (fix: mark -r as advanced, 2020-03-13)... Differential Revision: https://phab.mercurial-scm.org/D8808

File last commit:

r45376:2870f5d5 default
r45777:3ea3b85d default
Show More
narrowspec.py
350 lines | 11.2 KiB | text/x-python | PythonLexer
Gregory Szorc
narrowspec: move module into core...
r36178 # narrowspec.py - methods for working with a narrow view of a repository
#
# Copyright 2017 Google, Inc.
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
from __future__ import absolute_import
from .i18n import _
Gregory Szorc
py3: manually import getattr where it is needed...
r43359 from .pycompat import getattr
Augie Fackler
formatting: blacken the codebase...
r43346 from .interfaces import repository
Gregory Szorc
narrowspec: move module into core...
r36178 from . import (
error,
match as matchmod,
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 merge,
Augie Fackler
mergestate: split out merge state handling code from main merge module...
r45383 mergestate as mergestatemod,
Martin von Zweigbergk
narrow: make warning about possibly dirty files respect ui.relative-paths...
r42326 scmutil,
Pulkit Goyal
narrowspec: use sparse.parseconfig() to parse narrowspec file (BC)...
r38875 sparse,
Gregory Szorc
narrowspec: move module into core...
r36178 util,
)
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 # The file in .hg/store/ that indicates which paths exit in the store
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 FILENAME = b'narrowspec'
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 # The file in .hg/ that indicates which paths exit in the dirstate
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 DIRSTATE_FILENAME = b'narrowspec.dirstate'
Gregory Szorc
narrowspec: move module into core...
r36178
Gregory Szorc
narrowspec: limit patterns to path: and rootfilesin: (BC)...
r39567 # Pattern prefixes that are allowed in narrow patterns. This list MUST
# only contain patterns that are fast and safe to evaluate. Keep in mind
# that patterns are supplied by clients and executed on remote servers
Gregory Szorc
wireprotov2: advertise recognized path filter prefixes...
r39836 # as part of wire protocol commands. That means that changes to this
# data structure influence the wire protocol and should not be taken
# lightly - especially removals.
Gregory Szorc
narrowspec: limit patterns to path: and rootfilesin: (BC)...
r39567 VALID_PREFIXES = (
b'path:',
b'rootfilesin:',
)
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def normalizesplitpattern(kind, pat):
"""Returns the normalized version of a pattern and kind.
Returns a tuple with the normalized kind and normalized pattern.
"""
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 pat = pat.rstrip(b'/')
Gregory Szorc
narrowspec: move module into core...
r36178 _validatepattern(pat)
return kind, pat
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def _numlines(s):
"""Returns the number of lines in s, including ending empty lines."""
# We use splitlines because it is Unicode-friendly and thus Python 3
# compatible. However, it does not count empty lines at the end, so trick
# it by adding a character at the end.
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 return len((s + b'x').splitlines())
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def _validatepattern(pat):
"""Validates the pattern and aborts if it is invalid.
Patterns are stored in the narrowspec as newline-separated
POSIX-style bytestring paths. There's no escaping.
"""
# We use newlines as separators in the narrowspec file, so don't allow them
# in patterns.
if _numlines(pat) > 1:
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 raise error.Abort(_(b'newlines are not allowed in narrowspec paths'))
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 components = pat.split(b'/')
if b'.' in components or b'..' in components:
raise error.Abort(
_(b'"." and ".." are not allowed in narrowspec paths')
)
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: blacken the codebase...
r43346
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 def normalizepattern(pattern, defaultkind=b'path'):
Gregory Szorc
narrowspec: move module into core...
r36178 """Returns the normalized version of a text-format pattern.
If the pattern has no kind, the default will be added.
"""
kind, pat = matchmod._patsplit(pattern, defaultkind)
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 return b'%s:%s' % normalizesplitpattern(kind, pat)
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def parsepatterns(pats):
Gregory Szorc
narrowspec: limit patterns to path: and rootfilesin: (BC)...
r39567 """Parses an iterable of patterns into a typed pattern set.
Patterns are assumed to be ``path:`` if no prefix is present.
For safety and performance reasons, only some prefixes are allowed.
See ``validatepatterns()``.
This function should be used on patterns that come from the user to
normalize and validate them to the internal data structure used for
representing patterns.
"""
res = {normalizepattern(orig) for orig in pats}
validatepatterns(res)
return res
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: limit patterns to path: and rootfilesin: (BC)...
r39567 def validatepatterns(pats):
"""Validate that patterns are in the expected data structure and format.
And that is a set of normalized patterns beginning with ``path:`` or
``rootfilesin:``.
This function should be used to validate internal data structures
and patterns that are loaded from sources that use the internal,
prefixed pattern representation (but can't necessarily be fully trusted).
"""
if not isinstance(pats, set):
Augie Fackler
formatting: blacken the codebase...
r43346 raise error.ProgrammingError(
Martin von Zweigbergk
cleanup: join string literals that are already on one line...
r43387 b'narrow patterns should be a set; got %r' % pats
Augie Fackler
formatting: blacken the codebase...
r43346 )
Gregory Szorc
narrowspec: limit patterns to path: and rootfilesin: (BC)...
r39567
for pat in pats:
if not pat.startswith(VALID_PREFIXES):
# Use a Mercurial exception because this can happen due to user
# bugs (e.g. manually updating spec file).
Augie Fackler
formatting: blacken the codebase...
r43346 raise error.Abort(
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 _(b'invalid prefix on narrow pattern: %s') % pat,
Augie Fackler
formatting: blacken the codebase...
r43346 hint=_(
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 b'narrow patterns must begin with one of '
b'the following: %s'
Augie Fackler
formatting: blacken the codebase...
r43346 )
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 % b', '.join(VALID_PREFIXES),
Augie Fackler
formatting: blacken the codebase...
r43346 )
Gregory Szorc
narrowspec: move module into core...
r36178
def format(includes, excludes):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 output = b'[include]\n'
Gregory Szorc
narrowspec: move module into core...
r36178 for i in sorted(includes - excludes):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 output += i + b'\n'
output += b'[exclude]\n'
Gregory Szorc
narrowspec: move module into core...
r36178 for e in sorted(excludes):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 output += e + b'\n'
Gregory Szorc
narrowspec: move module into core...
r36178 return output
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def match(root, include=None, exclude=None):
if not include:
# Passing empty include and empty exclude to matchmod.match()
# gives a matcher that matches everything, so explicitly use
# the nevermatcher.
Martin von Zweigbergk
match: delete unused root and cwd arguments from {always,never,exact}() (API)...
r41825 return matchmod.never()
Augie Fackler
formatting: blacken the codebase...
r43346 return matchmod.match(
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 root, b'', [], include=include or [], exclude=exclude or []
Augie Fackler
formatting: blacken the codebase...
r43346 )
Gregory Szorc
narrowspec: move module into core...
r36178
Martin von Zweigbergk
narrow: extract helper for parsing narrowspec file...
r40726 def parseconfig(ui, spec):
# maybe we should care about the profiles returned too
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 includepats, excludepats, profiles = sparse.parseconfig(ui, spec, b'narrow')
Martin von Zweigbergk
narrow: extract helper for parsing narrowspec file...
r40726 if profiles:
Augie Fackler
formatting: blacken the codebase...
r43346 raise error.Abort(
_(
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 b"including other spec files using '%include' is not"
b" supported in narrowspec"
Augie Fackler
formatting: blacken the codebase...
r43346 )
)
Martin von Zweigbergk
narrow: extract helper for parsing narrowspec file...
r40726
validatepatterns(includepats)
validatepatterns(excludepats)
return includepats, excludepats
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def load(repo):
Martin von Zweigbergk
narrowspec: use vfs.tryread() instead of reimplementing...
r42596 # Treat "narrowspec does not exist" the same as "narrowspec file exists
# and is empty".
spec = repo.svfs.tryread(FILENAME)
Martin von Zweigbergk
narrow: extract helper for parsing narrowspec file...
r40726 return parseconfig(repo.ui, spec)
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def save(repo, includepats, excludepats):
Gregory Szorc
narrowspec: validate patterns when loading and saving spec file...
r39575 validatepatterns(includepats)
validatepatterns(excludepats)
Gregory Szorc
narrowspec: move module into core...
r36178 spec = format(includepats, excludepats)
Martin von Zweigbergk
narrow: move .hg/narrowspec to .hg/store/narrowspec (BC)...
r38908 repo.svfs.write(FILENAME, spec)
Gregory Szorc
narrowspec: move module into core...
r36178
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: copy store narrowspec to working copy immediately...
r41265 def copytoworkingcopy(repo):
spec = repo.svfs.read(FILENAME)
repo.vfs.write(DIRSTATE_FILENAME, spec)
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: call narrowspec.{save,restore,clear}backup directly...
r38905 def savebackup(repo, backupname):
if repository.NARROW_REQUIREMENT not in repo.requirements:
return
Martin von Zweigbergk
narrow: keep narrowspec backup in store...
r41070 svfs = repo.svfs
svfs.tryunlink(backupname)
util.copyfile(svfs.join(FILENAME), svfs.join(backupname), hardlink=True)
Martin von Zweigbergk
narrow: extract part of narrowspec backup to core...
r38872
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: call narrowspec.{save,restore,clear}backup directly...
r38905 def restorebackup(repo, backupname):
if repository.NARROW_REQUIREMENT not in repo.requirements:
return
Martin von Zweigbergk
narrow: keep narrowspec backup in store...
r41070 util.rename(repo.svfs.join(backupname), repo.svfs.join(FILENAME))
Martin von Zweigbergk
narrow: extract part of narrowspec backup to core...
r38872
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: make dirstateguard back up and restore working copy narrowspec instead...
r41263 def savewcbackup(repo, backupname):
Martin von Zweigbergk
narrow: call narrowspec.{save,restore,clear}backup directly...
r38905 if repository.NARROW_REQUIREMENT not in repo.requirements:
return
Martin von Zweigbergk
narrow: make dirstateguard back up and restore working copy narrowspec instead...
r41263 vfs = repo.vfs
vfs.tryunlink(backupname)
# It may not exist in old repos
if vfs.exists(DIRSTATE_FILENAME):
Augie Fackler
formatting: blacken the codebase...
r43346 util.copyfile(
vfs.join(DIRSTATE_FILENAME), vfs.join(backupname), hardlink=True
)
Martin von Zweigbergk
narrow: make dirstateguard back up and restore working copy narrowspec instead...
r41263
def restorewcbackup(repo, backupname):
if repository.NARROW_REQUIREMENT not in repo.requirements:
return
Martin von Zweigbergk
narrow: fix crash when restoring backup in legacy repo...
r41334 # It may not exist in old repos
if repo.vfs.exists(backupname):
util.rename(repo.vfs.join(backupname), repo.vfs.join(DIRSTATE_FILENAME))
Martin von Zweigbergk
narrow: make dirstateguard back up and restore working copy narrowspec instead...
r41263
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: make dirstateguard back up and restore working copy narrowspec instead...
r41263 def clearwcbackup(repo, backupname):
if repository.NARROW_REQUIREMENT not in repo.requirements:
return
Martin von Zweigbergk
narrow: fix crash when restoring backup in legacy repo...
r41334 repo.vfs.tryunlink(backupname)
Martin von Zweigbergk
narrow: extract part of narrowspec backup to core...
r38872
Augie Fackler
formatting: blacken the codebase...
r43346
Gregory Szorc
narrowspec: move module into core...
r36178 def restrictpatterns(req_includes, req_excludes, repo_includes, repo_excludes):
r""" Restricts the patterns according to repo settings,
results in a logical AND operation
:param req_includes: requested includes
:param req_excludes: requested excludes
:param repo_includes: repo includes
:param repo_excludes: repo excludes
:return: include patterns, exclude patterns, and invalid include patterns.
"""
res_excludes = set(req_excludes)
res_excludes.update(repo_excludes)
invalid_includes = []
if not req_includes:
res_includes = set(repo_includes)
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 elif b'path:.' not in repo_includes:
Gregory Szorc
narrowspec: move module into core...
r36178 res_includes = []
for req_include in req_includes:
req_include = util.expandpath(util.normpath(req_include))
if req_include in repo_includes:
res_includes.append(req_include)
continue
valid = False
for repo_include in repo_includes:
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 if req_include.startswith(repo_include + b'/'):
Gregory Szorc
narrowspec: move module into core...
r36178 valid = True
res_includes.append(req_include)
break
if not valid:
invalid_includes.append(req_include)
if len(res_includes) == 0:
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 res_excludes = {b'path:.'}
Gregory Szorc
narrowspec: move module into core...
r36178 else:
res_includes = set(res_includes)
else:
res_includes = set(req_includes)
return res_includes, res_excludes, invalid_includes
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 # These two are extracted for extensions (specifically for Google's CitC file
# system)
def _deletecleanfiles(repo, files):
for f in files:
repo.wvfs.unlinkpath(f)
Augie Fackler
formatting: blacken the codebase...
r43346
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 def _writeaddedfiles(repo, pctx, files):
actions = merge.emptyactions()
Augie Fackler
mergestate: split out merge state handling code from main merge module...
r45383 addgaction = actions[mergestatemod.ACTION_GET].append
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 mf = repo[b'.'].manifest()
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 for f in files:
if not repo.wvfs.exists(f):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 addgaction((f, (mf.flags(f), False), b"narrowspec updated"))
Augie Fackler
formatting: blacken the codebase...
r43346 merge.applyupdates(
repo,
actions,
wctx=repo[None],
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 mctx=repo[b'.'],
Augie Fackler
formatting: blacken the codebase...
r43346 overwrite=False,
wantfiledata=False,
)
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072
def checkworkingcopynarrowspec(repo):
Martin von Zweigbergk
narrowspec: replace one recursion-avoidance hack with another...
r42603 # Avoid infinite recursion when updating the working copy
if getattr(repo, '_updatingnarrowspec', False):
return
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 storespec = repo.svfs.tryread(FILENAME)
wcspec = repo.vfs.tryread(DIRSTATE_FILENAME)
if wcspec != storespec:
Augie Fackler
formatting: blacken the codebase...
r43346 raise error.Abort(
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 _(b"working copy's narrowspec is stale"),
hint=_(b"run 'hg tracked --update-working-copy'"),
Augie Fackler
formatting: blacken the codebase...
r43346 )
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072
Martin von Zweigbergk
narrow: reuse narrowspec.updateworkingcopy() when narrowing...
r41274 def updateworkingcopy(repo, assumeclean=False):
"""updates the working copy and dirstate from the store narrowspec
When assumeclean=True, files that are not known to be clean will also
be deleted. It is then up to the caller to make sure they are clean.
"""
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 oldspec = repo.vfs.tryread(DIRSTATE_FILENAME)
newspec = repo.svfs.tryread(FILENAME)
Martin von Zweigbergk
narrowspec: replace one recursion-avoidance hack with another...
r42603 repo._updatingnarrowspec = True
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072
oldincludes, oldexcludes = parseconfig(repo.ui, oldspec)
newincludes, newexcludes = parseconfig(repo.ui, newspec)
oldmatch = match(repo.root, include=oldincludes, exclude=oldexcludes)
newmatch = match(repo.root, include=newincludes, exclude=newexcludes)
addedmatch = matchmod.differencematcher(newmatch, oldmatch)
removedmatch = matchmod.differencematcher(oldmatch, newmatch)
ds = repo.dirstate
Augie Fackler
formatting: blacken the codebase...
r43346 lookup, status = ds.status(
removedmatch, subrepos=[], ignored=True, clean=True, unknown=True
)
Martin von Zweigbergk
narrow: reuse narrowspec.updateworkingcopy() when narrowing...
r41274 trackeddirty = status.modified + status.added
clean = status.clean
if assumeclean:
assert not trackeddirty
clean.extend(lookup)
else:
trackeddirty.extend(lookup)
_deletecleanfiles(repo, clean)
Martin von Zweigbergk
narrow: make warning about possibly dirty files respect ui.relative-paths...
r42326 uipathfn = scmutil.getuipathfn(repo)
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 for f in sorted(trackeddirty):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 repo.ui.status(
_(b'not deleting possibly dirty file %s\n') % uipathfn(f)
)
Martin von Zweigbergk
narrow: also warn when not deleting untracked or ignored files...
r42352 for f in sorted(status.unknown):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 repo.ui.status(_(b'not deleting unknown file %s\n') % uipathfn(f))
Martin von Zweigbergk
narrow: also warn when not deleting untracked or ignored files...
r42352 for f in sorted(status.ignored):
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 repo.ui.status(_(b'not deleting ignored file %s\n') % uipathfn(f))
Martin von Zweigbergk
narrow: reuse narrowspec.updateworkingcopy() when narrowing...
r41274 for f in clean + trackeddirty:
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 ds.drop(f)
Augie Fackler
formatting: byteify all mercurial/ and hgext/ string literals...
r43347 pctx = repo[b'.']
Martin von Zweigbergk
narrow: detect if narrowspec was changed in a different share...
r41072 newfiles = [f for f in pctx.manifest().walk(addedmatch) if f not in ds]
for f in newfiles:
ds.normallookup(f)
_writeaddedfiles(repo, pctx, newfiles)
Martin von Zweigbergk
narrowspec: replace one recursion-avoidance hack with another...
r42603 repo._updatingnarrowspec = False