librus-python-api 1.7.0__tar.gz → 1.8.0__tar.gz

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/API.md

@@ -148,11 +148,38 @@ refunded. Exhaustion raises `LimitError`; deadlines raise `OperationTimeoutError
   allowlisted modern directory and mailbox selections only. Arbitrary query keys,
   routes and modern-to-legacy reference reuse are rejected before dispatch.
 - `diagnostic_sink`: receives `DiagnosticEvent(operation, outcome,
-  elapsed_seconds, budget_requests_dispatched, budget_response_bytes)`.
-  `librus_python_api.diagnostics.logging_sink` emits allowlisted fields through
-  the standard `logging` logger named `librus_python_api`. The application owns
-  handlers and formatting; no logging dependency or global configuration is added. Sink errors
-  never affect results.
+  elapsed_seconds, budget_requests_dispatched, budget_response_bytes, frames)`.
+  `frames` (1.8.0) holds the code locations of a `LibrusError` outcome, as below;
+  it is empty on success and for timeouts, cancellation and replaced
+  connection errors. `librus_python_api.diagnostics.logging_sink` emits allowlisted fields
+  through the standard `logging` logger named `librus_python_api`. The
+  application owns handlers and formatting; no logging dependency or global
+  configuration is added. Sink errors never affect results.
+
+### Failure diagnostics (1.8.0)
+
+Errors carry only their kind, so these helpers read where a failure happened
+from the exception's own traceback. Neither raises.
+
+- `diagnostics.failure_frames(error, limit=6, packages=("librus_python_api",))`
+  returns code locations such as `("grade_records:_numeric:100",
+  "markup:tooltip_fields:113")`, the original failure site last. It follows an
+  explicit cause or a context suppressed with `from None`, and skips helpers
+  that only raise. The strings are opaque and change between releases; report
+  them with the library version.
+- `diagnostics.describe_failure(error)` returns the page structure around the
+  failure, or None: the HTML elements held by the innermost library frame that
+  holds any, with their path from the grade table, tags, safe class tokens,
+  known tooltip labels (`config.TOOLTIP_LABELS`), known detail-link families and
+  lengths. Text and attribute values are masked unless they equal a parser
+  constant, so a failing tooltip reads like `[[Data], [Waga], NO-COLON(len=17)]`.
+  Output is bounded. It is meant for a human to review before sharing, not for
+  automatic upload.
+- `python -m librus_python_api.inspect_page {grades,final-grades} FILE` parses a
+  saved page offline (a whole page or a copied table) and prints counts, or the
+  failure kind, frames and structure. It makes no request and applies the
+  library's parse size limit. Exit status: 0 parsed, 1 failed, 2 unreadable
+  file.
 
 All upstream routes and forms are fixed in `config.py` and documented in
 [contracts/upstream.openapi.yaml](contracts/upstream.openapi.yaml). There is no
@@ -249,6 +276,26 @@ such as `(0-100)`, not a grade symbol. The table's "Wyn." period results are
 into `averages`), and a point table with titled summary columns adds its
 subjects to `final_grades()`. See [point grades](contracts/grades.md#point-grades-170).
 
+Gateway descriptive grades (1.8.0) belong to schools on the new
+descriptive grading schema, whose grades page shows a subject table with empty
+semester cells that the page script fills from the gateway. In the `ALL` view
+only, `grades()` then reads those grades from the gateway with the login's
+session and the call's budget: three more requests, five when there are
+grades. They are `DescriptiveGrade`s in `descriptive` (kind `CURRENT`, no
+`href`), with the page's subject name, the scale value or else the content as
+`raw`, the civil date, semester 1 or 2, the teacher's name when listed, the
+comment and metadata pairs for the present fields only (`Obszar`, `Treść`,
+`Dodał`, `Komentarz`, `Skala`). `grades_window()` filters them like other
+dated records. `WEEK` and `LAST_LOGIN` do not include them, because the page
+narrows those views by a field whose meaning is not established; notifications
+therefore do not report them. A gateway error, an unknown subject, a grade with
+no value, an unexpected shape or a pagination member that shows more items
+fails the whole read instead of returning it without these grades; a refused
+gateway route (403) is `UNSUPPORTED_CAPABILITY`, so it does not put the other
+grade views into the access-denied cooldown. The routes and field names are
+source-informed; a first authorized live read parsed populated records on one
+school's login. See [gateway descriptive grades](contracts/grades.md#gateway-descriptive-grades-180-issue-73).
+
 ## Attendance
 
 - `attendance(view=AttendanceView.ALL)` returns `Attendance` with

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/CHANGELOG.md

@@ -1,5 +1,76 @@
 # Changelog
 
+## 1.8.0 (2026-10-28) - Failure diagnostics and gateway descriptive grades
+
+Errors still carry only their kind; new helpers say where a failure happened
+without page data. Schools on the new descriptive grading schema get their
+gateway grades.
+
+### Failure diagnostics
+
+- `diagnostics.failure_frames(error)` returns the failure's code locations
+  (`module:function:line`, the original site last) from its traceback, through
+  the parser thread, re-raises and a context suppressed with `from None`.
+- `diagnostics.describe_failure(error)` returns the page structure around the
+  failure: element path, tags, safe class tokens, known tooltip labels and
+  lengths, with every text and attribute value masked unless it equals a parser
+  constant. It names, for example, the unlabelled tooltip line that broke a
+  read.
+- `python -m librus_python_api.inspect_page {grades,final-grades} FILE` parses a
+  saved page or copied table offline and prints counts or the failure report.
+- `DiagnosticEvent.frames` carries the code locations to diagnostic sinks, and
+  `logging_sink` logs them.
+- `config.TOOLTIP_LABELS` lists the tooltip labels diagnostics may show by name.
+
+### Gateway descriptive grades
+
+Reads the grades of schools on the new descriptive grading schema, whose
+grades page renders a subject table with empty semester cells and loads the
+grades from gateway JSON routes. Routes and field names come from public client
+code and the official page script. A first authorized live read on 2026-10-28
+parsed four populated records on one school's login and showed the page
+layout below (issue #73).
+
+- Grades: in the `ALL` view, a page with the new-schema table adds its gateway
+  grades to `GradeRecords.descriptive` as `DescriptiveGrade` records, which
+  grade windows filter by date. The read makes three more requests, or five
+  when there are grades, under the same session and budget. Public types and
+  signatures are unchanged and `DescriptiveGrade` has no new field.
+- Grades: `WEEK` and `LAST_LOGIN` make no gateway request and do not include
+  these grades, so notifications do not report them yet.
+- Grades: a gateway error, unknown subject, grade without a value, malformed
+  or oversized response, unknown table layout or a pagination member showing
+  more items fails the whole all-view read on such a page, instead of
+  returning it without these grades. Pages without the table are unchanged.
+  A refused gateway route (403) is `UnsupportedCapabilityError`, so it does
+  not put the week and last-login views into the access-denied cooldown.
+- Upstream contract: five source-informed gateway operations; the two that
+  take an account identifier accept `[A-Za-z0-9_-]{1,128}`, every other
+  `{id}` route stays numeric.
+- Live check: the weekly grade checks and `scripts/live_capture.py` declare
+  the five gateway routes.
+- The page may hold an unclosed, row-less table of the same class before the
+  real one, and the real table has a period header row, hidden details rows
+  and a footer; only a table with subject rows of its own is read.
+
+## 1.7.1 (2026-10-27) - Observed point-grade page and multi-line comments
+
+Fixes for layouts 1.7.0 rejected with `ParseError`, established from an
+affected school's real point-grade page and a live grade read. Public types
+and signatures are unchanged.
+
+- Grades: a teacher's multi-line `Komentarz` continues on unlabelled tooltip
+  lines and is kept with its line breaks. Every grade read of an account with
+  such a comment failed in all releases up to 1.7.0; any other unlabelled
+  tooltip line still fails.
+- Point grades: a formative entry among the point entries is accepted as the
+  formative mirror it is; the empty footer row wider than the table is
+  skipped; titles that break their own label (`Ocena śródroczna <br> z
+  pierwszego okresu`) name the period columns, so point midterm grades are
+  read. These rules apply to point tables only.
+- Formative assessments: assessment text may contain line breaks. 1.7.0 and
+  earlier failed such a table with `UnsupportedCapabilityError`.
+
 ## 1.7.0 (2026-10-27) - Point grades
 
 Reads the "Oceny punktowe" table that point-grade schools show on the grades

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: librus-python-api
-Version: 1.7.0
+Version: 1.8.0
 Summary: Independent bounded async Librus Synergia client
 Project-URL: Repository, https://github.com/krzysztofbury/librus-python-api
 Project-URL: Issues, https://github.com/krzysztofbury/librus-python-api/issues
@@ -42,8 +42,11 @@ private ACLs. Windows installations include `pywin32` and `tzdata` automatically
 Network paths, reparse-point paths and unsafe storage permissions fail closed.
 See [platform requirements](contracts/persistence.md#windows-disk-boundary-25).
 
-**Status:** `1.7.0` reads point grades ("Oceny punktowe"), which made both grade
-reads fail at point-grade schools. It keeps the 1.6.4 linear-time message body
+**Status:** `1.8.0` reports where a failure happened (code locations and a
+redacted page structure, see [failure diagnostics](API.md#failure-diagnostics-180)),
+reads gateway descriptive grades for schools on the new descriptive schema
+(source-informed, first populated read live on one school) and keeps the 1.7.1 point
+grades and multi-line grade comments. It keeps the 1.6.4 linear-time message body
 rendering and the 1.6.2 completed-lesson and grade layouts, including behaviour
 points, which are validated and not reported as grades.
 Class free days, typed capability outcomes and the live-check freshness watchdog
@@ -57,7 +60,7 @@ See [limitations](#supported-features-and-limitations) below.
 Install the exact release from PyPI after its gated publication completes:
 
 ```sh
-python -m pip install librus-python-api==1.7.0
+python -m pip install librus-python-api==1.8.0
 ```
 
 Pin the exact version qualified by your application. Before publication, use a
@@ -73,10 +76,12 @@ python -m pip install .
 To install a locally built wheel instead:
 
 ```sh
-python -m pip install ./dist/librus_python_api-1.7.0-py3-none-any.whl
+python -m pip install ./dist/librus_python_api-1.8.0-py3-none-any.whl
 ```
 
-No CLI or background process is installed: import the library in your own program.
+No console script or background process is installed: import the library in your
+own program. `python -m librus_python_api.inspect_page` only parses a saved page
+offline for a bug report.
 
 ## First request
 
@@ -254,6 +259,32 @@ unqualified; backend acceptance is not proof of delivery. Tests cover supported
 contracts, not every school or role. Detailed coverage is in the
 [verification log][verification]; open work is tracked in [issues][issues].
 
+## Diagnosing failures
+
+Errors carry only their kind. To see where a failure happened without any page
+data, use the helpers in `librus_python_api.diagnostics` (see
+[API.md](API.md#failure-diagnostics-180)):
+
+```python
+from librus_python_api.diagnostics import describe_failure, failure_frames
+from librus_python_api.exceptions import LibrusError
+
+try:
+    await client.grades()
+except LibrusError as error:
+    print(
+        error.kind, failure_frames(error)
+    )  # ('grade_records:_numeric:100', 'markup:tooltip_fields:113')
+    print(describe_failure(error))  # masked HTML structure around the failure
+```
+
+To check a saved page offline (a page source saved with Ctrl+U, or a copied
+table), run `python -m librus_python_api.inspect_page grades page.html` (or
+`final-grades`). It prints counts, or the failure's code locations and masked
+structure, and makes no request. Pass a `diagnostic_sink` to `LibrusService`
+to receive one `DiagnosticEvent` per operation, with `frames` on failure.
+None of these print page text, values, logins or exception messages.
+
 ## Development and support
 
 Use a repository checkout for tests and development tools; they are deliberately

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/README.md

@@ -16,8 +16,11 @@ private ACLs. Windows installations include `pywin32` and `tzdata` automatically
 Network paths, reparse-point paths and unsafe storage permissions fail closed.
 See [platform requirements](contracts/persistence.md#windows-disk-boundary-25).
 
-**Status:** `1.7.0` reads point grades ("Oceny punktowe"), which made both grade
-reads fail at point-grade schools. It keeps the 1.6.4 linear-time message body
+**Status:** `1.8.0` reports where a failure happened (code locations and a
+redacted page structure, see [failure diagnostics](API.md#failure-diagnostics-180)),
+reads gateway descriptive grades for schools on the new descriptive schema
+(source-informed, first populated read live on one school) and keeps the 1.7.1 point
+grades and multi-line grade comments. It keeps the 1.6.4 linear-time message body
 rendering and the 1.6.2 completed-lesson and grade layouts, including behaviour
 points, which are validated and not reported as grades.
 Class free days, typed capability outcomes and the live-check freshness watchdog
@@ -31,7 +34,7 @@ See [limitations](#supported-features-and-limitations) below.
 Install the exact release from PyPI after its gated publication completes:
 
 ```sh
-python -m pip install librus-python-api==1.7.0
+python -m pip install librus-python-api==1.8.0
 ```
 
 Pin the exact version qualified by your application. Before publication, use a
@@ -47,10 +50,12 @@ python -m pip install .
 To install a locally built wheel instead:
 
 ```sh
-python -m pip install ./dist/librus_python_api-1.7.0-py3-none-any.whl
+python -m pip install ./dist/librus_python_api-1.8.0-py3-none-any.whl
 ```
 
-No CLI or background process is installed: import the library in your own program.
+No console script or background process is installed: import the library in your
+own program. `python -m librus_python_api.inspect_page` only parses a saved page
+offline for a bug report.
 
 ## First request
 
@@ -228,6 +233,32 @@ unqualified; backend acceptance is not proof of delivery. Tests cover supported
 contracts, not every school or role. Detailed coverage is in the
 [verification log][verification]; open work is tracked in [issues][issues].
 
+## Diagnosing failures
+
+Errors carry only their kind. To see where a failure happened without any page
+data, use the helpers in `librus_python_api.diagnostics` (see
+[API.md](API.md#failure-diagnostics-180)):
+
+```python
+from librus_python_api.diagnostics import describe_failure, failure_frames
+from librus_python_api.exceptions import LibrusError
+
+try:
+    await client.grades()
+except LibrusError as error:
+    print(
+        error.kind, failure_frames(error)
+    )  # ('grade_records:_numeric:100', 'markup:tooltip_fields:113')
+    print(describe_failure(error))  # masked HTML structure around the failure
+```
+
+To check a saved page offline (a page source saved with Ctrl+U, or a copied
+table), run `python -m librus_python_api.inspect_page grades page.html` (or
+`final-grades`). It prints counts, or the failure's code locations and masked
+structure, and makes no request. Pass a `diagnostic_sink` to `LibrusService`
+to receive one `DiagnosticEvent` per operation, with `frames` on failure.
+None of these print page text, values, logins or exception messages.
+
 ## Development and support
 
 Use a repository checkout for tests and development tools; they are deliberately

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/src/librus_python_api/__init__.py

@@ -138,7 +138,7 @@ from librus_python_api.models import (
 from librus_python_api.sending import SendAttempt
 from librus_python_api.service import AccountClient, LibrusService
 
-__version__ = "1.7.0"
+__version__ = "1.8.0"
 
 __all__ = [
     "ArchiveAbsences",

{librus_python_api-1.7.0 → librus_python_api-1.8.0}/src/librus_python_api/config.py

@@ -433,6 +433,51 @@ ENDPOINTS: Mapping[str, Endpoint] = MappingProxyType(
                 False,
                 Evidence.INDEPENDENTLY_OBSERVED,
             ),
+            # Gateway reads behind the grades page's new-schema descriptive
+            # table. Routes and field names come from public client code and the
+            # official page script, not from an observed populated response.
+            Endpoint(
+                "descriptive_token_info",
+                "GET",
+                "/gateway/api/2.0/Auth/TokenInfo",
+                SideEffect.NONE,
+                True,
+                Evidence.SOURCE_INFORMED,
+            ),
+            Endpoint(
+                "descriptive_user_info",
+                "GET",
+                "/gateway/api/2.0/Auth/UserInfo/{id}",
+                SideEffect.NONE,
+                True,
+                Evidence.SOURCE_INFORMED,
+            ),
+            # A read sent as POST with the fixed JSON body `{}`; it is never
+            # replayed, although it changes nothing that is known.
+            Endpoint(
+                "descriptive_partial_grades",
+                "POST",
+                "/gateway/api/2.0/Auth/DescriptiveGradingSystem/PartialGrades/Student/{id}",
+                SideEffect.NONE,
+                False,
+                Evidence.SOURCE_INFORMED,
+            ),
+            Endpoint(
+                "descriptive_subjects",
+                "GET",
+                "/gateway/api/3.0/Auth/Subjects",
+                SideEffect.NONE,
+                True,
+                Evidence.SOURCE_INFORMED,
+            ),
+            Endpoint(
+                "descriptive_users",
+                "GET",
+                "/gateway/api/2.0/Users",
+                SideEffect.NONE,
+                True,
+                Evidence.SOURCE_INFORMED,
+            ),
             Endpoint(
                 "attendance",
                 "POST",
@@ -659,6 +704,38 @@ GRADE_MAX_SUBJECTS = 128
 GRADE_MAX_VALUE_LENGTH = 1024
 GRADE_MERGED_SUBJECTS = frozenset({"Zachowanie"})
 GRADE_INLINE_DETAIL_LABEL = "Ocena"
+# Tooltip fields whose free text may continue on unlabelled lines. A teacher's
+# multi-line grade comment was observed on 2026-10-27.
+TOOLTIP_MULTILINE_LABELS = frozenset({"Komentarz"})
+# Tooltip labels observed on grade, attendance and point pages. Diagnostics
+# show only these by name; any other label is masked as teacher-entered text.
+TOOLTIP_LABELS = frozenset(
+    {
+        "Czy wycieczka",
+        "Data",
+        "Data realizacji",
+        "Data wystawienia",
+        "Data zapowiedzi",
+        "Dodał",
+        "Godzina lekcyjna",
+        "Kategoria",
+        "Komentarz",
+        "Lekcja",
+        "Licz do puli",
+        "Licz do wyniku",
+        "Licz do średniej",
+        "Maksymalna ilość punktów",
+        "Nauczyciel",
+        "Obowiązek wyk. zadania",
+        "Ocena",
+        "Rodzaj",
+        "Suma punktów",
+        "Temat zajęć",
+        "Waga",
+        "Zakres do",
+        "Zakres od",
+    }
+)
 # A point-grade ("Oceny punktowe") table marks each subject row's expander image
 # with this ID; ordinary grade rows use `przedmioty_<id>_node`.
 GRADE_POINT_ROW_NODE = re.compile(r"przedmioty_OP_[0-9A-Za-z_]{1,64}_node")
@@ -690,6 +767,21 @@ GRADE_PERIOD_HEADERS = MappingProxyType(
         "Ocena roczna": 0,
     }
 )
+# New-schema descriptive grading: the page renders this table with empty
+# semester cells and its script loads the grades from the gateway routes above.
+DESCRIPTIVE_TABLE_CLASS = "newSchemaGradesByStudentTable"
+DESCRIPTIVE_ROW_CLASS = "studentRow"
+# Gateway account and student identifiers are opaque strings, unlike every
+# other `{id}` route, which takes a numeric ID.
+DESCRIPTIVE_IDENTIFIER = re.compile(r"[A-Za-z0-9_-]{1,128}")
+DESCRIPTIVE_IDENTIFIER_OPERATIONS = frozenset(
+    {"descriptive_user_info", "descriptive_partial_grades"}
+)
+# The PartialGrades read is a POST whose only body is this fixed JSON object.
+DESCRIPTIVE_PARTIAL_GRADES_BODY = b"{}"
+DESCRIPTIVE_MAX_SUBJECTS = 1024
+DESCRIPTIVE_MAX_USERS = 8192
+DESCRIPTIVE_MAX_NAME_LENGTH = 1024
 GRADE_PREDICTED_ANNUAL_HEADER = "Przewidywana ocena roczna"
 GRADE_PREDICTED_PERIOD_HEADERS = MappingProxyType(
     {