package_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.

from __future__ import print_function

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

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

 * manifest data (description, license, author, depends, review status, url)
 * rosinstall configuration information (VCS URI, branches, etc...)
 * stack and stack siblings (packages)
 * depends-on information
 * msg/srv listing
"""

import codecs
import os
import sys
import traceback
import yaml

import rospkg

import roslib.msgs
import roslib.srvs

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

def compute_package_dictionary(p, m, repo, rospack, rosstack):
    """
    @param m: manifest
    @param p: package name
    """
    m.description = m.description or ''
    d = {
        'name': p,
        'brief': m.brief,
        'description': m.description.strip() or '',
        'license': m.license or '',
        'authors': m.author or '',
        'depends': [d.package for d in m.depends],
        'review_status': m.status or '',
        'review_notes': m.notes or '',
        'url': m.url,
        }
  
    if m.versioncontrol:
        d['version_control'] = m.versioncontrol.url
          
    d['api_documentation'] = package_link(p)
    d['dependency_tree'] = package_link(p) + '%s_deps.pdf'%p

    # set repository information
    # compute on-disk info
    siblings = []
    
    stack = rospack.stack_of(p) or ''
    if stack:
        d['stack'] = stack
        d['siblings'] = rosstack.packages_of(stack)
  
    d['depends_on'] = rospack.get_depends_on(p, implicit=False)
      
    d['msgs'] = roslib.msgs.list_msg_types(p, False)
    d['srvs'] = roslib.srvs.list_srv_types(p, False)        

    # set repository information
    
    # repository vs. repository-actual: we sometimes want to alias
    # stack-specific repositories to an aggregate
    # (e.g. institution-specific) name.
    d['repository'] = repo.aggregate_name or repo.name
    d['repository-actual'] = repo.name
    d['vcs'] = repo.type
    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] package is from released stack, using repo URI [%s]"%(p, 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(rospack.get_path(p))
        # update svn rules
        d['rosinstall']['svn']['uri'] = d['vcs_uri']
    elif repo.type == 'git':
        # de-resolve git submodules
        repo_type, repo_uri = guess_vcs_uri(rospack.get_path(p))
        d['vcs_uri'] = repo_uri
        # update git rules
        d['rosinstall']['git']['uri'] = repo_uri
    else:
        d['vcs_uri'] = repo.uri
    return d

def _generate_package_headers(ctx, repo, p, filename, rospack, rosstack):
    m = ctx.manifests[p]
    d = compute_package_dictionary(p, m, repo, rospack, rosstack)
    
    if p in ctx.external_docs:
        d['external_documentation'] = ctx.external_docs[p]
  
    # encode unicode entries. This is probably overkill, but it was hard
    # hunting the unicode encoding issues down
    d = safe_encode(d)
    with codecs.open(filename, mode='w', encoding='utf-8') as f:
        f.write(yaml.safe_dump(d, default_style="'"))
    
def generate_package_headers(ctx, repo, packages):
    """
    Generate manifest.yaml files for MoinMoin PackageHeader macro
    """
    rospack = rospkg.RosPack()
    rosstack = rospkg.RosStack()
    
    artifacts = []
    for p in packages:
        if not ctx.should_document(p):
            continue

        filename = os.path.join(ctx.docdir, p, 'manifest.yaml')
        filename_dir = os.path.dirname(filename)
        if not os.path.isdir(filename_dir):
            os.makedirs(filename_dir)

        try:
            if not ctx.quiet:
                print("writing package properties to", filename)
            _generate_package_headers(ctx, repo, p, filename, rospack, rosstack)
            artifacts.append(filename)
        except Exception as e:
          traceback.print_exc()
          print("Unable to generate manifest.yaml for %s: %s"%(p, e), file=sys.stderr)

    return artifacts

---

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