Commit62af56b

committed

Deprecate mixing positional and keyword args for legend(handles, labels)

This was previously already a warning and also broken.

1 parentfcd5bb1 commit62af56bCopy full SHA for 62af56b

File tree

+14

-7

lines changed

+14

-7

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,5 @@`
	`1`	+Mixing positional and keyword arguments for ``legend`` handles and labels
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+This was previously a plain warning, but is now deprecated. If passing`
	`4`	`+handles and labels, they must be passed either both positionally or both as`
	`5`	`+keyword.`

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1301,7 +1301,7 @@ def _parse_legend_args(axs, args, handles=None, labels=None, *kwargs):`
`1301`	`1301`	`legend(handles=handles, labels=labels)`
`1302`	`1302`
`1303`	`1303`	`The behavior for a mixture of positional and keyword handles and labels`
`1304`		`- is undefined and issues a warning.`
	`1304`	`+ is undefined and issues a warning; it will be an error in the future.`
`1305`	`1305`
`1306`	`1306`	`Parameters`
`1307`	`1307`	`----------`
`@@ -1334,8 +1334,10 @@ def _parse_legend_args(axs, args, handles=None, labels=None, *kwargs):`
`1334`	`1334`	`handlers=kwargs.get('handler_map')`
`1335`	`1335`
`1336`	`1336`	`if (handlesisnotNoneorlabelsisnotNone)andargs:`
`1337`		`-_api.warn_external("You have mixed positional and keyword arguments, "`
`1338`		`-"some input may be discarded.")`
	`1337`	`+_api.warn_deprecated("3.9",message=(`
	`1338`	`+"You have mixed positional and keyword arguments, some input may "`
	`1339`	`+"be discarded. This is deprecated since %(since)s and will "`
	`1340`	`+"become an error %(removal)s."))`
`1339`	`1341`
`1340`	`1342`	`if (hasattr(handles,"__len__")and`
`1341`	`1343`	`hasattr(labels,"__len__")and`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -405,10 +405,10 @@ def test_warn_mixed_args_and_kwargs(self):`
`405`	`405`	`th=np.linspace(0,2*np.pi,1024)`
`406`	`406`	`lns,=ax.plot(th,np.sin(th),label='sin')`
`407`	`407`	`lnc,=ax.plot(th,np.cos(th),label='cos')`
`408`		`-withpytest.warns(UserWarning)asrecord:`
	`408`	`+withpytest.warns(DeprecationWarning)asrecord:`
`409`	`409`	`ax.legend((lnc,lns),labels=('a','b'))`
`410`	`410`	`assertlen(record)==1`
`411`		`-assertstr(record[0].message)==(`
	`411`	`+assertstr(record[0].message).startswith(`
`412`	`412`	`"You have mixed positional and keyword arguments, some input may "`
`413`	`413`	`"be discarded.")`
`414`	`414`
`@@ -474,10 +474,10 @@ def test_warn_args_kwargs(self):`
`474`	`474`	`fig,axs=plt.subplots(1,2)`
`475`	`475`	`lines=axs[0].plot(range(10))`
`476`	`476`	`lines2=axs[1].plot(np.arange(10)*2.)`
`477`		`-withpytest.warns(UserWarning)asrecord:`
	`477`	`+withpytest.warns(DeprecationWarning)asrecord:`
`478`	`478`	`fig.legend((lines,lines2),labels=('a','b'))`
`479`	`479`	`assertlen(record)==1`
`480`		`-assertstr(record[0].message)==(`
	`480`	`+assertstr(record[0].message).startswith(`
`481`	`481`	`"You have mixed positional and keyword arguments, some input may "`
`482`	`482`	`"be discarded.")`
`483`	`483`

Comments

(0)