feat: add messages to time logs #337

prat0088 · 2019-11-16T21:20:34Z

Copied from @jnsebgosselin 's work on #252 and rebased.

To those coming from the feature request issues, you can install this now to play around with by running by running

pip install https://github.com/prat0088/Watson/archive/logmessage.zip

It has been working fine for me on Windows. But please be warned this change hasn't yet been merged into master so there's no guarantees it will continue to work or that it won't corrupt your existing data.

Closes #93

* Made 'watson.frames.Frames' a subclass of 'collections.OrderedDict'. * Changed order of items in 'watson.frames.Frame' to be more consistent with 'Frames.add()' and 'Frames.new_frame()'. This changes the on-disk JSON representation of the frames, i.e. the format of the '<app dir>/watson/frames' file. The code handles loading the old format automatically and on saving the file gets written in the new format. * Removed ability to look up frame by index with dict look-up syntax and provide 'Frames.get_by_index()' method as replacement. * Removed ability to delete frame by index (was not used aywhere). * Removed ability to get Frames column values with dict look-up syntax and provide 'Frames.get_column()' generator as replacement. * Iterating over 'Watson.frames' yields frame IDs instead of 'Frame' instances. Where the latter is desired, the 'values()' method must be used. * Adding a frame by assigning a 'Frame' instance to a key of a `Frames`, makes a copy of the 'Frame' instance with the given key as the frame ID. * Made 'Frame.filter()' a generator. * Adapted code using 'Frame' and 'Frames' to these changes. * Adapted tests and test data files. + Command line interface remains unchanged.

…ame object Signed-off-by: Christopher Arndt <[email protected]>

…mes format too; Clarify docstring on passing frames to construcutor as well Signed-off-by: Christopher Arndt <[email protected]>

Signed-off-by: Christopher Arndt <[email protected]>

…der for better perfomance in most likely case Signed-off-by: Christopher Arndt <[email protected]>

Signed-off-by: Christopher Arndt <[email protected]>

…evelopment)" This reverts commit c7c3c84.

…verse order for better perfomance in most likely case" This reverts commit 8d2206f.

This reverts commit c956089.

This reverts commit 73c2593.

…ist items" This reverts commit 714b581.

… new Frames format too; Clarify docstring on passing frames to construcutor as well" This reverts commit 553e34a.

…to the same object" This reverts commit 8ed29c8.

Signed-off-by: Christopher Arndt <[email protected]> Merge branch 'feature/log-message' of github.com:SpotlightKid/Watson into feature/log-message Signed-off-by: Christopher Arndt <[email protected]>

…ex'" This reverts commit a1a905a.

This reverts commit 92b8733.

…_log_message # Conflicts: # tests/test_watson.py # watson.completion # watson/cli.py

prat0088 · 2019-12-12T02:22:50Z

@k4nar @jnsebgosselin I could use a second opinion:

I had been using -m/--message on start/stop, mirroring the git parameter of the same name.

I added options --messages --no-messages to log, aggregate, and report to control whether or not messages get displayed. They really add a lot of noise, but are also useful in some cases, so I want to make sure users have can show and hide them when needed.

The problem is that aggregate and report already define -m to be --month, so I could define --message, but not -m. I want to keep the message flag consistent across commands to make it more intuitive to use. However -l (L) is already taken (--log-message), -s is already taken by --csv (--string, --summary), -t is already taken by --to (--text)....

I just thought of --note. No commands are using -n yet.

TL;DR

What do you think about renaming -m/--message to -n/--note so that we can use -n on start, stop, log, aggregate, and report? No, it's not the same as git's option, but I think a consistent abbreviation will make watson much easier to use, and the usage of -n is slightly different than git's -m anyway.

prat0088 · 2019-12-12T02:23:40Z

Update: Messages now get aggregated and displayed in report and aggregate, hidden by default.

prat0088 · 2019-12-30T15:13:50Z

@jnsebgosselin I'm going to go ahead with renaming -m and --message to -n and --note

-m and -M are currently used by some commands. -n and -N aren't. This diverges from the git -m/--message naming we were copying, but that doesn't bother me too much. The parameter behaves slightly different in watson, so it might even be better that we don't reuse a commonly used parameter name in another tool, as not to cause confusion

prat0088 · 2020-01-13T14:10:31Z

note to self: there is a bug in watson aggregate --note. It is expecting a parameter. It doesn't function as a flag.

prat0088 · 2020-01-13T14:43:18Z

@k4nar This is ready for review.

prat0088 · 2020-01-22T14:46:15Z

@k4nar @jmaupetit It has been two months since I have heard from either of you on this request. It is ready to merge. What needs to happen next?

k4nar · 2020-01-22T23:35:20Z

@prat0088 : Sorry, I'll try to do a final review soon 🙏 .

k4nar · 2020-01-30T12:58:50Z

watson/cli.py

@@ -227,6 +236,7 @@ def start(ctx, watson, confirm_new_project, confirm_new_tag, args, gap_=True):

    if project and watson.is_started and not gap_:
        current = watson.current
+        # TODO: log in error note


I think we can drop the TODO, don't you think?

k4nar · 2020-01-30T12:59:52Z

watson/cli.py

@@ -485,11 +516,13 @@ def status(watson, project, tags, elapsed):
              help="Format output in plain text (default)")
 @click.option('-g/-G', '--pager/--no-pager', 'pager', default=None,
              help="(Don't) view output through a pager.")
+@click.option('-n', '--note', 'show_notes', default=False, is_flag=True,


I think it should be --notes

k4nar · 2020-01-30T13:03:47Z

watson/watson.py

@@ -288,9 +291,14 @@ def stop(self, stop_at=None):
        if stop_at > arrow.now():
            raise WatsonError('Task cannot end in the future.')

+        if note is None:
+            note = old.get('note')


So that means that if a not is passed with watson stop, it will override a previous note passed via watson start? Shouldn't we try to concatenate them somehow, or at least not silently drop it?

I’m not sure what people would prefer: concatenating or dropping. Either way silently dropping is bad I agree.

How about printing a message that the old note from start is being overwritten, print it, the print the new one? The user can edit the frame if they want to amend the note. It will be obvious and they will have a copy of the old note, if needed.

My hypothesis is overwriting will be more common. When you start a task you might have a general idea of what to do but not the full picture. By the end of the task you can describe exactly what happened.

Ok for a warning + dropping it 👍 . I guess people will either pass a message to start or stop, but not both.

k4nar

A few small comments but otherwise it looks great 👍 . Thanks for the hard work, and sorry for the delay!

prat0088 · 2020-01-31T13:26:38Z

Thanks for the review! I’m swamped from work but will try to find time to address the feedback in the coming week.

SoAG · 2020-04-29T08:18:23Z

Any news on this?

joelostblom · 2020-05-16T04:22:20Z

I'm excited about using the functionality in this PR, thanks for all your hard work on it @prat0088!

joelostblom · 2020-06-16T16:15:15Z

@k4nar If this can be merged, I am happy to follow up with a PR addressing your three latest comments:

Removing TODO comment.
Making the flag plural "notes"
Printing the old note before overwriting it.

jmaupetit · 2020-06-17T20:44:46Z

I'll let @prat0088 decide if he can make it or prefer that you finish this awesome feature @joelostblom 🙏

That would make 4 external contributors working on this. You are awesome ✨ ❤️ 💪

prat0088 · 2020-06-17T22:55:59Z

Sorry I haven’t been active. Work has changed the way we log time and I no longer have a need for this program, but it is still by far my favorite way to log.

If this can be merged as is I’ll merge it. If it’s decided changes are needed first then I don’t mind if someone branches this branch, adds the changes, and commits.

jmaupetit · 2020-06-18T09:34:43Z

Thanks for the quick feedback @prat0088!

I would prefer to merge this feature once fully achieved, so @joelostblom feel free to add your fixes to a new branch and open a new PR 🙏

joelostblom · 2020-06-18T22:24:38Z

@jmaupetit Done! See #383

jmaupetit · 2020-06-19T06:25:47Z

Closing this in favor to #383

SpotlightKid and others added 30 commits June 15, 2016 22:12

Fix flake8 complaint by refactoring boolean expr

92b8733

Optimize index access to Frames and add tests for 'get_by_index'

a1a905a

Update merge command to work with new frame format

2ab1991

Remove uneccessary assignment since both names already refer to the s…

8ed29c8

…ame object Signed-off-by: Christopher Arndt <[email protected]>

Assigning a Frames instance to watson.frames should work with new Fra…

553e34a

…mes format too; Clarify docstring on passing frames to construcutor as well Signed-off-by: Christopher Arndt <[email protected]>

Make sure passing a sequence of frames works with tuple and list items

714b581

Signed-off-by: Christopher Arndt <[email protected]>

Add more tests for setting watson.frames

73c2593

(Re-)add support for looking up frames by ID prefix

c956089

Signed-off-by: Christopher Arndt <[email protected]>

When looking up a frame by ID prefix, iterate over keys in reverse or…

8d2206f

…der for better perfomance in most likely case Signed-off-by: Christopher Arndt <[email protected]>

Add script to convert between old and new frame format (for development)

c7c3c84

Signed-off-by: Christopher Arndt <[email protected]>

Add log message to frames and allow setting it with stop or edit command

909e091

Add tests for log messages

0fff33d

Signed-off-by: Christopher Arndt <[email protected]>

Add options for stop command to bash completion config

5a9578d

Signed-off-by: Christopher Arndt <[email protected]>

Update documentation for stop command

9b84581

Signed-off-by: Christopher Arndt <[email protected]>

Enhanced stop command help

c369bb7

Signed-off-by: Christopher Arndt <[email protected]>

Updated user guide

67db7ee

Signed-off-by: Christopher Arndt <[email protected]>

Revert "Add script to convert between old and new frame format (for d…

c5b11b5

…evelopment)" This reverts commit c7c3c84.

Revert "When looking up a frame by ID prefix, iterate over keys in re…

124dc00

…verse order for better perfomance in most likely case" This reverts commit 8d2206f.

Revert "(Re-)add support for looking up frames by ID prefix"

51c49c9

This reverts commit c956089.

Revert "Add more tests for setting watson.frames"

075580e

This reverts commit 73c2593.

Revert "Make sure passing a sequence of frames works with tuple and l…

39f966e

…ist items" This reverts commit 714b581.

Revert "Assigning a Frames instance to watson.frames should work with…

0b3673a

… new Frames format too; Clarify docstring on passing frames to construcutor as well" This reverts commit 553e34a.

Revert "Remove uneccessary assignment since both names already refer …

aa075b3

…to the same object" This reverts commit 8ed29c8.

Merge branch 'feature/refactor-frames' into feature/log-message

8f98674

Signed-off-by: Christopher Arndt <[email protected]> Merge branch 'feature/log-message' of github.com:SpotlightKid/Watson into feature/log-message Signed-off-by: Christopher Arndt <[email protected]>

Revert "Optimize index access to Frames and add tests for 'get_by_ind…

a09ada7

…ex'" This reverts commit a1a905a.

Revert "Fix flake8 complaint by refactoring boolean expr"

6463412

This reverts commit 92b8733.

Revert "Refactor 'watson.frames'"

4628f94

Add back a missing ) deleted by mistake

639553d

Merge remote-tracking branch 'refs/remotes/TailorDev/master' into add…

fd1869b

…_log_message # Conflicts: # tests/test_watson.py # watson.completion # watson/cli.py

prat0088 added 2 commits December 11, 2019 20:58

add tests for report log messages

aeb56cc

wip: report/aggregate messages

3a08968

prat0088 changed the title ~~feat: add messages to time logs~~ WIP: feat: add messages to time logs Dec 12, 2019

fix: aggregate/report -n params not detected as flags on Windows

c8e5edd

prat0088 changed the title ~~WIP: feat: add messages to time logs~~ feat: add messages to time logs Jan 13, 2020

prat0088 mentioned this pull request Jan 13, 2020

suggested new features #349

Closed

k4nar reviewed Jan 30, 2020

View reviewed changes

joelostblom mentioned this pull request Jun 18, 2020

Add --note flag to associate messages with frames #383

Open

jmaupetit closed this Jun 19, 2020

joelostblom mentioned this pull request Feb 11, 2021

[WIP] Add --notes flag (rebased) #405

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add messages to time logs #337

feat: add messages to time logs #337

prat0088 commented Nov 16, 2019 •

edited

Loading

prat0088 commented Dec 12, 2019

prat0088 commented Dec 12, 2019

prat0088 commented Dec 30, 2019

prat0088 commented Jan 13, 2020

prat0088 commented Jan 13, 2020

prat0088 commented Jan 22, 2020

k4nar commented Jan 22, 2020

k4nar Jan 30, 2020

k4nar Jan 30, 2020

k4nar Jan 30, 2020 •

edited

Loading

prat0088 Jan 31, 2020

k4nar Jan 31, 2020

k4nar left a comment

prat0088 commented Jan 31, 2020

SoAG commented Apr 29, 2020

joelostblom commented May 16, 2020

joelostblom commented Jun 16, 2020

jmaupetit commented Jun 17, 2020

prat0088 commented Jun 17, 2020 •

edited

Loading

jmaupetit commented Jun 18, 2020

joelostblom commented Jun 18, 2020

jmaupetit commented Jun 19, 2020

feat: add messages to time logs #337

feat: add messages to time logs #337

Conversation

prat0088 commented Nov 16, 2019 • edited Loading

prat0088 commented Dec 12, 2019

prat0088 commented Dec 12, 2019

prat0088 commented Dec 30, 2019

prat0088 commented Jan 13, 2020

prat0088 commented Jan 13, 2020

prat0088 commented Jan 22, 2020

k4nar commented Jan 22, 2020

k4nar Jan 30, 2020

Choose a reason for hiding this comment

k4nar Jan 30, 2020

Choose a reason for hiding this comment

k4nar Jan 30, 2020 • edited Loading

Choose a reason for hiding this comment

prat0088 Jan 31, 2020

Choose a reason for hiding this comment

k4nar Jan 31, 2020

Choose a reason for hiding this comment

k4nar left a comment

Choose a reason for hiding this comment

prat0088 commented Jan 31, 2020

SoAG commented Apr 29, 2020

joelostblom commented May 16, 2020

joelostblom commented Jun 16, 2020

jmaupetit commented Jun 17, 2020

prat0088 commented Jun 17, 2020 • edited Loading

jmaupetit commented Jun 18, 2020

joelostblom commented Jun 18, 2020

jmaupetit commented Jun 19, 2020

prat0088 commented Nov 16, 2019 •

edited

Loading

k4nar Jan 30, 2020 •

edited

Loading

prat0088 commented Jun 17, 2020 •

edited

Loading