diff options
Diffstat (limited to 'Doc/library/os.rst')
| -rw-r--r-- | Doc/library/os.rst | 36 |
1 files changed, 22 insertions, 14 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 7c96bfe..96d2184 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -13,26 +13,34 @@ module. For creating temporary files and directories see the :mod:`tempfile` module, and for high-level file and directory handling see the :mod:`shutil` module. -The design of all built-in operating system dependent modules of Python is such -that as long as the same functionality is available, it uses the same interface; -for example, the function ``os.stat(path)`` returns stat information about -*path* in the same format (which happens to have originated with the POSIX -interface). +Notes on the availability of these functions: -Extensions peculiar to a particular operating system are also available through -the :mod:`os` module, but using them is of course a threat to portability! +* The design of all built-in operating system dependent modules of Python is + such that as long as the same functionality is available, it uses the same + interface; for example, the function ``os.stat(path)`` returns stat + information about *path* in the same format (which happens to have originated + with the POSIX interface). -.. note:: +* Extensions peculiar to a particular operating system are also available + through the :mod:`os` module, but using them is of course a threat to + portability. - All functions accepting path or file names accept both bytes and string - objects, and result in an object of the same type, if a path or file name is - returned. +* All functions accepting path or file names accept both bytes and string + objects, and result in an object of the same type, if a path or file name is + returned. .. note:: If not separately noted, all functions that claim "Availability: Unix" are supported on Mac OS X, which builds on a Unix core. +* An "Availability: Unix" note means that this function is commonly found on + Unix systems. It does not make any claims about its existence on a specific + operating system. + +* If not separately noted, all functions that claim "Availability: Unix" are + supported on Mac OS X, which builds on a Unix core. + .. note:: All functions in this module raise :exc:`OSError` in the case of invalid or @@ -46,9 +54,9 @@ the :mod:`os` module, but using them is of course a threat to portability! .. data:: name - The name of the operating system dependent module imported. The following names - have currently been registered: ``'posix'``, ``'nt'``, ``'mac'``, ``'os2'``, - ``'ce'``, ``'java'``. + The name of the operating system dependent module imported. The following + names have currently been registered: ``'posix'``, ``'nt'``, ``'mac'``, + ``'os2'``, ``'ce'``, ``'java'``. .. _os-filenames: |