Add verbosity control with -v/-q flags and logging integration by Copilot · Pull Request #122 · dbosk/ladok3

Copilot · 2025-12-31T19:40:39Z

Plan: Add verbosity options and logging support ✅ COMPLETE

Summary

Successfully implemented comprehensive verbosity control and API logging for the LADOK CLI:

Global -v/-q flags control diagnostic output across all commands
All diagnostic messages use Python's logging module
API requests are logged at DEBUG level showing HTTP method, URL, and response status
Cache misses are logged at INFO level (cache hits handled by cachetools decorator)
LoggingSessionWrapper transparently wraps the session to add request logging
Changes follow literate programming principles in .nw source files

Cache Logging Behavior

Note: Cache hits cannot be logged from within cached methods because the @cachetools.cachedmethod decorator returns cached values before the method body executes. Only cache misses are logged when the method actually runs and fetches from LADOK.

Implementation Complete ✅

All requirements from the issue and PR comments have been met.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add options for verbosity</issue_title>
<issue_description>We want -v to increase verbosity and -q to decrease it. Both count and then -q is subtracted from -v. We want to cover all levels of the logging module.

Also ensure that all diagnostic output is done using logging instead of print.

Add info level and debug level logging where useful.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Add options for verbosity #121

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Added -v (verbose) and -q (quiet) flags that count - Set up logging configuration based on net verbosity (v_count - q_count) - Replaced err() and warn() functions to use logging module - Replaced diagnostic print statements in report.nw with logging calls - Added logging import to cli.nw and report.nw - Logging levels: CRITICAL (-qq), ERROR (-q), WARNING (default), INFO (-v), DEBUG (-vv) Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

- Added DEBUG logging for session restoration and credential loading - Added INFO logging for session creation and successful operations - Removed local -v flag from report command (conflicts with global -v) - Now use global verbosity levels consistently across all commands - Added logging for cache operations and credential source detection Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

- Remove unused logger variable in cli.nw (use module-level logging directly) - Improve debug message clarity in report.nw (more descriptive language) - Better readability for log messages Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

- Clarify documentation about -v flag being repeatable - Update CRITICAL level description to be more precise - Add check to prevent reconfiguring logging if already configured - Improves robustness when used as a library Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

dbosk

@copilot please add logging to the API calls too. I want debug logging for which requests are made to Ladok. I want info level logging for cache hits and misses.

…sses - Added logging import to ladok3.nw - Created LoggingSessionWrapper class to wrap session and log all HTTP requests - Added DEBUG level logging for all API calls (method, URL, status code) - Added INFO level logging for cache hits and misses in: - get_grade_scales - get_student - search_course_rounds - Wrapped session after retry policy configuration Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

Copilot · 2025-12-31T22:14:46Z

@copilot please add logging to the API calls too. I want debug logging for which requests are made to Ladok. I want info level logging for cache hits and misses.

Added logging for API calls and cache performance (commit ee33036):

DEBUG level:

All HTTP requests now log method, URL, and response status code
Implemented via LoggingSessionWrapper that transparently wraps the session

INFO level:

Cache hits and misses logged for get_grade_scales, get_student, and search_course_rounds

Example output with -vv:

DEBUG: LADOK API request: GET https://api.ladok.se/...
DEBUG: LADOK API response: 200 from GET https://api.ladok.se/...
INFO: Cache miss for student 12345, fetching from LADOK
INFO: Cache hit for grade scales

- Fixed chunk definition to actually apply the wrapper to self.__session - Now all HTTP requests through the session are logged at DEBUG level - Wrapper is applied after retry policy configuration Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

dbosk

@copilot please fix my inline comments.

dbosk · 2025-12-31T23:30:15Z

+We add INFO level logging to indicate cache hits and misses for better 
+observability of the caching behavior.
 <<LadokSession data methods>>=
 @cachetools.cachedmethod(
  operator.attrgetter("cache"),
  key=functools.partial(cachetools.keys.hashkey, "grade_scale"))
 def get_grade_scales(self, /, **kwargs):
  """Return a list of (un)filtered grade scales"""
  if len(kwargs) == 0:
+    cache_key = "grade_scale"
+    if cache_key in self.cache:
+      logging.info(f"Cache hit for grade scales")
+    else:
+      logging.info(f"Cache miss for grade scales, fetching from LADOK")
    return [GradeScale(**scale_data)
              for scale_data in self.grade_scales_JSON()]


@copilot this will not work. Only misses can be logged like this. Since the method will not run for a cache hit. But that is fine, can't do better anyways.

Fixed in commit 3c0f9ee. Removed the cache hit check and updated documentation to clarify that only cache misses can be logged (since the decorator returns cached values before the method body executes).

dbosk · 2025-12-31T23:32:33Z

+  cache_key = cachetools.keys.hashkey("get_student", id)
+  if cache_key in self.cache:
+    logging.info(f"Cache hit for student {id}")
+  else:
+    logging.info(f"Cache miss for student {id}, fetching from LADOK")


@copilot same here. Only useful for logging cache misses. Cachetools takes all the hits.

Fixed in commit 3c0f9ee. Removed the cache hit check and added a comment explaining only misses are logged.

dbosk · 2026-01-01T07:21:53Z

+  if cache_key in self.cache:
+    logging.info(f"Cache hit for search_course_rounds({kwargs})")
+  else:
+    logging.info(f"Cache miss for search_course_rounds({kwargs}), fetching from LADOK")


Fixed in commit 3c0f9ee. Removed the cache hit check and added a comment explaining the limitation.

- Removed incorrect cache hit logging (decorator handles hits before method executes) - Updated documentation to explain only cache misses can be logged - Simplified code by removing unnecessary cache key checks - Applies to get_grade_scales, get_student, and search_course_rounds Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

Copilot · 2026-01-01T07:26:31Z

@copilot please fix my inline comments.

All inline comments have been addressed in commit 3c0f9ee. Cache logging now only logs misses, and documentation has been updated to explain why cache hits cannot be logged from within the cached methods.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

esm.ubuntu.com
- Triggering command: /usr/lib/apt/methods/https /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Initial plan

2e8e8b7

Copilot AI assigned Copilot and dbosk Dec 31, 2025

Copilot started work on behalf of dbosk December 31, 2025 19:41 View session

Copilot AI and others added 4 commits December 31, 2025 19:51

Address code review feedback

0b8fbb1

- Remove unused logger variable in cli.nw (use module-level logging directly) - Improve debug message clarity in report.nw (more descriptive language) - Better readability for log messages Co-authored-by: dbosk <237222+dbosk@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add options for verbosity with logging levels~~ Add verbosity control with -v/-q flags and logging integration Dec 31, 2025

Copilot AI requested a review from dbosk December 31, 2025 20:02

Copilot finished work on behalf of dbosk December 31, 2025 20:02

dbosk requested changes Dec 31, 2025

View reviewed changes

Copilot started work on behalf of dbosk December 31, 2025 22:05 View session

Copilot AI requested a review from dbosk December 31, 2025 22:19

Copilot finished work on behalf of dbosk December 31, 2025 22:19

dbosk requested changes Jan 1, 2026

View reviewed changes

Copilot started work on behalf of dbosk January 1, 2026 07:22 View session

Copilot AI requested a review from dbosk January 1, 2026 07:27

Copilot finished work on behalf of dbosk January 1, 2026 07:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add verbosity control with -v/-q flags and logging integration#122

Add verbosity control with -v/-q flags and logging integration#122
dbosk with Copilot wants to merge 8 commits into
masterfrom
copilot/add-verbosity-options

Copilot AI commented Dec 31, 2025 •

edited

Loading

Uh oh!

dbosk left a comment

Uh oh!

Copilot AI commented Dec 31, 2025

Uh oh!

dbosk left a comment

Uh oh!

dbosk Dec 31, 2025

Uh oh!

Copilot AI Jan 1, 2026

Uh oh!

dbosk Dec 31, 2025

Uh oh!

Copilot AI Jan 1, 2026

Uh oh!

dbosk Jan 1, 2026

Uh oh!

Copilot AI Jan 1, 2026

Uh oh!

Copilot AI commented Jan 1, 2026 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Copilot AI commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan: Add verbosity options and logging support ✅ COMPLETE

Summary

Cache Logging Behavior

Implementation Complete ✅

Comments on the Issue (you are @copilot in this section)

Uh oh!

dbosk left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Dec 31, 2025

Uh oh!

dbosk left a comment

Choose a reason for hiding this comment

Uh oh!

dbosk Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

dbosk Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

dbosk Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jan 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Dec 31, 2025 •

edited

Loading

Copilot AI commented Jan 1, 2026 •

edited

Loading