univention.admindiary package

univention.admindiary.get_events_to_reject() → list[str]

univention.admindiary.get_logger(name: str) → Logger

class univention.admindiary.DiaryEntry(username: str, message: str, args: dict[str, str], tags: list[str], context_id: str, event_name: str)

Bases: object

assert_types() → None

to_json() → str

classmethod from_json(body: str) → Self

Submodules

univention.admindiary.backend module

univention.admindiary.backend.get_query_limit() → int

univention.admindiary.backend.get_engine() → sqlalchemy.Engine

univention.admindiary.backend.windowed_query(q, column, windowsize, single_entity=True)

Break a Query into chunks on a given unique column (usually primary key), then fetch chunks using LIMIT only, adding a WHERE clause that will ensure we only fetch rows greater than the last one we fetched. This will work for basically any database backend. The potential downside is that the database needs to sort the full set of remaining rows for each chunk, which may be inefficient, even if the sort column is indexed. However, the approach is very simple and can likely work for most ordinary use cases for a primary key column on a database that does not support window functions.

univention.admindiary.backend.get_session(auto_commit: bool = True) → Iterator[sqlalchemy.Session]

class univention.admindiary.backend.Meta(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

schema

class univention.admindiary.backend.Event(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

class univention.admindiary.backend.EventMessage(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

event_id

locale

message

locked

class univention.admindiary.backend.Entry(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

username

hostname

message

timestamp

context_id

event_id

main_id

event

args

tags

comments

class univention.admindiary.backend.Tag(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

entries

class univention.admindiary.backend.Arg(**kwargs)

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

entry_id

key

value

entry

class univention.admindiary.backend.Client(version: int, session: sqlalchemy.Session)

Bases: object

translate(event_name: str, locale: str) → str

options() → dict

add_tag(name: str) → Tag

add_event(name: str) → Event

add_event_message(event_id: int, locale: str, message: str, force: bool) → bool

add(diary_entry: DiaryEntry) → None

query(time_from=None, time_until=None, tag=None, event=None, username=None, hostname=None, message=None, locale='en')

get(context_id: int) → list[dict[str, Any]]

univention.admindiary.backend.get_client(version: int) → Iterator[Client]

exception univention.admindiary.backend.UnsupportedVersion

Bases: Exception

exception univention.admindiary.backend.NoDBConnection

Bases: Exception

univention.admindiary.client module

univention.admindiary.client.exceptionlogging(f: F) → F

class univention.admindiary.client.RsyslogEmitter

Bases: object

emit(entry: Any) → None

univention.admindiary.client.add_comment(message: str, context_id: str, username: str | None = None) → int | None

univention.admindiary.client.write_event(event: DiaryEvent, args: dict[str, str] | None = None, username: str | None = None, context_id: str | None = None) → int | None

univention.admindiary.client.write(message: str, args: dict[str, str] | None = None, username: str | None = None, tags: list[str] | None = None, context_id: str | None = None, event_name: str | None = None) → int | None

univention.admindiary.client.write_entry(entry: DiaryEntry) → int | None

univention.admindiary.events module

class univention.admindiary.events.DiaryEvent(name: str, message: dict[str, str], args: dict[str, str] | None = None, tags: list[str] | None = None, icon: str | None = None)

Bases: object

classmethod get(name: str) → DiaryEvent | None

classmethod names() → list[str]