文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

求求你,别用 Os.Path 了

2024-12-03 05:02

关注

前段时间,在使用新版本的 Django 时,我发现了 settings.py 的第一行代码从

  1. import os 
  2. BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 

变成了

  1. from pathlib import Path 
  2. BASE_DIR = Path(__file__).resolve().parent.parent 

于是我就好奇,os 和 pathlib 同样是标准库,为什么 pathlib 得到了 Django 的青睐?学习了一番 pathlib 之后,发现这是一个非常高效便捷的工具,用它来处理文件系统路径相关的操作最合适不过,集成了很多快捷的功能,提升你的编程效率,那是妥妥的。

接下来让一起看一下,为什么 pathlib 更值得我们使用。

pathlib vs os

话不多说,先看下使用对比:比如说

打印当前的路径:

使用 os:

  1. In [13]: import os 
  2.  
  3. In [14]: os.getcwd() 
  4. Out[14]: '/Users/aaron' 

使用 pathlib:

  1. In [15]: from pathlib import Path 
  2.  
  3. In [16]: Path.cwd() 
  4. Out[16]: PosixPath('/Users/aaron'
  5. In [17]: print(Path.cwd()) 
  6. /Users/aaron 

使用 print 打印的结果是一样的,但 os.getcwd() 返回的是字符串,而 Path.cwd() 返回的是 PosixPath 类,你还可以对此路径进行后续的操作,会很方便。

判断路径是否存在:

使用 os:

  1. In [18]: os.path.exists("/Users/aaron/tmp"
  2.  
  3. Out[18]: True 

使用 pathlib:

  1. In [21]: tmp = Path("/Users/aaron/tmp"
  2.  
  3. In [22]: tmp.exists() 
  4. Out[22]: True 

可以看出 pathlib 更易读,更面向对象。

显示文件夹的内容

  1. In [38]: os.listdir("/Users/aaron/tmp"
  2. Out[38]: ['.DS_Store''.hypothesis''b.txt''a.txt''c.py''.ipynb_checkpoints'
  3.  
  4. In [39]: tmp.iterdir() 
  5. Out[39]: at 0x7fa3f20d95f0> 
  6.  
  7. In [40]: list(tmp.iterdir()) 
  8. Out[40]: 
  9. [PosixPath('/Users/aaron/tmp/.DS_Store'), 
  10.  PosixPath('/Users/aaron/tmp/.hypothesis'), 
  11.  PosixPath('/Users/aaron/tmp/b.txt'), 
  12.  PosixPath('/Users/aaron/tmp/a.txt'), 
  13.  PosixPath('/Users/aaron/tmp/c.py'), 
  14.  PosixPath('/Users/aaron/tmp/.ipynb_checkpoints')] 

可以看出 Path().iterdir 返回的是一个生成器,这在目录内文件特别多的时候可以大大节省内存,提升效率。

通配符支持

os 不支持含有通配符的路径,但 pathlib 可以:

  1. In [45]: list(Path("/Users/aaron/tmp").glob("*.txt")) 
  2. Out[45]: [PosixPath('/Users/aaron/tmp/b.txt'), PosixPath('/Users/aaron/tmp/a.txt')] 

便捷的读写文件操作

这是 pathlib 特有的:

  1. f = Path('test_dir/test.txt')) 
  2. f.write_text('This is a sentence.'
  3. f.read_text() 

也可以使用 with 语句:

  1. >>> p = Path('setup.py'
  2. >>> with p.open() as f: f.readline() 
  3. ... 
  4. '#!/usr/bin/env python3\n' 

获取文件的元数据

  1. In [56]: p = Path("/Users/aaron/tmp/c.py"
  2.  
  3. In [57]: p.stat() 
  4. Out[57]: os.stat_result(st_mode=33188, st_ino=35768389, st_dev=16777221, st_nlink=1, st_uid=501, st_gid=20, st_size=20, st_atime=1620633580, st_mtime=1620633578, st_ctime=1620633578) 
  5.  
  6. In [58]: p.parts 
  7. Out[58]: ('/''Users''aaron''tmp''c.py'
  8.  
  9. In [59]: p.parent 
  10. Out[59]: PosixPath('/Users/aaron/tmp'
  11.  
  12. In [60]: p.resolve() 
  13. Out[60]: PosixPath('/Users/aaron/tmp/c.py'
  14.  
  15. In [61]: p.exists() 
  16. Out[61]: True 
  17.  
  18. In [62]: p.is_dir() 
  19. Out[62]: False 
  20.  
  21. In [63]: p.is_file() 
  22. Out[63]: True 
  23.  
  24. In [64]: p.owner() 
  25. Out[64]: 'aaron' 
  26.  
  27. In [65]: p.group() 
  28. Out[65]: 'staff' 
  29.  
  30. In [66]: p.name 
  31. Out[66]: 'c.py' 
  32.  
  33. In [67]: p.suffix 
  34. Out[67]: '.py' 
  35.  
  36. In [68]: p.suffixes 
  37. Out[68]: ['.py'
  38.  
  39. In [69]: p.stem 
  40. Out[69]: 'c' 

路径的连接 join

相比 os.path.join,使用一个 / 是不是更为直观和便捷?

  1. >>> p = PurePosixPath('foo'
  2. >>> p / 'bar' 
  3. PurePosixPath('foo/bar'
  4. >>> p / PurePosixPath('bar'
  5. PurePosixPath('foo/bar'
  6. >>> 'bar' / p 
  7. PurePosixPath('bar/foo'

当然,也可以使用 joinpath 方法

  1. >>> PurePosixPath('/etc').joinpath('passwd'
  2. PurePosixPath('/etc/passwd'
  3. >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd')) 
  4. PurePosixPath('/etc/passwd'
  5. >>> PurePosixPath('/etc').joinpath('init.d''apache2'
  6. PurePosixPath('/etc/init.d/apache2'
  7. >>> PureWindowsPath('c:').joinpath('/Program Files'
  8. PureWindowsPath('c:/Program Files'

路径匹配

  1. >>> PurePath('a/b.py').match('*.py'
  2. True 
  3. >>> PurePath('/a/b/c.py').match('b/*.py'
  4. True 
  5. >>> PurePath('/a/b/c.py').match('a/*.py'
  6. False 

pathlib 出现的背景和要解决的问题

pathlib 目的是提供一个简单的类层次结构来处理文件系统的路径,同时提供路径相关的常见操作。那为什么不使用 os 模块或者 os.path 来实现呢?

许多人更喜欢使用 datetime 模块提供的高级对象来处理日期和时间,而不是使用数字时间戳和 time 模块 API。同样的原因,假如使用专用类表示文件系统路径,也会更受欢迎。

换句话说,os.path 是面向过程风格的,而 pathlib 是面向对象风格的。Python 也在一直在慢慢地从复制 C 语言的 API 转变为围绕各种常见功能提供更好,更有用的抽象。

其他方面,使用专用的类处理特定的需求也是很有必要的,例如 Windows 路径不区分大小写。

在这样的背景下,pathlib 在 Python 3.4 版本加入标准库。

pathlib 的优势和劣势分别是什么

pathlib 的优势在于考虑了 Windows 路径的特殊性,同时提供了带 I/O 操作的和不带 I/O 操作的类,使用场景更加明确,API 调用更加易懂。

先看下 pathlib 对类的划分:

图中的箭头表示继承自,比如 Path 继承自 PurePath,PurePath 表示纯路径类,只提供路径常见的操作,但不包括实际 I/O 操作,相对安全;Path 包含 PurePath 的全部功能,包括 I/O 操作。

PurePath 有两个子类,一个是 PureWindowsPath,表示 Windows 下的路径,不区分大小写,另一个是 PurePosixPath,表示其他系统的路径。有了 PureWindowsPath,你可以这样对路径进行比较:

  1. from pathlib import PureWindowsPath 
  2. >>> PureWindowsPath('a') == PureWindowsPath('A'
  3. True 

PurePath 可以在任何操作系统上实例化,也就是说与平台无关,你可以在 unix 系统上使用 PureWindowsPath,也可以在 Windows 系统上使用 PurePosixPath,他们还可以相互比较。

  1. >>> from pathlib import PurePosixPath, PureWindowsPath, PosixPath   
  2. >>> PurePosixPath('a') == PurePosixPath('b'
  3. False 
  4. >>> PurePosixPath('a') < PurePosixPath('b'
  5. True 
  6. >>> PurePosixPath('a') == PosixPath('a'
  7. True 
  8. >>> PurePosixPath('a') == PureWindowsPath('a'
  9. False 

可以看出,同一个类可以相互比较,不同的类比较的结果是 False。

相反,包含 I/O 操作的类 PosixPath 及 WindowsPath 只能在对应的平台实例化:

  1. In [8]: from pathlib import PosixPath,WindowsPath 
  2.  
  3. In [9]: PosixPath('a'
  4. Out[9]: PosixPath('a'
  5.  
  6. In [10]: WindowsPath('a'
  7. --------------------------------------------------------------------------- 
  8. NotImplementedError                       Traceback (most recent call last
  9.  in  
  10. ----> 1 WindowsPath('a') 
  11.  
  12. /Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/pathlib.py in __new__(cls, *args, **kwargs) 
  13.    1038         self = cls._from_parts(args, init=False
  14.    1039         if not self._flavour.is_supported: 
  15. -> 1040             raise NotImplementedError("cannot instantiate %r on your system" 
  16.    1041                                       % (cls.__name__,)) 
  17.    1042         self._init() 
  18.  
  19. NotImplementedError: cannot instantiate 'WindowsPath' on your system 
  20.  
  21. In [11]: 

要说劣势,如果有的话,那就是在选择类时会比较困惑,到底用哪一个呢?其实如果你不太确定的话,用 Path 就可以了,这也是它的名称最短的原因,因为更加常用,短点的名称编写的更快。

适用的场景

如果要处理文件系统相关的操作,选 pathlib 就对了。

一些关键点

获取家目录:

  1. In [70]: from pathlib import Path 
  2.  
  3. In [71]: Path.home() 
  4. Out[71]: PosixPath('/Users/aaron'

父目录的层级获取:

  1. >>> p = PureWindowsPath('c:/foo/bar/setup.py'
  2. >>> p.parents[0] 
  3. PureWindowsPath('c:/foo/bar'
  4. >>> p.parents[1] 
  5. PureWindowsPath('c:/foo'
  6. >>> p.parents[2] 
  7. PureWindowsPath('c:/'

获取多个文件后缀:

  1. >>> PurePosixPath('my/library.tar.gar').suffixes 
  2. ['.tar''.gar'
  3. >>> PurePosixPath('my/library.tar.gz').suffixes 
  4. ['.tar''.gz'
  5. >>> PurePosixPath('my/library').suffixes 
  6. [] 

Windows 风格转 Posix:

  1. >>> p = PureWindowsPath('c:\\windows'
  2. >>> str(p) 
  3. 'c:\\windows' 
  4. >>> p.as_posix() 
  5. 'c:/windows' 

获取文件的 uri:

  1. >>> p = PurePosixPath('/etc/passwd'
  2. >>> p.as_uri() 
  3. 'file:///etc/passwd' 
  4. >>> p = PureWindowsPath('c:/Windows'
  5. >>> p.as_uri() 
  6. 'file:///c:/Windows' 

判断是否绝对路径:

  1. >>> PurePosixPath('/a/b').is_absolute() 
  2. True 
  3. >>> PurePosixPath('a/b').is_absolute() 
  4. False 
  5.  
  6. >>> PureWindowsPath('c:/a/b').is_absolute() 
  7. True 
  8. >>> PureWindowsPath('/a/b').is_absolute() 
  9. False 
  10. >>> PureWindowsPath('c:').is_absolute() 
  11. False 
  12. >>> PureWindowsPath('//some/share').is_absolute() 
  13. True 

文件名若有变化:

  1. >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz'
  2. >>> p.with_name('setup.py'
  3. PureWindowsPath('c:/Downloads/setup.py'

是不是非常方便?

技术的底层原理和关键实现

pathlib 并不是基于 str 的实现,而是基于 object 设计的,这样就严格地区分了 Path 对象和字符串对象,同时也用到了一点 os 的功能,比如 os.name,os.getcwd 等,这一点大家可以看 pathlib 的源码了解更多。

最后的话

本文分享了 pathlib 的用法,后面要处理路径相关的操作时,你应该第一时间想到 pathlib,不会用没有关系,搜索引擎所搜索 pathlib 就可以看到具体的使用方法。

虽然 pathlib 比 os 库更高级,更方便并且提供了很多便捷的功能,但是我们仍然需要知道如何使用 os 库,因为 os 库是 Python 中功能最强大且最基本的库之一,但是,在需要一些文件系统操作时,强烈建议使用 pathlib。

本文转载自微信公众号「Python七号」,可以通过以下二维码关注。转载本文请联系Python七号公众号。

 

来源: Python七号内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯