mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
02fea029bf
In Python3, the functions io.open() is an alias of the builtin open() and codecs.open() is functionally equivalent. To reduce indirection, number of imports, and number of patterns, always prefer the builtin. https://docs.python.org/3/library/io.html#high-level-module-interface > io.open() > > This is an alias for the builtin open() function.
98 lines
3.6 KiB
Python
98 lines
3.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinx.util.fileutil
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
File utility functions for Sphinx.
|
|
|
|
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
from __future__ import absolute_import
|
|
|
|
import os
|
|
import posixpath
|
|
|
|
from docutils.utils import relative_path
|
|
|
|
from sphinx.util.osutil import copyfile, ensuredir, walk
|
|
|
|
if False:
|
|
# For type annotation
|
|
from typing import Callable, Dict, Union # NOQA
|
|
from sphinx.util.matching import Matcher # NOQA
|
|
from sphinx.util.template import BaseRenderer # NOQA
|
|
|
|
|
|
def copy_asset_file(source, destination, context=None, renderer=None):
|
|
# type: (unicode, unicode, Dict, BaseRenderer) -> 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.exists(destination) and 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:
|
|
if renderer is None:
|
|
from sphinx.util.template import SphinxRenderer
|
|
renderer = SphinxRenderer()
|
|
|
|
with open(source, 'r', encoding='utf-8') as fsrc: # type: ignore
|
|
if destination.lower().endswith('_t'):
|
|
destination = destination[:-2]
|
|
with open(destination, 'w', encoding='utf-8') as fdst: # type: ignore
|
|
fdst.write(renderer.render_string(fsrc.read(), context))
|
|
else:
|
|
copyfile(source, destination)
|
|
|
|
|
|
def copy_asset(source, destination, excluded=lambda path: False, context=None, renderer=None):
|
|
# type: (unicode, unicode, Union[Callable[[unicode], bool], Matcher], Dict, BaseRenderer) -> None # NOQA
|
|
"""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
|
|
"""
|
|
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 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)):
|
|
copy_asset_file(posixpath.join(root, filename),
|
|
posixpath.join(destination, reldir),
|
|
context, renderer)
|