doc/salome/python_doc_generale.dox

   1 /*!
   2
   3 \page python_doc_generale General presentation of the KERNEL python package
   4
   5 The KERNEL python package essentially contains:
   6
   7 - Helper functions to manipulate KERNEL objects from python. For
   8   example, the <b>studyedit.py</b> module facilitates the
   9   manipulation of components and items in %SALOME study.
  10 - General purpose functions for logging and other recurrent
  11   stuff in python programming.
  12
  13 Note that these functions either encapsulate the python programming
  14 interface of KERNEL core (the CORBA or SWIG interfaces for example) or
  15 extend existing utilities as the <b>salome*.py</b> modules.
  16
  17 The functions are distributed in the python package
  18 <a href="group__salome__kernel.html">salome.kernel</a>. For example, the usage
  19 of the study editor to manipulate some objects can be done with a set
  20 of instructions as:
  21
  22 \code
  23 from salome.kernel.studyedit import getStudyEditor
  24
  25 studyEditor = getStudyEditor()  # Get an editor for the current study
  26
  27 myStudyComponent = studyEditor.findOrCreateComponent( moduleName,
  28                                                       componentName,
  29                                                       componentIcon )
  30 myStudyItem = studyEditor.createItem( myStudyComponent,
  31                                       itemName,
  32                                       comment = itemComment,
  33                                       icon = itemIcon )
  34 \endcode
  35
  36 The specification of the programming interface of this package is
  37 detailed in the part \ref python_doc_api of this documentation.
  38
  39 \note
  40 The main package \b salome contains other sub-packages that are
  41 distributed with the other %SALOME modules. For example, the GEOM
  42 module provides the python package \b salome.geom and SMESH the
  43 package \b salome.smesh.
  44
  45 */