OpenAlea core's API

openalea.core.package

This module defines Package classes.

A Package is a deplyment unit and contains a factories (Node generator) and meta informations (authors, license, doc...)

exception openalea.core.package.FactoryExistsError

exception openalea.core.package.UnknownNodeError(name)

class openalea.core.package.AbstractPackageReader(filename)

Abstract class to add a package in the package manager.

register_packages(pkgmanager)

Create and add a package in the package manager.

class openalea.core.package.DynamicPackage(name, metainfo)

Package for dynamical parsing of python file

class openalea.core.package.Package(name, metainfo, path=None)

A Package is a dictionnary of node factory. Each node factory is able to generate node and their widgets.

Meta informations are associated with a package.

add_factory(factory)

Add to the package a factory ( node or subgraph )

get_factory(id)

Return the factory associated with id

get_id()

Return the package id

get_metainfo(key)

Return a meta information. See the standard key in the __init__ function documentation.

Parameters:key -- todo

get_names()

Return all the factory names in a list

get_pkg_files()

Return the list of python filename of the package. The filename are relative to self.path

get_tip()

Return the package description

get_wralea_path()

Return the full path of the wralea.py (if set)

is_directory()

New style package. A package is embeded in a unique directory. This directory can not contain more than one package. Thus, you can move, copy or delete a package by acting on the directory without ambiguity.

Return True if the package is embeded in a directory.

is_editable()

A convention (for the GUI) to ensure that the user can modify the package.

reload()

Reload all python file of the package

remove_files()

Remove pkg files

update_factory(old_name, factory)

Update factory (change its name)

mimetype = 'openalea/package'

class openalea.core.package.PyPackageReader(filename)

Build packages from wralea file Use 'register_package' function

build_package(wraleamodule, pkgmanager)

Build package and update pkgmanager

filename_to_module(filename)

Transform the filename ending with .py to the module name

get_pkg_name()

Return the OpenAlea (uniq) full package name

register_packages(pkgmanager)

Execute Wralea.py

class openalea.core.package.PyPackageReaderVlab(filename)

Build a package from a vlab specification file.

register_packages(pkgmanager)

Create and add a package in the package manager.

class openalea.core.package.PyPackageReaderWralea(filename)

Build a package from a __wralea__.py Use module variable

build_package(wraleamodule, pkgmanager)

Build package and update pkgmanager

class openalea.core.package.PyPackageWriter(package)

Write a wralea python file

get_factories_str()

Return a dict of (name:repr) of all factory

get_str()

Return string to write

write_wralea(full_filename)

Write the wralea.py in the specified filename

pkg_template = '\n$PKGNAME\n\n$METAINFO\n\n$ALL\n\n$FACTORY_DECLARATION\n'

wralea_template = '\n# This file has been generated at $TIME\n\nfrom openalea.core import *\n\n$PKG_DECLARATION\n\n'

class openalea.core.package.UserPackage(name, metainfo, path=None)

Package user editable and persistent

add_data_file(filename, description='')

Add a file in a package (copy it in the directory)

add_factory(factory)

Write change on disk

clone_from_package(pkg)

Copy the contents of pkg in self

create_user_compositenode(name, category, description, inputs, outputs)

Add a new user composite node factory to the package and save the package. Returns the cn factory.

create_user_node(name, category, description, inputs, outputs)

Return a new user node factory This function create a new python module in the package directory The factory is added to the package and the package is saved.

is_editable()

remove_files()

Remove pkg files

set_icon(filename)

Set package icon Copy filename in the package dir

write()

Return the writer class

openalea.core.pkgmanager

This module defines the package manager.

It is able to find installed package and their wralea.py It stores the packages and nodes informations

exception openalea.core.pkgmanager.IllFormedUrlError(url)

exception openalea.core.pkgmanager.UnknowFileType

exception openalea.core.pkgmanager.UnknownPackageError(name)

class openalea.core.pkgmanager.Logger

OpenAlea logging class

add(msg)

Write to log file

print_log()

Print log file

class openalea.core.pkgmanager.PackageManager(verbose=True)

The PackageManager is a Dictionary of Packages It can locate OpenAlea packages on the system (with wralea).

add_package(package)

Add a package to the pkg manager

add_wralea_path(path, container)

Add a search path for wralea files

Parameters:

• path -- a path string
• container -- set containing the path

clear()

Remove all packages

create_readers(wralea_files)

create_user_package(name, metainfo, path=None)

Create a new package in the user space and register it Return the created package :param path : the directory where to create the package

dependencies(package_or_factory=None)

Return all the dependencies of a package or a factory.

emit_update()

find_all_wralea()

Find on the system all wralea.py files

:return : a list of file paths

find_and_register_packages(no_cache=False)

Find all wralea on the system and register them If no_cache is True, ignore cache file

find_vlab_dir(directory, recursive=True)

Find in a directory vlab specification file.

Search recursivly is recursive is True

Returns:a list of pkgreader instances

find_wralea_dir(directory, recursive=True)

Find in a directory wralea files, Search recursivly is recursive is True

:return : a list of pkgreader instances

find_wralea_files()

Find on the system all wralea.py files

:return : a list of pkgreader instances

get(*args)

get_composite_nodes(pkg_name=None)

get_data(pattern='*.*', pkg_name=None, as_paths=False)

Return all data that match the pattern.

get_factory_from_url(url)

Returns a node instance from the given url.

Parameters:

• url - is either a string or a urlparse.ParseResult instance.

It is encoded this way: oa://domain/packageName?fac=*factoryName*&ft=*factoryType* . "oa" means that it is meant to be used by openalea. "domain" MUST BE "local" for now. "packageName" is the name of the package "factoryName" is the of factory "factoryType" is one of {"CompositeNodeFactory", "NodeFactory", "DataFactory"}

get_node(pkg_id, factory_id)

Return a node instance giving a pkg_id and a factory_id

get_node_from_url(url)

get_nodes(pkg_name=None)

get_package_from_url(url)

get_packages(pkg_name=None)

Return all public packages.

get_pkgreader(filename)

Return the pkg reader corresponding to the filename

get_pseudo_cat()

Return a pseudo category structure

get_pseudo_pkg()

Return a pseudopackage structure

get_user_packages()

Return the list of user packages

get_wralea_path()

return the list of wralea path (union of user and system)

has_key(*args)

init(dirname=None, verbose=True)

Initialize package manager

If dirname is None, find wralea files on the system else load directory If verbose is False, don't print any output

items()

iteritems()

iterkeys()

itervalues()

keys()

load_directory(dirname)

Load a directory containing wraleas

missing_dependencies(package_or_factory=None)

Return all the dependencies of a package or a factory.

rebuild_category()

Rebuild all the category

recover_syspath()

Restore the initial sys path

reload(pkg=None)

Reload one or all packages.

If the package pkg is None reloa all the packages. Else reload only pkg.

rename_package(old_name, new_name)

Rename package 'old_name' to 'new_name'

search_node(search_str, nb_inputs=-1, nb_outputs=-1)

Return a list of Factory corresponding to search_str If nb_inputs or nb_outputs is specified, return only node with the same number of (in/out) ports

The results are sorted in the following way:

1 - Highest Priority : presence of search_str in factory name

and position in the name (closer to the begining = higher score)

2 - Then : Number of occurences of search_str in the factory

description.

3 - Then : Number of occurences of search_str in the category name 4 - Finally : presence of search_str in package name and position

in the name (close to the begining = higher score)

set_sys_wralea_path()

Define the default wralea search path

For that, we look for "wralea" entry points and deprecated_wralea entry point if a package is declared as deprecated_wralea, the module is not load

set_user_wralea_path()

Read user config

update_category(package)

Update the category dictionary with package contents

values()

who_use(factory_name)

Search who use a package or a factory

return a list of factory.

write_config()

Write user config

class openalea.core.pkgmanager.PseudoGroup(name)

Data structure used to separate dotted naming (packages, category)

add_name(name, value)

Add a value in the structure with the key name_tuple

get_id()

todo

get_tip()

todo

new(name)

todo

mimetype = 'openalea/package'

sep = '.'

class openalea.core.pkgmanager.PseudoPackage(name)

Package structure used to separate dotted naming (packages, category)

get_metainfo(key)

todo

get_tip()

todo

is_real_package()

todo

new(name)

todo

openalea.core.pkgmanager.cmp_name(x, y)

Comparison function