Skip to main content
Version: 2026R2

Chapter

class compolyx.Chapter(name, parent, view=None, ply_entities=(), id=0, show_rosettes=True)

Class to represent plybook chapter.

Attributes

NameDescription
Chapter.is_dict_itemSpecifies whether the object is an item of a dict
Chapter.is_list_itemSpecifies whether the object is an item of a list
Chapter.link_pathRoot path of the current node in the tree for links to this object
Chapter.nameName of object
Chapter.parentParent object in tree
Chapter.ply_entitiesPlies/PlyGroups for the chapter
Chapter.root_pathRoot path of the current node in the tree
Chapter.show_rosettesShow the rosettes linked to a ply in snapshots
Chapter.view

Methods

NameDescription
Chapter.find_parent(type)Steps up the tree and returns the first parent with given type
Chapter.generate_reST(reST_chapter_template, ...)Get the interpolated reST string for the chapter
Chapter.get_production_plies()Return a list of production plies which are associated with this chapter
Chapter.serialize()
Chapter.update()
Chapter.visit(visitor)Walk through the tree and let the visitor perform an action on every descendant node