Url¶

py_moodle.url ¶

URL module management for Moodle CLI.

Provides functions to create and delete "url" modules linking to external resources. All code and comments are in English.

Classes:

Name	Description
`MoodleUrlError`	Exception raised for errors in URL module operations.

Functions:

Name	Description
`add_url`	Create a new URL module in a course section.
`delete_url`	Delete a URL module by its course module ID.

Attributes¶

MODULE_NAME `module-attribute` ¶

MODULE_NAME = 'url'

Classes¶

MoodleUrlError ¶

Bases: Exception

Exception raised for errors in URL module operations.

Functions¶

add_url ¶

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

Create a new URL module in a course section.

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 URL to.	required
`section_id`	`int`	ID of the section within the course.	required
`name`	`str`	Name of the URL module.	required
`external_url`	`str`	The external URL to be linked.	required
`intro`	`str`	Optional introduction or description for the URL.	`''`
`visible`	`int`	Visibility flag (1 for visible, 0 for hidden).	`1`

Returns:

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

delete_url ¶

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

Delete a URL module by its course module ID.