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_i0lnpfqa',
'profile_4f5b9ty5',
'profile_25hh45ug',
'.X11-unix',
'systemd-private-8e0863d855584cee9be22cd63dc71fc7-systemd-logind.service-SezRIc',
'www-data-temp-aspnet-0',
'profile_3u2_5632',
'profile_tohvgv8d',
'dotnet-diagnostic-1608-15567-socket',
'profile_zn87vbdj',
'profile_9iresbh8',
'profile_vq0i6w49',
'profile_zim2l4be',
'profile_m_1px1nj',
'profile_lo_u5amc',
'profile_8zoh8myy',
'profile_k3s4i2ah',
'profile_9e5g3j88',
'profile_25d51f_g',
'systemd-private-8e0863d855584cee9be22cd63dc71fc7-haveged.service-rrW2rp',
'profile_wcitnept',
'profile_5usy0qye',
'clr-debug-pipe-1624-15804-in',
'profile_551loxgs',
'profile_nmoqhohe',
'profile_i41rizq7',
'profile_uz119sgq',
'profile_lsj9qvhs',
'profile_5zixz_ug',
'profile_28tnk4ye',
'clr-debug-pipe-1608-15567-in',
'profile_mc1cohvw',
'profile_dpi7nrv1',
'profile_j9lym78t',
'profile_5qcssb5q',
'profile_1cnv3bk5',
'profile_bzz22crw',
'.Test-unix',
'profile_4nlrvaob',
'profile__v_zgizm',
'profile_xl64aqgd',
'clr-debug-pipe-1624-15804-out',
'profile_gpb20q61',
'profile_djxcd62l',
'profile_3qqrm60p',
'profile_nur46o_q',
'profile_i5rzkzqf',
'profile_dc8b9e_g',
'profile_00znd7pb',
'profile_jm7bai7x',
'profile_o05nn60o',
'dotnet-diagnostic-1624-15804-socket',
'profile_flg1d7js',
'profile_4gu8ipt5',
'profile_r7p9pyfr',
'profile_s3l6i38j',
'clr-debug-pipe-600-960-in',
'profile_9kbvwma8',
'profile_57opvdm1',
'profile_517h8mrj',
'profile_zazdo3b4',
'systemd-private-8e0863d855584cee9be22cd63dc71fc7-systemd-resolved.service-0BaROl',
'.font-unix',
'profile_109t5nmw',
'profile_an_sfa9_',
'profile_i04016b2',
'clr-debug-pipe-1608-15567-out',
'profile_au8oqm4f',
'profile_0a4fqym6',
'.XIM-unix',
'profile_ii90kxdw',
'profile_3fdiky3p',
'profile_9uijnewb',
'profile_3rvxh8e1',
'profile_amy_trcr',
'profile_ykhw7bd7',
'profile_rgghzmhu',
'profile_pgkem0ez',
'profile_x7dmoxbs',
'systemd-private-8e0863d855584cee9be22cd63dc71fc7-chrony.service-riRQec',
'clr-debug-pipe-600-960-out',
'profile_1y4_uhg5',
'profile_hcejn5ct',
'profile_upmho4o7',
'profile_dohkjgqg',
'profile_z3vbl3mp',
'.ICE-unix',
'profile_ay2fq_wp',
'profile_gp9a_f38',
'dotnet-diagnostic-600-960-socket',
'snap-private-tmp']
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/junk.txt
/tmp/dotnet-diagnostic-1608-15567-socket
/tmp/clr-debug-pipe-1624-15804-in
/tmp/clr-debug-pipe-1608-15567-in
/tmp/clr-debug-pipe-1624-15804-out
/tmp/dotnet-diagnostic-1624-15804-socket
/tmp/clr-debug-pipe-600-960-in
/tmp/clr-debug-pipe-1608-15567-out
/tmp/clr-debug-pipe-600-960-out
/tmp/dotnet-diagnostic-600-960-socket
/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/dhist
/tmp/bookmarks
/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.11.9 (main, Apr 2 2024, 15:19:53) [GCC 11.4.0]'
In [41]: sys.prefix
Out[41]: '/opt/hostedtoolcache/Python/3.11.9/x64'
List of command line arguments passed to a Python script:
In [42]: sys.argv
Out[42]:
['/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/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.11.9/x64/lib/python311.zip',
'/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11',
'/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/lib-dynload',
'/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/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']