Python:通过比较两个绝对路径获得相对路径


143

说,我有两条绝对路径。我需要检查其中一条路径所指的位置是否是另一条路径的后代。如果为真,则需要找出祖先的后代的相对路径。用Python实现此功能的好方法是什么?我可以受益于任何图书馆?

Answers:


167

os.path.commonprefix()os.path.relpath()是您的朋友:

>>> print os.path.commonprefix(['/usr/var/log', '/usr/var/security'])
'/usr/var'
>>> print os.path.commonprefix(['/tmp', '/usr/var'])  # No common prefix: the root is the common prefix
'/'

因此,您可以测试公共前缀是否是路径之一,即,其中一个路径是否是公共祖先:

paths = […, …, …]
common_prefix = os.path.commonprefix(list_of_paths)
if common_prefix in paths:
    

然后,您可以找到相对路径:

relative_paths = [os.path.relpath(path, common_prefix) for path in paths]

您甚至可以使用此方法处理两条以上的路径,并测试所有路径是否都在其中一条路径以下。

PS:根据您的路径看起来,您可能想先执行一些规范化操作(这在不知道它们是否始终以“ /”结尾或某些路径是否相对的情况下很有用)。相关功能包括os.path.abspath()os.path.normpath()

PPS:正如Peter Briggs在评论中提到的那样,上述简单方法可能会失败:

>>> os.path.commonprefix(['/usr/var', '/usr/var2/log'])
'/usr/var'

即使/usr/var没有路径的一个共同的前缀。在调用之前强制所有路径以“ /”结尾commonprefix()可解决此(特定)问题。

PPPS:如bluenote10所述,添加斜杠不能解决一般问题。这是他的后续问题:如何避免Python的os.path.commonprefix的谬误?

PPPPS:从Python 3.4开始,我们有pathlib,该模块提供了更合理的路径操作环境。我猜想,可以通过获取每个路径的所有前缀(带有PurePath.parents()),获取所有这些父集的交集并选择最长的公共前缀来获得一组路径的公共前缀。

PPPPPS:Python 3.5为这个问题引入了适当的解决方案:os.path.commonpath(),它返回有效路径。


正是我所需要的。感谢您的迅速答复。时间限制解除后,您将接受您的回答。
tamakisquare 2011年

10
注意commonprefix,例如,/usr/var/log和的公共前缀以-的形式/usr/var2/log返回/usr/var-可能不是您期望的那样。(也有可能返回无效目录的路径。)
Peter Briggs 2012年

@PeterBriggs:谢谢,这一警告很重要。我添加了一个PPS。
埃里克·O·勒比戈特

1
@EOL:我真的不知道如何通过添加斜杠来解决问题:(。如果有,['/usr/var1/log/', '/usr/var2/log/']怎么办?
bluenote10 2014年

1
@EOL:由于我没有找到解决此问题的有效方法,尽管我可以在一个单独的问题中讨论此子问题,但我可以。
bluenote10

86

os.path.relpath

从当前目录或可选的起点返回相对文件路径的路径。

>>> from os.path import relpath
>>> relpath('/usr/var/log/', '/usr/var')
'log'
>>> relpath('/usr/var/log/', '/usr/var/sad/')
'../log'

因此,如果相对路径以'..'- 开头,则表示第二条路径不是第一条路径的后代。

在Python3中,您可以使用PurePath.relative_to

Python 3.5.1 (default, Jan 22 2016, 08:54:32)
>>> from pathlib import Path

>>> Path('/usr/var/log').relative_to('/usr/var/log/')
PosixPath('.')

>>> Path('/usr/var/log').relative_to('/usr/var/')
PosixPath('log')

>>> Path('/usr/var/log').relative_to('/etc/')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/local/Cellar/python3/3.5.1/Frameworks/Python.framework/Versions/3.5/lib/python3.5/pathlib.py", line 851, in relative_to
    .format(str(self), str(formatted)))
ValueError: '/usr/var/log' does not start with '/etc'

2
检查是否存在os.pardir比检查更健壮..(虽然同意,但其他约定不多)。
Eric O Lebigot 2011年

8
我会错还是os.relpath因为它可以处理..PurePath.relative_to()不会更强大?我想念什么吗?
雷·萨利米

15

另一种选择是

>>> print os.path.relpath('/usr/var/log/', '/usr/var')
log

这总是返回相对路径。这并不能直接表明其中一条路径是否在另一条路径之上(不过,一条路径可以检查os.pardir在两条可能的相对路径前面是否存在)。
Eric O Lebigot 2011年

8

在Python 3中使用pathlib编写了jme的建议。

from pathlib import Path
parent = Path(r'/a/b')
son = Path(r'/a/b/c/d')            

if parent in son.parents or parent==son:
    print(son.relative_to(parent)) # returns Path object equivalent to 'c/d'

因此,dir1.relative_to(dir2)如果它们相同,将给出PosixPath('。')。使用时,if dir2 in dir1.parents它将排除身份区分。如果某人正在比较Paths并希望relative_to()在它们与Path兼容的情况下运行,则更好的解决方案可能是if dir2 in (dir1 / 'x').parentsif dir2 in dir1.parents or dir2 == dir1。然后涵盖了路径兼容性的所有情况。
ingyhere

3

不带dep的纯Python2:

def relpath(cwd, path):
    """Create a relative path for path from cwd, if possible"""
    if sys.platform == "win32":
        cwd = cwd.lower()
        path = path.lower()
    _cwd = os.path.abspath(cwd).split(os.path.sep)
    _path = os.path.abspath(path).split(os.path.sep)
    eq_until_pos = None
    for i in xrange(min(len(_cwd), len(_path))):
        if _cwd[i] == _path[i]:
            eq_until_pos = i
        else:
            break
    if eq_until_pos is None:
        return path
    newpath = [".." for i in xrange(len(_cwd[eq_until_pos+1:]))]
    newpath.extend(_path[eq_until_pos+1:])
    return os.path.join(*newpath) if newpath else "."

这个看起来不错,但是,正如我偶然发现的,当cwdpath相同时存在一个问题。它应该首先检查这两个是否相同,然后返回"""."
–SrđanPopić18'July

1

编辑:请参阅jme的答案以获取使用Python3的最佳方法。

使用pathlib,您有以下解决方案:

假设我们要检查是否son是的后代parent,并且两者都是Path对象。我们可以使用来获得路径中零件的列表list(parent.parts)。然后,我们只检查儿子的开头是否等于父母的片段列表。

>>> lparent = list(parent.parts)
>>> lson = list(son.parts)
>>> if lson[:len(lparent)] == lparent:
>>> ... #parent is a parent of son :)

如果您想剩下的部分,您可以做

>>> ''.join(lson[len(lparent):])

它是一个字符串,但是您当然可以将其用作其他Path对象的构造函数。


4
甚至比这更容易:简单地说parent in son.parents,如果是的话,用取余数son.relative_to(parent)
jme 2015年

@jme您的回答甚至更好,为什么不发布呢?
杰里米·科乔伊
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.