Page¶

py_moodle.page ¶

Page module management for Moodle CLI.

Provides functions to create and delete 'page' modules, allowing HTML content to be added to a course. All code and comments are in English.

Classes:

Name	Description
`MoodlePageError`	Exception raised for errors in page operations.

Functions:

Name	Description
`add_page`	Create a new page module with the provided HTML content.
`delete_page`	Delete a page module by its course module ID.

Attributes¶

MODULE_NAME `module-attribute` ¶

MODULE_NAME = 'page'

Classes¶

MoodlePageError ¶

Bases: Exception

Exception raised for errors in page operations.

Functions¶

add_page ¶

add_page(
    session: Session,
    base_url: str,
    sesskey: str,
    course_id: int,
    section_id: int,
    name: str,
    content: str,
    intro: str = "",
    visible: int = 1,
) -> int

Create a new page module with the provided HTML content.

Parameters:

Name	Type	Description	Default
`session`	`Session`	Authenticated `requests.Session` object.	required
`base_url`	`str`	Base URL of the Moodle instance.	required
`sesskey`	`str`	Session key for form submissions.	required
`course_id`	`int`	ID of the course to add the page to.	required
`section_id`	`int`	ID of the section within the course.	required
`name`	`str`	Name of the page module.	required
`content`	`str`	HTML content of the page.	required
`intro`	`str`	Optional introduction displayed above the content.	`''`
`visible`	`int`	Whether the module is visible (1) or hidden (0).	`1`

Returns:

Type	Description
`int`	The new course module ID (cmid).

delete_page ¶

delete_page(
    session: Session, base_url: str, sesskey: str, cmid: int
) -> bool

Delete a page module by its course module ID.