"stat" --- Interpreting "stat()" results
****************************************

**Code source :** Lib/stat.py

======================================================================

The "stat" module defines constants and functions for interpreting the
results of "os.stat()", "os.fstat()" and "os.lstat()" (if they exist).
For complete details about the "stat()", "fstat()" and "lstat()"
calls, consult the documentation for your system.

Modifié dans la version 3.4: Le module *stat* est implémenté en C.

Le module "stat" définit les fonctions suivantes pour tester des types
de fichiers spécifiques :

stat.S_ISDIR(mode)

   Renvoie une valeur différente de zéro si c'est un mode d'un
   répertoire.

stat.S_ISCHR(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'un fichier
   spécial caractère de périphérique.

stat.S_ISBLK(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'un fichier
   spécial bloc.

stat.S_ISREG(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'un fichier
   normal.

stat.S_ISFIFO(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'une FIFO
   (tube nommé)

stat.S_ISLNK(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'un lien
   symbolique.

stat.S_ISSOCK(mode)

   Renvoie une valeur différente de zéro si c'est le mode d'un
   *socket*.

stat.S_ISDOOR(mode)

   Return non-zero if the mode is from a door.

   Ajouté dans la version 3.4.

stat.S_ISPORT(mode)

   Return non-zero if the mode is from an event port.

   Ajouté dans la version 3.4.

stat.S_ISWHT(mode)

   Return non-zero if the mode is from a whiteout.

   Ajouté dans la version 3.4.

Deux autres fonctions sont définies pour permettre plus de
manipulation du mode du fichier :

stat.S_IMODE(mode)

   Return the portion of the file's mode that can be set by
   "os.chmod()"---that is, the file's permission bits, plus the sticky
   bit, set-group-id, and set-user-id bits (on systems that support
   them).

stat.S_IFMT(mode)

   Return the portion of the file's mode that describes the file type
   (used by the "S_IS*()" functions above).

Normally, you would use the "os.path.is*()" functions for testing the
type of a file; the functions here are useful when you are doing
multiple tests of the same file and wish to avoid the overhead of the
"stat()" system call for each test.  These are also useful when
checking for information about a file that isn't handled by "os.path",
like the tests for block and character devices.

Exemple :

   import os, sys
   from stat import *

   def walktree(top, callback):
       '''recursively descend the directory tree rooted at top,
          calling the callback function for each regular file'''

       for f in os.listdir(top):
           pathname = os.path.join(top, f)
           mode = os.lstat(pathname).st_mode
           if S_ISDIR(mode):
               # It's a directory, recurse into it
               walktree(pathname, callback)
           elif S_ISREG(mode):
               # It's a file, call the callback function
               callback(pathname)
           else:
               # Unknown file type, print a message
               print('Skipping %s' % pathname)

   def visitfile(file):
       print('visiting', file)

   if __name__ == '__main__':
       walktree(sys.argv[1], visitfile)

An additional utility function is provided to convert a file's mode in
a human readable string:

stat.filemode(mode)

   Convert a file's mode to a string of the form '-rwxrwxrwx'.

   Ajouté dans la version 3.3.

   Modifié dans la version 3.4: The function supports "S_IFDOOR",
   "S_IFPORT" and "S_IFWHT".

All the variables below are simply symbolic indexes into the 10-tuple
returned by "os.stat()", "os.fstat()" or "os.lstat()".

stat.ST_MODE

   Mode de protection de l'*inode*.

stat.ST_INO

   Numéro d'*inode*.

stat.ST_DEV

   Device inode resides on.

stat.ST_NLINK

   Nombre de liens vers l'*inode*.

stat.ST_UID

   Identifiant utilisateur du propriétaire.

stat.ST_GID

   Identifiant de groupe du propriétaire.

stat.ST_SIZE

   Size in bytes of a plain file; amount of data waiting on some
   special files.

stat.ST_ATIME

   L'heure du dernier accès.

stat.ST_MTIME

   L'heure de la dernière modification.

stat.ST_CTIME

   The "ctime" as reported by the operating system.  On some systems
   (like Unix) is the time of the last metadata change, and, on others
   (like Windows), is the creation time (see platform documentation
   for details).

The interpretation of "file size" changes according to the file type.
For plain files this is the size of the file in bytes.  For FIFOs and
sockets under most flavors of Unix (including Linux in particular),
the "size" is the number of bytes waiting to be read at the time of
the call to "os.stat()", "os.fstat()", or "os.lstat()"; this can
sometimes be useful, especially for polling one of these special files
after a non-blocking open.  The meaning of the size field for other
character and block devices varies more, depending on the
implementation of the underlying system call.

The variables below define the flags used in the "ST_MODE" field.

Use of the functions above is more portable than use of the first set
of flags:

stat.S_IFSOCK

   Socket.

stat.S_IFLNK

   Lien symbolique.

stat.S_IFREG

   Fichier normal.

stat.S_IFBLK

   Périphérique en mode bloc.

stat.S_IFDIR

   Dossier.

stat.S_IFCHR

   Périphérique en mode caractère.

stat.S_IFIFO

   FIFO.

stat.S_IFDOOR

   Door.

   Ajouté dans la version 3.4.

stat.S_IFPORT

   Event port.

   Ajouté dans la version 3.4.

stat.S_IFWHT

   Whiteout.

   Ajouté dans la version 3.4.

Note:

  "S_IFDOOR", "S_IFPORT" or "S_IFWHT" sont définies à 0 si la
  plateforme ne prend pas en charge les types de fichiers.

Les drapeaux suivant peuvent aussi être utilisé dans l'argument *mode*
de "os.chmod()" :

stat.S_ISUID

   Définit le bit UID.

stat.S_ISGID

   Set-group-ID bit.  This bit has several special uses.  For a
   directory it indicates that BSD semantics is to be used for that
   directory: files created there inherit their group ID from the
   directory, not from the effective group ID of the creating process,
   and directories created there will also get the "S_ISGID" bit set.
   For a file that does not have the group execution bit ("S_IXGRP")
   set, the set-group-ID bit indicates mandatory file/record locking
   (see also "S_ENFMT").

stat.S_ISVTX

   Sticky bit.  When this bit is set on a directory it means that a
   file in that directory can be renamed or deleted only by the owner
   of the file, by the owner of the directory, or by a privileged
   process.

stat.S_IRWXU

   Mask for file owner permissions.

stat.S_IRUSR

   Le propriétaire possède le droit de lecture.

stat.S_IWUSR

   Le propriétaire possède le droit d'écriture.

stat.S_IXUSR

   Le propriétaire possède le droit d'exécution.

stat.S_IRWXG

   Masque pour extraire les permissions du groupe.

stat.S_IRGRP

   Le groupe possède le droit de lecture.

stat.S_IWGRP

   Le groupe possède le droit d'écriture.

stat.S_IXGRP

   Le groupe possède le droit d'exécution.

stat.S_IRWXO

   Mask for permissions for others (not in group).

stat.S_IROTH

   Others have read permission.

stat.S_IWOTH

   Others have write permission.

stat.S_IXOTH

   Others have execute permission.

stat.S_ENFMT

   System V file locking enforcement.  This flag is shared with
   "S_ISGID": file/record locking is enforced on files that do not
   have the group execution bit ("S_IXGRP") set.

stat.S_IREAD

   Unix V7 synonym for "S_IRUSR".

stat.S_IWRITE

   Unix V7 synonym for "S_IWUSR".

stat.S_IEXEC

   Unix V7 synonym for "S_IXUSR".

The following flags can be used in the *flags* argument of
"os.chflags()":

stat.UF_SETTABLE

   All user settable flags.

   Ajouté dans la version 3.13.

stat.UF_NODUMP

   Do not dump the file.

stat.UF_IMMUTABLE

   Le fichier ne peut pas être modifié.

stat.UF_APPEND

   The file may only be appended to.

stat.UF_OPAQUE

   The directory is opaque when viewed through a union stack.

stat.UF_NOUNLINK

   Le fichier ne peut pas être renommé ou supprimé.

stat.UF_COMPRESSED

   The file is stored compressed (macOS 10.6+).

stat.UF_TRACKED

   Used for handling document IDs (macOS)

   Ajouté dans la version 3.13.

stat.UF_DATAVAULT

   The file needs an entitlement for reading or writing (macOS 10.13+)

   Ajouté dans la version 3.13.

stat.UF_HIDDEN

   Le fichier ne peut pas être affiché dans une GUI (macOS 10.5+).

stat.SF_SETTABLE

   All super-user changeable flags

   Ajouté dans la version 3.13.

stat.SF_SUPPORTED

   All super-user supported flags

   Availability: macOS

   Ajouté dans la version 3.13.

stat.SF_SYNTHETIC

   All super-user read-only synthetic flags

   Availability: macOS

   Ajouté dans la version 3.13.

stat.SF_ARCHIVED

   Le fichier peut être archivé.

stat.SF_IMMUTABLE

   Le fichier ne peut pas être modifié.

stat.SF_APPEND

   The file may only be appended to.

stat.SF_RESTRICTED

   The file needs an entitlement to write to (macOS 10.13+)

   Ajouté dans la version 3.13.

stat.SF_NOUNLINK

   Le fichier ne peut pas être renommé ou supprimé.

stat.SF_SNAPSHOT

   The file is a snapshot file.

stat.SF_FIRMLINK

   The file is a firmlink (macOS 10.15+)

   Ajouté dans la version 3.13.

stat.SF_DATALESS

   The file is a dataless object (macOS 10.15+)

   Ajouté dans la version 3.13.

See the *BSD or macOS systems man page *chflags(2)* for more
information.

On Windows, the following file attribute constants are available for
use when testing bits in the "st_file_attributes" member returned by
"os.stat()". See the Windows API documentation for more detail on the
meaning of these constants.

stat.FILE_ATTRIBUTE_ARCHIVE
stat.FILE_ATTRIBUTE_COMPRESSED
stat.FILE_ATTRIBUTE_DEVICE
stat.FILE_ATTRIBUTE_DIRECTORY
stat.FILE_ATTRIBUTE_ENCRYPTED
stat.FILE_ATTRIBUTE_HIDDEN
stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
stat.FILE_ATTRIBUTE_NORMAL
stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
stat.FILE_ATTRIBUTE_OFFLINE
stat.FILE_ATTRIBUTE_READONLY
stat.FILE_ATTRIBUTE_REPARSE_POINT
stat.FILE_ATTRIBUTE_SPARSE_FILE
stat.FILE_ATTRIBUTE_SYSTEM
stat.FILE_ATTRIBUTE_TEMPORARY
stat.FILE_ATTRIBUTE_VIRTUAL

   Ajouté dans la version 3.5.

On Windows, the following constants are available for comparing
against the "st_reparse_tag" member returned by "os.lstat()". These
are well-known constants, but are not an exhaustive list.

stat.IO_REPARSE_TAG_SYMLINK
stat.IO_REPARSE_TAG_MOUNT_POINT
stat.IO_REPARSE_TAG_APPEXECLINK

   Ajouté dans la version 3.8.
