feat: add flags for get-status subcommand by slate5 · Pull Request #37 · ProtossGP32/woffu-client

slate5 · 2025-10-13T21:31:05Z

Closes #33

ProtossGP32

Changes reviewed, please address what's commented in the review.

ProtossGP32 · 2025-10-16T11:36:49Z

        """Return the total amount of worked hours and current sign status."""
+        # Retrieve info for the period flags, e.g., --week, --month, --year
+        if period != "today":
+            return self._get_status_period(period), None


get_status returns a tuple[timedelta, bool] but you're returning tuple[timedelta, None]. Pylance is complaining about this, so we should fix this. Maybe we should invoke a new method that only returns self._get_status_period(period) if you only want the total time... Or make the bool return value optional.

I would rather use Optional[bool] to avoid dispersing subcommands and their flags. Ideally, we would execute one function from cli.py that represents a subcommand and pass any flags as arguments.

Another option is to return the sign-in status also for each variation of get-status, which would imply 2 REST API calls for period flags (e.g., --week, --month, --year).

What do you think?

Let's go with the Optional[bool] option for now. I'll let you know if Pylance complains about any other thing then (it hates types inconsistencies during unit tests).

Additionally, the get-status command in woffu-cli ends with error when defining different time windows due to the status not being available:

(.venv) mpalacin@bsc-84885021:~/GitHub/personal_projects/woffu-client$ woffu-cli get-status [2025-10-17 10:04:53] INFO woffu_api_client: Hours worked today: 00:42:22 [2025-10-17 10:04:53] INFO woffu_api_client: You're currently signed in. (.venv) mpalacin@bsc-84885021:~/GitHub/personal_projects/woffu-client$ woffu-cli get-status --week [2025-10-17 10:05:02] INFO woffu_api_client: Hours worked this week: 14:25 ❌ Error retrieving status: not enough values to unpack (expected 2, got 1)

Please try to secure this.

ProtossGP32 · 2025-10-17T08:10:43Z

+                from_date = today.replace(month=1, day=1)
+                to_date = today.replace(month=12, day=31)
+
+        diary_json = self.get(


Here you're calling the same HTTP endpoint as in _get_presence() private method. Maybe we can create a base method for presence retrieving to avoid duplicated code? And then this new method can be used for both the current _get_presence() and the new _get_status_period().

ProtossGP32 · 2025-10-17T08:12:58Z

        """Return the total amount of worked hours and current sign status."""
+        # Retrieve info for the period flags, e.g., --week, --month, --year
+        if period != "today":
+            return self._get_status_period(period), None


Additionally, the get-status command in woffu-cli ends with error when defining different time windows due to the status not being available:

(.venv) mpalacin@bsc-84885021:~/GitHub/personal_projects/woffu-client$ woffu-cli get-status [2025-10-17 10:04:53] INFO woffu_api_client: Hours worked today: 00:42:22 [2025-10-17 10:04:53] INFO woffu_api_client: You're currently signed in. (.venv) mpalacin@bsc-84885021:~/GitHub/personal_projects/woffu-client$ woffu-cli get-status --week [2025-10-17 10:05:02] INFO woffu_api_client: Hours worked this week: 14:25 ❌ Error retrieving status: not enough values to unpack (expected 2, got 1)

Please try to secure this.

ProtossGP32 · 2025-10-17T08:15:33Z

+
+        h, m = map(int, diary_json["totalWorkedTimeFormatted"]["values"])
+        logger.info(
+            "Hours worked this {}: {:02d}:{:02d}".format(period, h, m),


For consistency's sake with the default results, we should use the same time format, including hours, minutes and seconds. This way we ease the job of any external parser that might want to extract this value:

"Hours worked today: {:02d}:{:02d}:{:02d}".format( int(hours), int(minutes), int(seconds), ),

ProtossGP32 · 2025-10-21T06:40:58Z

+        const="year",
+        help="Get current year's total hours",
+    )
+    st_parser.set_defaults(period="today")


I think it would be good to also define a subparser argument for --today even though it's the default value, so users using some kind of automated script to invoke woffu-cli can easily swap between any of the options and not worry about having to leave it empty. What do you think?

ProtossGP32 · 2025-11-21T07:26:37Z

 """
 from __future__ import annotations

+import calendar


calendar package is deprecated (https://pypi.org/project/Calendar/). Please use any alternative actively maintained to avoid technical debt in the future.

Also, when importing new modules, please add them to the corresponding pyproject.toml section.

ProtossGP32 · 2025-12-19T14:04:17Z

I've rebased this branch with fix #41 to prevent tests from failing. Please update your local branch (git pull --rebase) before committing any new change, thanks!

for more information, see https://pre-commit.ci

ProtossGP32 · 2026-02-02T11:24:38Z

I've found out that we can use lighter HTTP requests to retrieve the same weekly, monthly and yearly information:

Summary and Presence

ℹ️ This section contains queries related to summary and presence.

Time formats can vary depending on the values precision, and its format is defined in the resource key:

For instance, values that are rounded to the hour and only return a single item in the values array will have _HoursFormatted as the resource type

If values array contains more than one item, then the resource type will be _HoursMinutesFormatted

TODO: check if there are other resource types

The query is the same for all except the start and end dates and the diaryPresenceType value:

1 is for weekly summary

2 is for monthly summary

3 is for yearly summary

Weekly summary:

Query:

https://bsc.woffu.com/api/svc/core/diariesquery/users/<user_id>/diarysummary/presence/summary?fromDate=<current_week_monday>&toDate=<current_week_sunday>&diaryPresenceType=1

JSON response:

{
    'detailEndDate': '2026-02-08T00:00:00',
    'detailStartDate': '2026-02-02T00:00:00',
    'hasAlert': False,
    'percentWorked': 50,
    'title': '_ThisWeek',
    'totalWorkedTimeFormatted': {'resource': '_HoursFormatted', 'values': ['0']},
    'totalWorkingTimeFormatted': {'resource': '_HoursMinutesFormatted',
                                'values': ['37', '30']},
    'totalWorkingTimeUntilTodayFormatted': {'resource': '_HoursFormatted',
                                            'values': ['0']},
    'userId': <user_id>
}

Monthly summary:

Query:

https://bsc.woffu.com/api/svc/core/diariesquery/users/<user_id>/diarysummary/presence/summary?fromDate=<current_month_first_day>&toDate=<current_month_last_day>&diaryPresenceType=2

JSON response:

{
    'detailEndDate': '2026-02-01T00:00:00+00:00',
    'detailStartDate': '2026-02-01T00:00:00',
    'hasAlert': False,
    'percentWorked': 50,
    'title': '_February',
    'totalWorkedTimeFormatted': {'resource': '_HoursFormatted', 'values': ['0']},
    'totalWorkingTimeFormatted': {'resource': '_HoursFormatted',
                                'values': ['150']},
    'totalWorkingTimeUntilTodayFormatted': {'resource': '_HoursFormatted',
                                            'values': ['0']},
    'userId': <user_id>
}

Yearly summary:

Query:

https://bsc.woffu.com/api/svc/core/diariesquery/users/<user_id>/diarysummary/presence/summary?fromDate=<year>-01-01&toDate=<year>-12-31&diaryPresenceType=3

JSON response:

{
    'detailEndDate': '2026-02-01T00:00:00+00:00',
    'detailStartDate': '2026-01-01T00:00:00',
    'hasAlert': False,
    'percentWorked': 52,
    'title': '2026',
    'totalWorkedTimeFormatted': {'resource': '_HoursMinutesFormatted',
                                'values': ['156', '24']},
    'totalWorkingTimeFormatted': {'resource': '_HoursFormatted',
                                'values': ['1642']},
    'totalWorkingTimeUntilTodayFormatted': {'resource': '_HoursFormatted',
                                            'values': ['150']},
    'userId': <user_id>
}

It automatically clamps the time window between the start of the current year and the day before the current day
- So it doesn't take into account the already worked hours in the current day

Current approach: reusing presence query

Query:

https://bsc.woffu.com/api/svc/core/diariesquery/users/<user_id>/diaries/summary/presence?fromDate=<start_date>&toDate=<end_date>

JSON response:

{
    'diaries: [ "..." ],
    'dynamicColumns': None,
    'isUserAcceptable': True,
    'totalDifferenceTime': 0,
    'totalDifferenceTimeFormatted': {'resource': '_HoursFormatted',
                                    'values': ['0']},
    'totalDynamicColumnsFormatted': {},
    'totalNotRecognizedTimeFormatted': {'resource': '_HoursFormatted',
                                        'values': ['0']},
    'totalRecords': 365,
    'totalScheduleTimeFormatted': {'resource': '_HoursMinutesFormatted',
                                    'values': ['2737', '30']},
    'totalWorkedTimeFormatted': {'resource': '_HoursMinutesFormatted',
                                'values': ['156', '24']},
    'totalWorkingTimeFormatted': {'resource': '_HoursMinutesFormatted',
                                'values': ['1852', '30']}
}

This is a lot heavier than the previous one (we get info of all the days within that time period) and we only use the totalWorkedTimeFormatted key, which returns the same for both queries. Also, totalWorkingTimeFormatted value doesn't match the previous query for diaryPresenceType=3, so we should verify which one of these is the right one.

ProtossGP32 self-requested a review October 14, 2025 09:21

ProtossGP32 assigned ProtossGP32 and slate5 Oct 14, 2025

ProtossGP32 requested changes Oct 16, 2025

View reviewed changes

slate5 requested a review from ProtossGP32 October 17, 2025 13:04

slate5 force-pushed the feature/get-status-period branch from d764480 to f69c0c0 Compare October 20, 2025 22:08

ProtossGP32 requested changes Nov 10, 2025

View reviewed changes

ProtossGP32 requested changes Nov 21, 2025

View reviewed changes

ProtossGP32 force-pushed the feature/get-status-period branch 2 times, most recently from 13be18b to e244231 Compare December 19, 2025 13:57

slate5 and others added 7 commits January 5, 2026 12:02

feat: add flags for get-status subcommand

de16d02

[pre-commit.ci] auto fixes from pre-commit.com hooks

99fc326

for more information, see https://pre-commit.ci

fix: run pre-commit checks

6d1a6e3

upd: add tests

59443e8

upd: avoid importing date

28a318f

fix: make types consistent

466e063

rollback: remove code intended for future PR

a9c8ab7

ProtossGP32 force-pushed the feature/get-status-period branch from e244231 to a9c8ab7 Compare January 5, 2026 11:02

Merge branch 'main' into feature/get-status-period

0ea74e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add flags for get-status subcommand#37

feat: add flags for get-status subcommand#37
slate5 wants to merge 8 commits into
ProtossGP32:mainfrom
slate5:feature/get-status-period

slate5 commented Oct 13, 2025

Uh oh!

ProtossGP32 left a comment

Uh oh!

ProtossGP32 Oct 16, 2025

Uh oh!

slate5 Oct 16, 2025

Uh oh!

ProtossGP32 Oct 16, 2025 •

edited

Loading

Uh oh!

ProtossGP32 Oct 17, 2025

Uh oh!

ProtossGP32 Oct 17, 2025

Uh oh!

ProtossGP32 Oct 17, 2025

Uh oh!

ProtossGP32 Oct 17, 2025

Uh oh!

ProtossGP32 Oct 21, 2025 •

edited

Loading

Uh oh!

ProtossGP32 Nov 21, 2025 •

edited

Loading

Uh oh!

ProtossGP32 commented Dec 19, 2025 •

edited

Loading

Uh oh!

ProtossGP32 commented Feb 2, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

slate5 commented Oct 13, 2025

Uh oh!

ProtossGP32 left a comment

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

slate5 Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ProtossGP32 Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

ProtossGP32 commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary and Presence

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ProtossGP32 Oct 16, 2025 •

edited

Loading

ProtossGP32 Oct 21, 2025 •

edited

Loading

ProtossGP32 Nov 21, 2025 •

edited

Loading

ProtossGP32 commented Dec 19, 2025 •

edited

Loading

ProtossGP32 commented Feb 2, 2026 •

edited

Loading