MagicStack / MagicStack/asyncpg
Document exceptions
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 8.1k
- Fork
- 468
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
```
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu từ các lớp ngoại lệ của asyncpg và danh sách ngoại lệ được nêu trong issue, tách các ngoại lệ cơ sở và ngoại lệ API khỏi các ngoại lệ được tạo bởi SQLSTATE. Ghi lại các lớp hiện có và phần mô tả của chúng, bao gồm phạm vi bao phủ của SQLSTATE; công việc được coi là hoàn tất khi phần tham chiếu ngoại lệ được bao phủ trong tài liệu của dự án.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- postgresql, python
- Lĩnh vực
- databases, documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 42/100