Function annotation with two or more return parametersWhat does ** (double star/asterisk) and * (star/asterisk) do for parameters?How to merge two dictionaries in a single expression?How to flush output of print function?How to return multiple values from a function?Using global variables in a functionLimiting floats to two decimal pointsHow to make a chain of function decorators?How do I concatenate two lists in Python?Why didn't PEP 3107 (or 484) include syntax for annotating global/local variables?function annotations in python
Working hours and productivity expectations for game artists and programmers
Bash Array of Word-Splitting Headaches
Why does snapping your fingers activate the Infinity Gauntlet?
Isn't Kirchhoff's junction law a violation of conservation of charge?
How to safely discharge oneself
Will this series of events work to drown the Tarrasque?
Can 2 light bulbs of 120V in series be used on 230V AC?
How could the B-29 bomber back up under its own power?
Why are Marine Le Pen's possible connections with Steve Bannon something worth investigating?
Does the Aboleth have expertise in history and perception?
Is being an extrovert a necessary condition to be a manager?
Parse a C++14 integer literal
How to convince boss to spend notice period on documentation instead of new projects
Have I found a major security issue with login
Managing heat dissipation in a magic wand
Does science define life as "beginning at conception"?
Greek theta instead of lower case þ (Icelandic) in TexStudio
Why didn't Daenerys' advisers suggest assassinating Cersei?
Why could the Lunar Ascent Engine be used only once?
400 - 430 degrees celsius heated bath
Was Tyrion always a poor strategist?
Head-internal relative clauses
What city and town structures are important in a low fantasy medieval world?
Why favour the standard WP loop over iterating over (new WP_Query())->get_posts()?
Function annotation with two or more return parameters
What does ** (double star/asterisk) and * (star/asterisk) do for parameters?How to merge two dictionaries in a single expression?How to flush output of print function?How to return multiple values from a function?Using global variables in a functionLimiting floats to two decimal pointsHow to make a chain of function decorators?How do I concatenate two lists in Python?Why didn't PEP 3107 (or 484) include syntax for annotating global/local variables?function annotations in python
.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty height:90px;width:728px;box-sizing:border-box;
When I write an annotation for a function which returns one parameter, I have no problems.
def func() -> str:
return "ok"
However, when I write an annotation with two or more parameters, my PyCharm gives me SyntaxError: invalid syntax
.
def func() -> str, str:
return "ok - 1", "ok - 2"
I think that the parameters can be combined with a tuple
, but I don't think that's the best way to do it.
My question is: how can I properly annotate a function with two or more return parameters?
Please include a PEP link, if any, in your response. I looked for the answer at PEP 484 and PEP 3107 and could not find it.
python python-3.x type-hinting
add a comment |
When I write an annotation for a function which returns one parameter, I have no problems.
def func() -> str:
return "ok"
However, when I write an annotation with two or more parameters, my PyCharm gives me SyntaxError: invalid syntax
.
def func() -> str, str:
return "ok - 1", "ok - 2"
I think that the parameters can be combined with a tuple
, but I don't think that's the best way to do it.
My question is: how can I properly annotate a function with two or more return parameters?
Please include a PEP link, if any, in your response. I looked for the answer at PEP 484 and PEP 3107 and could not find it.
python python-3.x type-hinting
It should be noted that the secondfunc
is equivalent totmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.
– Peilonrayz
May 7 at 9:01
add a comment |
When I write an annotation for a function which returns one parameter, I have no problems.
def func() -> str:
return "ok"
However, when I write an annotation with two or more parameters, my PyCharm gives me SyntaxError: invalid syntax
.
def func() -> str, str:
return "ok - 1", "ok - 2"
I think that the parameters can be combined with a tuple
, but I don't think that's the best way to do it.
My question is: how can I properly annotate a function with two or more return parameters?
Please include a PEP link, if any, in your response. I looked for the answer at PEP 484 and PEP 3107 and could not find it.
python python-3.x type-hinting
When I write an annotation for a function which returns one parameter, I have no problems.
def func() -> str:
return "ok"
However, when I write an annotation with two or more parameters, my PyCharm gives me SyntaxError: invalid syntax
.
def func() -> str, str:
return "ok - 1", "ok - 2"
I think that the parameters can be combined with a tuple
, but I don't think that's the best way to do it.
My question is: how can I properly annotate a function with two or more return parameters?
Please include a PEP link, if any, in your response. I looked for the answer at PEP 484 and PEP 3107 and could not find it.
python python-3.x type-hinting
python python-3.x type-hinting
edited May 7 at 2:47
gmds
10.9k11038
10.9k11038
asked May 7 at 2:05
KirillKirill
1809
1809
It should be noted that the secondfunc
is equivalent totmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.
– Peilonrayz
May 7 at 9:01
add a comment |
It should be noted that the secondfunc
is equivalent totmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.
– Peilonrayz
May 7 at 9:01
It should be noted that the second
func
is equivalent to tmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.– Peilonrayz
May 7 at 9:01
It should be noted that the second
func
is equivalent to tmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.– Peilonrayz
May 7 at 9:01
add a comment |
1 Answer
1
active
oldest
votes
Use typing.Tuple
:
from typing import Tuple
def func() -> Tuple[str, str]:
return 'a', 'b'
This is appropriate because, conceptually, you are actually returning a single tuple
containing those values. Note:
print(type(func()))
Output:
<class 'tuple'>
Note that except for the empty tuple
(()
), parentheses are not necessary to define a tuple
, which means that 'a', 'b'
is created as a tuple
, rather than being separate values gathered into one by the return
statement.
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.
– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically returntuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?
– gmds
May 7 at 2:57
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
|
show 2 more comments
Your Answer
StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");
StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);
else
createEditor();
);
function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);
);
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f56014563%2ffunction-annotation-with-two-or-more-return-parameters%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
Use typing.Tuple
:
from typing import Tuple
def func() -> Tuple[str, str]:
return 'a', 'b'
This is appropriate because, conceptually, you are actually returning a single tuple
containing those values. Note:
print(type(func()))
Output:
<class 'tuple'>
Note that except for the empty tuple
(()
), parentheses are not necessary to define a tuple
, which means that 'a', 'b'
is created as a tuple
, rather than being separate values gathered into one by the return
statement.
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.
– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically returntuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?
– gmds
May 7 at 2:57
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
|
show 2 more comments
Use typing.Tuple
:
from typing import Tuple
def func() -> Tuple[str, str]:
return 'a', 'b'
This is appropriate because, conceptually, you are actually returning a single tuple
containing those values. Note:
print(type(func()))
Output:
<class 'tuple'>
Note that except for the empty tuple
(()
), parentheses are not necessary to define a tuple
, which means that 'a', 'b'
is created as a tuple
, rather than being separate values gathered into one by the return
statement.
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.
– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically returntuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?
– gmds
May 7 at 2:57
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
|
show 2 more comments
Use typing.Tuple
:
from typing import Tuple
def func() -> Tuple[str, str]:
return 'a', 'b'
This is appropriate because, conceptually, you are actually returning a single tuple
containing those values. Note:
print(type(func()))
Output:
<class 'tuple'>
Note that except for the empty tuple
(()
), parentheses are not necessary to define a tuple
, which means that 'a', 'b'
is created as a tuple
, rather than being separate values gathered into one by the return
statement.
Use typing.Tuple
:
from typing import Tuple
def func() -> Tuple[str, str]:
return 'a', 'b'
This is appropriate because, conceptually, you are actually returning a single tuple
containing those values. Note:
print(type(func()))
Output:
<class 'tuple'>
Note that except for the empty tuple
(()
), parentheses are not necessary to define a tuple
, which means that 'a', 'b'
is created as a tuple
, rather than being separate values gathered into one by the return
statement.
edited 2 hours ago
answered May 7 at 2:07
gmdsgmds
10.9k11038
10.9k11038
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.
– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically returntuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?
– gmds
May 7 at 2:57
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
|
show 2 more comments
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.
– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically returntuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?
– gmds
May 7 at 2:57
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
1
1
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.– kojiro
May 7 at 2:48
Tuple
is reasonable. It may be too strict in some cases, but there isn’t a better alternative without different tradeoffs as far as I can tell.– kojiro
May 7 at 2:48
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
@kojiro It seems to me that that would not apply in the case of return values...?
– gmds
May 7 at 2:50
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
I think it still applies. The main thing about the signature isn’t that the function returns a tuple per se, but that it return an unpackable with a specific length. There are plenty of sequence types that are unpackable, but no generic unpackable type that also has length and inner-type specifiers. Tuple can specify everything, but is too strict.
– kojiro
May 7 at 2:54
4
4
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically return
tuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?– gmds
May 7 at 2:57
@kojiro I might be misunderstanding you, but is it not the case that functions with multiple return values specifically return
tuple
, as opposed to a function with a single return value that also happens to be an unpackable object that knows its length and elements' types, which would require such a specifier?– gmds
May 7 at 2:57
1
1
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
A tuple is still a single object that happens to be unpackable. That’s what I’m saying. There isn’t a way to express python returning multiple values from a function because python can’t return multiple values from a function. But it can return a sequence, and a tuple is one kind of sequence.
– kojiro
May 7 at 3:05
|
show 2 more comments
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f56014563%2ffunction-annotation-with-two-or-more-return-parameters%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
It should be noted that the second
func
is equivalent totmp = ('ok - 1', 'ok - 2')
return tmp
, making it immediately apparent why it requires Tuple.– Peilonrayz
May 7 at 9:01