[GUI Plugin] View Manager

[kovidgoyal]

Put in a print statement in restore_state() to check if restoreState() is returning True or not.

[JimmXinu]

Yes, it does. I also deleted gprefs['book_list_pin_splitter_state'] and then tried again with `calibre --ignore-plugins` and it still re-centered.

I added some debug output and save_state is being called during startup before restore_state. (calibre-debug doesn't support --ignore-plugins, BTW)

Debug output:

Spoiler:

calibre 3.17* [64bit]  embedded-python: True is64bit: True
Windows-10-10.0.16299-SP0 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.16299')
Python 2.7.12+
Windows: ('10', '10.0.16299', 'SP0', u'Multiprocessor Free')
Interface language: None
Successfully initialized third party plugins: DeDRM (6, 5, 2) && SmartEject (2, 0, 7) && Count Pages (1, 8, 0) && FictionDB (1, 0, 10) && fanficauthors.net CSS Fix (0, 0, 2) && Generate Cover (1, 5, 21) && Unplugged (1, 0, 0) && FanFicFare (2, 22, 2) && Webscription (1, 1, 0) && ColumnSum (2, 0, 0) && EpubSplit (2, 3, 0) && View Manager (1, 4, 3) && Reading List (1, 6, 6) && EpubMerge (2, 1, 1) && Quality Check (1, 9, 11) && Find Duplicates (1, 6, 3) && Modify ePub (1, 3, 13) && Barnes & Noble (1, 2, 14) && Favourites Menu (1, 0, 4) && Kindle 2, 3, 4, Touch, PaperWhite, Voyage Device Interface MBP Update Mod (1, 0, 0) && Manage Series (1, 2, 8)
Turning on automatic hidpi scaling
devicePixelRatio: 1.0
logicalDpi: 96.0 x 96.0
physicalDpi: 141.76744186 x 141.402061856
Using calibre Qt style: True
Starting up...
save_state:
PyQt5.QtCore.QByteArray('\x00\x00\x00\xff\x00\x00\x00\x01\x00\x00\x00\x02\xff\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\x01\x00\x00\x00\x01\x00')
restore_state():
bytearray(b'\x00\x00\x00\xff\x00\x00\x00\x01\x00\x00\x00\x02\xff\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\x01\x00\x00\x00\x01\x00')
restoreState:True
save_state:
PyQt5.QtCore.QByteArray('\x00\x00\x00\xff\x00\x00\x00\x01\x00\x00\x00\x02\x00\x00\x00F\x00\x00\x00F\x00\xff\xff\xff\xff\x01\x00\x00\x00\x01\x00')
Started up in 4.08 seconds with 17 books

I threw a quick lock boolean in to prevent saving before restoring and now the split bar is staying where I put it across restarts.

Kludged & debug PinContainer:

Spoiler:

import pprint
pp = pprint.PrettyPrinter(indent=4)

class PinContainer(QSplitter):

    def __init__(self, books_view, parent=None):
        QSplitter.__init__(self, parent)
        self.setChildrenCollapsible(False)
        self.books_view = books_view
        self.addWidget(books_view)
        self.addWidget(books_view.pin_view)
        books_view.pin_view.splitter = self
        self.has_loaded = False

    def save_state(self):
        print("save_state:")
        if self.has_loaded:
            state = bytearray(self.saveState())
            pp.pprint(self.saveState())
            gprefs['book_list_pin_splitter_state'] = state
        else:
            print("DONT save yet")

    def restore_state(self):
        val = gprefs.get('book_list_pin_splitter_state', None)
        print("restore_state():")
        self.has_loaded = True
        pp.pprint(val)
        if val is not None:
            print("restoreState:%s"%self.restoreState(val))

I can clean that code up and submit it if you find it an acceptable workaround, but it doesn't explain why it happens in the first place.

[kovidgoyal]

Stick an

import traceback
traceback.print_stack()

in save_state to see what function chain is leading to it being called.

[JimmXinu]

(I removed username path)

Starting up...
save_state:
  File "site.py", line 101, in main
  File "site.py", line 78, in run_entry_point
  File "C:\...\calibre\src\calibre\debug.py", line 260, in main
  File "C:\...\calibre\src\calibre\gui_launch.py", line 74, in calibre
  File "C:\...\calibre\src\calibre\gui2\main.py", line 557, in main
  File "C:\...\calibre\src\calibre\gui2\main.py", line 392, in run_gui
  File "C:\...\calibre\src\calibre\gui2\main.py", line 351, in initialize
  File "C:\...\calibre\src\calibre\gui2\main.py", line 332, in initialize_db
  File "C:\...\calibre\src\calibre\gui2\main.py", line 293, in initialize_db_stage2
  File "C:\...\calibre\src\calibre\gui2\main.py", line 233, in start_gui
  File "C:\...\calibre\src\calibre\gui2\ui.py", line 349, in initialize
  File "C:\...\calibre\src\calibre\gui2\init.py", line 67, in init_library_view_mixin
  File "C:\...\calibre\src\calibre\gui2\library\views.py", line 811, in set_database
  File "C:\...\calibre\src\calibre\gui2\library\models.py", line 307, in set_database
  File "C:\...\calibre\src\calibre\gui2\library\views.py", line 904, in database_changed
  File "C:\...\calibre\src\calibre\gui2\library\views.py", line 768, in restore_state
  File "C:\...\calibre\src\calibre\gui2\pin_columns.py", line 121, in restore_state
  File "C:\...\calibre\src\calibre\gui2\pin_columns.py", line 70, in apply_state
  File "C:\...\calibre\src\calibre\gui2\pin_columns.py", line 114, in save_state
  File "C:\...\calibre\src\calibre\gui2\pin_columns.py", line 143, in save_state

[kovidgoyal]

This should take care of it: https://github.com/kovidgoyal/calibr...a692d0292d6549

[JimmXinu]

That does it, thanks!


If VM plugin ever does want to save/set the splitter location, we'll have to discuss how it should be done. I was mostly just curious right now.

[sweth]

I've recently been playing with the "Split the book list" feature, and noticed that the View Manager appears to only change the view settings for the left-hand pane of the split view--the RHS uses some other view (maybe the original Calibre default?) and ignores whatever I select in View Manager. Is this expected behavior? I see some discussion earlier in the thread about testing the two together?

[JimmXinu]

When split book list came along, I tested to see what would happen and Kovid kindly fixed a problem found then.

But after documenting what you found (VM effects left-hand pane only), no one expressed any interest using VM and split view together, so it was left as is.

If there are users that would use it, I can revisit expanding VM to manage both panes.

[sweth]

Originally Posted by JimmXinu

If there are users that would use it, I can revisit expanding VM to manage both panes.

Well, there's at least one user that would use it.

[JimmXinu]

@kovidgoyal,

View Manager plugin can manage the right pane column order, sizes and show/hide and whether splitter is shown or not pretty easily. Adjusting the position of the splitter is down another level. With the existing code I can:

## uses same state schema (minus 'sort_history') as library_view state
## to show/hide/order/size columns
pin_state = self.gui.library_view.pin_view.get_state()
# ...
self.gui.library_view.pin_view.apply_state(pin_state)

## simple boolean Qt call for splitter visibility.
show = self.gui.library_view.pin_view.isVisible()
# ...
self.gui.library_view.pin_view.setVisible(show)

## Call Qt methods directly, returns PyQt5.QtCore.QByteArray, convert to 
## save/set splitter location
splitter_state = bytearray(self.gui.library_view.pin_view.splitter.saveState())
# ...
self.gui.library_view.pin_view.splitter.restoreState(splitter_state)

Is it acceptable to you(Kovid) for VM to use these?

[kovidgoyal]

Should be fine. For maximum robustness, probably best to sue the functions I introduced here: https://github.com/kovidgoyal/calibr...e26b06b2816991

[JimmXinu]

I could use some input from VM PI users.

I've figured out how to save and apply splitter on/off, splitter location, shown/hidden columns and columns sizes in right hand pane. Sort order is applied as before(*).

It became complex when I started thinking about different possible use cases and configuration options.

Which of the following would you find useful?

• Everything View - Apply/save state/location of splitter, left columns/sizes, right columns/sizes and sort. Save what you see, apply it again later.
• Left Only View - Apply/save only left pane view, leaving splitter as is--either shown or not. (Same as VM is doing now.)
• Right Only View - Apply/save state/location of splitter and only right pane columns/sizes.
• Sort Only View - Apply/save sort separate from other options.
• Views without Sort - Option to disable sort on other types of views.

Actually doing all these is fairly straightforward. What's complex is coming up with ways to configure them that are intuitive for the user.

My first thought was to add another list of columns to show/hide and order for the right pane and call it a day. "Everything View" all the time.

My second thought was, typically for me, about how to allow more customization instead. Which soon spun out of control.

Feel free at this point to suggest other ideas for consideration.


(*) - Calibre limits how many sort columns it applies to 4 by default when apply_state() is called and at Calibre startup--not sure how I never noticed that before. But we can pass in a bigger value. Also, it looks like Calibre forces timestamp into the sort order if not already included, either adding it or replacing the last(least precedence) sort item.

[JimmXinu]

New Test Version

Here's a new test version of View Manager that can save and apply split, split location and the columns in both left and right panes.

By default, a View will be of type Automatic and save & apply everything. In VM config, there's a checkbox above the list for the right pane that controls whether the split is shown or hidden. In Automatic that will be changed when you 'Save View' to match what you have on the screen.

You can change a View (in VM config) to be a Manual type view which adds checkboxes for whether to save/apply column settings in the left pane, show/hide the split pane and also whether to save/apply Sort order. The presence/absence of the splitter will not be changed with the Save View menu action.

These let you make Views that add (or change) split & right pane without changing the left pane, and Views without Sort or with only Sort as you like.

This is a compromise solution between useful features and intuitive (to me at least) configuration.

Let me know what you think.

Known Issues:

- Sort depth: Calibre limits how many sort columns it applies to 4 by default when apply_state() is called and at Calibre startup--not sure how I never noticed that before. But we can pass in a bigger value. This version saves and applies all sorted columns. Perhaps VM should be similarly limited instead?

- Also, it looks like Calibre forces Date aka timestamp(desc) into the sort order if not already included, either adding it or replacing the last(least precedence) sort item. Is this a concern or continue to ignore?

- VM PI doesn't currently rebuild its menu if you add/rename/remove a View from config but then hit Cancel instead of OK. Need to fix.

[BetterRed]

Originally Posted by JimmXinu

Known Issues:

- Sort depth: Calibre limits how many sort columns it applies to 4 by default when apply_state() is called and at Calibre startup--not sure how I never noticed that before. But we can pass in a bigger value. This version saves and applies all sorted columns. Perhaps VM should be similarly limited instead?

This limitation was one of the prime reasons why I started using VM.

Originally Posted by JimmXinu

- Also, it looks like Calibre forces Date aka timestamp(desc) into the sort order if not already included, either adding it or replacing the last(least precedence) sort item. Is this a concern or continue to ignore?

I think this explains, in part at least, why I was getting what I regarded as bizarre behaviour in June of last year when you implemented some other changes, IIRC they were VM related.

As you may recall, because the changes you implemented back then didn't really interest me, I decided to stick with version 1.3.2. I don't use Split View, but before upgrading to calibre 3.17 I did do some tests to ensure it didn't interfere with my usage of the old VM, which it didn't. When you release the new version I'll reconsider my decision of June 2017, my preference always is to be using current versions - assuming it doesn't involve any monetary considerations.

BR

[JimmXinu]

BR - Maybe this is a good time to discuss what you didn't like about the VM changes before and what we can do to accommodate you.

As I recall, you wanted to be able to save column order/sizes without changing your sort order in a View.

In the latest test version, I was trying to allow separate Views that only do Sort and nothing else. But I see that I failed--if you uncheck "Columns in Split(right) Pane", the splitter is removed.