Skip to content

Deprecate abf and dot #4515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pp-mo merged 2 commits into from
Jan 25, 2022
Merged

Deprecate abf and dot #4515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69865af
Deprecate abf and dot
Jan 20, 2022
3389037
Defer import of fileformats.abf to avoid deprecation warning.
pp-mo Jan 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,11 @@ This document explains the changes made to Iris for this release
believed to still be in use. The deprecation warnings invite users to contact
the Iris Developers if this isn't the case. (:pull:`4525`)

#. `@wjbenfold`_ deprecated :mod:`iris.fileformats.abf` and
:mod:`iris.fileformats.dot` as they are not believed to still be in use. The
deprecation warnings invite users to contact the Iris Developers if this
isn't the case. (:pull:`4515`)


🔗 Dependencies
===============
Expand Down
13 changes: 10 additions & 3 deletions lib/iris/fileformats/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
UriProtocol,
)

from . import abf, name, netcdf, nimrod, pp, um
from . import name, netcdf, nimrod, pp, um

__all__ = ["FORMAT_AGENT"]

Expand Down Expand Up @@ -224,16 +224,23 @@ def _load_grib(*args, **kwargs):

#
# ABF/ABL
# TODO: now deprecated, remove later
#
def load_cubes_abf_abl(*args, **kwargs):
from . import abf

return abf.load_cubes(*args, **kwargs)


FORMAT_AGENT.add_spec(
FormatSpecification(
"ABF", FileExtension(), ".abf", abf.load_cubes, priority=3
"ABF", FileExtension(), ".abf", load_cubes_abf_abl, priority=3
)
)


FORMAT_AGENT.add_spec(
FormatSpecification(
"ABL", FileExtension(), ".abl", abf.load_cubes, priority=3
"ABL", FileExtension(), ".abl", load_cubes_abf_abl, priority=3
)
)
9 changes: 9 additions & 0 deletions lib/iris/fileformats/abf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,20 @@
import numpy.ma as ma

import iris
from iris._deprecation import warn_deprecated
from iris.coord_systems import GeogCS
from iris.coords import AuxCoord, DimCoord
import iris.fileformats
import iris.io.format_picker

wmsg = (
"iris.fileformats.abf has been deprecated and will be removed in a "
"future release. If you make use of this functionality, please contact "
"the Iris Developers to discuss how to retain it (which may involve "
"reversing the deprecation)."
)
warn_deprecated(wmsg)

X_SIZE = 4320
Y_SIZE = 2160

Expand Down
9 changes: 9 additions & 0 deletions lib/iris/fileformats/dot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,17 @@
import subprocess

import iris
from iris._deprecation import warn_deprecated
import iris.util

wmsg = (
"iris.fileformats.dot has been deprecated and will be removed in a "
"future release. If you make use of this functionality, please contact "
"the Iris Developers to discuss how to retain it (which may involve "
"reversing the deprecation)."
)
warn_deprecated(wmsg)

_GRAPH_INDENT = " " * 4
_SUBGRAPH_INDENT = " " * 8

Expand Down