Library Media Stats #2186

herby2212 · 2023-10-28T15:52:44Z

Description

This PR adds the total media runtime and total file size as indicators to several sections of the library.

The table header of the Media Info section of the library now directly displays those indicators.

If Calculate Total File Size is enabled in the config the duration aka. runtime is now included for each item. This column, like the other ones, an be shown/hidden.

The Libraries overview also includes those as fields in two new configurable columns.

For this a new method get_library_media_stats got added to the API which returns the total size, the total duration aka. runtime and total storage of a library.
This data gets cached into a new file media_stats_<section_id> to allow for faster loading times. For this the caching methods for saving and loading have been rebuild to a generic version.

After first updating to this version, when enabled in the config, the file size and duration will be recalculated and saved to the cache for the items.

The API documentation got updated.

Issues Fixed or Closed

Implements Show total runtime of media #2141.

Type of Change

New feature (non-breaking change which adds functionality)

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated the docstring for new or existing methods

JonnyWong16 · 2023-10-28T16:20:37Z

My idea was to decouple the media info from the total. We can get the total directly from Plex without adding up all the individual items. This means the total can be shown regardless of the file sizes setting.

Refer to the Plex API library here:

https://github.com/pkkid/python-plexapi/blob/a3af807c6bb2f4bb5a150f4ddff05314a30093db/plexapi/library.py#L462C17-L462C17

This also opens up the option to add the totals to columns on the Libraries table (cache to database library_sections on libraries list refresh).

herby2212 · 2023-10-28T16:32:16Z

My idea was to decouple the media info from the total. We can get the total directly from Plex without adding up all the individual items. This means the total can be shown regardless of the file sizes setting.

Refer to the Plex API library here:

https://github.com/pkkid/python-plexapi/blob/a3af807c6bb2f4bb5a150f4ddff05314a30093db/plexapi/library.py#L462C17-L462C17

Interesting. This would save both on loading time and also on complexity, but would mean to replace the calculation logic entirely. It would also allow to make a new call which can be used internally for the total, but also provided via the API.

I will start working on that, but keep the visual changes so far made as those still seem fitting to me.

Since when is this call supported by Plex? Do we need to check for a special plex server version.

This also opens up the option to add the totals to columns on the Libraries table (cache to database library_sections on libraries list refresh).

Good call👍

JonnyWong16 · 2023-10-28T16:47:23Z

Since when is this call supported by Plex? Do we need to check for a special plex server version.

Over 3 years when Plex Dash was released.

Might need to verify that the API endpoint isn't Plex Pass only because Plex Dash is Plex Pass only. I don't think it is.

herby2212 · 2023-10-29T19:15:37Z

Ready for review. I updated the main message to reflect the new changes.

I also decided to keep the addition of the duration in the file size calculation per item as it seems like a logical addition and doesn't increase the runtime as no additional call is made.
The fields containing the total indicators use the new call including caching.

Did you verify if the calls for the properties are Plex Pass only? Does the python-plexapi include a field or indication for premium required functions/calls, if not this would seem like a good addition.

JimbooMan · 2023-11-07T23:26:56Z

I dont know if this is a bug or not. But i wanted to sort out which of my movies that have been watched. If i choose a movie that i know have been seen by me and others the all time watch time is 0. Why is that? I installed Tautulli using the simple way with the EXE file. Is there anything else that i need?
Will it only count from the day that i installed Tautulli?

herby2212 · 2023-11-08T16:50:43Z

I dont know if this is a bug or not. But i wanted to sort out which of my movies that have been watched. If i choose a movie that i know have been seen by me and others the all time watch time is 0. Why is that? I installed Tautulli using the simple way with the EXE file. Is there anything else that i need?

Please use the issue section of github to report a problem or ask for support in the future (https://github.com/Tautulli/Tautulli/issues) as this discussion is only regarding the content of the PR.

Will it only count from the day that i installed Tautulli?

Yes as Tautulli tracks informations far more detailed then Plex does and so needs to run to gather this data.

github-actions · 2023-12-08T19:11:13Z

This PR is stale because it has been open for 30 days with no activity. Remove the stale label or comment, otherwise this will be closed in 5 days.

github-actions · 2023-12-13T19:11:38Z

This PR was closed because it has been stalled for 5 days with no activity.

herby2212 · 2023-12-19T19:07:30Z

@JonnyWong16 Still ready for review. Any timeframe the review will be done?

JonnyWong16 · 2023-12-21T17:47:24Z

I will get to this soon. I've been busy.

JonnyWong16

Revert the cache changes. It's making this PR very difficult to review.

JonnyWong16 · 2024-02-17T23:28:32Z

plexpy/libraries.py

@@ -143,6 +145,44 @@ def has_library_type(section_type):
    result = monitor_db.select_single(query=query, args=args)
    return bool(result)

+def get_library_media_stats(section_id=None, refresh=False):


Save to the database library_sections table instead of caching to a file. Add two new columns total_storage and total_duration. total_size is already the count column in the database.

You can keep the total_size in the returned dict for the API.

JonnyWong16 · 2024-02-17T23:32:57Z

plexpy/libraries.py

@@ -409,18 +449,23 @@ def get_datatables_list(self, kwargs=None, grouping=None):
            else:
                library_art = item['library_art']

+            library_media_stats = get_library_media_stats(item['section_id'])


Once added to the database, just add the columns to the query above.

herby2212 added 3 commits October 28, 2023 17:38

initial release for movie media type

0fb362d

total duration for shows

2b1d7b4

update naming and API doc

e29cbdf

herby2212 added 9 commits October 29, 2023 12:18

get_libray_media_stats API call

aed8485

library_media_stats for libraries page

7bc94cd

using new API call for getting library media stats

8c1248e

remove debug logs

0235ebe

duration for items in media info

672835e

rebuilt to generic cache handling and cache for library media stats

ad4d3c3

fix cell formatting and concat of rating_key and section_id

2689646

refresh for library page

31f5dcd

refresh of library media stats for libraries page

b447c37

github-actions bot added the stale label Dec 8, 2023

github-actions bot closed this Dec 13, 2023

JonnyWong16 reopened this Dec 13, 2023

JonnyWong16 added status:in-progress and removed stale labels Dec 13, 2023

JonnyWong16 requested changes Feb 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Library Media Stats #2186

Library Media Stats #2186

herby2212 commented Oct 28, 2023 •

edited

JonnyWong16 commented Oct 28, 2023

herby2212 commented Oct 28, 2023 •

edited

JonnyWong16 commented Oct 28, 2023

herby2212 commented Oct 29, 2023

JimbooMan commented Nov 7, 2023

herby2212 commented Nov 8, 2023 •

edited

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 13, 2023

herby2212 commented Dec 19, 2023 •

edited

JonnyWong16 commented Dec 21, 2023

JonnyWong16 left a comment

JonnyWong16 Feb 17, 2024

JonnyWong16 Feb 17, 2024

Library Media Stats #2186

Are you sure you want to change the base?

Library Media Stats #2186

Conversation

herby2212 commented Oct 28, 2023 • edited

Description

Issues Fixed or Closed

Type of Change

Checklist

JonnyWong16 commented Oct 28, 2023

herby2212 commented Oct 28, 2023 • edited

JonnyWong16 commented Oct 28, 2023

herby2212 commented Oct 29, 2023

JimbooMan commented Nov 7, 2023

herby2212 commented Nov 8, 2023 • edited

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 13, 2023

herby2212 commented Dec 19, 2023 • edited

JonnyWong16 commented Dec 21, 2023

JonnyWong16 left a comment

Choose a reason for hiding this comment

JonnyWong16 Feb 17, 2024

Choose a reason for hiding this comment

JonnyWong16 Feb 17, 2024

Choose a reason for hiding this comment

herby2212 commented Oct 28, 2023 •

edited

herby2212 commented Oct 28, 2023 •

edited

herby2212 commented Nov 8, 2023 •

edited

herby2212 commented Dec 19, 2023 •

edited