NotificationsYou must be signed in to change notification settings
Fork441
Star1.8k

Switch LTI class and subclasses to use ninputs, noutputs, nstates#515

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

bnavigator merged 4 commits intopython-control:masterfrommurrayrm:input_output_to_ninput_noutput

Jan 24, 2021

Merged

Switch LTI class and subclasses to use ninputs, noutputs, nstates#515

bnavigator merged 4 commits intopython-control:masterfrommurrayrm:input_output_to_ninput_noutput

Jan 24, 2021

Conversation

Copy link

Member

murrayrm commentedJan 20, 2021•
edited
Loading

This PR changes theLTI class and theStateSpace class (and all derived classes) to useninputs,noutputs, andnstates as the attributes for storing these properties instead ofinputs,outputs, andstates. The former names are consistent with what is used in theInputOutputSystem class.

Following the suggestion of@bnavigator in issue#451, getter and setter functions are used for backward compatibility, but with aPendingDeprecationWarning.

~~Note that this PR will generate some small conflicts with#514. I'll rebase based on which one we merge first.~~ [done]

murrayrm added this to the0.9.0 milestone

Jan 20, 2021

murrayrm mentioned this pull request

Jan 20, 2021

Release 0.8.4 and 0.9.0 sequencing#451

Closed

Copy link

coveralls commentedJan 20, 2021•
edited
Loading

Coverage decreased (-0.06%) to 87.553% when pullingeb401a9 on murrayrm:input_output_to_ninput_noutput into1502d38 on python-control:master.

Copy link

Contributor

sawyerbfuller commentedJan 20, 2021

Awesome! Looks good to me.

Copy link

Contributor

sawyerbfuller commentedJan 20, 2021

One more thing I noticed: there are a few mentions of sys.inputs/outputs in docs in xferfunc.py that should probably be fixed.

convert inputs, outputs, ... to ninputs... w/ getter/setter warning

5a4c3ab

murrayrm force-pushed theinput_output_to_ninput_noutput branch from374c82f to5a4c3abCompare

January 21, 2021 00:53

Copy link

MemberAuthor

murrayrm commentedJan 21, 2021

Rebased against master (and apparently fixed up the xferfcn.py docstring, since I can't find sys.inputs in that file anymore).

Copy link

Contributor

sawyerbfuller commentedJan 21, 2021 via email•
edited by murrayrm
Loading

May also need to check for self.inputs ?

update getter/setter comments to match code

9d469f1

sawyerbfuller reviewed

Jan 23, 2021

View reviewed changes

Copy link

Contributor

sawyerbfuller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

One more comment: was it a deliberate choice to leave init keywords as inputs/outputs rather than ninputs/noutputs, eg in lti.py:

definit(self, inputs=1, outputs=1, dt=None):

add unit test for input/output/state deprecation warning

f633874

murrayrm force-pushed theinput_output_to_ninput_noutput branch fromd614c01 tof633874Compare

January 23, 2021 18:37

Copy link

MemberAuthor

murrayrm commentedJan 24, 2021

was it a deliberate choice to leave init keywords as inputs/outputs rather than ninputs/noutputs,

This matches the syntax we use in theInputOutputSystem class constructor. In that setting (and perhaps later here as well), inputs and outputs can be an integer or a list of strings (which get used for signal names).

Copy link

Contributor

sawyerbfuller commentedJan 24, 2021

That makes sense. Thanks!

bnavigator reviewed

Jan 24, 2021

View reviewed changes

control/lti.py Outdated

Comment on lines 64 to 67

		raise PendingDeprecationWarning(
		"The LTI `inputs` attribute will be deprecated in a future "
		"release. Use `ninputs` instead.")
		return self.ninputs

Copy link

Contributor

bnavigatorJan 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This raises an Exception of the classPendingDeprecationWarning and never returns self.inputs.

Python 3.8.6 (default, Nov 09 2020, 12:09:06) [GCC] on linuxType "help", "copyright", "credits" or "license" for more information.>>> import control>>> rsys = control.rss(3,3,3)>>> ninputs = rsys.inputsTraceback (most recent call last):  File "<stdin>", line 1, in <module>  File "/home/ben/src/python-control/control/lti.py", line 64, in inputs    raise PendingDeprecationWarning(PendingDeprecationWarning: The LTI `inputs` attribute will be deprecated in a future release.  Use `ninputs` instead.>>> ninputsTraceback (most recent call last):  File "<stdin>", line 1, in <module>NameError: name 'ninputs' is not defined

Suggested change

	raisePendingDeprecationWarning(
	"The LTI `inputs` attribute will be deprecated in a future "
	"release. Use `ninputs` instead.")
	returnself.ninputs
	warn("The LTI `inputs` attribute will be deprecated in a future "
	"release. Use `ninputs` instead.",
	PendingDeprecationWarning,stacklevel=2)
	returnself.ninputs

Additionally, either a warning filter needs to be set in order to make the warning visible to end users, or a different category than*DeprecationWarning needs to be used.

filterwarnings('module',message=".*LTI.*attribute.*deprecated",category=PendingDeprecationWarning)

Python 3.8.6 (default, Nov 09 2020, 12:09:06) [GCC] on linuxType "help", "copyright", "credits" or "license" for more information.>>> import control; rsys = control.rss(3,3,3); ninputs = rsys.inputs<stdin>:1: PendingDeprecationWarning: The LTI `inputs` attribute will be deprecated in a future release.  Use `ninputs` instead.>>> ninputs3

Please add a check using pytest.warns().

Copy link

MemberAuthor

murrayrmJan 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I've fixed these up and decide to use DeprecationWarning for now (keep things internal to developers) but in a future release (0.9.x) we should change to FutureWarning, which will make it show up for users as well.

Copy link

Contributor

bnavigatorJan 24, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Still using raise instead ofwarn. Now we are at:

This raises an Exception of the class DeprecationWarning and never returns self.inputs.

Python 3.8.6 (default, Nov 09 2020, 12:09:06) [GCC] on linuxType "help", "copyright", "credits" or "license" for more information.>>> import control; rsys = control.rss(3,3,3); ninputs = rsys.inputsTraceback (most recent call last):  File "<stdin>", line 1, in <module>  File "/home/ben/src/python-control/control/lti.py", line 64, in inputs    raise DeprecationWarning(DeprecationWarning: The LTI `inputs` attribute will be deprecated in a future release.  Use `ninputs` instead.>>> ninputsTraceback (most recent call last):  File "<stdin>", line 1, in <module>NameError: name 'ninputs' is not defined>>>