通过比较两个绝对路径获取相对路径

Question

说，我有两条绝对路径。我需要检查其中一个路径引用的位置是否是另一个路径的后代。如果为真，我需要从祖先中找出后代的相对路径。在 Python 中实现这个的好方法是什么？我可以从中受益的任何图书馆？

Answer 1

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 在 cmets 中提到的，上述简单方法可能会失败：

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

即使/usr/var 不是路径的公共前缀。在调用commonprefix() 之前强制所有路径以“/”结尾可以解决这个（特定）问题。

PPPS：正如 bluenote10 提到的，添加斜线并不能解决一般问题。这是他的后续问题：How to circumvent the fallacy of Python's os.path.commonprefix?

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

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

Answer 2

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'

Answer 3

另一种选择是

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

Answer 4

在 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'

Answer 5

纯Python2 w/o dep：

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 "."

Answer 6

编辑：请参阅 jme 的回答，了解 Python3 的最佳方式。

使用 pathlib，您有以下解决方案：

假设我们要检查son 是否是parent 的后代，并且两者都是Path 对象。 我们可以通过list(parent.parts) 获得路径中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 对象的构造函数。