Skip to content

Tidy wrapper imports and reinstate docs for iris.analysis.interpolate. #2272

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
marqh merged 1 commit into from
Jan 9, 2017
Merged

Tidy wrapper imports and reinstate docs for iris.analysis.interpolate. #2272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions lib/iris/analysis/_interpolate_backdoor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
import iris.coord_systems
import iris.coords
import iris.exceptions
from . import _interpolate_private as oldinterp
from . import _interpolate_private as _interp


_INTERPOLATE_DEPRECATION_WARNING = \
Expand All @@ -71,9 +71,9 @@ def nearest_neighbour_indices(cube, sample_points):
'iris.analysis.interpolate.nearest_neighbour_indices() '
'with iris.coords.Coord.nearest_neighbour_index()).')
_warn_deprecated(msg)
return oldinterp.nearest_neighbour_indices(cube, sample_points)
return _interp.nearest_neighbour_indices(cube, sample_points)

nearest_neighbour_indices.__doc__ = oldinterp.nearest_neighbour_indices.__doc__
nearest_neighbour_indices.__doc__ = _interp.nearest_neighbour_indices.__doc__


def extract_nearest_neighbour(cube, sample_points):
Expand All @@ -82,9 +82,9 @@ def extract_nearest_neighbour(cube, sample_points):
'iris.analysis.interpolate.extract_nearest_neighbour() with '
'iris.cube.Cube.interpolate(..., scheme=iris.analysis.Nearest()).')
_warn_deprecated(msg)
return oldinterp.extract_nearest_neighbour(cube, sample_points)
return _interp.extract_nearest_neighbour(cube, sample_points)

extract_nearest_neighbour.__doc__ = oldinterp.extract_nearest_neighbour.__doc__
extract_nearest_neighbour.__doc__ = _interp.extract_nearest_neighbour.__doc__


def nearest_neighbour_data_value(cube, sample_points):
Expand All @@ -93,20 +93,20 @@ def nearest_neighbour_data_value(cube, sample_points):
'iris.analysis.interpolate.nearest_neighbour_data_value() with '
'iris.cube.Cube.interpolate(..., scheme=iris.analysis.Nearest()).')
_warn_deprecated(msg)
return oldinterp.nearest_neighbour_data_value(cube, sample_points)
return _interp.nearest_neighbour_data_value(cube, sample_points)

nearest_neighbour_data_value.__doc__ = \
oldinterp.nearest_neighbour_data_value.__doc__
_interp.nearest_neighbour_data_value.__doc__


def regrid(source_cube, grid_cube, mode='bilinear', **kwargs):
msg = (_INTERPOLATE_DEPRECATION_WARNING + '\n' +
'Please replace usage of iris.analysis.interpolate.regrid() '
'with iris.cube.Cube.regrid().')
_warn_deprecated(msg)
return oldinterp.regrid(source_cube, grid_cube, mode=mode, **kwargs)
return _interp.regrid(source_cube, grid_cube, mode=mode, **kwargs)

regrid.__doc__ = oldinterp.regrid.__doc__
regrid.__doc__ = _interp.regrid.__doc__


def regrid_to_max_resolution(cubes, **kwargs):
Expand All @@ -115,25 +115,25 @@ def regrid_to_max_resolution(cubes, **kwargs):
'iris.analysis.interpolate.regrid_to_max_resolution() '
'with iris.cube.Cube.regrid().')
_warn_deprecated(msg)
return oldinterp.regrid_to_max_resolution(cubes, **kwargs)
return _interp.regrid_to_max_resolution(cubes, **kwargs)

regrid_to_max_resolution.__doc__ = oldinterp.regrid_to_max_resolution.__doc__
regrid_to_max_resolution.__doc__ = _interp.regrid_to_max_resolution.__doc__


def linear(cube, sample_points, extrapolation_mode='linear'):
msg = (_INTERPOLATE_DEPRECATION_WARNING + '\n' +
'Please replace usage of iris.analysis.interpolate.linear() with '
'iris.cube.Cube.interpolate(..., scheme=iris.analysis.Linear()).')
_warn_deprecated(msg)
return oldinterp.linear(cube, sample_points,
extrapolation_mode=extrapolation_mode)
return _interp.linear(cube, sample_points,
extrapolation_mode=extrapolation_mode)

linear.__doc__ = oldinterp.linear.__doc__
linear.__doc__ = _interp.linear.__doc__


class Linear1dExtrapolator(six.with_metaclass(ClassWrapperSameDocstring,
oldinterp.Linear1dExtrapolator)):
@wraps(oldinterp.Linear1dExtrapolator.__init__)
_interp.Linear1dExtrapolator)):
@wraps(_interp.Linear1dExtrapolator.__init__)
def __init__(self, interpolator):
_warn_deprecated()
super(Linear1dExtrapolator, self).__init__(interpolator)
11 changes: 11 additions & 0 deletions lib/iris/analysis/interpolate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,16 @@
from iris.analysis._interpolate_backdoor import *
from iris.analysis._interpolate_backdoor import _warn_deprecated


# List all the content exported from _interpolate_backdoor, to ensure we build
# docs for them.
__all__ = [
'nearest_neighbour_indices',
'extract_nearest_neighbour',
'nearest_neighbour_data_value',
'regrid',
'regrid_to_max_resolution',
'linear']

# Issue a deprecation message when the module is loaded.
_warn_deprecated()