From c29cd9384a7ef55a6f9d212965b78584843225d9 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Thu, 10 Mar 2011 23:38:18 +0200 Subject: Use simpler assert in basic example. --- Doc/library/unittest.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index f41bab3..10e415b 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -127,13 +127,13 @@ Here is a short script to test three functions from the :mod:`random` module:: def test_choice(self): element = random.choice(self.seq) - self.assertIn(element, self.seq) + self.assertTrue(element in self.seq) def test_sample(self): with self.assertRaises(ValueError): random.sample(self.seq, 20) for element in random.sample(self.seq, 5): - self.assertIn(element, self.seq) + self.assertTrue(element in self.seq) if __name__ == '__main__': unittest.main() -- cgit v0.12 From 30178068d941ba3e42c6345d466576b0ca69d72c Mon Sep 17 00:00:00 2001 From: R David Murray Date: Thu, 10 Mar 2011 17:18:33 -0500 Subject: #10999: Add missing documentation for chflags constants to stat module docs Patch by Michal Nowikowski. --- Doc/library/os.rst | 20 ++++++------ Doc/library/stat.rst | 88 +++++++++++++++++++++++++++++++++++++++------------- Misc/ACKS | 1 + 3 files changed, 77 insertions(+), 32 deletions(-) diff --git a/Doc/library/os.rst b/Doc/library/os.rst index bacb008..3f6d69d 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -842,16 +842,16 @@ Files and Directories Set the flags of *path* to the numeric *flags*. *flags* may take a combination (bitwise OR) of the following values (as defined in the :mod:`stat` module): - * ``UF_NODUMP`` - * ``UF_IMMUTABLE`` - * ``UF_APPEND`` - * ``UF_OPAQUE`` - * ``UF_NOUNLINK`` - * ``SF_ARCHIVED`` - * ``SF_IMMUTABLE`` - * ``SF_APPEND`` - * ``SF_NOUNLINK`` - * ``SF_SNAPSHOT`` + * :data:`stat.UF_NODUMP` + * :data:`stat.UF_IMMUTABLE` + * :data:`stat.UF_APPEND` + * :data:`stat.UF_OPAQUE` + * :data:`stat.UF_NOUNLINK` + * :data:`stat.SF_ARCHIVED` + * :data:`stat.SF_IMMUTABLE` + * :data:`stat.SF_APPEND` + * :data:`stat.SF_NOUNLINK` + * :data:`stat.SF_SNAPSHOT` Availability: Unix. diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst index 9100910..3419820 100644 --- a/Doc/library/stat.rst +++ b/Doc/library/stat.rst @@ -73,6 +73,34 @@ for each test. These are also useful when checking for information about a file that isn't handled by :mod:`os.path`, like the tests for block and character devices. +Example:: + + 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.stat(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) + All the variables below are simply symbolic indexes into the 10-tuple returned by :func:`os.stat`, :func:`os.fstat` or :func:`os.lstat`. @@ -262,31 +290,47 @@ The following flags can also be used in the *mode* argument of :func:`os.chmod`: Unix V7 synonym for :data:`S_IXUSR`. -Example:: +The following flags can be used in the *flags* argument of :func:`os.chflags`: - import os, sys - from stat import * +.. data:: UF_NODUMP - def walktree(top, callback): - '''recursively descend the directory tree rooted at top, - calling the callback function for each regular file''' + Do not dump the file. - for f in os.listdir(top): - pathname = os.path.join(top, f) - mode = os.stat(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) +.. data:: UF_IMMUTABLE - def visitfile(file): - print('visiting', file) + The file may not be changed. - if __name__ == '__main__': - walktree(sys.argv[1], visitfile) +.. data:: UF_APPEND + + The file may only be appended to. + +.. data:: UF_OPAQUE + + The file may not be renamed or deleted. + +.. data:: UF_NOUNLINK + + The directory is opaque when viewed through a union stack. + +.. data:: SF_ARCHIVED + + The file may be archived. + +.. data:: SF_IMMUTABLE + + The file may not be changed. + +.. data:: SF_APPEND + + The file may only be appended to. + +.. data:: SF_NOUNLINK + + The file may not be renamed or deleted. + +.. data:: SF_SNAPSHOT + + The file is a snapshot file. + +See the \*BSD or Mac OS systems man page :manpage:`chflags(2)` for more information. diff --git a/Misc/ACKS b/Misc/ACKS index 023fe94..9d4be3f 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -578,6 +578,7 @@ Stefan Norberg Tim Northover Joe Norton Neal Norwitz +Michal Nowikowski Nigel O'Brian Kevin O'Connor Tim O'Malley -- cgit v0.12