Setting for number format in archive tab #1719

bigtedde · 2023-05-23T04:35:54Z

Description

I am introducing a setting in the Misc tab that allows the user to decide if they want archive sizes in the archive tab to be displayed in a fixed or dynamic number format.

Right now this change adds a setting in the Misc tab, and when the setting is changed it emits a pyqt signal to call populate_from_profile in the ArchiveTab, which checks the setting and displays the archive size in a fixed or dynamic number format accordingly. Here is a short demo:

Related Issue

#1595
#1598
#1692

Motivation and Context

#1713

How Has This Been Tested?

Added unit test to ensure the setting updates the archive table units as expected. Test locally, and passes all GitHub CI checks.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have read the CONTRIBUTING guide.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

I provide my contribution under the terms of the license of this repository and I affirm the Developer Certificate of Origin.

real-yfprojects · 2023-05-23T06:13:25Z

I added the Fixes keyword so that the issue will be closed automatically when merging the PR.

src/vorta/store/settings.py

bigtedde · 2023-05-24T00:41:58Z

I added the Fixes keyword so that the issue will be closed automatically when merging the PR.

Thank you.

I changed the typo in setting tooltip, and have begun work writing tests.

hariseldon78 · 2023-05-25T00:37:31Z

Hey, I'm the one who made the single unit pr in the first place, sorry for replying so late.

I'm glad you jumped in and made the setting yourself, it's a good idea. I also propose to improve my algorithm so if someone want to have a single size unit, and there are big differences like in your case, the smallest sizes could be rounded to zero, maybe with a symbol that indicates near 0.

It's probably difficult to come up with a configuration that satisfy everybody, so let's talk about it and if we find a good fit i can do the change myself.

bigtedde · 2023-05-25T17:07:23Z

I also propose to improve my algorithm so if someone want to have a single size unit, and there are big differences like in your case, the smallest sizes could be rounded to zero, maybe with a symbol that indicates near 0.

I really like your idea here. The question that comes to my mind is what the threshold would be for something to be considered 'near 0' and what approach to take to implement this?

bigtedde · 2023-05-26T00:35:58Z

I added the tests for the archive units setting, pretty_bytes_dynamic_units, and the pyqt signal that connects the setting to a refresh of the archive tab.

Additionally, I renamed pretty_bytes to pretty_bytes_fixed_units to help make it distinct from pretty_bytes_dynamic_units

@real-yfprojects @m3nu I am eager to hear your thoughts, and what I can do to get this ready to review for merge.

m3nu · 2023-05-26T06:15:52Z

Looks good when quickly looking over it.

I do think the challenge here is more human than technical. So let's also ping @hariseldon78 who first added the feature in Feb.

real-yfprojects · 2023-05-26T13:03:02Z

So let's also ping @hariseldon78 who first added the feature in Feb.

He is already part of the discussion: #1719 (comment)

bigtedde · 2023-05-26T18:53:36Z

@hariseldon78 FWIW I left your code largely unchanged, with only a rename of the pretty_bytes method. My aim with this PR was narrow - add back the old pretty_bytes method from v8.10 and offer users a setting to decided which format is best for them. I am eager to hear your thoughts!

hariseldon78 · 2023-05-29T02:56:07Z

FWIW I approve completely adding a setting, I always appreciate configurability in a software. I'm not sure which methods should be set as default at installation, I leave that to your sensibility.

As for the improvement of my algorithm at the moment I don't have the possibility of putting much time in it, but if anybody have ideas on the matter I'm happy to discuss it here or on another issue, just ping me!

Looking at my archive list at the moment it is shown in MB, just because 2 on 20 archives are smaller than 100 MB... All the others are at least near a GB or in one case (the first backup) as big as 150 GB, making it hard, at a glance, to see if we are talking 1.5 TB or 150 GB. So it's definitely not perfect, maybe adding the thousands separation could help, but then you need to deal with localization formats because everyone have different ideas about how big numbers should be written...

real-yfprojects · 2023-05-29T07:43:44Z

maybe adding the thousands separation could help, but then you need to deal with localization formats because everyone have different ideas about how big numbers should be written

Qt might provide methods for that. However I would prefer discussing this in a separate issue.

src/vorta/utils.py

tests/test_utils.py

src/vorta/views/archive_tab.py

…ting

bigtedde · 2023-08-01T19:44:10Z

@real-yfprojects Thank you for the feedback on this setting. I have addressed each of your concerns with the most recent commits, tested the setting locally, and everything appears to work as intended.

real-yfprojects · 2023-08-02T07:26:09Z

src/vorta/utils.py

+def pretty_bytes_dynamic_units(size, metric=True, sign=False, precision=1):
+    if not isinstance(size, int):
+        return ''
+    prefix = '+' if sign and size > 0 else ''
+    power, units = (10**3, METRIC_UNITS) if metric else (2**10, NONMETRIC_UNITS)
+    n = find_best_unit_for_size(size, metric=metric, precision=precision)
+    size /= power**n
+    try:
+        unit = units[n]
+        return f'{prefix}{round(size, precision)} {unit}B'
+    except KeyError as e:
+        logger.error(e)
+        return "NaN"
+


Now that you changed this method to use find_best_unit_for_size it does exactly the same as pretty_bytest_fixed_units when passing fixed_unit=None. Consequently we only need the latter.

I just combined these two into one pretty_bytes() function, and rewrote the tests to ensure functionality.

Also, went through the files affected by previous (and now reverted) pretty_bytes name change and set them back to their original state.

tests/test_utils.py

bigtedde · 2023-08-07T03:52:18Z

@real-yfprojects Please let me know if anything else is stopping this from being merged 👍

m3nu · 2023-08-09T19:30:14Z

Some merge conflicts.

…ting

bigtedde · 2023-08-09T20:01:19Z

Some merge conflicts.

Fixed merge conflicts, reduced superfluous code in misc_tab, and streamlined testing.

m3nu · 2023-08-10T10:28:22Z

Works well and solves the problem we had after adding this feature. 👏

I do think we can do better on the tooltip and label. Here my suggestion:

Label: "Use the same unit of measurement for archive sizes"
Tooltip: "When enabled, all archive sizes will use the same unit of measurement, like MB or KB. Can make reading sizes easier to read."

Also pinging @hariseldon78 for his 5 cents.

bigtedde · 2023-08-10T17:27:16Z

src/vorta/store/settings.py

+            'tooltip': trans_late(
+                'settings',
+                'When enabled, all archive sizes will use the same unit of measurement, '
+                'such as  KB or MB. This can make archive sizes easier to compare.',


I used the word "compare" instead of "read", since that might to be closer to the original intention of the setting.

I like that!

m3nu · 2023-08-11T11:22:26Z

Thanks for the work, @bigtedde ! Very nice addition.

hariseldon78 · 2023-08-11T13:38:39Z

Also pinging @hariseldon78 for his 5 cents.

I think the text is good and i'm sorry i had to abandon this feature to its destiny, work is increasing costantly and filling all the spare time... Thanks for taking care of improving it!

Archive tab setting + dynamic pretty bytes

c55a713

real-yfprojects reviewed May 23, 2023

View reviewed changes

src/vorta/store/settings.py Outdated Show resolved Hide resolved

bigtedde added 2 commits May 23, 2023 17:26

Merge branch 'borgbase:master' into archive_units_setting

dbc7d93

updated setting tooltip

8074e53

bigtedde marked this pull request as draft May 25, 2023 00:18

added tests, rename pretty_bytes

4281b2e

bigtedde marked this pull request as ready for review May 29, 2023 19:29

bigtedde changed the title ~~Setting for new number format (work in progress)~~ Setting for number format in archive tab May 29, 2023

bigtedde added 2 commits May 30, 2023 14:27

Merge branch 'master' into archive_units_setting

2581e43

Merge branch 'borgbase:master' into archive_units_setting

5604d92

real-yfprojects reviewed Aug 1, 2023

View reviewed changes

src/vorta/utils.py Outdated Show resolved Hide resolved

src/vorta/utils.py Outdated Show resolved Hide resolved

src/vorta/utils.py Outdated Show resolved Hide resolved

tests/test_utils.py Outdated Show resolved Hide resolved

src/vorta/views/archive_tab.py Outdated Show resolved Hide resolved

bigtedde added 3 commits August 1, 2023 10:32

Merge remote-tracking branch 'upstream/master' into archive_units_set…

5fa1539

…ting

parameterized pretty_bytes tests

ebb77e0

removed duplicate code

cc14820

real-yfprojects reviewed Aug 2, 2023

View reviewed changes

bigtedde added 3 commits August 2, 2023 13:55

combined pretty_bytes _fixed and _dynamic into one function

303a4bb

reverted pretty_bytes calls in 2 files

fb04a67

reworded 'dynamic' to 'nonfixed'

6f17d33

bigtedde added 2 commits August 9, 2023 12:32

Merge remote-tracking branch 'upstream/master' into archive_units_set…

cbf031a

…ting

streamlined setting and testing

1179cff

minor changes to _click_toggle_setting

3386cd9

updated verbiage for setting/tooltip

4733c85

bigtedde commented Aug 10, 2023

View reviewed changes

test fix to match new setting label

c4a58cb

m3nu approved these changes Aug 11, 2023

View reviewed changes

m3nu merged commit b58ffb6 into borgbase:master Aug 11, 2023
39 checks passed

bigtedde deleted the archive_units_setting branch August 11, 2023 17:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setting for number format in archive tab #1719

Setting for number format in archive tab #1719

bigtedde commented May 23, 2023 •

edited

Loading

real-yfprojects commented May 23, 2023

bigtedde commented May 24, 2023

hariseldon78 commented May 25, 2023

bigtedde commented May 25, 2023

bigtedde commented May 26, 2023

m3nu commented May 26, 2023

real-yfprojects commented May 26, 2023

bigtedde commented May 26, 2023 •

edited

Loading

hariseldon78 commented May 29, 2023

real-yfprojects commented May 29, 2023

bigtedde commented Aug 1, 2023

real-yfprojects Aug 2, 2023

bigtedde Aug 2, 2023

bigtedde Aug 2, 2023

bigtedde commented Aug 7, 2023

m3nu commented Aug 9, 2023

bigtedde commented Aug 9, 2023

m3nu commented Aug 10, 2023

bigtedde Aug 10, 2023

real-yfprojects Aug 10, 2023

m3nu commented Aug 11, 2023

hariseldon78 commented Aug 11, 2023 •

edited

Loading

Setting for number format in archive tab #1719

Setting for number format in archive tab #1719

Conversation

bigtedde commented May 23, 2023 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

real-yfprojects commented May 23, 2023

bigtedde commented May 24, 2023

hariseldon78 commented May 25, 2023

bigtedde commented May 25, 2023

bigtedde commented May 26, 2023

m3nu commented May 26, 2023

real-yfprojects commented May 26, 2023

bigtedde commented May 26, 2023 • edited Loading

hariseldon78 commented May 29, 2023

real-yfprojects commented May 29, 2023

bigtedde commented Aug 1, 2023

real-yfprojects Aug 2, 2023

Choose a reason for hiding this comment

bigtedde Aug 2, 2023

Choose a reason for hiding this comment

bigtedde Aug 2, 2023

Choose a reason for hiding this comment

bigtedde commented Aug 7, 2023

m3nu commented Aug 9, 2023

bigtedde commented Aug 9, 2023

m3nu commented Aug 10, 2023

bigtedde Aug 10, 2023

Choose a reason for hiding this comment

real-yfprojects Aug 10, 2023

Choose a reason for hiding this comment

m3nu commented Aug 11, 2023

hariseldon78 commented Aug 11, 2023 • edited Loading

bigtedde commented May 23, 2023 •

edited

Loading

bigtedde commented May 26, 2023 •

edited

Loading

hariseldon78 commented Aug 11, 2023 •

edited

Loading