为os.stat(myfile).st_mode提供更好的asserequal()方法

Question

我有一个代码检查文件的st_mode:

self.assertEqual(16877, os.stat(my_directory).st_mode)

只有老派的unix专家才能熟练地破译整数值16877。

是否有更可读的方法来检查这个值?

Answer 1

可以使用已定义的常量。它们可以在stat(文档)中找到。它们是:

stat.S_IRUSR for owner read permission，

stat.S_IWUSR表示所有者写权限，

stat.S_IXUSR for owner execute permission，

stat.S_IRGRP for group read permission，

stat.S_IWGRP for组写权限，

stat.S_IXGRP for group execute permission，

stat.S_IROTH for others read permission，

stat.S_IWOTH for others write permission，

stat.S_IXOTH for others execute permission，

stat.S_IFDIR for directory.

它们可以使用位或|组合。然后你的代码看起来像:

import stat
import os
permissions = (stat.S_IFDIR | 
               stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR |
               stat.S_IRGRP | stat.S_IXGRP |
               stat.S_IROTH | stat.S_IXOTH)
self.assertEqual(permissions, os.stat(my_directory).st_mode)

Answer 2

以下是stat手册中关于st_mode的一些信息，引用如下

       S_IFMT     0170000   bit mask for the file type bit field
       S_IFSOCK   0140000   socket
       S_IFLNK    0120000   symbolic link
       S_IFREG    0100000   regular file
       S_IFBLK    0060000   block device
       S_IFDIR    0040000   directory
       S_IFCHR    0020000   character device
       S_IFIFO    0010000   FIFO
       S_ISUID      04000   set-user-ID bit
       S_ISGID      02000   set-group-ID bit (see below)
       S_ISVTX      01000   sticky bit (see below)
       S_IRWXU      00700   owner has read, write, and execute permission
       S_IRUSR      00400   owner has read permission
       S_IWUSR      00200   owner has write permission
       S_IXUSR      00100   owner has execute permission
       S_IRWXG      00070   group has read, write, and execute permission
       S_IRGRP      00040   group has read permission
       S_IWGRP      00020   group has write permission
       S_IXGRP      00010   group has execute permission
       S_IRWXO      00007   others (not in group) have read, write, and
                            execute permission
       S_IROTH      00004   others have read permission
       S_IWOTH      00002   others have write permission
       S_IXOTH      00001   others have execute permission

这些都是八进制数。

oct(16877)等价于0o40755。这意味着以下位是活动的:

• 40000或S_IFDIR:目录
• 700，这意味着所有者可以读写和执行
• 50，表示组可以读和执行，但不能写。
• 5，这意味着世界可以读和执行，但不能写。

(755为目录模式)

一些你可能会做的事情:

1. 链接文档中的stat手册，或者添加我粘贴的代码。然后，可以使用

   self.assertEqual(0o40755, os.stat(my_directory).st_mode)
   

，这意味着完全相同的东西，但它变得更容易调试。
2. 您可以使用ctypes模块自己实现位域。python wiki有更多信息。(搜索"位域")

3. 您可以将16877或040755(以及其他输出)作为常量变量的值，可能是全局的。

   DIR_755 = 0o40755
   

   然后，你可以这样做:

   self.assertEqual(DIR_755, os.stat(my_directory).st_mode)
   

4. 你可以创建一个代码和值的字典:

   st_mode_vals = {
       "S_IFMT": 0170000,  # Or instead, "filetype_bitmask"
       "S_IFSOCK": 0140000,  # Or instead, "socket"
       ...
       "S_IXOTH": 0o1  # Or instead, "other_x"
   }
   

   那么你就可以将它们定义为:

   DIR_755 = st_mode_vals["directory"] +
             st_mode_vals["usr_rwx"] +
             st_mode_vals["grp_r"] + st_mode_vals["grp_x"] +
             st_mode_vals["oth_r"] + st_mode_vals["oth_x"]
   self.assertEqual(DIR_755, os.stat(my_directory).st_mode)
   

我个人会使用#1(链接到文档)，如果有经常被重用的代码，则使用#3。对于所有这些，也许您还可以添加一个注释，以十进制表示值?

编辑:我没有看到在我发布之前添加的答案。我不知道stat模块做了什么，所以我没有想到它。不管怎样，我还是会用#1或者#3。然而，他写的东西肯定会取代#4(字典)作为另一种选择，而且确实会好得多。

Answer 3

如果我可以扩展这个问题一点，并将其理解为"是否有更可读的方式来检查文件模式?，那么我将建议添加一个自定义断言。目标:

self.assertFileMode(my_directory, user="rwx", group="rx", others="rx")

怎么做

让我们把这个断言放到mixin中:

import os
import stat
class FileAssertions(object):
    FILE_PERMS = {
        'user': {'r': stat.S_IRUSR, 'w': stat.S_IWUSR, 'x': stat.S_IXUSR, 's': stat.S_ISUID},
        'group': {'r': stat.S_IRGRP, 'w': stat.S_IWGRP, 'x': stat.S_IXGRP, 's': stat.S_ISGID},
        'others': {'r': stat.S_IROTH, 'w': stat.S_IWOTH, 'x': stat.S_IXOTH},
    }
    def assertFileMode(self, path, **kwargs):
        mode = os.stat(path).st_mode
        for key, perm_defs in self.FILE_PERMS.items():
            expected = kwargs.pop(key, None)
            if expected is not None:
                actual_perms = mode & sum(perm_defs.values())
                expected_perms = sum(perm_defs[flag] for flag in expected)
                if actual_perms != expected_perms:
                    msg = '{key} permissions: {expected} != {actual} for {path}'.format(
                        key=key, path=path,
                        expected=''.join(sorted(expected)),
                        actual=''.join(sorted(flag for flag, value in perm_defs.items()
                                              if value & mode != 0))
                    )
                    raise self.failureException(msg)
        if kwargs:
            raise TypeError('assertFileMode: unknown arguments %s' % ', '.join(kwargs))

使用

现在，我们测试一些文件模式如何?

# We use our mixin
class MyTestCase(FileAssertions, TestCase):
    def test_some_paths(self):
        # Test all permissions
        self.assertFileMode('/foo/bar', user='rwx', group='rx', others='')
        # Only test user permissions
        self.assertFileMode('/foo/bar', user='rwx')
        # We support the suid/sgid bits as well
        self.assertFileMode('/foo/bar', user='rwxs', group='rxs', others='rx')

示例输出:

AssertionError: user permissions: rw != rwx for /foo/bar

指出:

• 只测试给方法的权限。要测试是否不存在权限，传递一个空字符串。
大部分的复杂性来自于生成用户友好的消息。
• 权限在错误消息中按字母顺序排序，因此更容易进行肉眼比较。为了简单起见，我没有处理测试粘性位。

Answer 4

self.assertEqual(16877, os.stat(my_directory).st_mode)

只有老派的unix专家才能熟练地破译整数值16877。

实际上，老派的unix专家可能也有同样的想法，因为这些东西都是用八进制显示的。

我:

• 切换到八进制指定模式
• 添加文本表示和注释

像这样:

# 'my_directory' should be a directory with full permissions for user and
# read/execute permissions for group and other
# drwxr-xr-x
self.assertEqual(0o40755, os.stat(my_directory).st_mode)