openstack-interpreter 0.4.2

tools examples

Maybe you want to look at some of the values on an OpenStack resource. Since most of the client libraries give resources a to_dict function (NOTE: this may not always be the case) you can do the following:

servers = list(conn.compute.servers())

output.print_dict(servers[0].to_dict())

Or just print the object itself, since it may not have to_dict anyway:

output.print_object(servers[0])

Although some of the fields may be dicts and this harder to read, so we’d like to format them a little:

output.print_object(
    servers[0], formatters={
        'addresses': output.json_formatter,
        'flavor': output.json_formatter,
        'image': output.json_formatter,
        'links': output.json_formatter})

Or maybe you’re looking at a list of resources, and you only care about certain fields:

output.print_list(servers, ["name", "id", "status"])

You can even format lists, although be careful as listing does not auto wrap properly yet:

output.print_list(
    servers, ['name', 'status', 'addresses'],
        formatters={'addresses': output.json_formatter})

Or maybe you are looking at a lot of data and want to highlight something:

rows = []

for server in servers:
    if server.status == "ACTIVE":
        rows.append([
            server.name, server.id,
            output.style_text(server.status, ['green', 'bold'])
        ])
    elif server.status == "ERROR":
        rows.append([
            server.name, server.id,
            output.style_text(server.status, ['red', 'bold'])
        ])
    else:
        rows.append([server.name, server.id, server.status])

output.print_list_rows(rows, ["name", "id", "status"])

Or want to delete a ton of instances, but want ones with certain names (or maybe even tags) to ask for a prompt first:

for server in conn.compute.servers():
    if "prod" in server.name:
        output.print_object(server)
        if prompt.prompt_yes_no(
                "Are you sure you want to delete this?"):
            server.delete()
    else:
        server.delete()

Or maybe you’re just curious how long it takes to run something:

with timed("listing servers"):
    servers = list(conn.compute.servers())