Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

The public Python API

Aperta
  • Qualcosa non va?
#5,555 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api, developer-experience, testing-qa

Direzione di ricerca

Inizia esaminando le esportazioni pubbliche di robot.api e robot.libdoc, quindi confrontale con gli import elencati da robot.libdocpkg.model, robot.running.arguments.argumentmapper, robot.version, robot.variables e robot.errors. L’issue è incompleta e richiede una decisione sull’ambito dell’API; si considererebbe completata quando le aspettative richieste sull’accesso pubblico saranno risolte e documentate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I've been working on https://github.com/Lakitna/robotframework-find-unused quite a bit lately. For this tool, I try to use as much of the Robot parsing functions and existing types. This makes the tool better and it makes it a lot simpler for me to implement :)

In doing this, I've noticed that there are some things that I really need, but are not in the public API at robot.api or robot.libdoc. This is an (incomplete) list:

Used only as types

These I really can't remove. They are quite hard to duck-type too.

from robot.libdocpkg.model import LibraryDoc
from robot.libdocpkg.model import KeywordDoc
from robot.libdocpkg.model import ArgumentSpec

This one is more specific. I use it to differentiate between user-supplied keyword args and default args. I have not yet tried very hard to get rid of this one.

from robot.running.arguments.argumentmapper import DefaultValue

Used for implementation

I expect that this one is considered to be public API by many, but it's not under robot.api.

from robot.version import get_version

I implemented variable file parsing today. I don't expect these ones to be moved to the public API. I just included them for completeness sake.

In my code I wrapped the imports and usage in a try...catch so stuff won't horribly break if these classes change.

from robot.variables.filesetter import VariableFileSetter
from robot.variables.store import VariableStore

Sometimes I need to catch Robot errors. But the errors are not in the public API:

import robot.errors
Lingua principale
Python
Stelle
11.9k
Fork
2.6k
Merge medio
3g 23h
PR unite (30g)
6

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di robotframework/robotframework

Tutte le issue di robotframework/robotframework

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.