base-classes.rst 939 B

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. _class-reference:
  2. odML-Base Classes
  3. =================
  4. These classes are the core data-structures of odML.
  5. To sum things up, an odML-Document consists of several Sections.
  6. Each Section may contain other Sections and Properties.
  7. Again each Property can have multiple Values.
  8. The odml Module contains wrappers, that are shortcuts for creating the main objects::
  9. >>> from odml import Document, Section, Property
  10. >>> Document(version=0.9, author="Kermit")
  11. <Doc 0.9 by Kermit (0 sections)>
  12. Several modules exist to extend the implementation.
  13. The ones included in the library are those:
  14. Document
  15. --------
  16. .. autoclass:: odml.doc.BaseDocument
  17. :members:
  18. :inherited-members:
  19. :undoc-members:
  20. Section
  21. -------
  22. .. autoclass:: odml.section.BaseSection
  23. :members:
  24. :inherited-members:
  25. :undoc-members:
  26. Property
  27. --------
  28. .. autoclass:: odml.property.BaseProperty
  29. :members:
  30. :inherited-members:
  31. :undoc-members: