__init__.py :  » Development » SnapLogic » snaplogic » Python Open Source

Home
Python Open Source
1.3.1.2 Python
2.Ajax
3.Aspect Oriented
4.Blog
5.Build
6.Business Application
7.Chart Report
8.Content Management Systems
9.Cryptographic
10.Database
11.Development
12.Editor
13.Email
14.ERP
15.Game 2D 3D
16.GIS
17.GUI
18.IDE
19.Installer
20.IRC
21.Issue Tracker
22.Language Interface
23.Log
24.Math
25.Media Sound Audio
26.Mobile
27.Network
28.Parser
29.PDF
30.Project Management
31.RSS
32.Search
33.Security
34.Template Engines
35.Test
36.UML
37.USB Serial
38.Web Frameworks
39.Web Server
40.Web Services
41.Web Unit
42.Wiki
43.Windows
44.XML
Python Open Source » Development » SnapLogic 
SnapLogic » snaplogic » __init__.py
# $SnapHashLicense:
# 
# SnapLogic - Open source data services
# 
# Copyright (C) 2009, SnapLogic, Inc.  All rights reserved.
# 
# See http://www.snaplogic.org for more information about
# the SnapLogic project. 
# 
# This program is free software, distributed under the terms of
# the GNU General Public License Version 2. See the LEGAL file
# at the top of the source tree.
# 
# "SnapLogic" is a trademark of SnapLogic, Inc.
# 
# 
# $

# $Id: __init__.py 7193 2009-04-08 22:18:36Z dmitri $
""" The main SnapLogic package """

__docformat__ = "epytext en"

def get_component_list():
    """
    Retrieve the list of components contained within this package.
    
    This function is used by component registration and discovery and is required for all component packages.
    It should return a list of all component classes contained within the package. These should be the class objects
    not their names.
    
    In order for component registration to function properly, a naming style for component modules and classes should
    be observed. The file the component is located in must match the class name exactly (including case) except for the
    '.py' suffix. This is necessary because the component's module name is used to identify the component both for
    config file names and within the SnapLogic server.
    
    The L{snaplogic.cc.registration} module provides some helper functions to make this task easier for component
    pacakge writers. Most notable is the L{registration.discover_package_components} method.
    
    For small packages, it may however be easier to just import the component classes and return them as a list.
    Example::
        # File: my_package/__init__.py
        
        def get_component_list():
            from my_package.component_a import ComponentA
            from my_package.component_b import ComponentB
            return [ComponentA, ComponentB]
    
    @return: The list of component classes contained within this package.
    @rtype: list
    
    """
    from snaplogic.cc import registration
    from snaplogic.common.snap_exceptions import SnapValueError

    comps = registration.discover_package_components("snaplogic.components", ['TestComps', 'DBUtils', 'FileUtils',
                                                                              'computils', 'test', 'unported'])
    try:
        comps.extend(registration.discover_package_components("snaplogic.components.TestComps", ['test', 'unported']))
    except SnapValueError, e:
        # Ignore when the TestComps dir is missing. This happens when installed.
        pass

    try:
        comps.extend(registration.discover_package_components("snaplogic.components.TestComps.upgrade"))
    except SnapValueError, e:
        # Ignore when the upgrade test dir is missing. This happens when installed.
        pass
        
    return comps

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.