summaryrefslogtreecommitdiffstats
path: root/python/python-scandir/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python-scandir/README')
-rw-r--r--python/python-scandir/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/python/python-scandir/README b/python/python-scandir/README
new file mode 100644
index 0000000000..7fcbf2782f
--- /dev/null
+++ b/python/python-scandir/README
@@ -0,0 +1,13 @@
+scandir, a better directory iterator and faster os.walk()
+
+scandir() is a generator version of os.listdir() that returns
+an iterator over files in a directory, and also exposes the
+extra information most OSes provide while iterating files in a
+directory (such as type and stat information).
+
+This module also includes a version of os.walk() that uses
+scandir() to speed it up significantly.
+
+NOTE: If you’re using Python version 3.5+, os.scandir() and the
+speed improvements to os.walk() are already available in the
+standard library.