mercurial-scm/hg-stable: mercurial/vfs.py annotate

annotate mercurial/vfs.py @ 43076:2372284d9457

formatting: blacken the codebase This is using my patch to black (https://github.com/psf/black/pull/826) so we don't un-wrap collection literals. Done with: hg files 'set:**.py - mercurial/thirdparty/** - "contrib/python-zstandard/**"' | xargs black -S # skip-blame mass-reformatting only # no-check-commit reformats foo_bar functions Differential Revision: https://phab.mercurial-scm.org/D6971

author	Augie Fackler <augie@google.com>
date	Sun, 06 Oct 2019 09:45:02 -0400
parents	3518da504303
children	687b865b95ad

rev	line source
31227 0f31830fbfc4 vfs: extract 'vfs' class and related code to a new 'vfs' module (API) Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 31045 diff changeset	1 # vfs.py - Mercurial 'vfs' classes
13962 8b252e826c68 add: introduce a warning message for non-portable filenames (issue2756) (BC) Adrian Buehlmann <adrian@cadifra.com> parents: diff changeset	2 #
8b252e826c68 add: introduce a warning message for non-portable filenames (issue2756) (BC) Adrian Buehlmann <adrian@cadifra.com> parents: diff changeset	3 # Copyright Matt Mackall <mpm@selenic.com>
8b252e826c68 add: introduce a warning message for non-portable filenames (issue2756) (BC) Adrian Buehlmann <adrian@cadifra.com> parents: diff changeset	4 #
8b252e826c68 add: introduce a warning message for non-portable filenames (issue2756) (BC) Adrian Buehlmann <adrian@cadifra.com> parents: diff changeset	5 # This software may be used and distributed according to the terms of the
8b252e826c68 add: introduce a warning message for non-portable filenames (issue2756) (BC) Adrian Buehlmann <adrian@cadifra.com> parents: diff changeset	6 # GNU General Public License version 2 or any later version.
27482 dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	7 from __future__ import absolute_import
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	8
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	9 import contextlib
27482 dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	10 import errno
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	11 import os
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	12 import shutil
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	13 import stat
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	14 import threading
27482 dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	15
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	16 from .i18n import _
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	17 from . import (
34040 d5b2beca16c0 python3: wrap all uses of <exception>.strerror with strtolocal Augie Fackler <raf@durin42.com> parents: 33647 diff changeset	18 encoding,
27482 dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	19 error,
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	20 pathutil,
30318 af7c60988f6e py3: make scmutil.rcpath() return bytes Pulkit Goyal <7895pulkit@gmail.com> parents: 30109 diff changeset	21 pycompat,
27482 dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	22 util,
dde3da2246f1 scmutil: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27093 diff changeset	23 )
18690 4c6f7f0dadab scmutil: split platform-specific bits into their own modules Kevin Bullock <kbullock@ringworld.org> parents: 18678 diff changeset	24
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	25
33280 646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	26 def _avoidambig(path, oldstat):
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	27 """Avoid file stat ambiguity forcibly
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	28
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	29 This function causes copying ``path`` file, if it is owned by
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	30 another (see issue5418 and issue5584 for detail).
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	31 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	32
33280 646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	33 def checkandavoid():
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	34 newstat = util.filestat.frompath(path)
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	35 # return whether file stat ambiguity is (already) avoided
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	36 return not newstat.isambig(oldstat) or newstat.avoidambig(path, oldstat)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	37
33280 646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	38 if not checkandavoid():
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	39 # simply copy to change owner of path to get privilege to
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	40 # advance mtime (see issue5418)
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	41 util.rename(util.mktempcopy(path), path)
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	42 checkandavoid()
646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	43
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	44
17649 f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	45 class abstractvfs(object):
14089 d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	46 """Abstract base class; cannot be instantiated"""
d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	47
d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	48 def __init__(self, args, *kwargs):
d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	49 '''Prevent instantiation; don't call this from subclasses.'''
d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	50 raise NotImplementedError('attempted instantiating ' + str(type(self)))
d3f7e110c3c0 opener: introduce an abstact superclass of it Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14068 diff changeset	51
41094 d9b6b9ed96d8 vfs: add a `_auditpath` to abstract vfs Boris Feld <boris.feld@octobus.net> parents: 41093 diff changeset	52 def _auditpath(self, path, mode):
41098 e0d00ec2d614 vfs: raise NotImplementedError in abstractvfs._auditvfs Boris Feld <boris.feld@octobus.net> parents: 41097 diff changeset	53 raise NotImplementedError
41094 d9b6b9ed96d8 vfs: add a `_auditpath` to abstract vfs Boris Feld <boris.feld@octobus.net> parents: 41093 diff changeset	54
16455 154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	55 def tryread(self, path):
16479 fc04698fa778 opener: coding style, use triple quotes for doc string Thomas Arendsen Hein <thomas@intevation.de> parents: 16455 diff changeset	56 '''gracefully return an empty string for missing files'''
16455 154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	57 try:
154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	58 return self.read(path)
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 25658 diff changeset	59 except IOError as inst:
16455 154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	60 if inst.errno != errno.ENOENT:
154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	61 raise
154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	62 return ""
154219f3a6a4 opener: introduce tryread helper Matt Mackall <mpm@selenic.com> parents: 16436 diff changeset	63
23368 bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	64 def tryreadlines(self, path, mode='rb'):
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	65 '''gracefully return an empty array for missing files'''
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	66 try:
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	67 return self.readlines(path, mode=mode)
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 25658 diff changeset	68 except IOError as inst:
23368 bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	69 if inst.errno != errno.ENOENT:
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	70 raise
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	71 return []
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	72
29730 2dd8c225e94c vfs: use propertycache for open Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 29727 diff changeset	73 @util.propertycache
2dd8c225e94c vfs: use propertycache for open Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 29727 diff changeset	74 def open(self):
23370 46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	75 '''Open ``path`` file, which is relative to vfs root.
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	76
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	77 Newly created directories are marked as "not to be indexed by
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	78 the content indexing service", if ``notindexed`` is specified
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	79 for "write" mode access.
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	80 '''
29730 2dd8c225e94c vfs: use propertycache for open Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 29727 diff changeset	81 return self.__call__
19897 896a4568def7 vfs: add "open()" for newly added code paths which open files via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19896 diff changeset	82
14167 0e4753807c93 util & scmutil: adapt read/write helpers as request by mpm Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14138 diff changeset	83 def read(self, path):
27706 22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	84 with self(path, 'rb') as fp:
14097 ca3376f044f8 opener: add read & write utility methods Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14090 diff changeset	85 return fp.read()
ca3376f044f8 opener: add read & write utility methods Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14090 diff changeset	86
23368 bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	87 def readlines(self, path, mode='rb'):
27706 22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	88 with self(path, mode=mode) as fp:
23368 bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	89 return fp.readlines()
bf8c3172255c vfs: add "readlines" and "tryreadlines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23259 diff changeset	90
35725 2a7e777c9eed write: add the possibility to pass keyword argument from batchget to vfs Boris Feld <boris.feld@octobus.net> parents: 35625 diff changeset	91 def write(self, path, data, backgroundclose=False, **kwargs):
2a7e777c9eed write: add the possibility to pass keyword argument from batchget to vfs Boris Feld <boris.feld@octobus.net> parents: 35625 diff changeset	92 with self(path, 'wb', backgroundclose=backgroundclose, **kwargs) as fp:
14167 0e4753807c93 util & scmutil: adapt read/write helpers as request by mpm Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14138 diff changeset	93 return fp.write(data)
0e4753807c93 util & scmutil: adapt read/write helpers as request by mpm Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14138 diff changeset	94
23371 1df6519eb3ab vfs: add "writelines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23370 diff changeset	95 def writelines(self, path, data, mode='wb', notindexed=False):
27706 22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	96 with self(path, mode=mode, notindexed=notindexed) as fp:
23371 1df6519eb3ab vfs: add "writelines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23370 diff changeset	97 return fp.writelines(data)
1df6519eb3ab vfs: add "writelines" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23370 diff changeset	98
14167 0e4753807c93 util & scmutil: adapt read/write helpers as request by mpm Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14138 diff changeset	99 def append(self, path, data):
27706 22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	100 with self(path, 'ab') as fp:
14097 ca3376f044f8 opener: add read & write utility methods Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14090 diff changeset	101 return fp.write(data)
ca3376f044f8 opener: add read & write utility methods Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14090 diff changeset	102
25770 39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	103 def basename(self, path):
39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	104 """return base element of a path (as os.path.basename would do)
39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	105
39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	106 This exists to allow handling of strange encoding if needed."""
39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	107 return os.path.basename(path)
39de2e9cc6f4 vfs: add basename FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25739 diff changeset	108
20086 f3df2612f3c3 vfs: add "chmod()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20085 diff changeset	109 def chmod(self, path, mode):
f3df2612f3c3 vfs: add "chmod()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20085 diff changeset	110 return os.chmod(self.join(path), mode)
f3df2612f3c3 vfs: add "chmod()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20085 diff changeset	111
25772 5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	112 def dirname(self, path):
5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	113 """return dirname element of a path (as os.path.dirname would do)
5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	114
5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	115 This exists to allow handling of strange encoding if needed."""
5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	116 return os.path.dirname(path)
5471965af5cb vfs: add dirname FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 25770 diff changeset	117
17161 be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	118 def exists(self, path=None):
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	119 return os.path.exists(self.join(path))
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	120
19899 8c3dcbbfb5de changelog: use "vfs.fstat()" instead of "util.fstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19897 diff changeset	121 def fstat(self, fp):
8c3dcbbfb5de changelog: use "vfs.fstat()" instead of "util.fstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19897 diff changeset	122 return util.fstat(fp)
8c3dcbbfb5de changelog: use "vfs.fstat()" instead of "util.fstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19897 diff changeset	123
17161 be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	124 def isdir(self, path=None):
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	125 return os.path.isdir(self.join(path))
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	126
20085 589d6bb5b18d vfs: add "isfile()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20045 diff changeset	127 def isfile(self, path=None):
589d6bb5b18d vfs: add "isfile()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20045 diff changeset	128 return os.path.isfile(self.join(path))
589d6bb5b18d vfs: add "isfile()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20045 diff changeset	129
18949 138978f20180 localrepo: use "vfs.islink()" instead of "os.path.islink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18948 diff changeset	130 def islink(self, path=None):
138978f20180 localrepo: use "vfs.islink()" instead of "os.path.islink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18948 diff changeset	131 return os.path.islink(self.join(path))
138978f20180 localrepo: use "vfs.islink()" instead of "os.path.islink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18948 diff changeset	132
27571 6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	133 def isfileorlink(self, path=None):
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	134 '''return whether path is a regular file or a symlink
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	135
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	136 Unlike isfile, this doesn't follow symlinks.'''
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	137 try:
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	138 st = self.lstat(path)
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	139 except OSError:
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	140 return False
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	141 mode = st.st_mode
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	142 return stat.S_ISREG(mode) or stat.S_ISLNK(mode)
6a6e78f84cc6 merge: while checking for unknown files don't follow symlinks (issue5027) Siddharth Agarwal <sid0@fb.com> parents: 26836 diff changeset	143
23581 aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	144 def reljoin(self, *paths):
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	145 """join various elements of a path together (as os.path.join would do)
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	146
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	147 The vfs base is not injected so that path stay relative. This exists
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	148 to allow handling of strange encoding if needed."""
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	149 return os.path.join(*paths)
aed981c7bebf vfs: add a 'reljoin' function for joining relative paths Pierre-Yves David <pierre-yves.david@fb.com> parents: 23539 diff changeset	150
23582 7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	151 def split(self, path):
7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	152 """split top-most element of a path (as os.path.split would do)
7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	153
7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	154 This exists to allow handling of strange encoding if needed."""
7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	155 return os.path.split(path)
7559dc8c4238 vfs: add a 'split' method Pierre-Yves David <pierre-yves.david@fb.com> parents: 23581 diff changeset	156
21563 764b691b8bda vfs: add lexists() in current api Chinmay Joshi <c@chinmayjoshi.com> parents: 21111 diff changeset	157 def lexists(self, path=None):
764b691b8bda vfs: add lexists() in current api Chinmay Joshi <c@chinmayjoshi.com> parents: 21111 diff changeset	158 return os.path.lexists(self.join(path))
764b691b8bda vfs: add lexists() in current api Chinmay Joshi <c@chinmayjoshi.com> parents: 21111 diff changeset	159
19900 7c21e3398931 context: use "vfs.lstat()" instead of "os.lstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19899 diff changeset	160 def lstat(self, path=None):
7c21e3398931 context: use "vfs.lstat()" instead of "os.lstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19899 diff changeset	161 return os.lstat(self.join(path))
7c21e3398931 context: use "vfs.lstat()" instead of "os.lstat()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19899 diff changeset	162
21799 dfacdd6a111e vfs: add listdir for os.listdir in vfs Chinmay Joshi <c@chinmayjoshi.com> parents: 21716 diff changeset	163 def listdir(self, path=None):
dfacdd6a111e vfs: add listdir for os.listdir in vfs Chinmay Joshi <c@chinmayjoshi.com> parents: 21716 diff changeset	164 return os.listdir(self.join(path))
dfacdd6a111e vfs: add listdir for os.listdir in vfs Chinmay Joshi <c@chinmayjoshi.com> parents: 21716 diff changeset	165
17161 be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	166 def makedir(self, path=None, notindexed=True):
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	167 return util.makedir(self.join(path), notindexed)
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	168
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	169 def makedirs(self, path=None, mode=None):
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	170 return util.makedirs(self.join(path), mode)
be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	171
20090 88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	172 def makelock(self, info, path):
88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	173 return util.makelock(info, self.join(path))
88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	174
17723 ab23768746fd scmutil: reorder newly added functions for vfs support in dictionary order FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17681 diff changeset	175 def mkdir(self, path=None):
ab23768746fd scmutil: reorder newly added functions for vfs support in dictionary order FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17681 diff changeset	176 return os.mkdir(self.join(path))
ab23768746fd scmutil: reorder newly added functions for vfs support in dictionary order FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17681 diff changeset	177
35625 390f860228ba vfs: drop text mode flag (API) Yuya Nishihara <yuya@tcha.org> parents: 35432 diff changeset	178 def mkstemp(self, suffix='', prefix='tmp', dir=None):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	179 fd, name = pycompat.mkstemp(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	180 suffix=suffix, prefix=prefix, dir=self.join(dir)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	181 )
20980 6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	182 dname, fname = util.split(name)
6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	183 if dir:
6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	184 return fd, os.path.join(dir, fname)
6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	185 else:
6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	186 return fd, fname
6fb4c94ae300 vfs: add "mkstemp()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20862 diff changeset	187
17747 aad3bce98f76 store: invoke "osutil.listdir()" via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17726 diff changeset	188 def readdir(self, path=None, stat=None, skip=None):
32248 d74b0cff94a9 osutil: proxy through util (and platform) modules (API) Yuya Nishihara <yuya@tcha.org> parents: 31649 diff changeset	189 return util.listdir(self.join(path), stat, skip)
17747 aad3bce98f76 store: invoke "osutil.listdir()" via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17726 diff changeset	190
20090 88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	191 def readlock(self, path):
88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	192 return util.readlock(self.join(path))
88d8e568add1 vfs: add "makelock()" and "readlock()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 20086 diff changeset	193
29203 731ced087a4b vfs: make rename avoid ambiguity of file stat if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29202 diff changeset	194 def rename(self, src, dst, checkambig=False):
29367 4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	195 """Rename from src to dst
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	196
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	197 checkambig argument is used with util.filestat, and is useful
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	198 only if destination file is guarded by any lock
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	199 (e.g. repo.lock or repo.wlock).
33282 d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	200
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	201 To avoid file stat ambiguity forcibly, checkambig=True involves
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	202 copying ``src`` file, if it is owned by another. Therefore, use
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	203 checkambig=True only in limited cases (see also issue5418 and
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	204 issue5584 for detail).
29367 4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	205 """
41095 9e593db5f1a1 vfs: also audit rename Boris Feld <boris.feld@octobus.net> parents: 41094 diff changeset	206 self._auditpath(dst, 'w')
32768 ed66ec39933f vfs: create copy at renaming to avoid file stat ambiguity if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 32767 diff changeset	207 srcpath = self.join(src)
29203 731ced087a4b vfs: make rename avoid ambiguity of file stat if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29202 diff changeset	208 dstpath = self.join(dst)
32792 7ad95626f6a7 filestat: move __init__ to frompath constructor Siddharth Agarwal <sid0@fb.com> parents: 32768 diff changeset	209 oldstat = checkambig and util.filestat.frompath(dstpath)
29203 731ced087a4b vfs: make rename avoid ambiguity of file stat if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29202 diff changeset	210 if oldstat and oldstat.stat:
33281 6af0f023d014 vfs: replace avoiding ambiguity in abstractvfs.rename with _avoidambig FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33280 diff changeset	211 ret = util.rename(srcpath, dstpath)
6af0f023d014 vfs: replace avoiding ambiguity in abstractvfs.rename with _avoidambig FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33280 diff changeset	212 _avoidambig(dstpath, oldstat)
29203 731ced087a4b vfs: make rename avoid ambiguity of file stat if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29202 diff changeset	213 return ret
32768 ed66ec39933f vfs: create copy at renaming to avoid file stat ambiguity if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 32767 diff changeset	214 return util.rename(srcpath, dstpath)
18948 2f05fa162316 localrepo: use "vfs.rename()" instead of "util.rename()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18945 diff changeset	215
18950 647e3b0c8751 localrepo: use "vfs.readlink()" instead of "os.readlink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18949 diff changeset	216 def readlink(self, path):
39909 5fe0b880200e py3: convert os.readlink() path to native strings on Windows Matt Harbison <matt_harbison@yahoo.com> parents: 39481 diff changeset	217 return util.readlink(self.join(path))
18950 647e3b0c8751 localrepo: use "vfs.readlink()" instead of "os.readlink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18949 diff changeset	218
24693 0d28b0df77ea vfs: add removedirs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24689 diff changeset	219 def removedirs(self, path=None):
0d28b0df77ea vfs: add removedirs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24689 diff changeset	220 """Remove a leaf directory and all empty intermediate ones
0d28b0df77ea vfs: add removedirs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24689 diff changeset	221 """
0d28b0df77ea vfs: add removedirs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24689 diff changeset	222 return util.removedirs(self.join(path))
0d28b0df77ea vfs: add removedirs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24689 diff changeset	223
39481 3dd34b401bc2 merge: use vfs methods for I/O Gregory Szorc <gregory.szorc@gmail.com> parents: 38497 diff changeset	224 def rmdir(self, path=None):
3dd34b401bc2 merge: use vfs methods for I/O Gregory Szorc <gregory.szorc@gmail.com> parents: 38497 diff changeset	225 """Remove an empty directory."""
3dd34b401bc2 merge: use vfs methods for I/O Gregory Szorc <gregory.szorc@gmail.com> parents: 38497 diff changeset	226 return os.rmdir(self.join(path))
3dd34b401bc2 merge: use vfs methods for I/O Gregory Szorc <gregory.szorc@gmail.com> parents: 38497 diff changeset	227
24689 ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	228 def rmtree(self, path=None, ignore_errors=False, forcibly=False):
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	229 """Remove a directory tree recursively
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	230
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	231 If ``forcibly``, this tries to remove READ-ONLY files, too.
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	232 """
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	233 if forcibly:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	234
24689 ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	235 def onerror(function, path, excinfo):
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	236 if function is not os.remove:
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	237 raise
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	238 # read-only files cannot be unlinked under Windows
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	239 s = os.stat(path)
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	240 if (s.st_mode & stat.S_IWRITE) != 0:
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	241 raise
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	242 os.chmod(path, stat.S_IMODE(s.st_mode) \| stat.S_IWRITE)
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	243 os.remove(path)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	244
24689 ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	245 else:
ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	246 onerror = None
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	247 return shutil.rmtree(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	248 self.join(path), ignore_errors=ignore_errors, onerror=onerror
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	249 )
24689 ca3a90096c95 vfs: add rmtree FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24635 diff changeset	250
18951 d13916a00b7e localrepo: use "vfs.setflags()" instead of "util.setflags()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18950 diff changeset	251 def setflags(self, path, l, x):
d13916a00b7e localrepo: use "vfs.setflags()" instead of "util.setflags()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18950 diff changeset	252 return util.setflags(self.join(path), l, x)
d13916a00b7e localrepo: use "vfs.setflags()" instead of "util.setflags()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18950 diff changeset	253
17726 7cb7e17c23b2 store: invoke "os.stat()" for "createmode" initialization via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17725 diff changeset	254 def stat(self, path=None):
7cb7e17c23b2 store: invoke "os.stat()" for "createmode" initialization via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17725 diff changeset	255 return os.stat(self.join(path))
7cb7e17c23b2 store: invoke "os.stat()" for "createmode" initialization via vfs FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17725 diff changeset	256
19895 37c0d93fb166 bookmarks: use "vfs.unlink()" instead of "util.unlink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19655 diff changeset	257 def unlink(self, path=None):
37c0d93fb166 bookmarks: use "vfs.unlink()" instead of "util.unlink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19655 diff changeset	258 return util.unlink(self.join(path))
37c0d93fb166 bookmarks: use "vfs.unlink()" instead of "util.unlink()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19655 diff changeset	259
31548 fad440db3565 vfs: add tryunlink method Ryan McElroy <rmcelroy@fb.com> parents: 31318 diff changeset	260 def tryunlink(self, path=None):
fad440db3565 vfs: add tryunlink method Ryan McElroy <rmcelroy@fb.com> parents: 31318 diff changeset	261 """Attempt to remove a file, ignoring missing file errors."""
fad440db3565 vfs: add tryunlink method Ryan McElroy <rmcelroy@fb.com> parents: 31318 diff changeset	262 util.tryunlink(self.join(path))
fad440db3565 vfs: add tryunlink method Ryan McElroy <rmcelroy@fb.com> parents: 31318 diff changeset	263
38497 da2a7d8354b2 unlinkpath: make empty directory removal optional (issue5901) (issue5826) Kyle Lippincott <spectral@google.com> parents: 38197 diff changeset	264 def unlinkpath(self, path=None, ignoremissing=False, rmdir=True):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	265 return util.unlinkpath(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	266 self.join(path), ignoremissing=ignoremissing, rmdir=rmdir
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	267 )
21716 90f9be5adade vfs: add unlinkpath to vfs Chinmay Joshi <c@chinmayjoshi.com> parents: 21563 diff changeset	268
19896 af03279c766a bookmarks: use "vfs.utime()" instead of "os.utime()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19895 diff changeset	269 def utime(self, path=None, t=None):
af03279c766a bookmarks: use "vfs.utime()" instead of "os.utime()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19895 diff changeset	270 return os.utime(self.join(path), t)
af03279c766a bookmarks: use "vfs.utime()" instead of "os.utime()" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19895 diff changeset	271
24725 ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	272 def walk(self, path=None, onerror=None):
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	273 """Yield (dirpath, dirs, files) tuple for each directories under path
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	274
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	275 ``dirpath`` is relative one from the root of this vfs. This
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	276 uses ``os.sep`` as path separator, even you specify POSIX
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	277 style ``path``.
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	278
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	279 "The root of this vfs" is represented as empty ``dirpath``.
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	280 """
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	281 root = os.path.normpath(self.join(None))
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	282 # when dirpath == root, dirpath[prefixlen:] becomes empty
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	283 # because len(dirpath) < prefixlen.
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	284 prefixlen = len(pathutil.normasprefix(root))
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	285 for dirpath, dirs, files in os.walk(self.join(path), onerror=onerror):
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	286 yield (dirpath[prefixlen:], dirs, files)
ee751d47cf2c vfs: add walk FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 24723 diff changeset	287
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	288 @contextlib.contextmanager
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	289 def backgroundclosing(self, ui, expectedcount=-1):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	290 """Allow files to be closed asynchronously.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	291
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	292 When this context manager is active, ``backgroundclose`` can be passed
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	293 to ``__call__``/``open`` to result in the file possibly being closed
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	294 asynchronously, on a background thread.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	295 """
35432 60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	296 # Sharing backgroundfilecloser between threads is complex and using
60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	297 # multiple instances puts us at risk of running out of file descriptors
60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	298 # only allow to use backgroundfilecloser when in main thread.
60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	299 if not isinstance(threading.currentThread(), threading._MainThread):
60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	300 yield
60f2a215faa7 workers: don't use backgroundfilecloser in threads Wojciech Lis <wlis@fb.com> parents: 34645 diff changeset	301 return
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	302 vfs = getattr(self, 'vfs', self)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	303 if getattr(vfs, '_backgroundfilecloser', None):
29389 98e8313dcd9e i18n: translate abort messages liscju <piotr.listkiewicz@gmail.com> parents: 29373 diff changeset	304 raise error.Abort(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	305 _('can only have 1 active background file closer')
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	306 )
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	307
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	308 with backgroundfilecloser(ui, expectedcount=expectedcount) as bfc:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	309 try:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	310 vfs._backgroundfilecloser = bfc
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	311 yield bfc
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	312 finally:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	313 vfs._backgroundfilecloser = None
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	314
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	315
17649 f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	316 class vfs(abstractvfs):
f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	317 '''Operate files relative to a base directory
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	318
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	319 This class is used to hide the details of COW semantics and
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	320 remote file access from higher level code.
33647 377e8ddaebef pathauditor: disable cache of audited paths by default (issue5628) Yuya Nishihara <yuya@tcha.org> parents: 33435 diff changeset	321
377e8ddaebef pathauditor: disable cache of audited paths by default (issue5628) Yuya Nishihara <yuya@tcha.org> parents: 33435 diff changeset	322 'cacheaudited' should be enabled only if (a) vfs object is short-lived, or
377e8ddaebef pathauditor: disable cache of audited paths by default (issue5628) Yuya Nishihara <yuya@tcha.org> parents: 33435 diff changeset	323 (b) the base directory is managed by hg and considered sort-of append-only.
377e8ddaebef pathauditor: disable cache of audited paths by default (issue5628) Yuya Nishihara <yuya@tcha.org> parents: 33435 diff changeset	324 See pathutil.pathauditor() for details.
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	325 '''
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	326
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	327 def __init__(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	328 self,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	329 base,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	330 audit=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	331 cacheaudited=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	332 expandpath=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	333 realpath=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	334 ):
18945 e75b72fffdfe vfs: split "expand" into "realpath"/"expandpath" to apply each separately FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18900 diff changeset	335 if expandpath:
e75b72fffdfe vfs: split "expand" into "realpath"/"expandpath" to apply each separately FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18900 diff changeset	336 base = util.expandpath(base)
e75b72fffdfe vfs: split "expand" into "realpath"/"expandpath" to apply each separately FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18900 diff changeset	337 if realpath:
e75b72fffdfe vfs: split "expand" into "realpath"/"expandpath" to apply each separately FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18900 diff changeset	338 base = os.path.realpath(base)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	339 self.base = base
33259 6fb5c5096887 vfs: drop the 'mustaudit' API Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33257 diff changeset	340 self._audit = audit
6fb5c5096887 vfs: drop the 'mustaudit' API Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33257 diff changeset	341 if audit:
33647 377e8ddaebef pathauditor: disable cache of audited paths by default (issue5628) Yuya Nishihara <yuya@tcha.org> parents: 33435 diff changeset	342 self.audit = pathutil.pathauditor(self.base, cached=cacheaudited)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	343 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	344 self.audit = lambda path, mode=None: True
33259 6fb5c5096887 vfs: drop the 'mustaudit' API Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33257 diff changeset	345 self.createmode = None
6fb5c5096887 vfs: drop the 'mustaudit' API Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33257 diff changeset	346 self._trustnlink = None
43027 3518da504303 vfs: give all vfs an options attribute by default Pierre-Yves David <pierre-yves.david@octobus.net> parents: 41098 diff changeset	347 self.options = {}
17554 5450c8ad9d98 scmutil: turn opener._audit into a property, mustaudit Bryan O'Sullivan <bryano@fb.com> parents: 17248 diff changeset	348
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	349 @util.propertycache
14261 e3649bcca3f6 opener: rename _can_symlink to _cansymlink Adrian Buehlmann <adrian@cadifra.com> parents: 14236 diff changeset	350 def _cansymlink(self):
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	351 return util.checklink(self.base)
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	352
18192 f9a89bdd64a6 scmutil: don't try to match modes on filesystems without modes (issue3740) Matt Mackall <mpm@selenic.com> parents: 17850 diff changeset	353 @util.propertycache
f9a89bdd64a6 scmutil: don't try to match modes on filesystems without modes (issue3740) Matt Mackall <mpm@selenic.com> parents: 17850 diff changeset	354 def _chmod(self):
f9a89bdd64a6 scmutil: don't try to match modes on filesystems without modes (issue3740) Matt Mackall <mpm@selenic.com> parents: 17850 diff changeset	355 return util.checkexec(self.base)
f9a89bdd64a6 scmutil: don't try to match modes on filesystems without modes (issue3740) Matt Mackall <mpm@selenic.com> parents: 17850 diff changeset	356
17763 13070de77c86 vfs: backout fchmod change from 76b73ce0ffac Matt Mackall <mpm@selenic.com> parents: 17752 diff changeset	357 def _fixfilemode(self, name):
18192 f9a89bdd64a6 scmutil: don't try to match modes on filesystems without modes (issue3740) Matt Mackall <mpm@selenic.com> parents: 17850 diff changeset	358 if self.createmode is None or not self._chmod:
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	359 return
25658 e93036747902 global: mass rewrite to use modern octal syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 25629 diff changeset	360 os.chmod(name, self.createmode & 0o666)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	361
40788 34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	362 def _auditpath(self, path, mode):
34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	363 if self._audit:
41093 c8006a25b845 vfs: makes all audited path relative Boris Feld <boris.feld@octobus.net> parents: 40999 diff changeset	364 if os.path.isabs(path) and path.startswith(self.base):
c8006a25b845 vfs: makes all audited path relative Boris Feld <boris.feld@octobus.net> parents: 40999 diff changeset	365 path = os.path.relpath(path, self.base)
40788 34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	366 r = util.checkosfilename(path)
34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	367 if r:
34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	368 raise error.Abort("%s: %r" % (r, path))
34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	369 self.audit(path, mode=mode)
34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	370
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	371 def __call__(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	372 self,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	373 path,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	374 mode="r",
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	375 atomictemp=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	376 notindexed=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	377 backgroundclose=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	378 checkambig=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	379 auditpath=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	380 makeparentdirs=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	381 ):
23370 46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	382 '''Open ``path`` file, which is relative to vfs root.
46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	383
40825 03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	384 By default, parent directories are created as needed. Newly created
03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	385 directories are marked as "not to be indexed by the content indexing
03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	386 service", if ``notindexed`` is specified for "write" mode access.
03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	387 Set ``makeparentdirs=False`` to not create directories implicitly.
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	388
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	389 If ``backgroundclose`` is passed, the file may be closed asynchronously.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	390 It can only be used if the ``self.backgroundclosing()`` context manager
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	391 is active. This should only be specified if the following criteria hold:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	392
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	393 1. There is a potential for writing thousands of files. Unless you
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	394 are writing thousands of files, the performance benefits of
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	395 asynchronously closing files is not realized.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	396 2. Files are opened exactly once for the ``backgroundclosing``
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	397 active duration and are therefore free of race conditions between
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	398 closing a file on a background thread and reopening it. (If the
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	399 file were opened multiple times, there could be unflushed data
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	400 because the original file handle hasn't been flushed/closed yet.)
29202 76f1ea360c7e vfs: make atomictempfile avoid ambiguity of file stat if needed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29119 diff changeset	401
29367 4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	402 ``checkambig`` argument is passed to atomictemplfile (valid
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	403 only for writing), and is useful only if target file is
4e6e280e238f doc: describe detail about checkambig optional argument FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29341 diff changeset	404 guarded by any lock (e.g. repo.lock or repo.wlock).
33282 d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	405
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	406 To avoid file stat ambiguity forcibly, checkambig=True involves
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	407 copying ``path`` file opened in "append" mode (e.g. for
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	408 truncation), if it is owned by another. Therefore, use
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	409 combination of append mode and checkambig=True only in limited
d1db7af81548 vfs: add explanation about cost of checkambig=True in corner case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33281 diff changeset	410 cases (see also issue5418 and issue5584 for detail).
23370 46265d0f0c7b vfs: add "notindexed" argument to invoke "ensuredir" with it in write mode FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 23368 diff changeset	411 '''
33257 15e9cbe6ae49 vfs: simplify path audit disabling in stream clone Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33234 diff changeset	412 if auditpath:
40788 34f15db81cf0 vfs: extract the audit path logic into a submethod Boris Feld <boris.feld@octobus.net> parents: 39909 diff changeset	413 self._auditpath(path, mode)
16199 8181bd808dc5 scmutil: add join method to opener to construct path relative to base Idan Kamara <idankk86@gmail.com> parents: 16198 diff changeset	414 f = self.join(path)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	415
35625 390f860228ba vfs: drop text mode flag (API) Yuya Nishihara <yuya@tcha.org> parents: 35432 diff changeset	416 if "b" not in mode:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	417 mode += "b" # for that other OS
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	418
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	419 nlink = -1
17937 3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	420 if mode not in ('r', 'rb'):
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	421 dirname, basename = util.split(f)
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	422 # If basename is empty, then the path is malformed because it points
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	423 # to a directory. Let the posixfile() call below raise IOError.
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	424 if basename:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	425 if atomictemp:
40825 03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	426 if makeparentdirs:
03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	427 util.makedirs(dirname, self.createmode, notindexed)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	428 return util.atomictempfile(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	429 f, mode, self.createmode, checkambig=checkambig
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	430 )
17937 3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	431 try:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	432 if 'w' in mode:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	433 util.unlink(f)
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	434 nlink = 0
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	435 else:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	436 # nlinks() may behave differently for files on Windows
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	437 # shares if the file is open.
27706 22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	438 with util.posixfile(f):
22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	439 nlink = util.nlinks(f)
22e362da27cf scmutil: use context managers for file handles Gregory Szorc <gregory.szorc@gmail.com> parents: 27651 diff changeset	440 if nlink < 1:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	441 nlink = 2 # force mktempcopy (issue1922)
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 25658 diff changeset	442 except (OSError, IOError) as e:
17937 3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	443 if e.errno != errno.ENOENT:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	444 raise
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	445 nlink = 0
40825 03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	446 if makeparentdirs:
03bca908d9fb vfs: add option to not create parent directories implicitly Yuya Nishihara <yuya@tcha.org> parents: 40788 diff changeset	447 util.makedirs(dirname, self.createmode, notindexed)
17937 3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	448 if nlink > 0:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	449 if self._trustnlink is None:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	450 self._trustnlink = nlink > 1 or util.checknlink(f)
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	451 if nlink > 1 or not self._trustnlink:
3cb032d50447 vfs: optimize __call__ by not calling util.split for reads Adrian Buehlmann <adrian@cadifra.com> parents: 17850 diff changeset	452 util.rename(util.mktempcopy(f), f)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	453 fp = util.posixfile(f, mode)
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	454 if nlink == 0:
17763 13070de77c86 vfs: backout fchmod change from 76b73ce0ffac Matt Mackall <mpm@selenic.com> parents: 17752 diff changeset	455 self._fixfilemode(f)
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	456
30000 9766d88c2465 vfs: use checkambigatclosing in checkambig=True but atomictemp=False case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29999 diff changeset	457 if checkambig:
9766d88c2465 vfs: use checkambigatclosing in checkambig=True but atomictemp=False case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29999 diff changeset	458 if mode in ('r', 'rb'):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	459 raise error.Abort(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	460 _(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	461 'implementation error: mode %s is not'
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	462 ' valid for checkambig=True'
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	463 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	464 % mode
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	465 )
30000 9766d88c2465 vfs: use checkambigatclosing in checkambig=True but atomictemp=False case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29999 diff changeset	466 fp = checkambigatclosing(fp)
9766d88c2465 vfs: use checkambigatclosing in checkambig=True but atomictemp=False case FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29999 diff changeset	467
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	468 if backgroundclose and isinstance(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	469 threading.currentThread(), threading._MainThread
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	470 ):
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	471 if not self._backgroundfilecloser:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	472 raise error.Abort(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	473 _(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	474 'backgroundclose can only be used when a '
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	475 'backgroundclosing context manager is active'
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	476 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	477 )
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	478
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	479 fp = delayclosedfile(fp, self._backgroundfilecloser)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	480
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	481 return fp
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	482
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	483 def symlink(self, src, dst):
18327 4aecdb91443c scmutil: simplify vfs.audit - drop wrapped vfs.auditor Mads Kiilerich <mads@kiilerich.com> parents: 18316 diff changeset	484 self.audit(dst)
16199 8181bd808dc5 scmutil: add join method to opener to construct path relative to base Idan Kamara <idankk86@gmail.com> parents: 16198 diff changeset	485 linkname = self.join(dst)
31555 18b9d9b95719 vfs: use tryunlink Ryan McElroy <rmcelroy@fb.com> parents: 31548 diff changeset	486 util.tryunlink(linkname)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	487
29017 07be86828e79 util: fix race in makedirs() Adam Simpkins <simpkins@fb.com> parents: 28819 diff changeset	488 util.makedirs(os.path.dirname(linkname), self.createmode)
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	489
14261 e3649bcca3f6 opener: rename _can_symlink to _cansymlink Adrian Buehlmann <adrian@cadifra.com> parents: 14236 diff changeset	490 if self._cansymlink:
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	491 try:
d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	492 os.symlink(src, linkname)
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 25658 diff changeset	493 except OSError as err:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	494 raise OSError(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	495 err.errno,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	496 _('could not symlink to %r: %s')
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	497 % (src, encoding.strtolocal(err.strerror)),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	498 linkname,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	499 )
13970 d13913355390 move opener from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13962 diff changeset	500 else:
17768 9837cafc25b1 vfs: use self.write to write symlink placeholders Matt Mackall <mpm@selenic.com> parents: 17763 diff changeset	501 self.write(dst, src)
13971 bfeaa88b875d move canonpath from util to scmutil Adrian Buehlmann <adrian@cadifra.com> parents: 13970 diff changeset	502
24628 a0b47885a1c5 vfs: make it possible to pass multiple path elements to join Matt Harbison <matt_harbison@yahoo.com> parents: 24582 diff changeset	503 def join(self, path, *insidef):
17161 be016e96117a localrepo: use file API via vfs while ensuring repository directory FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17157 diff changeset	504 if path:
24628 a0b47885a1c5 vfs: make it possible to pass multiple path elements to join Matt Harbison <matt_harbison@yahoo.com> parents: 24582 diff changeset	505 return os.path.join(self.base, path, *insidef)
17681 a41fd730f230 scmutil: backout 83785bb56062 (issue3643) Matt Mackall <mpm@selenic.com> parents: 17675 diff changeset	506 else:
a41fd730f230 scmutil: backout 83785bb56062 (issue3643) Matt Mackall <mpm@selenic.com> parents: 17675 diff changeset	507 return self.base
16199 8181bd808dc5 scmutil: add join method to opener to construct path relative to base Idan Kamara <idankk86@gmail.com> parents: 16198 diff changeset	508
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	509
17649 f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	510 opener = vfs
f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	511
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	512
41096 6498f0e03526 vfs: fix proxyvfs inheritance Boris Feld <boris.feld@octobus.net> parents: 41095 diff changeset	513 class proxyvfs(abstractvfs):
17845 408ded42c5ec scmutil: abstract out mustaudit delegation Bryan O'Sullivan <bryano@fb.com> parents: 17821 diff changeset	514 def __init__(self, vfs):
408ded42c5ec scmutil: abstract out mustaudit delegation Bryan O'Sullivan <bryano@fb.com> parents: 17821 diff changeset	515 self.vfs = vfs
408ded42c5ec scmutil: abstract out mustaudit delegation Bryan O'Sullivan <bryano@fb.com> parents: 17821 diff changeset	516
41097 adee334d94cd vfs: handle _auditpath in proxyvfs Boris Feld <boris.feld@octobus.net> parents: 41096 diff changeset	517 def _auditpath(self, path, mode):
adee334d94cd vfs: handle _auditpath in proxyvfs Boris Feld <boris.feld@octobus.net> parents: 41096 diff changeset	518 return self.vfs._auditpath(path, mode)
adee334d94cd vfs: handle _auditpath in proxyvfs Boris Feld <boris.feld@octobus.net> parents: 41096 diff changeset	519
27879 52a4ad62b006 cleanup: use modern @property/@foo.setter property specification Augie Fackler <augie@google.com> parents: 27851 diff changeset	520 @property
29727 69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	521 def options(self):
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	522 return self.vfs.options
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	523
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	524 @options.setter
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	525 def options(self, value):
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	526 self.vfs.options = value
69109052d9ac auditvfs: forward options property from nested vfs Augie Fackler <augie@google.com> parents: 29417 diff changeset	527
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	528
41096 6498f0e03526 vfs: fix proxyvfs inheritance Boris Feld <boris.feld@octobus.net> parents: 41095 diff changeset	529 class filtervfs(proxyvfs, abstractvfs):
17649 f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	530 '''Wrapper vfs for filtering filenames with a function.'''
14090 e24b5e3c2f27 add filteropener abstraction for store openers Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14089 diff changeset	531
17846 f42cf30873dc scmutil: add mustaudit delegation to filtervfs (issue3673) Bryan O'Sullivan <bryano@fb.com> parents: 17845 diff changeset	532 def __init__(self, vfs, filter):
33412 a42369e04aee vfs: rename auditvfs to proxyvfs Yuya Nishihara <yuya@tcha.org> parents: 33282 diff changeset	533 proxyvfs.__init__(self, vfs)
14090 e24b5e3c2f27 add filteropener abstraction for store openers Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14089 diff changeset	534 self._filter = filter
e24b5e3c2f27 add filteropener abstraction for store openers Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14089 diff changeset	535
e24b5e3c2f27 add filteropener abstraction for store openers Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14089 diff changeset	536 def __call__(self, path, args, *kwargs):
17846 f42cf30873dc scmutil: add mustaudit delegation to filtervfs (issue3673) Bryan O'Sullivan <bryano@fb.com> parents: 17845 diff changeset	537 return self.vfs(self._filter(path), args, *kwargs)
14090 e24b5e3c2f27 add filteropener abstraction for store openers Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14089 diff changeset	538
24628 a0b47885a1c5 vfs: make it possible to pass multiple path elements to join Matt Harbison <matt_harbison@yahoo.com> parents: 24582 diff changeset	539 def join(self, path, *insidef):
17725 ffd589d4b785 vfs: define "join()" in each classes derived from "abstractvfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17723 diff changeset	540 if path:
24628 a0b47885a1c5 vfs: make it possible to pass multiple path elements to join Matt Harbison <matt_harbison@yahoo.com> parents: 24582 diff changeset	541 return self.vfs.join(self._filter(self.vfs.reljoin(path, *insidef)))
17725 ffd589d4b785 vfs: define "join()" in each classes derived from "abstractvfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17723 diff changeset	542 else:
17846 f42cf30873dc scmutil: add mustaudit delegation to filtervfs (issue3673) Bryan O'Sullivan <bryano@fb.com> parents: 17845 diff changeset	543 return self.vfs.join(path)
17725 ffd589d4b785 vfs: define "join()" in each classes derived from "abstractvfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17723 diff changeset	544
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	545
17649 f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	546 filteropener = filtervfs
f65c6a5f256c scmutil: rename classes from "opener" to "vfs" FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17561 diff changeset	547
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	548
41096 6498f0e03526 vfs: fix proxyvfs inheritance Boris Feld <boris.feld@octobus.net> parents: 41095 diff changeset	549 class readonlyvfs(proxyvfs):
18213 c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	550 '''Wrapper vfs preventing any writing.'''
c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	551
c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	552 def __init__(self, vfs):
33412 a42369e04aee vfs: rename auditvfs to proxyvfs Yuya Nishihara <yuya@tcha.org> parents: 33282 diff changeset	553 proxyvfs.__init__(self, vfs)
18213 c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	554
c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	555 def __call__(self, path, mode='r', args, *kw):
c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	556 if mode not in ('r', 'rb'):
29389 98e8313dcd9e i18n: translate abort messages liscju <piotr.listkiewicz@gmail.com> parents: 29373 diff changeset	557 raise error.Abort(_('this vfs is read only'))
18213 c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	558 return self.vfs(path, mode, args, *kw)
c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	559
26156 a112fffdb632 scmutil.readonlyvfs: implement join Siddharth Agarwal <sid0@fb.com> parents: 26098 diff changeset	560 def join(self, path, *insidef):
a112fffdb632 scmutil.readonlyvfs: implement join Siddharth Agarwal <sid0@fb.com> parents: 26098 diff changeset	561 return self.vfs.join(path, *insidef)
18213 c38a62af000e vfs: add a read only vfs Pierre-Yves David <pierre-yves.david@ens-lyon.org> parents: 18206 diff changeset	562
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	563
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	564 class closewrapbase(object):
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	565 """Base class of wrapper, which hooks closing
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	566
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	567 Do not instantiate outside of the vfs layer.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	568 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	569
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	570 def __init__(self, fh):
31649 f80d9ddc40f3 py3: abuse r'' to preserve str-ness of literals passed to __setattr__() Yuya Nishihara <yuya@tcha.org> parents: 31555 diff changeset	571 object.__setattr__(self, r'_origfh', fh)
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	572
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	573 def __getattr__(self, attr):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	574 return getattr(self._origfh, attr)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	575
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	576 def __setattr__(self, attr, value):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	577 return setattr(self._origfh, attr, value)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	578
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	579 def __delattr__(self, attr):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	580 return delattr(self._origfh, attr)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	581
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	582 def __enter__(self):
40468 8d9f366b7f19 vfs: ensure closewrapbase fh doesn't escape by entering context manager Matt Harbison <matt_harbison@yahoo.com> parents: 39909 diff changeset	583 self._origfh.__enter__()
8d9f366b7f19 vfs: ensure closewrapbase fh doesn't escape by entering context manager Matt Harbison <matt_harbison@yahoo.com> parents: 39909 diff changeset	584 return self
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	585
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	586 def __exit__(self, exc_type, exc_value, exc_tb):
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	587 raise NotImplementedError('attempted instantiating ' + str(type(self)))
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	588
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	589 def close(self):
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	590 raise NotImplementedError('attempted instantiating ' + str(type(self)))
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	591
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	592
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	593 class delayclosedfile(closewrapbase):
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	594 """Proxy for a file object whose close is delayed.
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	595
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	596 Do not instantiate outside of the vfs layer.
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	597 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	598
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	599 def __init__(self, fh, closer):
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	600 super(delayclosedfile, self).__init__(fh)
31649 f80d9ddc40f3 py3: abuse r'' to preserve str-ness of literals passed to __setattr__() Yuya Nishihara <yuya@tcha.org> parents: 31555 diff changeset	601 object.__setattr__(self, r'_closer', closer)
29998 0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	602
0c40e64d6154 scmutil: factor out common logic of delayclosedfile to reuse it FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29813 diff changeset	603 def __exit__(self, exc_type, exc_value, exc_tb):
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	604 self._closer.close(self._origfh)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	605
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	606 def close(self):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	607 self._closer.close(self._origfh)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	608
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	609
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	610 class backgroundfilecloser(object):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	611 """Coordinates background closing of file handles on multiple threads."""
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	612
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	613 def __init__(self, ui, expectedcount=-1):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	614 self._running = False
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	615 self._entered = False
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	616 self._threads = []
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	617 self._threadexception = None
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	618
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	619 # Only Windows/NTFS has slow file closing. So only enable by default
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	620 # on that platform. But allow to be enabled elsewhere for testing.
34645 75979c8d4572 codemod: use pycompat.iswindows Jun Wu <quark@fb.com> parents: 34040 diff changeset	621 defaultenabled = pycompat.iswindows
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	622 enabled = ui.configbool('worker', 'backgroundclose', defaultenabled)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	623
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	624 if not enabled:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	625 return
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	626
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	627 # There is overhead to starting and stopping the background threads.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	628 # Don't do background processing unless the file count is large enough
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	629 # to justify it.
33231 d19804c16710 configitems: register the 'worker.backgroundcloseminfilecount' config Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33230 diff changeset	630 minfilecount = ui.configint('worker', 'backgroundcloseminfilecount')
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	631 # FUTURE dynamically start background threads after minfilecount closes.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	632 # (We don't currently have any callers that don't know their file count)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	633 if expectedcount > 0 and expectedcount < minfilecount:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	634 return
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	635
33230 5dcbd2045dcb configitems: register the 'worker.backgroundclosemaxqueue' config Pierre-Yves David <pierre-yves.david@octobus.net> parents: 32792 diff changeset	636 maxqueue = ui.configint('worker', 'backgroundclosemaxqueue')
33232 4531a967e7f1 configitems: register the 'worker.backgroundclosethreadcount' config Pierre-Yves David <pierre-yves.david@octobus.net> parents: 33231 diff changeset	637 threadcount = ui.configint('worker', 'backgroundclosethreadcount')
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	638
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	639 ui.debug(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	640 'starting %d threads for background file closing\n' % threadcount
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	641 )
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	642
37890 8fb9985382be pycompat: export queue module instead of symbols in module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35725 diff changeset	643 self._queue = pycompat.queue.Queue(maxsize=maxqueue)
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	644 self._running = True
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	645
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	646 for i in range(threadcount):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	647 t = threading.Thread(target=self._worker, name='backgroundcloser')
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	648 self._threads.append(t)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	649 t.start()
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	650
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	651 def __enter__(self):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	652 self._entered = True
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	653 return self
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	654
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	655 def __exit__(self, exc_type, exc_value, exc_tb):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	656 self._running = False
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	657
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	658 # Wait for threads to finish closing so open files don't linger for
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	659 # longer than lifetime of context manager.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	660 for t in self._threads:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	661 t.join()
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	662
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	663 def _worker(self):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	664 """Main routine for worker thread."""
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	665 while True:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	666 try:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	667 fh = self._queue.get(block=True, timeout=0.100)
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	668 # Need to catch or the thread will terminate and
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	669 # we could orphan file descriptors.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	670 try:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	671 fh.close()
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	672 except Exception as e:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	673 # Stash so can re-raise from main thread later.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	674 self._threadexception = e
37890 8fb9985382be pycompat: export queue module instead of symbols in module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35725 diff changeset	675 except pycompat.queue.Empty:
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	676 if not self._running:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	677 break
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	678
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	679 def close(self, fh):
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	680 """Schedule a file for closing."""
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	681 if not self._entered:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	682 raise error.Abort(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	683 _('can only call close() when context manager ' 'active')
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	684 )
27895 2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	685
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	686 # If a background thread encountered an exception, raise now so we fail
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	687 # fast. Otherwise we may potentially go on for minutes until the error
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	688 # is acted on.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	689 if self._threadexception:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	690 e = self._threadexception
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	691 self._threadexception = None
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	692 raise e
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	693
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	694 # If we're not actively running, close synchronously.
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	695 if not self._running:
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	696 fh.close()
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	697 return
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	698
2d6a89e79b48 scmutil: support background file closing Gregory Szorc <gregory.szorc@gmail.com> parents: 27879 diff changeset	699 self._queue.put(fh, block=True, timeout=None)
29999 57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	700
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	701
29999 57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	702 class checkambigatclosing(closewrapbase):
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	703 """Proxy for a file object, to avoid ambiguity of file stat
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	704
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	705 See also util.filestat for detail about "ambiguity of file stat".
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	706
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	707 This proxy is useful only if the target file is guarded by any
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	708 lock (e.g. repo.lock or repo.wlock)
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	709
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	710 Do not instantiate outside of the vfs layer.
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	711 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43027 diff changeset	712
29999 57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	713 def __init__(self, fh):
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	714 super(checkambigatclosing, self).__init__(fh)
32792 7ad95626f6a7 filestat: move __init__ to frompath constructor Siddharth Agarwal <sid0@fb.com> parents: 32768 diff changeset	715 object.__setattr__(self, r'_oldstat', util.filestat.frompath(fh.name))
29999 57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	716
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	717 def _checkambig(self):
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	718 oldstat = self._oldstat
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	719 if oldstat.stat:
33280 646352291f5b vfs: copy if EPERM to avoid file stat ambiguity forcibly at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 33259 diff changeset	720 _avoidambig(self._origfh.name, oldstat)
29999 57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	721
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	722 def __exit__(self, exc_type, exc_value, exc_tb):
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	723 self._origfh.__exit__(exc_type, exc_value, exc_tb)
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	724 self._checkambig()
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	725
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	726 def close(self):
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	727 self._origfh.close()
57830bd0e787 scmutil: add file object wrapper class to check ambiguity at closing FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 29998 diff changeset	728 self._checkambig()

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/vfs.py @ 43076:2372284d9457