Regression from 8.2: AttributeError: 'Figure' object has no attribute '_mpl_orig_savefig'

[ocehugo]

I just deployed a new environment; the most recent EOmaps 8.3.1 broke savefig, whereas 8.2 works.

Describe the bug
I can't save a _maps_base class figure.

To Reproduce

from eomaps import Maps
import cartopy.crs as ccrs
import matplotlib.pyplot as plt

fig = plt.figure()
m = Maps(ccrs.PlateCarree(),f=fig)
m.savefig('test.png')
AttributeError: 'Figure' object has no attribute '_mpl_orig_savefig'

Expected behavior
Figure is saved.

General information:
python = 3.12.7 | packaged by conda-forge | (main, Oct 4 2024, 16:05:46) [GCC 13.3.0]
EOmaps = 8.3.

A quick fix :

            if '_mpl_orig_savefig' in dir(self.f):
                self.f._mpl_orig_savefig(*args, **kwargs)
            else:
                self.f.savefig(*args,**kwargs)

It seems to work, but it may have side effects that I'm not aware of yet.

[raphaelquast]

Hey @ocehugo, thanks for reporting the issue!

There seems to be a problem if an explicit Figure object is passed to the initialization of the Maps object
(which is possible, but 99% of the cases not necessary)

Is there a particular reason why you want to pass an explicit Figure object to the initialization of the map?

In general, if you initialize the map without a dedicated figure, all works as expected:

m = Maps()
m.savefig("test.png")

You can then always access the underlying Figure object via m.f

[ocehugo]

Is there a particular reason why you want to pass an explicit Figure object to the initialization of the map?

Because i declare a custom figure first (e.g. size) instead of modifying a fig postfacto, which is more verbose than passing the object rightly configured. Also, mpl habit...

[raphaelquast]

@ocehugo
OK, in this case, did you know that any additional keyword-argument passed to the initialization of the Maps object is forwarded to the initialization of the underlying figure (e.g. plt.figure())?

So this means you can save yourself 2 lines of code and directly do:

from eomaps import Maps
m = Maps(crs=3057, figsize=(10, 5))

(... and just to be clear... this is a valid bug and will be fixed in the next release! :-)