stack_header.py

Go to the documentation of this file.

# Software License Agreement (BSD License)
#
# Copyright (c) 2009, Willow Garage, 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 Willow Garage, 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.
#
# Revision $Id: stack_header.py 16306 2012-02-15 19:03:55Z kwc $
# $Author: kwc $

"""
The stack header is a YAML file that is used by the ROS.org wiki as
well as rosinstall.  It is similar in concept to the stack manifest
(stack.xml), but it contains additional data and is in YAML format for
easier processing in python scripts.

The data in the stack header is not formally specified, but includes:

 * manifest data (description, license, author, depends, review status, url)
 * rosinstall configuration information (VCS URI, branches, etc...)
 * packages in stack
 * depends-on information
"""

from __future__ import print_function

import os
import sys
import codecs
import traceback

import rospkg
import yaml

from .core import Repo, safe_encode
from .repo_util import guess_vcs_uri, get_svn_url

def _generate_stack_headers(ctx, filename, s, repo, rospack, rosstack):
    m = ctx.stack_manifests[s]
    rospack = rospkg.RosPack()
    rosstack = rospkg.RosStack()
    d = {
        'name': s,
        'brief': m.brief,
        'description': m.description.strip() or '',
        'license': m.license or '',
        'authors': m.author or '',
        'depends': [d.stack for d in m.depends],
        'review_status': m.status or '',
        'review_notes': m.notes or '',
        'url': m.url,
        'packages': rosstack.packages_of(s),
        'depends_on': rosstack.get_depends_on(s, implicit=False),
      }

    d['vcs'] = repo.type
    d['repository'] = repo.aggregate_name or repo.name
    d['repository-actual'] = repo.name
    d['rosinstall'] = repo.rosinstall.copy()
    # rosinstalls is a richer dictionary of rosinstall configurations
    # based on 'devel' and 'release' configurations for the repo.  It
    # is only set for repos that are released stacks.
    if repo.rosinstalls:
        d['rosinstalls'] = repo.rosinstalls.copy()

    if repo.is_released_stack:
        # no VCS information available on disk as we are using a
        # binary install.
        print("[%s] stack is a released stack, using repo URI [%s]"%(s, repo.uri))
        print("loading vcs URI", repo.uri)
        d['vcs_uri'] = repo.uri
    elif repo.type == 'svn':
        # svn allows partial checkouts, DVCSs generally don't
        d['vcs_uri'] = get_svn_url(rosstack.get_path(s))
        # update svn rules
        d['rosinstall']['svn']['uri'] = d['vcs_uri']
    elif repo.type == 'git':
        repo_type, repo_uri = guess_vcs_uri(rosstack.get_path(s))
        d['vcs_uri'] = repo_uri
        # update git rules
        d['rosinstall']['git']['uri'] = repo_uri
    else:
        d['vcs_uri'] = repo.uri

    # encode unicode entries
    d = safe_encode(d)

    if not ctx.quiet:
        print("writing stack properties to", filename)
    with codecs.open(filename, mode='w', encoding='utf-8') as f:
        f.write(yaml.safe_dump(d, default_style="'"))  

def generate_stack_headers(ctx, repo, stacks):
    """
    Generate stack.yaml files for MoinMoin PackageHeader macro

    @return: list of stack.yaml files
    @rtype: [str]
    """
    rospack = rospkg.RosPack()
    rosstack = rospkg.RosStack()
    
    artifacts = []
    for s in stacks:
        
        filename = os.path.join(ctx.docdir, s, 'stack.yaml')
        filename_dir = os.path.dirname(filename)
        if not os.path.isdir(filename_dir):
            os.makedirs(filename_dir)
        artifacts.append(filename)
        
        try:
            #print("generating stack wiki files for", s)
            _generate_stack_headers(ctx, filename, s, repo, rospack, rosstack)
        except Exception as e:
            traceback.print_exc()
            print("Unable to generate stack.yaml for %s: %s"%(s, e), file=sys.stderr)

    return artifacts

---

rosdoc_rosorg
Author(s): Ken Conley
autogenerated on Fri Jan 11 09:12:19 2013