provide `typing.Protocol` for `dash_duo`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 24.4k
- Forks
- 2.3k
- Ø Merge
- 2 T. 7 Std.
- Gemergte PRs (30 T.)
- 13
Beschreibung
Is your feature request related to a problem? Please describe.
The DX for using the pytest fixture dash.testing.plugin.dash_duo() could be improved by providing a typing.Protocol to type hint available methods and their signatures.
Describe the solution you'd like
from typing import Protocol
import dash
from dash.testing.application_runners import import_app
from dash.testing.wait import wait_for_element_by_css_selector, wait_for_text_to_equal
class DashDuo(Protocol):
"The dash_duo pytest fixture lives in dash.testing.plugin.dash_duo."
def start_server(self, start_server) -> None:
...
def find_element(self, selector: str) -> dash.development.base_component.Component:
...
def test_example_app(dash_duo: DashDuo): # type hint for dash_duo enables auto-complete
app = import_app("example")
dash_duo.start_server(app)
my_component = dash_duo.find_element("#hello-world")
assert "my-value" == my_component.get_attribute("value")
....
Screenshot from VS Code showing auto-complete in action

Describe alternatives you've considered
None
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Fixture dash.testing.plugin.dash_duo und untersuche die von ihm bereitgestellten Methoden und Signaturen, einschließlich start_server und find_element. Definiere ein typing.Protocol, das diese Fixture-Methoden repräsentiert, und überprüfe, dass die Annotation eines pytest-Tests damit die angeforderten Methodensignaturen und Autovervollständigungsunterstützung bereitstellt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- developer-experience, testing-qa
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100