settings

settings

SettingsPart and closely related objects.

SettingsPart

SettingsPart(
    partname: PackURI,
    content_type: str,
    element: CT_Settings,
    package: Package,
)

Bases: XmlPart

Document-level settings part of a WordprocessingML (WML) package.

Source code in src/docx/parts/settings.py

def __init__(
    self, partname: PackURI, content_type: str, element: CT_Settings, package: Package
):
    super().__init__(partname, content_type, element, package)
    self._settings = element

settings property

settings: Settings

A Settings proxy object for the w:settings element in this part.

Contains the document-level settings for this document.

default classmethod

default(package: Package)

Return a newly created settings part, containing a default w:settings element tree.

Source code in src/docx/parts/settings.py

@classmethod
def default(cls, package: Package):
    """Return a newly created settings part, containing a default `w:settings` element tree."""
    partname = PackURI("/word/settings.xml")
    content_type = CT.WML_SETTINGS
    element = cast("CT_Settings", parse_xml(cls._default_settings_xml()))
    return cls(partname, content_type, element, package)