6.1.2.15. pycropml.package module

from pycropml import composition from pycropml.pparse import model_parser from path import Path import networkx as nx from collections import defaultdict from IPython.display import Image, display from networkx.drawing.nx_pydot import to_pydot from pycropml.render_cyml import signature

class pycropml.package.AbstractPackageReader(filename)

Bases: object

Abstract class to add a package in the package manager.

register_packages(pkgmanager)

Create and add a package in the package manager.

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

Bases: pycropml.package.PackageDict

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_modelunit(modelunit)

Add to the package a factory ( node or subgraph )

get_crop2ml_path()

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

get_id()

Return the package id

get_metainfo(key)

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

get_modelunit(modelid)

Return the factory associated with id

get_names()

Return all the factory names in a list

get_pkg_files()

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

get_tip()

Return the package description

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.

mimetype = 'pycrop2ml/package'

reload()

Reload all xml file of the package

remove_files()

Remove pkg files

update_modelunit(old_name, modelunit)

Update factory (change its name)

class pycropml.package.PackageDict(*args)

Bases: dict

Dictionnary with case insensitive key This object is able to handle protected entry begining with an ‘#’

get(k[, d]) → D[k] if k in D, else d. d defaults to None.

has_key(k) → True if D has a key k, else False

iter_public_values()

Iterate througth dictionnary value (remove protected value)

nb_public_values()

Return the number of unprotected values

class pycropml.package.PackageManager

add_crop2ml_path(path, container)

Add a search path for wralea files

Parameters:

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

add_package(package)

Add a package to the pkg manager

clear()

Remove all packages

create_readers(crop2ml_files)

find_and_register_packages(no_cache=False)

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

find_crop2ml_dir(directory, recursive=True)

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

:return : a list of pkgreader instances

get(*args)

get_pkgreader(filename)

Return the pkg reader corresponding to the filename

has_key(*args)

init(dirname=None, verbose=True)

Initialize package manager

If dirname is None, find composition files on the system else load directory

items()

iteritems()

iterkeys()

itervalues()

keys()

load_directory(dirname)

Load a directory containing wraleas

rebuild_category()

Rebuild all the category

reload(pkg=None)

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

set_sys_crop2ml_path()

Define the default composition files search path

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

update_category(package)

Update the category dictionary with package contents

values()

class pycropml.package.PseudoGroup(name)

Bases: pycropml.package.PackageDict

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

mimetype = 'pycrop2ml/package'

new(name)

todo

sep = '.'

class pycropml.package.PyPackageReader(filename)

Bases: pycropml.package.AbstractPackageReader

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 model.py

class pycropml.package.PyPackageReaderModel(filename)

Bases: pycropml.package.PyPackageReader

Build a package from a __wralea__.py Use module variable

build_package(wraleamodule, pkgmanager)

Build package and update pkgmanager

check_exist()

contain_pkg(pkg)

get_path(pkg, name)

class pycropml.package.PyPackageWriter(package)

Bases: object

Write a wralea python file

get_str()

Return string to write

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

wralea_template = '\n# This file has been generated at $TIME\n$PKG_DECLARATION\n'

write_wralea(full_filename)

Write the wralea.py in the specified filename

exception pycropml.package.UnknownNodeError(name)

Bases: exceptions.Exception

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

Bases: pycropml.package.Package

Package user editable and persistent

pycropml.package.get_default_home_dir()

Return the home directory (valid on linux and windows)

pycropml.package.get_openalea_home_dir(name='.pycrop2ml')

Return the crop2ml home directory If it doesn’t exist, create it

pycropml.package.get_userpkg_dir(name='user_pkg')

Get user package directory (the place where are the wralea.py files). If it doesn’t exist, create it

pycropml.package.is_protected(item)

Return true the item is protected

pycropml.package.lower(item)

pycropml.package.protected(item)

Return corresponding protected name for item