inginious.common package

Common package: basic library for INGInious, needed by all its components.

Subpackages

• inginious.common.task_file_readers package
  • Submodules
  • inginious.common.task_file_readers.abstract_reader module
  • inginious.common.task_file_readers.yaml_reader module
• inginious.common.tests package
  • Submodules
  • inginious.common.tests.TestBase module
  • inginious.common.tests.TestCourse module
  • inginious.common.tests.TestCustomYaml module
  • inginious.common.tests.TestHookManager module
  • inginious.common.tests.TestTask module

Submodules

inginious.common.asyncio_utils module

inginious.common.base module

inginious.common.course_factory module

inginious.common.courses module

Contains the class Course and utility functions

class inginious.common.courses.Course(courseid, content_description, task_factory, hook_manager)

Bases: object

Represents a course

get_descriptor()

Get (a copy) the description of the course

get_id()

Return the _id of this course

get_task(taskid)

Returns a Task object

get_tasks()

Get all tasks in this course

inginious.common.custom_yaml module

inginious.common.exceptions module

Some type of exceptions used by parts of INGInious

exception inginious.common.exceptions.CourseAlreadyExistsException

Bases: exceptions.Exception

exception inginious.common.exceptions.CourseNotFoundException

Bases: exceptions.Exception

exception inginious.common.exceptions.CourseUnreadableException

Bases: exceptions.Exception

exception inginious.common.exceptions.InvalidNameException

Bases: exceptions.Exception

exception inginious.common.exceptions.TaskNotFoundException

Bases: exceptions.Exception

exception inginious.common.exceptions.TaskReaderNotFoundException

Bases: exceptions.Exception

exception inginious.common.exceptions.TaskUnreadableException

Bases: exceptions.Exception

inginious.common.hook_manager module

Hook Manager

class inginious.common.hook_manager.HookManager

Bases: object

Registers an manages hooks. Hooks are callback functions called when the inginious.backend does a specific action.

add_hook(name, callback)

Add a new hook that can be called with the call_hook function

call_hook(name, **kwargs)

Call all hooks registered with this name. Returns a list of the returns values of the hooks (in the order the hooks were added)

inginious.common.log module

Some common functions for logging

class inginious.common.log.CustomLogMiddleware(app, logger)

WSGI middleware for logging the status in webpy

log(status, environ)

inginious.common.log.get_course_logger(coursename)

Parameters:coursename – the course id Returns:a logger object associated to a specific course

inginious.common.log.init_logging(log_level=10)

Init logging :param log_level: An integer representing the log level or a string representing one

inginious.common.message_meta module

inginious.common.messages module

inginious.common.task_factory module

inginious.common.tasks module

inginious.common.tasks_code_boxes module

inginious.common.tasks_problems module