mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-28 10:50:26 +00:00
f22da352db
## Summary Adds a way to list all members of an `Enum` and implements almost all of the mechanisms by which members are distinguished from non-members ([spec](https://typing.python.org/en/latest/spec/enums.html#defining-members)). This has no effect on actual enums, so far. ## Test Plan New Markdown tests using `ty_extensions.enum_members`.
63 lines
2.5 KiB
Python
63 lines
2.5 KiB
Python
from enum import Enum
|
|
from typing import Any, LiteralString, _SpecialForm
|
|
|
|
# Special operations
|
|
def static_assert(condition: object, msg: LiteralString | None = None) -> None: ...
|
|
|
|
# Types
|
|
Unknown = object()
|
|
AlwaysTruthy = object()
|
|
AlwaysFalsy = object()
|
|
|
|
# Special forms
|
|
Not: _SpecialForm
|
|
Intersection: _SpecialForm
|
|
TypeOf: _SpecialForm
|
|
CallableTypeOf: _SpecialForm
|
|
|
|
# ty treats annotations of `float` to mean `float | int`, and annotations of `complex`
|
|
# to mean `complex | float | int`. This is to support a typing-system special case [1].
|
|
# We therefore provide `JustFloat` and `JustComplex` to represent the "bare" `float` and
|
|
# `complex` types, respectively.
|
|
#
|
|
# [1]: https://typing.readthedocs.io/en/latest/spec/special-types.html#special-cases-for-float-and-complex
|
|
type JustFloat = TypeOf[1.0]
|
|
type JustComplex = TypeOf[1.0j]
|
|
|
|
# Predicates on types
|
|
#
|
|
# Ideally, these would be annotated using `TypeForm`, but that has not been
|
|
# standardized yet (https://peps.python.org/pep-0747).
|
|
def is_equivalent_to(type_a: Any, type_b: Any) -> bool: ...
|
|
def is_subtype_of(type_derived: Any, type_base: Any) -> bool: ...
|
|
def is_assignable_to(type_target: Any, type_source: Any) -> bool: ...
|
|
def is_disjoint_from(type_a: Any, type_b: Any) -> bool: ...
|
|
def is_singleton(type: Any) -> bool: ...
|
|
def is_single_valued(type: Any) -> bool: ...
|
|
|
|
# Returns the generic context of a type as a tuple of typevars, or `None` if the
|
|
# type is not generic.
|
|
def generic_context(type: Any) -> Any: ...
|
|
|
|
# Returns the `__all__` names of a module as a tuple of sorted strings, or `None` if
|
|
# either the module does not have `__all__` or it has invalid elements.
|
|
def dunder_all_names(module: Any) -> Any: ...
|
|
|
|
# List all members of an enum.
|
|
def enum_members[E: type[Enum]](enum: E) -> tuple[str, ...]: ...
|
|
|
|
# Returns the type that's an upper bound of materializing the given (gradual) type.
|
|
def top_materialization(type: Any) -> Any: ...
|
|
|
|
# Returns the type that's a lower bound of materializing the given (gradual) type.
|
|
def bottom_materialization(type: Any) -> Any: ...
|
|
|
|
# Returns a tuple of all members of the given object, similar to `dir(obj)` and
|
|
# `inspect.getmembers(obj)`, with at least the following differences:
|
|
#
|
|
# * `dir` and `inspect.getmembers` may use runtime mutable state to construct
|
|
# the list of attributes returned. In contrast, this routine is limited to
|
|
# static information only.
|
|
# * `dir` will respect an object's `__dir__` implementation, if present, but
|
|
# this method (currently) does not.
|
|
def all_members(obj: Any) -> tuple[str, ...]: ...
|