# Software License Agreement (BSD License)
#
# Copyright (c) 2013, Open Source Robotics Foundation, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided
# with the distribution.
# * Neither the name of Open Source Robotics Foundation, Inc. nor
# the names of its contributors may be used to endorse or promote
# products derived from this software without specific prior
# written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
from __future__ import print_function
import gzip
try:
from cStringIO import StringIO
except ImportError:
from io import BytesIO as StringIO
import sys
import yaml
from . import _get_dist_file_data
from . import logger
# legacy imports
from . import common # noqa
from .aptdistro import AptDistro # noqa
from .develdistro import DevelDistro # noqa
from .rosdistro import RosDistro # noqa
from .rosdistro import walks # noqa
from .doc_build_file import DocBuildFile
from .doc_file import DocFile
from .loader import load_url
from .manifest_provider.cache import CachedManifestProvider
from .release import Release
from .release_build import ReleaseBuild
from .release_build_file import ReleaseBuildFile
from .release_cache import ReleaseCache
from .release_file import ReleaseFile
from .source_build_file import SourceBuildFile
from .source_file import SourceFile
# release information
[docs]def get_cached_release(index, dist_name, cache=None, allow_lazy_load=False):
print('# rosdistro.get_cached_release() has been deprecated in favor of the new function rosdistro.get_cached_distribution() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
if cache is None:
try:
cache = get_release_cache(index, dist_name)
except Exception:
if not allow_lazy_load:
raise
# create empty cache instance
rel_file_data = _get_dist_file_data(index, dist_name, 'release')
cache = ReleaseCache(dist_name, rel_file_data=rel_file_data)
rel = Release(
cache.release_file,
[CachedManifestProvider(cache, Release.default_manifest_providers if allow_lazy_load else None)])
assert cache.release_file.name == dist_name
return rel
[docs]def get_release(index, dist_name):
print('# rosdistro.get_release() has been deprecated in favor of the new function rosdistro.get_cached_distribution() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
rel_file = get_release_file(index, dist_name)
return Release(rel_file)
[docs]def get_release_file(index, dist_name):
print('# rosdistro.get_release_file() has been deprecated in favor of the new function rosdistro.get_distribution_file() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'distribution')
return ReleaseFile(dist_name, data)
[docs]def get_release_cache(index, dist_name):
print('# rosdistro.get_release_cache() has been deprecated in favor of the new function rosdistro.get_distribution_cache() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
if dist_name not in index.distributions.keys():
raise RuntimeError("Unknown release: '{0}'. Valid release names are: {1}".format(dist_name, ', '.join(sorted(index.distributions.keys()))))
dist = index.distributions[dist_name]
if 'distribution_cache' not in dist.keys():
raise RuntimeError("Release has no cache: '{0}'".format(dist_name))
url = dist['distribution_cache']
logger.debug('Load cache from "%s"' % url)
if url.endswith('.yaml'):
yaml_str = load_url(url)
elif url.endswith('.yaml.gz'):
yaml_gz_str = load_url(url, skip_decode=True)
yaml_gz_stream = StringIO(yaml_gz_str)
f = gzip.GzipFile(fileobj=yaml_gz_stream, mode='rb')
yaml_str = f.read()
if not isinstance(yaml_str, str):
yaml_str = yaml_str.decode('utf-8')
f.close()
else:
raise NotImplementedError('The url of the cache must end with either ".yaml" or ".yaml.gz"')
data = yaml.safe_load(yaml_str)
return ReleaseCache(dist_name, data)
[docs]def get_release_builds(index, release_file):
print("# rosdistro.get_release_builds() has been deprecated and its functionality is now handled by the 'ros_buildfarm.config' module", file=sys.stderr)
build_files = get_release_build_files(index, release_file.name)
builds = []
for build_file in build_files:
builds.append(ReleaseBuild(release_file, build_file))
return builds
[docs]def get_release_build_files(index, dist_name):
print("# rosdistro.get_release_build_files() has been deprecated and its functionality is now handled by the 'ros_buildfarm.config' module", file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'release_builds')
build_files = []
for d in data:
build_files.append(ReleaseBuildFile(dist_name, d))
return build_files
# source information
[docs]def get_source_file(index, dist_name):
print('# rosdistro.get_source_file() has been deprecated in favor of the new function rosdistro.get_distribution_file() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'distribution')
return SourceFile(dist_name, data)
[docs]def get_source_build_files(index, dist_name):
print("# rosdistro.get_source_build_files() has been deprecated and its functionality is now handled by the 'ros_buildfarm.config' module", file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'source_builds')
build_files = []
for d in data:
build_files.append(SourceBuildFile(dist_name, d))
return build_files
# doc information
[docs]def get_doc_file(index, dist_name):
print('# rosdistro.get_doc_file() has been deprecated in favor of the new function rosdistro.get_distribution_file() - please check that you have the latest versions of the Python tools (e.g. on Ubuntu/Debian use: sudo apt-get update && sudo apt-get install --only-upgrade python-bloom python-rosdep python-rosinstall python-rosinstall-generator)', file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'distribution')
return DocFile(dist_name, data)
[docs]def get_doc_build_files(index, dist_name):
print("# rosdistro.get_doc_build_files() has been deprecated and its functionality is now handled by the 'ros_buildfarm.config' module", file=sys.stderr)
data = _get_dist_file_data(index, dist_name, 'doc_builds')
build_files = []
for d in data:
build_files.append(DocBuildFile(dist_name, d))
return build_files