🔍 Code Extractor

Represents a OneNote notebook entity with access to its sections and section groups, providing a hierarchical structure for organizing OneNote content.

Purpose

The Notebook class models a OneNote notebook within the Microsoft Graph API hierarchy. It extends OnenoteEntityHierarchyModel to provide access to the notebook's sections and section groups through lazy-loaded entity collections. This class serves as a container for organizing OneNote content and enables navigation through the notebook's hierarchical structure. It is designed to work within the office365 SDK framework for interacting with Microsoft OneNote services.

Source Code

class Notebook(OnenoteEntityHierarchyModel):
    """A OneNote notebook."""

    @property
    def sections(self):
        # type: () -> EntityCollection[OnenoteSection]
        """
        Retrieve a list of onenoteSection objects from the specified notebook.
        """
        return self.properties.get(
            "sections",
            EntityCollection(
                self.context,
                OnenoteSection,
                ResourcePath("sections", self.resource_path),
            ),
        )

    @property
    def section_groups(self):
        """
        Retrieve a list of onenoteSection objects from the specified notebook.
        """

        from office365.onenote.sectiongroups.section_group import SectionGroup

        return self.properties.get(
            "sectionGroups",
            EntityCollection(
                self.context,
                SectionGroup,
                ResourcePath("sectionGroups", self.resource_path),
            ),
        )

    def get_property(self, name, default_value=None):
        if default_value is None:
            property_mapping = {"sectionGroups": self.section_groups}
            default_value = property_mapping.get(name, None)
        return super(Notebook, self).get_property(name, default_value)

Parameters

Parameter Details

context: The client context object required for making API calls to Microsoft Graph. Inherited from parent class and used to initialize entity collections.

resource_path: The resource path identifying this notebook in the API hierarchy. Inherited from parent class and used to construct paths for child resources like sections and section groups.

Return Value

Instantiation returns a Notebook object representing a OneNote notebook. The sections property returns an EntityCollection[OnenoteSection] containing all sections in the notebook. The section_groups property returns an EntityCollection[SectionGroup] containing all section groups. The get_property method returns the requested property value or the provided default_value if not found.

Class Interface

Methods

Attributes

Dependencies

• office365
• typing

Required Imports

from office365.onenote.notebooks.notebook import Notebook
from office365.entity_collection import EntityCollection
from office365.onenote.entity_hierarchy_model import OnenoteEntityHierarchyModel
from office365.onenote.sections.section import OnenoteSection
from office365.runtime.paths.resource_path import ResourcePath

Conditional/Optional Imports

These imports are only needed under specific conditions:

from office365.onenote.sectiongroups.section_group import SectionGroup

Usage Example

from office365.graph_client import GraphClient
from office365.onenote.notebooks.notebook import Notebook

# Authenticate and create client context
client = GraphClient.with_token(lambda: 'your_access_token')

# Get a specific notebook
notebook = client.me.onenote.notebooks.get_by_id('notebook_id')

# Access sections in the notebook
sections = notebook.sections
for section in sections:
    print(section.display_name)

# Access section groups
section_groups = notebook.section_groups
for group in section_groups:
    print(group.display_name)

# Use get_property to retrieve properties
section_groups_alt = notebook.get_property('sectionGroups')

Best Practices

• The Notebook class uses lazy loading for sections and section_groups properties - they are only instantiated when first accessed
• Always ensure the context object is properly authenticated before accessing notebook properties
• The sections and section_groups properties return EntityCollection objects that may require additional API calls to load data
• Use get_property method when you need to access properties with custom default values or when working with dynamic property names
• The class inherits from OnenoteEntityHierarchyModel, so all parent class methods and properties are available
• Section groups are imported lazily within the section_groups property to avoid circular import issues
• Properties are cached in the internal properties dictionary after first access for performance
• When iterating over sections or section_groups, be aware that this may trigger API calls to Microsoft Graph

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Onenote 83.5% similar

  The Onenote class serves as the entry point for accessing Microsoft OneNote resources through the Microsoft Graph API, providing access to notebooks, pages, sections, and other OneNote entities.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/onenote.py

• class SectionGroup 82.6% similar

  Represents a section group in a OneNote notebook that can contain both sections and nested section groups, providing hierarchical organization of OneNote content.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/sectiongroups/section_group.py

• class OnenoteEntityHierarchyModel 80.0% similar

  A model class representing OneNote entities with hierarchical properties such as notebooks, sections, and pages, providing access to display name, creation/modification metadata, and identity information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/entity_hierarchy_model.py

• class NotebookCollection 79.2% similar

  A collection class for managing OneNote notebooks, providing methods to create, retrieve, and query notebooks within Microsoft 365, SharePoint, or group contexts.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/notebooks/collection.py

• class OnenoteEntityBaseModel 77.3% similar

  OnenoteEntityBaseModel is a base class for OneNote entities that inherits from Entity. It serves as a foundational type for all OneNote-related entity models in the Office365 SDK.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/entity_base_model.py