python.scripts.gen_klass Namespace Reference

Classes
class	GenTypes
class	Templates

Functions
	gen_files (pkg="", klass="", klass_type='object', fname='foo', ipkg="", iklass="")
	gen_pyfiles (pkg="", klass="", klass_type='pyalg', fname='foo')
	main (args)

Variables
str	__author__ = "Sebastien Binet"
str	__doc__

Function Documentation

gen_files()

python.scripts.gen_klass.gen_files	(		pkg = "",
			klass = "",
			klass_type = 'object',
			fname = 'foo',
			ipkg = "",
			iklass = "" )

Simple helper function to generate files based off some informations
 @param pkg the name of the package holding the class we want to generate
 @param klass the (fully qualified) name of the C++ class to generate
 @param klass_type the type of class to generate (svc/tool/alg/object)
 @param fname the filename to generate
 @param ipkg the name of the package holding the interface of the class
 @param iklass the name of the interface of the class we generate

Definition at line 535 of file gen_klass.py.

              ipkg="", iklass=""):
    """Simple helper function to generate files based off some informations
     @param pkg the name of the package holding the class we want to generate
     @param klass the (fully qualified) name of the C++ class to generate
     @param klass_type the type of class to generate (svc/tool/alg/object)
     @param fname the filename to generate
     @param ipkg the name of the package holding the interface of the class
     @param iklass the name of the interface of the class we generate
    """
    try:
        hdr = getattr(Templates, '%s_hdr_template'%klass_type)
        cxx = getattr(Templates, '%s_cxx_template'%klass_type)
    except AttributeError as err:
        print ("::: UNKNOWN klass_type [%s] !" % klass_type)
        raise err
 
    namespace_klass = klass.replace('::','_')
    namespace_begin,namespace_end = "",""
    if klass.count("::")>0:
        nm    = klass.split("::")[0]
        klass = klass.split("::")[1]
        namespace_begin = os.linesep + "namespace %s {" % nm + os.linesep
        namespace_end   = os.linesep + "} // namespace %s" % nm + os.linesep
        pass
 
    guard = "%s_%s_H" % (pkg.upper(), namespace_klass.upper())
 
    d = dict( pkg=pkg,
              klass=klass,
              ipkg=ipkg,
              iklass=iklass,
              guard=guard,
              namespace_begin=namespace_begin,
              namespace_end=namespace_end,
              copyright=Templates.copyright_template
              )
    fname = os.path.splitext(fname)[0]
 
    o_hdr = open(fname+'.h', 'w')
    o_hdr.writelines(hdr%d)
    o_hdr.flush()
    o_hdr.close()
 
    if len(cxx)>0:
        o_cxx = open(fname+'.cxx', 'w')
        o_cxx.writelines(cxx%d)
        o_cxx.flush()
        o_cxx.close()
 
    return 0
 
 

gen_pyfiles()

python.scripts.gen_klass.gen_pyfiles	(		pkg = "",
			klass = "",
			klass_type = 'pyalg',
			fname = 'foo' )

Simple helper function to generate (python) files based off some
   user informations.
 @param pkg the name of the package holding the class we want to generate
 @param klass the name of the python class to generate
 @param klass_type the type of class to generate (pysvc/pytool/pyalg/pyaud)
 @param fname the filename to generate

Definition at line 588 of file gen_klass.py.

def gen_pyfiles(pkg="", klass="", klass_type='pyalg', fname='foo'):
    """Simple helper function to generate (python) files based off some
       user informations.
     @param pkg the name of the package holding the class we want to generate
     @param klass the name of the python class to generate
     @param klass_type the type of class to generate (pysvc/pytool/pyalg/pyaud)
     @param fname the filename to generate
    """
    try:
        py_template = getattr(Templates, '%s_template'%klass_type)
    except AttributeError as err:
        print ("::: UNKNOWN klass_type [%s] !" % klass_type)
        raise err
 
    invalid_py_chars = ( ':', '.', '>', '<', ' ' )
 
    if any([c for c in invalid_py_chars if c in klass]):
        err = "::: INVALID class name ! (%s) !\n"%klass
        err += "::: python class names can *NOT* contain any character of %s"%\
               repr(invalid_py_chars)
        print (err)
        raise RuntimeError(err)
 
    fname=''.join([fname,'.py'])
    d = dict( pkg=pkg,
              klass=klass,
              fname=fname,
              copyright=Templates.copyright_template
              )
    o = open(fname, 'w')
    o.writelines(py_template%d)
    o.flush()
    o.close()
    return 0
 
@acmdlib.command(name='gen-klass')
@acmdlib.argument(
    "--klass",
    required=True,
    help = "The (fully qualified) name of the python or C++ class to create (ex: ElectronContainer, Analysis::Electron, MyAlgTool, PyTestAlg)")
@acmdlib.argument(
    "--pkg",
    required=True,
    help = "The name of the package holding the C++ class to create (ex: MyAnalysis, JetEvent)")
@acmdlib.argument(
    "--type",
    dest = "klass_type",
    required=True,
    choices = GenTypes.values,
    help = "The type of class to create")
@acmdlib.argument(
    "--ipkg",
    default = None,
    help = "The name of the package holding the interface of the C++ class (mandatory for 'svc' and 'tool' types)")
@acmdlib.argument(
    "--iklass",
    default = None,
    help = "The name of the interface the C++ class is implementing (mandatory for 'svc' and 'tool' types)")
@acmdlib.argument(
    "-o",
    "--output-file",
    required=True,
    dest = "fname",
    help = "The name of the file(s) which will hold header and implementation of the class (ex: 'Foo' --> ('Foo.h','Foo.cxx'))")

main()

python.scripts.gen_klass.main

(

args

)

helper script to generate header and cxx files
of various athena components (svc/tool/alg/isvc/itool/object)

Definition at line 652 of file gen_klass.py.

def main(args):
    """helper script to generate header and cxx files
    of various athena components (svc/tool/alg/isvc/itool/object)
    """
 
    exitcode = 0
 
    if args.klass_type in GenTypes.needing_iface and \
       ( args.ipkg is None or args.iklass is None ) :
        print (":: You have to give 'ipkg' and 'iklass' options to properly ",)
        print ("generate an implementation for '%s'"%args.klass_type)
        return 3
 
 
    if args.ipkg is None:
        args.ipkg = ""
 
    if args.iklass is None:
        args.iklass = ""
 
    if args.klass_type.startswith('py'):
        exitcode = gen_pyfiles(
            klass=args.klass,
            klass_type=args.klass_type,
            pkg=args.pkg,
            fname=args.fname
            )
    else:
        exitcode = gen_files(
            klass=args.klass,
            klass_type=args.klass_type,
            pkg=args.pkg,
            iklass=args.iklass,
            ipkg=args.ipkg,
            fname=args.fname
            )
    return exitcode

Variable Documentation

__author__

str python.scripts.gen_klass.__author__ = "Sebastien Binet"

private

Definition at line 11 of file gen_klass.py.

__doc__

str python.scripts.gen_klass.__doc__

private

Initial value:

=  """\
helper script to generate header and cxx files of various athena
components (svc/tool/alg/isvc/itool/object)
"""

Definition at line 12 of file gen_klass.py.