repo_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: package_header.py 11472 2010-10-12 02:08:53Z kwc $
# $Author: kwc $

import os
import sys
import codecs
import traceback

import yaml

from .core import Repo

def generate_repo_header(ctx, repo, stack_files, package_files):
    """
    Generate repo.yaml files for MoinMoin Repo macros

    @param stack_files: list of stack.yaml files related to this repo
    @return: list of generate files (a single repo.yaml file)
    @rtype: [str]
    """
    if repo.name is None:
        sys.stderr.write("Invalid repo file (repo.name is None), ignoring\n")
        return []

    repo_data = {
        'name': repo.name,
        'vcs': {
            'type': repo.type,
            'uri': repo.uri,
            },
        'stacks': {},
        'packages': {},
        }
    for f in stack_files:
        name = os.path.basename(os.path.dirname(f))
        if os.path.isfile(f):
            with open(f) as yaml_f:
                # trim down metadata as repo files can be very large
                d = yaml.load(yaml_f)
                for k in ['depends', 'depends_on', 'repository', 'review_notes', 'review_status', 'vcs']:
                    try:
                        del d[k]
                    except:
                        pass
                repo_data['stacks'][name] = d
            
    for f in package_files:
        name = os.path.basename(os.path.dirname(f))
        if os.path.isfile(f):
            with open(f) as yaml_f:
                # trim down metadata as repo files can be very large. This
                # metadata is available elsewhere.
                d = yaml.load(yaml_f)
                for k in ['depends', 'depends_on', 'siblings', 'msgs', 'srvs', 'dependency_tree', 'repository', 'review_notes', 'review_status', 'api_documentation', 'description', 'vcs']:
                    try:
                        del d[k]
                    except:
                        pass
                repo_data['packages'][name] = d
        
    filename = os.path.join(ctx.docdir, repo.name, 'repo.yaml')
    filename_dir = os.path.dirname(filename)
    if not os.path.isdir(filename_dir):
        os.makedirs(filename_dir)

    with open(filename, 'w') as f:
        print "generating repo header %s"%(filename)
        f.write(yaml.safe_dump(repo_data, default_style="'"))
        
    return [filename_dir]

---

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