generate_index.py

Go to the documentation of this file.

#!/usr/bin/env python

from __future__ import print_function

import os
import sys
import yaml
import urllib2
import rospkg.distro

def get_base_dir():
    return os.getcwd()

def get_repos_list(base_dir):
    f = urllib2.urlopen('https://code.ros.org/svn/ros/stacks/rosorg/trunk/rosdoc_rosorg/repos.list')
    return yaml.load(f.read())

def _validate(rosinstall_data):
    for frag in rosinstall_data:
        for vcs_type, data in frag.items():
            if vcs_type == 'other' or vcs_type == 'setup-file':
                if not 'local-name' in data:
                    raise TypeError('invalid rosinstall snippet, missing key [local-name]')
                continue
            for reqd in ['local-name', 'uri']:
                if not reqd in data:
                    raise TypeError('invalid rosinstall snippet, missing key [%s]'%(reqd))
                path = data['local-name']
                uri = data['uri']
                version = data.get('version', '')
                for d in [path, uri, version]:
                    if not type(d) == type('str'):
                        raise TypeError('invalid rosinstall snippet, entry has bad type: %s'%(data))
                    
def load_rosinstalls(repos_list, distro_name=None):
    print("repos list:")
    for repo_def in repos_list:
        print(yaml.dump(repo_def, default_flow_style=False))
    # process list    
    to_download = []
    for repo_def in repos_list:
        uri = repo_def['uri']
        name = repo_def.get('name', None)
        to_download.append((uri, name))

    #output data
    rosinstall_text = []


    
    
    # download
    for uri, name in to_download:
        try:
            print("download rosinstall [%s]"%(uri))
            f = urllib2.urlopen(uri)
            text = f.read()
            rosinstall_text.append((uri, name, text))
        except:
            print("ERROR: cannot download [%s]"%(uri), file=sys.stderr)

    # unmarshal
    rosinstall_data = []
    for uri, name, text in rosinstall_text:
        try:
            data = yaml.load(text)
            if not type(data) == list:
                raise TypeError("rosinstall data must be a list")
            _validate(data)
            rosinstall_data.append((uri, name, data))
        except Exception as e:
            print("ERROR: invalid YAML format in [%s:%s]: %s\n.Ignoring repo.  Text is:\n[%s]"%(name, uri, e, text))
            
    if distro_name:
        # seed with rosdistro contents
        print("seeding with %s.rosdistro"%distro_name)
        distro_obj = rospkg.distro.load_distro(rospkg.distro.distro_uri(distro_name))
        text = rospkg.distro.distro_to_rosinstall(distro_obj, 'devel')
        rosinstall_data.append(('http://code.ros.org/svn/release/distros/%s.rosdistro'%distro_name, 'rosdistro_%s'%distro_name, text))
    return rosinstall_data

def create_repos_data(rosinstalls):
    alldata = []
    # take union in reverse order to match rosinstall precedence
    for uri, name, data in reversed(rosinstalls):
        # insert meta: repo-name into data
        if name:
            try:
                for entry in data:
                    type_ = entry.keys()[0]
                    if not 'meta' in entry[type_]:
                        entry[type_]['meta'] = {}
                    entry[type_]['meta']['repo-name'] = name
            except IndexError:
                print("ERROR: Invalid rosinstall file entry in [%s] (IndexError), ignoring\n%s"%(name, entry), file=sys.stderr)
            except TypeError:
                print("ERROR: Invalid rosinstall file entry in [%s] (TypeError), ignoring\n%s"%(name, entry), file=sys.stderr)

        alldata.extend(data)
    return alldata
    
def generate_index(output_file, repo_name=None, rosdistro=None):
    base_dir = get_base_dir()
    repos_list = get_repos_list(base_dir)
    if repo_name:
        repos_list = [r for r in repos_list if r.get('name', None) in [repo_name, 'ros', 'ros-docs']]
    rosinstalls = load_rosinstalls(repos_list, rosdistro)
    data = create_repos_data(rosinstalls)
    print("writing %s"%(output_file))
    with open(output_file, 'w') as f:
        f.write(yaml.dump(data, default_flow_style=False))

if __name__ == '__main__':
    from optparse import OptionParser
    parser = OptionParser(usage="usage: %prog [options] <output-file>", prog='generate_index.py')
    parser.add_option("--repo", 
                      dest="repo_name", default=None,
                      metavar="REPO-NAME",
                      help="only generate for a particular repo")
    parser.add_option("--rosdistro", 
                      dest="rosdistro", default=None,
                      metavar="rosdistro to use in the index",
                      help="add a distro the the index")
    options, args = parser.parse_args()
    if args:
        output_file = args[0]
    else:
        output_file ='repos.rosinstall'
    generate_index(output_file, repo_name=options.repo_name, rosdistro=options.rosdistro)

---

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