"""This module defines functions generally useful in scikit-build."""
import contextlib
import errno
import os
from collections import namedtuple
from contextlib import contextmanager
from distutils.command.build_py import build_py as distutils_build_py
from distutils.errors import DistutilsTemplateError
from distutils.filelist import FileList
from distutils.text_file import TextFile
from functools import wraps
try:
import logging
import setuptools.logging # noqa: F401
distutils_log = logging.getLogger("skbuild")
distutils_log.setLevel(logging.INFO)
logging_module = True
except ImportError:
from distutils import log as distutils_log
logging_module = False
def _log_warning(msg, *args):
try:
if logging_module:
distutils_log.warning(msg, *args)
else:
distutils_log.warn(msg, *args) # pylint: disable=deprecated-method
except ValueError:
# Setuptools might disconnect the logger. That shouldn't be an error for a warning.
print(msg % args)
[docs]class ContextDecorator(object):
"""A base class or mixin that enables context managers to work as
decorators."""
def __init__(self, **kwargs):
self.__dict__.update(kwargs)
def __enter__(self):
# Note: Returning self means that in "with ... as x", x will be self
return self
def __exit__(self, typ, val, traceback):
pass
def __call__(self, func):
@wraps(func)
def inner(*args, **kwds):
with self:
return func(*args, **kwds)
return inner
[docs]def mkdir_p(path):
"""Ensure directory ``path`` exists. If needed, parent directories
are created.
Adapted from http://stackoverflow.com/a/600612/1539918
"""
try:
os.makedirs(path)
except OSError as exc: # Python >2.5
if exc.errno == errno.EEXIST and os.path.isdir(path):
pass
else: # pragma: no cover
raise
[docs]class push_dir(ContextDecorator):
"""Context manager to change current directory."""
def __init__(self, directory=None, make_directory=False):
"""
:param directory:
Path to set as current working directory. If ``None``
is passed, ``os.getcwd()`` is used instead.
:param make_directory:
If True, ``directory`` is created.
"""
self.directory = None
self.make_directory = None
self.old_cwd = None
super(push_dir, self).__init__(directory=directory, make_directory=make_directory)
def __enter__(self):
self.old_cwd = os.getcwd()
if self.directory:
if self.make_directory:
mkdir_p(self.directory)
os.chdir(self.directory)
return self
def __exit__(self, typ, val, traceback):
os.chdir(self.old_cwd)
[docs]def new_style(klass):
"""distutils/setuptools command classes are old-style classes, which
won't work with mixins.
To work around this limitation, we dynamically convert them to new style
classes by creating a new class that inherits from them and also <object>.
This ensures that <object> is always at the end of the MRO, even after
being mixed in with other classes.
"""
return type("NewStyleClass<{}>".format(klass.__name__), (klass, object), {})
[docs]class PythonModuleFinder(new_style(distutils_build_py)):
"""Convenience class to search for python modules.
This class is based on ``distutils.command.build_py.build_by`` and
provides a specialized version of ``find_all_modules()``.
"""
def __init__(self, packages, package_dir, py_modules, alternative_build_base=None):
"""
:param packages: List of packages to search.
:param package_dir: Dictionary mapping ``package`` with ``directory``.
:param py_modules: List of python modules.
:param alternative_build_base: Additional directory to search in.
"""
self.distribution = namedtuple("Distribution", "script_name")
self.distribution.script_name = "setup.py"
self.packages = packages
self.package_dir = package_dir
self.py_modules = py_modules
self.alternative_build_base = alternative_build_base
[docs] def find_all_modules(self, project_dir=None):
"""Compute the list of all modules that would be built by
project located in current directory, whether they are
specified one-module-at-a-time ``py_modules`` or by whole
packages ``packages``.
By default, the function will search for modules in the current
directory. Specifying ``project_dir`` parameter allow to change
this.
Return a list of tuples ``(package, module, module_file)``.
"""
with push_dir(project_dir):
return super(PythonModuleFinder, self).find_all_modules()
[docs] def find_package_modules(self, package, package_dir):
"""Temporally prepend the ``alternative_build_base`` to ``module_file``.
Doing so will ensure modules can also be found in other location
(e.g ``skbuild.constants.CMAKE_INSTALL_DIR``).
"""
if package_dir != "" and not os.path.exists(package_dir) and self.alternative_build_base is not None:
package_dir = os.path.join(self.alternative_build_base, package_dir)
modules = super(PythonModuleFinder, self).find_package_modules(package, package_dir)
# Strip the alternative base from module_file
def _strip_directory(entry):
module_file = entry[2]
if self.alternative_build_base is not None and module_file.startswith(self.alternative_build_base):
module_file = module_file[len(self.alternative_build_base) + 1 :]
return entry[0], entry[1], module_file
return map(_strip_directory, modules)
[docs] def check_module(self, module, module_file):
"""Return True if ``module_file`` belongs to ``module``."""
if self.alternative_build_base is not None:
updated_module_file = os.path.join(self.alternative_build_base, module_file)
if os.path.exists(updated_module_file):
module_file = updated_module_file
if not os.path.isfile(module_file):
_log_warning("file %s (for module %s) not found", module_file, module)
return False
return True
[docs]def to_unix_path(path):
"""Return a version of ``path`` where all separator are ``/``"""
return path.replace("\\", "/") if path is not None else None
[docs]@contextmanager
def distribution_hide_listing(distribution):
"""Given a ``distribution``, this context manager temporarily
sets distutils threshold to WARN if ``--hide-listing`` argument
was provided.
It yields True if ``--hide-listing`` argument was provided.
"""
hide_listing = hasattr(distribution, "hide_listing") and distribution.hide_listing
if logging_module:
# Setuptools 60.2+, will always be on Python 3.6+
old_level = distutils_log.getEffectiveLevel()
if hide_listing:
distutils_log.setLevel(logging.WARNING)
try:
if hide_listing:
# The classic logger doesn't respond to set_threshold anymore,
# but it does log info and above to stdout, so let's hide that
with open(os.devnull, "w") as f, contextlib.redirect_stdout(f):
yield hide_listing
else:
yield hide_listing
finally:
distutils_log.setLevel(old_level)
else:
old_threshold = distutils_log._global_log.threshold
if hide_listing:
distutils_log.set_threshold(distutils_log.WARN)
try:
yield hide_listing
finally:
distutils_log.set_threshold(old_threshold)
[docs]def parse_manifestin(template):
"""This function parses template file (usually MANIFEST.in)"""
if not os.path.exists(template):
return []
template = TextFile(
template, strip_comments=1, skip_blanks=1, join_lines=1, lstrip_ws=1, rstrip_ws=1, collapse_join=1
)
file_list = FileList()
try:
while True:
line = template.readline()
if line is None: # end of file
break
try:
file_list.process_template_line(line)
# the call above can raise a DistutilsTemplateError for
# malformed lines, or a ValueError from the lower-level
# convert_path function
except (DistutilsTemplateError, ValueError) as msg:
print("%s, line %d: %s" % (template.filename, template.current_line, msg))
return file_list.files
finally:
template.close()