Přeskočit obsah

Modul Marks

Modul Marks slouží k načítání a práci se známkami. Umí:

  • stáhnout známky ze serveru školy,
  • pracovat s předměty a jejich známkami (včetně nových známek),
  • filtrovat známky podle data nebo rozsahu datumů,
  • vracet známky seskupené podle předmětů,
  • formátovaný výstup

Tento modul již provádí autorizované dotazy, takže je nutné již mít údaje o tokenech, případně provést první přihlášení.

Třída Marks

class Marks
1
2
3
4
5
6
from async_bakalari_api import Bakalari

class Marks:
    """Marks class."""

    def __init__(self, bakalari: Bakalari): ...

Jako jediný parametr přijímá inicializovanou instanci Bakalari.

1
2
3
4
5
6
7
from async_bakalari_api import Bakalari
from async_bakalari_api.marks import Marks

bakalari = Bakalari("http://server")
bakalari.load_credentials("credentials.json")

marks = Marks(bakalari)

Načtení známek ze serveru

Známky načte metoda fetch_marks().

Metoda se nevolá automaticky při inicializaci třídy Marks. Je nutné ji volat ručně vždy, když chcete aktualizovat známky.

Načtení známek
1
await marks.fetch_marks()

Upozornění

Pro správné fungování je nutné mít platné přihlašovací údaje (tokeny) v instanci Bakalari.

Datové struktury

Známky a předměty se ukládají do speciálních tříd, které modul používá interně i v návratových hodnotách API:

  • SubjectsBase

    • id: str — identifikátor předmětu
    • abbr: str — zkratka předmětu
    • name: str — název předmětu
    • average_text: str — textový průměr (řeší server)
    • points_only: bool — zda je předmět pouze bodově hodnocen
    • marks: MarksRegistry — kolekce známek pro daný předmět

  • MarksBase

    • id: str - id známky
    • date: datetime - datum známky
    • caption: str - text známky
    • theme: str | None - název tématu známky
    • marktext: MarkOptionsBase | None — textová reprezentace známky (1, A, +, apod.)
    • teacher: str | None - učitel, který vydal známku
    • subject_id: str - identifikátor předmětu
    • is_new: bool - nová známka
    • is_points: bool - zda je známka bodová
    • points_text: str | None - textová reprezentace bodů
    • max_points: int | None - maximální počet bodů

  • MarkOptionsBase

    • id: str
    • abbr: str
    • text: str

Logování a fallbacky

  • Pokud server vrátí MarkText, který není v MarkOptions, do logu se zapíše warning a modul použije „placeholder“ MarkOptionsBase, aby zpracování nespadlo.
  • Pokud server vrátí známku k neznámému subject_id, modul to zaloguje jako warning a danou známku přeskočí.

Základní čtení dat

Získání seznamu předmětů

Seznam předmětů
1
2
3
4
subjects = await marks.get_subjects()
print(f"Načteno předmětů: {len(subjects)}")
for s in subjects:
    print(s.id, s.abbr, s.name, s.average_text, s.points_only)

Získání známek pro konkrétní předmět

Známky pro předmět
1
2
3
4
subject_id = "SUBJECT_ID"
subject_marks = await marks.get_marks(subject_id)
for m in subject_marks:
    print(m.date.date(), m.caption, (m.marktext.text if m.marktext else ""))

Práce s novými známkami

Všechny nové známky (napříč předměty)

Nové známky
1
2
3
4
5
new_marks_grouped = await marks.get_new_marks()
for subj in new_marks_grouped:
    print(subj.name, f"({subj.abbr})")
    for m in subj.marks:
        print(" ", m.date.date(), m.caption)

Nové známky podle dne nebo rozsahu

Nové známky v rozsahu
1
2
3
4
5
from datetime import datetime

# Jeden den
day = datetime(2025, 9, 12)
by_day = await marks.get_new_marks_by_date(date=day)
Nové známky v rozsahu
1
2
3
4
5
6
7
8
9
from datetime import datetime

# Rozsah včetně krajních dnů
start = datetime(2025, 9, 1)
end = datetime(2025, 9, 30)
by_range = await marks.get_new_marks_by_date(date=start, date_to=end)

# Jen pro konkrétní předmět
by_subject = await marks.get_new_marks_by_date(date=start, date_to=end, subject_id="SUBJECT_ID")

Kompletní přehled známek (seskupeno dle předmětů)

Vrátit jako data

Všechny známky (seskupené)
1
2
3
4
5
groups = await marks.get_marks_all()
for subj in groups:
    print(subj.name, f"({subj.abbr})")
    for m in subj.marks:
        print(" ", m.date.date(), m.caption)

Filtrovat dle data/rozsahu a/nebo předmětu

Filtrace známek
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from datetime import datetime

# vše v jednom dni
text = await marks.format_all_marks(date=datetime(2025, 9, 12))

# v rozsahu dat
text = await marks.format_all_marks(date=datetime(2025, 9, 1), date_to=datetime(2025, 9, 30))

# pouze daný předmět
text = await marks.format_all_marks(subject_id="SUBJECT_ID")
print(text)

Výpis na stdout

Modul má i helper, který rovnou vypíše formátovaný přehled: 

1
await marks.print_all_marks()  # případně s filtry date/date_to/subject_id