.. _spkg_scandir:

scandir: Fast file system iteration for Python
==============================================

Description
-----------

scandir, a better directory iterator and faster os.walk()

scandir() is a directory iteration function like os.listdir(), except
that instead of returning a list of bare filenames, it yields DirEntry
objects that include file type and stat information along with the name.
Using scandir() increases the speed of os.walk() by 2-20 times
(depending on the platform and file system) by avoiding unnecessary
calls to os.stat() in most cases.

Type
----

standard


Version Information
-------------------

package-version.txt::

    1.9.0

install-requires.txt::

    scandir >=1.9.0


Equivalent System Packages
--------------------------

conda:

.. CODE-BLOCK:: bash

    $ conda install python:scandir

opensuse:

.. CODE-BLOCK:: bash

    $ sudo zypper install python:scandir

See https://repology.org/project/python:scandir/versions

However, these system packages will not be used for building Sage
because using Python site-packages is not supported by the Sage distribution;
see https://trac.sagemath.org/ticket/29023