python / python/typing

Types for "truthy" and "falsy" values

Offen
#1,606 7 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic: feature
Vorherrschende Sprache
Python
Sterne
1.8k
Forks
302
Ø Merge
23 Std.
Gemergte PRs (30 T.)
8

Beschreibung

I found this function in our codebase and I'm trying to type it:

def run_until_truthy(fn, num_tries=5):
    for _ in range(num_tries):
        if res := fn():
            return res

    Exception('Giving up.')

The function repeatedly calls a callable without arguments until it returns a "truthy" value. Then it returns that value. Easy enough:

def run_until_truthy[T](fn: Callable[[], T], num_tries: int = 5) -> T: ...

This is correct but too restrictive. Usages like this don't work:

def load_something() -> str | None:
    pass

# mypy: Incompatible types in assignment (expression has type "str | None", variable has type "str")
something: str = run_until_truthy(load_something)

I can hack it to make it work:

type Falsy = Literal[None, False, 0, "", b""] | tuple[()]

def run_until_truthy[T](fn: Callable[[], T | Falsy], num_tries: int = 5) -> T: ...

Does it make sense to add official Truthy and Falsy types to the standard library?

Maybe a Truthy type would also make sense. Truthy can't be defined as a type alias of existing types, but could probably also be useful sometimes, e.g. to type the following function:

def get_falsy_values[T](seq: list[T | Truthy]) -> list[T]:
    return [i for i in seq if not i]

From thinking about it for a few minutes, I think Falsy would be more often useful than Truthy, at least in combination with the current typing features.


If there's an intersection type constructor at some point, the above examples could be written like this instead, which might be easier to understand:

def run_until_truthy[T](fn: Callable[[], T], num_tries: int = 5) -> T & Truthy: ...
def get_falsy_values[T](seq: list[T]) -> list[T & Falsy]:

2024-11-25

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Es werden keine Implementierungsdateien oder Tests genannt. Beginne mit der Prüfung der truthy- und falsy-Beispiele, lies anschließend die verlinkten Vorschläge zu Intersection Types und die Leitlinien des typing-Projekts; die Arbeit ist erst abgeschlossen, wenn das Design und das erwartete Verhalten der Typprüfung vereinbart sind und die relevante typing-Unterstützung spezifiziert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.