Returning Windows file attribute information via os.stat()

Modules/_stat.c

 /* stat.h interface
  *
  * The module defines all S_IF*, S_I*, UF_*, SF_* and ST_* constants to
  * sensible default values as well as defines S_IS*() macros in order to keep
  * backward compatibility with the old stat.py module.
  *
  * New constants and macros such as S_IFDOOR / S_ISDOOR() are always defined
  * as int 0.
  *
  * NOTE: POSIX only defines the values of the S_I* permission bits.
  *
  */
 
 #define PY_SSIZE_T_CLEAN
 #include "Python.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 #ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif /* HAVE_SYS_TYPES_H */
 
 #ifdef HAVE_SYS_STAT_H
 #include <sys/stat.h>
 #endif /* HAVE_SYS_STAT_H */
 
 #ifdef MS_WINDOWS
+#include <windows.h>
 typedef unsigned short mode_t;
 #endif
 
 /* From Python's stat.py */
 #ifndef S_IMODE
 #  define S_IMODE 07777
 #endif
 
 /* S_IFXXX constants (file types)
  *
@@ skipping 426 matching lines @@
 "ST_MODE\n\
 ST_INO\n\
 ST_DEV\n\
 ST_NLINK\n\
 ST_UID\n\
 ST_GID\n\
 ST_SIZE\n\
 ST_ATIME\n\
 ST_MTIME\n\
 ST_CTIME\n\
+\n"
+
+"FILE_ATTRIBUTE_*: Windows file attribute constants (only present on Windows)\n\
 ");
 
 
 static struct PyModuleDef statmodule = {
     PyModuleDef_HEAD_INIT,
     "_stat",
     module_doc,
     -1,
     stat_methods,
     NULL,
@@ skipping 61 matching lines @@
     if (PyModule_AddIntConstant(m, "ST_MODE", 0)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_INO", 1)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_DEV", 2)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_NLINK", 3)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_UID", 4)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_GID", 5)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_SIZE", 6)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_ATIME", 7)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_MTIME", 8)) return NULL;
     if (PyModule_AddIntConstant(m, "ST_CTIME", 9)) return NULL;
+
+#ifdef MS_WINDOWS

[Zach Ware, 2014/06/13 15:49:28]

Even though these constants are really only useful on Windows, I wonder if we
shouldn't define them on all platforms anyway since all other stat constants are
at least defined (if only to 0).

Either way, these should probably be defined in stat.py as well (sorry; I should
have said 'as well as' instead of 'instead of' when I mentioned _stat.c in the
email thread).

[haypo, 2014/06/13 16:00:20]

The purpose of the _stat module is to only provide data from the OS, to not
hardcode constants. So -1 to provide these constants on all platforms.

[Zach Ware, 2014/06/13 22:56:16]

This is just the opposite of the situation for the rest of the constants in this
module, most of which are not defined outside of this module on Windows.  I'm
not terribly bothered either way, though.

+    // For some reason FILE_ATTRIBUTE_INTEGRITY_STREAM and

[Zach Ware, 2014/06/13 15:49:28]

PEP 7 bans C++ style comments.

+    // FILE_ATTRIBUTE_NO_SCRUB_DATA are not present in VC2010,

[Zach Ware, 2014/06/13 15:49:28]

As the API doc says, those two are related to ReFS and only present on Windows
Server 2012 and later.

[haypo, 2014/06/13 16:00:20]

If the constant is only available on new Visual Studio version, we may hardcode
the constant to avoid the dependency on a specific Visual Studio version. For
example, in unicodeobject.c I used:

#ifndef WC_ERR_INVALID_CHARS
#  define WC_ERR_INVALID_CHARS 0x0080
#endif

The constant was introduced in Windows Vista. There is a check at runtime in
unicodeobject.c to check if the Windows version of Vista or later.

Since FILE_ATTRIBUTE_xxx constants are just a bit mask, it's safe to add a
constant even if the Windows version will never set these bits.

+    // so define them manually
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_ARCHIVE)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_COMPRESSED)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_DEVICE)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_DIRECTORY)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_ENCRYPTED)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_HIDDEN)) return NULL;
+    if (PyModule_AddIntConstant(m, "FILE_ATTRIBUTE_INTEGRITY_STREAM", 0x8000)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_NORMAL)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)) return NULL;
+    if (PyModule_AddIntConstant(m, "FILE_ATTRIBUTE_NO_SCRUB_DATA", 0x20000)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_OFFLINE)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_READONLY)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_REPARSE_POINT)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_SPARSE_FILE)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_SYSTEM)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_TEMPORARY)) return NULL;
+    if (PyModule_AddIntMacro(m, FILE_ATTRIBUTE_VIRTUAL)) return NULL;
+#endif
 
     return m;
 }
 
 #ifdef __cplusplus
 }
 #endif