Skip to content

Remove API methods deprecated in version 1.0 #233

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
merged 1 commit into from
Oct 29, 2025
+13 −161
Merged

Remove API methods deprecated in version 1.0 #233

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
118 changes: 13 additions & 105 deletions mph/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
from numpy import integer
from pathlib import Path
from re import match
from warnings import warn
from logging import getLogger

from jpype import JClass
Expand Down Expand Up @@ -629,30 +628,27 @@ def rename(self, name: str):

@overload
def parameter(self,
name: str,
value: str | int | float | complex,
unit: str | None,
description: str | None,
evaluate: Literal[False],
name: str,
value: str | int | float | complex,
*,
evaluate: Literal[False],
): ...
@overload
def parameter(self,
name: str,
value: Literal[None],
unit: Literal[None],
description: Literal[None],
evaluate: Literal[False],
name: str,
value: Literal[None],
*,
evaluate: Literal[False],
) -> str: ...
@overload
def parameter(self,
name: str,
value: Literal[None],
unit: Literal[None],
description: Literal[None],
evaluate: Literal[True],
name: str,
value: Literal[None],
*,
evaluate: Literal[True],
) -> int | float | complex: ...
def parameter(
self, name, value=None, unit=None, description=None, evaluate=False
self, name, value=None, *, evaluate=False
):
"""
Returns or sets the parameter of the given name.
Expand All @@ -669,21 +665,7 @@ def parameter(
the unit, again inside brackets. If the option `evaluate` is set
to `True`, the numerical value that the expression evaluates to
is returned.

*Warning*: The optional arguments `unit` and `description` are
deprecated and will be removed in a future release. Include the
unit in the value expression and call the `description()` method
to change a parameter description.
"""
if unit is not None:
warn('Argument "unit" to Model.parameter() is deprecated. '
'Include the unit in the value inside square brackets.')
if value:
value = f'{value} [{unit}]'
if description is not None:
warn('Argument "description" to Model.parameter() is deprecated. '
'Call .description() instead.')
self.description(name, description)
if value is None:
if not evaluate:
try:
Expand Down Expand Up @@ -725,13 +707,6 @@ def parameters(self, evaluate=False):
the user, unless `evaluate` is set to `True`, in which case
the expressions are evaluated and the corresponding numbers
are returned.

*Warning*: Prior to version 1.0, this method would return
a list of named tuples holding name, value, and description.
It now returns a dictionary, which is a breaking change that
may require application code to be adapted. The descriptions
can be retrieved by additionally calling `.description()` or
`.descriptions()`.
"""
if not evaluate:
return {str(name): str(self.java.param().get(name))
Expand Down Expand Up @@ -1010,70 +985,3 @@ def save(self, path: Path | str = None, format: str = None):
else:
self.java.save(str(file), type)
log.info('Finished saving model.')

###############
# Deprecation #
###############

def features(self, physics: str) -> list[str]:
# Returns the names of all features in a given physics interface.
#
# The term feature refers to the nodes defined under a physics
# interface. They define the differential equations, boundary
# conditions, initial values, etc.
warn('Model.features() is deprecated. Use the Node class instead.')
if physics not in self.physics():
error = f'No physics interface named "{physics}".'
log.error(error)
raise LookupError(error)
tags = [tag for tag in self.java.physics().tags()]
ptag = tags[self.physics().index(physics)]
tags = [tag for tag in self.java.physics(ptag).feature().tags()]
return [str(self.java.physics(ptag).feature(ftag).label())
for ftag in tags]

def toggle(self, physics: str, feature: str, action: str = 'flip'):
# Enables or disables features of a physics interface.
#
# If `action` is `'flip'` (the default), it enables the feature
# if it is currently disabled or disables it if enabled. Pass
# `'enable'` or `'on'` to enable the feature regardless of its
# current state. Pass `'disable'` or `'off'` to disable it.
warn('Model.toggle() is deprecated. Use the Node class instead.')
if physics not in self.physics():
error = f'No physics interface named "{physics}".'
log.error(error)
raise LookupError(error)
tags = [tag for tag in self.java.physics().tags()]
ptag = tags[self.physics().index(physics)]
node = self.java.physics(ptag)
if feature not in self.features(physics):
error = f'No feature named "{feature}" in physics "{physics}".'
log.error(error)
raise LookupError(error)
tags = [tag for tag in node.feature().tags()]
ftag = tags[self.features(physics).index(feature)]
node = node.feature(ftag)
if action == 'flip':
node.active(not node.isActive())
elif action in ('enable', 'on', 'activate'):
node.active(True)
elif action in ('disable', 'off', 'deactivate'):
node.active(False)

def load(self, file: Path | str, interpolation: str):
# Loads data from a file and assigns it to an interpolation function.
warn('Model.load() is deprecated. Call .import_() instead.')
for tag in self.java.func().tags():
if str(self.java.func(tag).label()) == interpolation:
break
else:
error = f'Interpolation function "{interpolation}" does not exist.'
log.error(error)
raise LookupError(error)
file = Path(file)
log.info(f'Loading external data from file "{file.name}".')
self.java.func(tag).discardData()
self.java.func(tag).set('filename', f'{file}')
self.java.func(tag).importData()
log.info('Finished loading external data.')
56 changes: 0 additions & 56 deletions tests/test_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import models
from fixtures import logging_disabled
from fixtures import warnings_disabled
from fixtures import setup_logging

from numpy.testing import assert_allclose
Expand Down Expand Up @@ -424,10 +423,6 @@ def test_parameter():
model.parameter('non-existing')
with raises(RuntimeError):
model.parameter('non-existing', evaluate=True)
with warnings_disabled():
model.parameter('U', '1', 'V')
assert model.parameter('U') == '1 [V]'
model.parameter('U', description='applied voltage')
model.parameter('U', value)
assert model.parameter('U') == value

Expand Down Expand Up @@ -730,53 +725,6 @@ def test_problems():
assert not model.problems()


def test_features():
with warnings_disabled():
assert 'Laplace equation' in model.features('electrostatic')
assert 'zero charge' in model.features('electrostatic')
assert 'initial values' in model.features('electrostatic')
assert 'anode' in model.features('electrostatic')
assert 'cathode' in model.features('electrostatic')
with logging_disabled(), raises(LookupError):
model.features('non-existing')


def test_toggle():
with warnings_disabled():
model.solve('static')
assert abs(model.evaluate('V_es').mean()) < 0.1
model.toggle('electrostatic', 'cathode')
model.solve('static')
assert abs(model.evaluate('V_es').mean() - 0.5) < 0.1
model.toggle('electrostatic', 'cathode', 'on')
model.solve('static')
assert abs(model.evaluate('V_es').mean()) < 0.1
model.toggle('electrostatic', 'cathode', 'off')
model.solve('static')
assert abs(model.evaluate('V_es').mean() - 0.5) < 0.1
with logging_disabled():
with raises(LookupError):
model.toggle('non-existing', 'feature')
with raises(LookupError):
model.toggle('electrostatic', 'non-existing')


def test_load():
with warnings_disabled():
image = model.create('functions/image', 'Image')
image.property('funcname', 'im')
image.property('fununit', '1/m^2')
image.property('xmin', -5)
image.property('xmax', +5)
image.property('ymin', -5)
image.property('ymax', +5)
image.property('extrap', 'value')
model.load('gaussian.tif', 'image')
model.remove('functions/image')
with logging_disabled(), raises(LookupError):
model.load('image.png', 'non-existing')


if __name__ == '__main__':
setup_logging()
setup_module()
Expand Down Expand Up @@ -833,9 +781,5 @@ def test_load():

test_problems()

test_features()
test_toggle()
test_load()

finally:
teardown_module()