Na}{

File Content: `fileutil.py`

"""
    sphinx.util.fileutil
    ~~~~~~~~~~~~~~~~~~~~

    File utility functions for Sphinx.

    :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import os
import posixpath
from typing import TYPE_CHECKING, Callable, Dict

from docutils.utils import relative_path

from sphinx.util.osutil import copyfile, ensuredir
from sphinx.util.typing import PathMatcher

if TYPE_CHECKING:
    from sphinx.util.template import BaseRenderer


def copy_asset_file(source: str, destination: str,
                    context: Dict = None, renderer: "BaseRenderer" = None) -> None:
    """Copy an asset file to destination.

    On copying, it expands the template variables if context argument is given and
    the asset is a template file.

    :param source: The path to source file
    :param destination: The path to destination file or directory
    :param context: The template variables.  If not given, template files are simply copied
    :param renderer: The template engine.  If not given, SphinxRenderer is used by default
    """
    if not os.path.exists(source):
        return

    if os.path.isdir(destination):
        # Use source filename if destination points a directory
        destination = os.path.join(destination, os.path.basename(source))

    if source.lower().endswith('_t') and context is not None:
        if renderer is None:
            from sphinx.util.template import SphinxRenderer
            renderer = SphinxRenderer()

        with open(source, encoding='utf-8') as fsrc:
            if destination.lower().endswith('_t'):
                destination = destination[:-2]
            with open(destination, 'w', encoding='utf-8') as fdst:
                fdst.write(renderer.render_string(fsrc.read(), context))
    else:
        copyfile(source, destination)


def copy_asset(source: str, destination: str, excluded: PathMatcher = lambda path: False,
               context: Dict = None, renderer: "BaseRenderer" = None,
               onerror: Callable[[str, Exception], None] = None) -> None:
    """Copy asset files to destination recursively.

    On copying, it expands the template variables if context argument is given and
    the asset is a template file.

    :param source: The path to source file or directory
    :param destination: The path to destination directory
    :param excluded: The matcher to determine the given path should be copied or not
    :param context: The template variables.  If not given, template files are simply copied
    :param renderer: The template engine.  If not given, SphinxRenderer is used by default
    :param onerror: The error handler.
    """
    if not os.path.exists(source):
        return

    if renderer is None:
        from sphinx.util.template import SphinxRenderer
        renderer = SphinxRenderer()

    ensuredir(destination)
    if os.path.isfile(source):
        copy_asset_file(source, destination, context, renderer)
        return

    for root, dirs, files in os.walk(source, followlinks=True):
        reldir = relative_path(source, root)
        for dir in dirs[:]:
            if excluded(posixpath.join(reldir, dir)):
                dirs.remove(dir)
            else:
                ensuredir(posixpath.join(destination, reldir, dir))

        for filename in files:
            if not excluded(posixpath.join(reldir, filename)):
                try:
                    copy_asset_file(posixpath.join(root, filename),
                                    posixpath.join(destination, reldir),
                                    context, renderer)
                except Exception as exc:
                    if onerror:
                        onerror(posixpath.join(root, filename), exc)
                    else:
                        raise

Name	Size	Permission
__pycache__	---	0755
stemmer	---	0755
__init__.py	19702 bytes	0644
build_phase.py	417 bytes	0644
cfamily.py	14290 bytes	0644
compat.py	1231 bytes	0644
console.py	3566 bytes	0644
docfields.py	16499 bytes	0644
docstrings.py	3737 bytes	0644
docutils.py	18978 bytes	0644
fileutil.py	3812 bytes	0644
i18n.py	9939 bytes	0644
images.py	2994 bytes	0644
inspect.py	32109 bytes	0644
inventory.py	6428 bytes	0644
jsdump.py	5823 bytes	0644
logging.py	18350 bytes	0644
matching.py	3300 bytes	0644
math.py	1896 bytes	0644
nodes.py	22847 bytes	0644
osutil.py	6956 bytes	0644
parallel.py	5403 bytes	0644
png.py	1601 bytes	0644
pycompat.py	2085 bytes	0644
requests.py	4153 bytes	0644
rst.py	3434 bytes	0644
smartypants.py	15986 bytes	0644
tags.py	2784 bytes	0644
template.py	4761 bytes	0644
texescape.py	5589 bytes	0644
typing.py	18879 bytes	0644

File Content: fileutil.py

File Content: `fileutil.py`