MagicStack / MagicStack/asyncpg

Document exceptions

Ouverte
#441 0 commentaires 9 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
8.1k
Forks
468
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Please add the asyncpg exceptions to the documentation. I have no trouble reading source code, so was pleasantly surprised to find how rich the included exception classes are.

```python
>>> exceptions = sorted((o for o in vars(asyncpg).values() if isinstance(o, type) and issubclass(o, Exception)), key=lambda o: o.__name__)
>>> for exc in exceptions:
... if getattr(exc, 'sqlstate', None): continue # looong list otherwise
... print(exc.__name__)
... if exc.__doc__: print(exc.__doc__)
... print()
...
FatalPostgresError
A fatal error that should result in server disconnection.

InterfaceError
An error caused by improper use of asyncpg API.

InterfaceWarning
A warning caused by an improper use of asyncpg API.

InternalClientError
All unexpected errors not classified otherwise.

OutdatedSchemaCacheError
A value decoding error caused by a schema change before row fetching.

PostgresError
Base class for all Postgres errors.

ProtocolError
Unexpected condition in the handling of PostgreSQL protocol input.

UnknownPostgresError
An error with an unknown SQLSTATE code.

>>> # generated exceptions for all possible sqlstate values
...
>>> sum(1 for exc in exceptions if getattr(exc, 'sqlstate', None))
240
```

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les classes d’exception de asyncpg et la liste des exceptions présentée dans l’issue, en séparant les exceptions de base et d’API des exceptions générées par SQLSTATE. Documentez les classes disponibles et leurs descriptions, y compris la couverture de SQLSTATE ; le travail est considéré comme terminé lorsque la référence des exceptions est couverte dans la documentation du projet.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
postgresql, python
Domaine
databases, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.