Add new plugin to allow one to disable ZIP generation on a per album basis #368

riton · 2019-05-14T16:24:52Z

Heavily inspired by the .nomedia file, this patch introduces a new plugin called nozip_gallery.

If zip_gallery is enabled, this plugin allows to control on a per album basis if a ZIP file should be generated or not.

It currently uses a .nozip_gallery file (empty or not) to achieve such behavior.

The motivation behind this plugin is:

disable ZIP file generation for my very old photo albums
enable ZIP file generation for my recent photo albums


        Add new plugin to allow one to disable ZIP generation on a per album …

…basis * Heavily inspired by the '.nomedia' file

codecov · 2019-05-14T16:29:42Z

Codecov Report

Merging #368 into master will decrease coverage by 0.76%.
The diff coverage is 13.33%.

@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
- Coverage   87.38%   86.62%   -0.77%     
==========================================
  Files          18       19       +1     
  Lines        1443     1458      +15     
==========================================
+ Hits         1261     1263       +2     
- Misses        182      195      +13

Impacted Files	Coverage Δ
sigal/plugins/nozip_gallery.py	`0% <0%> (ø)`
sigal/gallery.py	`88.88% <66.66%> (-0.16%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 912ca39...43f07a7. Read the comment docs.

codecov · 2019-05-14T16:29:42Z

Codecov Report

Merging #368 into master will increase coverage by 0.19%.
The diff coverage is 90.47%.

@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
+ Coverage   87.38%   87.58%   +0.19%     
==========================================
  Files          18       19       +1     
  Lines        1443     1466      +23     
==========================================
+ Hits         1261     1284      +23     
  Misses        182      182

Impacted Files	Coverage Δ
sigal/gallery.py	`89.52% <100%> (+0.48%)`	⬆️
sigal/plugins/zip_gallery.py	`90.24% <90.24%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 912ca39...a3bf898. Read the comment docs.

riton · 2019-05-14T16:30:45Z

Note:

Another solution would have been to rely on the album index.md file with a GenerateZIP: true / false setting.

I've chosen to use a .nozip_gallery file like the .nomedia file for consistency.

saimn · 2019-05-22T22:06:08Z

Hi,
Thanks for the PR, and sorry for the delay. This would indeed be a nice feature to have. Thinking about it, we could maybe move the zip feature to the plugin, that would then take care of adding the zip method to the albums when the plugin is activated and when the special file does not exists. Would you be interested to have a look at this?
Also it will need some unit tests :)

@saimn


        Adapt zip_gallery logic to a dedicated plugin like suggested by @saimn

* ZIP generation logic is now self contained in a plugin * '.nozip_gallery' file logic is now contained in the same plugin that managed the zip generation

riton · 2019-06-03T20:32:20Z

Hi, my turn to take a long time to respond, sorry about that.

I've made some modifications and moved the whole zip generation logic to a zip_gallery plugin.
Is this what you meant / wanted ?

About the unit tests, I'll see if I can find some time to write them. Before going further, I want to be sure that we're on the same page about the zip logic modifications that I've made in fc14de3

riton · 2019-06-03T20:38:12Z

BTW @saimn , just noticed that you're from Lyon. If you want to meet and discuss further in real life next to a beer or so, I'd be glad 😉

saimn · 2019-06-04T22:14:57Z

sigal/plugins/zip_gallery.py

+                    ".nozip_gallery file", album.name)
+        zip_method = noop_zip_method
+
+    album.__class__.zip = cached_property(zip_method)


Since the property is set on the class, it will be used for all the Album objects (the last will win). So instead I think that you can check for the "nozip" file directly in generate_album_zip_method ?

You're absolutely right, this was too naive. I've switched to a single function that does all the checks and contains all the logic.

saimn · 2019-06-04T22:16:54Z

sigal/gallery.py

-            archive.close()
-            self.logger.debug('Created ZIP archive %s', archive_path)
-            return zip_gallery
+        return None


I wonder if having the placeholder method is necessary? Jinja evaluates missing attributes to an empty string - I think, so it should be fine if the .zip method is missing.

I don't think this is necessary. I just thought this can make the code easier to read.
For the reader, this placeholder may give a hint on where the actual implementation of the zip property is made. (I'm not a huge fan of magic properties that just appears you don't know where from even if python allows it 😄 )

Anyway, If you'd like me to remove the placeholder, no problem for me. I can simply replace it with a comment to help future readers.

I see your point about the magic aspect and agree in general, but on the other side it is weird to have some unrelated zip stuff here, since this is now an independent feature. And the implementation will be easy to find in the zip plugin.

sigal/plugins/zip_gallery.py

saimn · 2019-06-04T22:29:50Z

Thanks @riton , I think this is a very nice improvement!
For the test, there is already a test_zip.py file, so the easiest would to add a "nozip" file in some directory in tests/sample/pictures, and check that the zip archive for this directory is not created (in test_zipped_correctly).
And yes, I would be happy to have a beer in Lyon :)

@saimn


        Adapt zip_gallery plugin to @saimn recommendations

* One single entry point for the 'zip' property

@saimn


        Adapt docstring for the zip_gallery plugin as suggested by @saimn

riton · 2019-06-05T07:14:17Z

@saimn I've made some quick modifications following your suggestions. Still no unit tests for now.

saimn · 2019-06-13T19:36:33Z

docs/plugins.rst

@@ -119,6 +119,11 @@ Nomedia plugin

 .. automodule:: sigal.plugins.nomedia

+No ZIP Gallery plugin


Suggested change

No ZIP Gallery plugin

ZIP Gallery plugin

The plugin is more general now ;)

saimn · 2019-06-13T19:36:33Z

sigal/gallery.py

-            archive.close()
-            self.logger.debug('Created ZIP archive %s', archive_path)
-            return zip_gallery
+        return None


I see your point about the magic aspect and agree in general, but on the other side it is weird to have some unrelated zip stuff here, since this is now an independent feature. And the implementation will be easy to find in the zip plugin.

saimn · 2019-06-13T19:36:33Z

sigal/plugins/zip_gallery.py

+    Album.zip = cached_property(generate_album_zip)
+
+def register(settings):
+    signals.album_initialized.connect(nozip_galery_file)


galery -> gallery (and the same above)

saimn · 2019-06-13T19:36:33Z

sigal/plugins/zip_gallery.py

+                album.logger.warn('Failed to add %s to the ZIP: %s', p, e)
+
+        archive.close()
+        album.logger.debug('Created ZIP archive %s', archive_path)


You can use the logger defined at the top of the module instead of album.logger.

saimn · 2019-06-13T19:38:09Z

@riton - Could you have a look at the test to see why it is failing ?


        Fix api link


        Fix typo and use the module logger


        Activate the zip_gallery plugin for tests


        Add test for .nozip_gallery


        Forgot to add file for the test


        Improve docs

saimn · 2019-08-26T10:23:32Z

Hi @riton ,
I have finalized the PR with the tests and a few details, so this is now good to go. Thanks for your work !

Add new plugin to allow one to disable ZIP generation on a per album …

Loading status checks…

43f07a7

…basis * Heavily inspired by the '.nomedia' file

Adapt zip_gallery logic to a dedicated plugin like suggested by @saimn

Loading status checks…

fc14de3

* ZIP generation logic is now self contained in a plugin * '.nozip_gallery' file logic is now contained in the same plugin that managed the zip generation

saimn reviewed Jun 4, 2019

View changes

sigal/plugins/zip_gallery.py Outdated Show resolved Hide resolved

riton added 2 commits Jun 5, 2019

Adapt zip_gallery plugin to @saimn recommendations

Loading status checks…

7952cb0

* One single entry point for the 'zip' property

Adapt docstring for the zip_gallery plugin as suggested by @saimn

Loading status checks…

fd51aed

saimn reviewed Jun 13, 2019

View changes

saimn added 4 commits Aug 25, 2019

Fix api link

cd1d5e9

Fix typo and use the module logger

98e1018

Activate the zip_gallery plugin for tests

bcf4b82

Add test for .nozip_gallery

Loading status checks…

2677cba

saimn added this to the 2.1 milestone Aug 25, 2019

saimn added 2 commits Aug 25, 2019

Forgot to add file for the test

1d79e3f

Improve docs

Loading status checks…

a3bf898

saimn merged commit dcefc35 into saimn:master Aug 26, 2019
3 checks passed

3 checks passed

codecov/patch 90.47% of diff hit (target 87.38%)
Details

codecov/project 87.58% (+0.19%) compared to 912ca39
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

saimn/sigal

Add new plugin to allow one to disable ZIP generation on a per album basis #368

Add new plugin to allow one to disable ZIP generation on a per album basis #368

riton commented May 14, 2019

This comment has been minimized.

codecov bot commented May 14, 2019

This comment has been minimized.

codecov bot commented May 14, 2019 •

edited

This comment has been minimized.

riton commented May 14, 2019

This comment has been minimized.

saimn commented May 22, 2019

This comment has been minimized.

riton commented Jun 3, 2019

This comment has been minimized.

riton commented Jun 3, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

saimn commented Jun 4, 2019

This comment has been minimized.

riton commented Jun 5, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

saimn commented Jun 13, 2019

This comment has been minimized.

saimn commented Aug 26, 2019

saimn/sigal

Join GitHub today

Add new plugin to allow one to disable ZIP generation on a per album basis #368

Conversation

riton commented May 14, 2019

This comment has been minimized.

codecov bot commented May 14, 2019

Codecov Report

This comment has been minimized.

codecov bot commented May 14, 2019 • edited

Codecov Report

This comment has been minimized.

riton commented May 14, 2019

This comment has been minimized.

saimn commented May 22, 2019

This comment has been minimized.

riton commented Jun 3, 2019

This comment has been minimized.

riton commented Jun 3, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

saimn commented Jun 4, 2019

This comment has been minimized.

riton commented Jun 5, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

saimn commented Jun 13, 2019

This comment has been minimized.

saimn commented Aug 26, 2019

codecov bot commented May 14, 2019 •

edited