1.2.7. Standard Library¶
Note
Reference document for this section:
The Python Standard Library documentation: https://docs.python.org/3/library/index.html
Python Essential Reference, David Beazley, Addison-Wesley Professional
1.2.7.1. os module: operating system functionality¶
“A portable way of using operating system dependent functionality.”
Directory and file manipulation¶
Current directory:
In [1]: import os
In [2]: os.getcwd()
Out[2]: '/tmp'
List a directory:
In [3]: os.listdir(os.curdir)
Out[3]:
['profile_nzae034o',
'profile_t_5d5nvn',
'profile_01entgu1',
'profile_yd33qsl7',
'profile_mg8smfm0',
'profile_w1kc1i01',
'profile_7f4ezeoj',
'profile_hbuat1og',
'profile_xxc413i6',
'profile_c3z39rws',
'systemd-private-295be512d7dc468db55d1715ec5318c2-ModemManager.service-i7zSBF',
'profile_92reyj6u',
'profile_ixdz3yah',
'profile_4z3v831q',
'profile_ynq9lelq',
'profile_nlwsi04o',
'profile_3l63nzjh',
'profile_yyr8tsvw',
'clr-debug-pipe-1724-6800-in',
'profile_btcs96gu',
'profile_prv2ylqv',
'systemd-private-295be512d7dc468db55d1715ec5318c2-systemd-resolved.service-loINjr',
'profile_s_z7d_7m',
'profile_t_b8k5dr',
'systemd-private-295be512d7dc468db55d1715ec5318c2-haveged.service-wbwP2H',
'clr-debug-pipe-836-1099-in',
'profile_txfvbx5f',
'dotnet-diagnostic-1704-5172-socket',
'profile_7cq70ru8',
'profile_c7z7qew1',
'profile_vy_83ker',
'profile_bymrsiap',
'profile_mfplklzy',
'profile__p0k6jik',
'.X11-unix',
'profile_jg1p_qfz',
'snap-private-tmp',
'profile_gn7efaqx',
'profile_iy5xzbhn',
'profile_d5zghg_u',
'clr-debug-pipe-1704-5172-in',
'clr-debug-pipe-836-1099-out',
'profile_8sa51niz',
'profile_fpo5b209',
'profile_kmgv5chb',
'profile_nvhaza4v',
'profile_4q5mf6k6',
'profile_tflbfyvm',
'systemd-private-295be512d7dc468db55d1715ec5318c2-chrony.service-vqfEZX',
'profile__uz7374g',
'profile_9dgeusic',
'profile_3tt834je',
'.ICE-unix',
'profile_jjo7hqat',
'systemd-private-295be512d7dc468db55d1715ec5318c2-systemd-logind.service-ZGgqIQ',
'profile_0h8ylr0f',
'profile_05tjnkz0',
'profile_scy06n8e',
'profile_73ifia0m',
'profile_jmivhb10',
'profile_kae2zv11',
'profile_gv4djixj',
'dotnet-diagnostic-1724-6800-socket',
'profile_4daxe13w',
'profile_131ezv7o',
'profile_0l86llrd',
'profile_xc5_ucb5',
'profile__g_yq8cq',
'profile_9mwi7yb6',
'profile_l6rrprd4',
'profile_8us6bgkh',
'profile_pgn6nzw7',
'clr-debug-pipe-1724-6800-out',
'profile_85fo5qrq',
'profile_rby7podi',
'.XIM-unix',
'profile_yhyi2nld',
'profile_d0s8cwvn',
'dotnet-diagnostic-836-1099-socket',
'clr-debug-pipe-1704-5172-out',
'.font-unix',
'profile_5116q8fo',
'profile_3jiu7p4p',
'profile__t3xfd2w',
'profile_jz0hhwbr',
'systemd-private-295be512d7dc468db55d1715ec5318c2-polkit.service-FK8x4n',
'profile_4xk4q27a',
'profile_spuk0sru',
'profile_yhq6l8ip',
'profile_nt_53bbe',
'hsperfdata_root']
Make a directory:
In [4]: os.mkdir('junkdir')
In [5]: 'junkdir' in os.listdir(os.curdir)
Out[5]: True
Rename the directory:
In [6]: os.rename('junkdir', 'foodir')
In [7]: 'junkdir' in os.listdir(os.curdir)
Out[7]: False
In [8]: 'foodir' in os.listdir(os.curdir)
Out[8]: True
In [9]: os.rmdir('foodir')
In [10]: 'foodir' in os.listdir(os.curdir)
Out[10]: False
Delete a file:
In [11]: fp = open('junk.txt', 'w')
In [12]: fp.close()
In [13]: 'junk.txt' in os.listdir(os.curdir)
Out[13]: True
In [14]: os.remove('junk.txt')
In [15]: 'junk.txt' in os.listdir(os.curdir)
Out[15]: False
os.path: path manipulations¶
os.path provides common operations on pathnames.
In [16]: fp = open('junk.txt', 'w')
In [17]: fp.close()
In [18]: a = os.path.abspath('junk.txt')
In [19]: a
Out[19]: '/tmp/junk.txt'
In [20]: os.path.split(a)
Out[20]: ('/tmp', 'junk.txt')
In [21]: os.path.dirname(a)
Out[21]: '/tmp'
In [22]: os.path.basename(a)
Out[22]: 'junk.txt'
In [23]: os.path.splitext(os.path.basename(a))
Out[23]: ('junk', '.txt')
In [24]: os.path.exists('junk.txt')
Out[24]: True
In [25]: os.path.isfile('junk.txt')
Out[25]: True
In [26]: os.path.isdir('junk.txt')
Out[26]: False
In [27]: os.path.expanduser('~/local')
Out[27]: '/home/runner/local'
In [28]: os.path.join(os.path.expanduser('~'), 'local', 'bin')
Out[28]: '/home/runner/local/bin'
Running an external command¶
In [29]: os.system('ls')
Out[29]: 0
Note
Alternative to os.system
A noteworthy alternative to os.system is the sh module. Which provides much more convenient ways to
obtain the output, error stream and exit code of the external command.
In [30]: import sh
In [31]: com = sh.ls()
In [31]: print(com)
basic_types.rst exceptions.rst oop.rst standard_library.rst
control_flow.rst first_steps.rst python_language.rst
demo2.py functions.rst python-logo.png
demo.py io.rst reusing_code.rst
In [32]: type(com)
Out[32]: str
Walking a directory¶
os.path.walk generates a list of filenames in a directory tree.
In [33]: for dirpath, dirnames, filenames in os.walk(os.curdir):
....: for fp in filenames:
....: print(os.path.abspath(fp))
....:
....:
/tmp/clr-debug-pipe-1724-6800-in
/tmp/clr-debug-pipe-836-1099-in
/tmp/dotnet-diagnostic-1704-5172-socket
/tmp/junk.txt
/tmp/clr-debug-pipe-1704-5172-in
/tmp/clr-debug-pipe-836-1099-out
/tmp/dotnet-diagnostic-1724-6800-socket
/tmp/clr-debug-pipe-1724-6800-out
/tmp/dotnet-diagnostic-836-1099-socket
/tmp/clr-debug-pipe-1704-5172-out
/tmp/README
/tmp/README
/tmp/bookmarks
/tmp/dhist
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
/tmp/README
Environment variables:¶
In [34]: os.environ.keys()
Out[34]: KeysView(environ({'SHELL': '/bin/bash', 'COLORTERM': 'truecolor', ...}))
In [35]: os.environ['SHELL']
Out[35]: '/bin/bash'
1.2.7.2. shutil: high-level file operations¶
The shutil provides useful file operations:
shutil.rmtree: Recursively delete a directory tree.
shutil.move: Recursively move a file or directory to another location.
shutil.copy: Copy files or directories.
1.2.7.3. glob: Pattern matching on files¶
The glob module provides convenient file pattern matching.
Find all files ending in .txt:
In [36]: import glob
In [37]: glob.glob('*.txt')
Out[37]: ['junk.txt']
1.2.7.4. sys module: system-specific information¶
System-specific information related to the Python interpreter.
Which version of python are you running and where is it installed:
In [38]: import sys
In [39]: sys.platform
Out[39]: 'linux'
In [40]: sys.version
Out[40]: '3.12.8 (main, Dec 4 2024, 06:20:31) [GCC 13.2.0]'
In [41]: sys.prefix
Out[41]: '/opt/hostedtoolcache/Python/3.12.8/x64'
List of command line arguments passed to a Python script:
In [42]: sys.argv
Out[42]:
['/opt/hostedtoolcache/Python/3.12.8/x64/lib/python3.12/site-packages/sphinx/__main__.py',
'-b',
'latex',
'-d',
'build/doctrees',
'.',
'build/latex']
sys.path is a list of strings that specifies the search path for
modules. Initialized from PYTHONPATH:
In [43]: sys.path
Out[43]:
['/home/runner/work/scientific-python-lectures/scientific-python-lectures',
'/opt/hostedtoolcache/Python/3.12.8/x64/lib/python312.zip',
'/opt/hostedtoolcache/Python/3.12.8/x64/lib/python3.12',
'/opt/hostedtoolcache/Python/3.12.8/x64/lib/python3.12/lib-dynload',
'/opt/hostedtoolcache/Python/3.12.8/x64/lib/python3.12/site-packages']
1.2.7.5. pickle: easy persistence¶
Useful to store arbitrary objects to a file. Not safe or fast!
In [44]: import pickle
In [45]: l = [1, None, 'Stan']
In [46]: with open('test.pkl', 'wb') as file:
....: pickle.dump(l, file)
....:
In [47]: with open('test.pkl', 'rb') as file:
....: out = pickle.load(file)
....:
In [48]: out
Out[48]: [1, None, 'Stan']