this post was submitted on 01 Feb 2024
23 points (100.0% liked)

Python

6366 readers
3 users here now

Welcome to the Python community on the programming.dev Lemmy instance!

πŸ“… Events

PastNovember 2023

October 2023

July 2023

August 2023

September 2023

🐍 Python project:
πŸ’“ Python Community:
✨ Python Ecosystem:
🌌 Fediverse
Communities
Projects
Feeds

founded 1 year ago
MODERATORS
[email protected]
[email protected]
[email protected]
23
Generic Typing with Iterable[str] or Collection[str]: Should you use it? (feddit.de)
submitted 9 months ago* (last edited 9 months ago) by [email protected] to c/[email protected]
17 comments fedilink hide all child comments
 

I often find myself defining function args with list[SomeClass] type and think "do I really care that it's a list? No, tuple or Generator is fine, too". I then tend to use Iterable[SomeClass] or Collection[SomeClass]. But when it comes to str, I really don't like that solution, because if you have this function:

def foo(bar: Collection[str]) -> None:
    pass

Then calling foo("hello") is fine, too, because "hello" is a collection of strings with length 1, which would not be fine if I just used list[str] in the first place. What would you do in a situation like this?

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 6 points 9 months ago* (last edited 9 months ago) (3 children)

I'd leave a docstring:

def foo(bor: Iterable[str]) -> None:
    """foos bars by doing x and y to each bar"""

Type hinting isn't intended to prevent all classes of errors, it's intended to provide documentation to the caller. Iterable[str] provides that documentation, and a docstring gives additional context if needed. If you want strict typing assurances, Python probably isn't the tool you're looking for.

[–] [email protected] 2 points 9 months ago (1 children)

This + an assert seems like the way to go. I think that str should never have fulfilled these contracts in the first place and should have a .chars property that returns a list of one-character-strings. But this change would break existing code, so it is not going to happen.

[–] [email protected] 1 points 9 months ago (1 children)

IDK, I think strings being simple lists is less surprising than having a unique type. Most other languages model them that way, and it's nice to be able to use regular list actions to interact with them.

It's really not something I'm likely to run into in practice. The only practical way I see messing this up is with untrusted inputs, but I sanitize those anyway.

[–] [email protected] 1 points 9 months ago

Yes, you're right. It also a lot of benefits.

load more comments (1 replies)