Doc/library/statvfs.rst

   1 :mod:`statvfs` --- Constants used with :func:`os.statvfs`
   2 =========================================================
   3
   4 .. module:: statvfs
   5    :synopsis: Constants for interpreting the result of os.statvfs().
   6    :deprecated:
   7
   8 .. deprecated:: 2.6
   9    The :mod:`statvfs` module has been deprecated for removal in Python 3.0.
  10
  11
  12 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
  13
  14
  15 The :mod:`statvfs` module defines constants so interpreting the result if
  16 :func:`os.statvfs`, which returns a tuple, can be made without remembering
  17 "magic numbers."  Each of the constants defined in this module is the *index* of
  18 the entry in the tuple returned by :func:`os.statvfs` that contains the
  19 specified information.
  20
  21
  22 .. data:: F_BSIZE
  23
  24    Preferred file system block size.
  25
  26
  27 .. data:: F_FRSIZE
  28
  29    Fundamental file system block size.
  30
  31
  32 .. data:: F_BLOCKS
  33
  34    Total number of blocks in the filesystem.
  35
  36
  37 .. data:: F_BFREE
  38
  39    Total number of free blocks.
  40
  41
  42 .. data:: F_BAVAIL
  43
  44    Free blocks available to non-super user.
  45
  46
  47 .. data:: F_FILES
  48
  49    Total number of file nodes.
  50
  51
  52 .. data:: F_FFREE
  53
  54    Total number of free file nodes.
  55
  56
  57 .. data:: F_FAVAIL
  58
  59    Free nodes available to non-super user.
  60
  61
  62 .. data:: F_FLAG
  63
  64    Flags. System dependent: see :c:func:`statvfs` man page.
  65
  66
  67 .. data:: F_NAMEMAX
  68
  69    Maximum file name length.
  70