search

aio-libs / aiomysql

aiomysql is a library for accessing a MySQL database from the asyncio
https://aiomysql.rtfd.io
MIT License
1.72k stars 254 forks source link

docs: fix description type #980

Closed trim21 closed 3 months ago

trim21 commented 3 months ago

What do these changes do?

fix wrong document about type or Cursor.description

Are there changes in behavior for the user?

No

Related issue number

Checklist

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.64%. Comparing base (83aa96e) to head (3c835d6).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #980 +/- ## ========================================== - Coverage 93.68% 93.64% -0.04% ========================================== Files 36 36 Lines 5538 5538 Branches 895 895 ========================================== - Hits 5188 5186 -2 - Misses 260 262 +2 Partials 90 90 ``` | [Flag](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | Coverage Δ | | |---|---|---| | [CI-GHA](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.24% <ø> (-0.04%)` | :arrow_down: | | [DB-mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.28% <ø> (ø)` | | | [DB-mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.28% <ø> (ø)` | | | [DB-mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.30% <ø> (ø)` | | | [DB-mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.28% <ø> (ø)` | | | [DB-mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.28% <ø> (ø)` | | | [DB-mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.28% <ø> (ø)` | | | [DB-mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.98% <ø> (ø)` | | | [DB-mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.37% <ø> (-0.04%)` | :arrow_down: | | [OS-Linux](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.24% <ø> (-0.04%)` | :arrow_down: | | [Py-3.10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `?` | | | [Py-3.10.13](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.15% <ø> (?)` | | | [Py-3.11.3](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `?` | | | [Py-3.11.8](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.15% <ø> (?)` | | | [Py-3.7.16](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `?` | | | [Py-3.7.17](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.78% <ø> (?)` | | | [Py-3.8.16](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `?` | | | [Py-3.8.18](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.18% <ø> (?)` | | | [Py-3.9.16](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `?` | | | [Py-3.9.18](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.02% <ø> (?)` | | | [VM-ubuntu-latest](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `93.24% <ø> (-0.04%)` | :arrow_down: | | [ubuntu-latest_3.10_mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.10_mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.10_mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.21% <ø> (ø)` | | | [ubuntu-latest_3.10_mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.10_mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.10_mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.10_mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.89% <ø> (ø)` | | | [ubuntu-latest_3.10_mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.28% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.21% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.11_mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.19% <ø> (ø)` | | | [ubuntu-latest_3.11_mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.89% <ø> (ø)` | | | [ubuntu-latest_3.11_mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.28% <ø> (-0.04%)` | :arrow_down: | | [ubuntu-latest_3.7_mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.64% <ø> (ø)` | | | [ubuntu-latest_3.7_mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.64% <ø> (ø)` | | | [ubuntu-latest_3.7_mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.66% <ø> (ø)` | | | [ubuntu-latest_3.7_mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.64% <ø> (ø)` | | | [ubuntu-latest_3.7_mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.64% <ø> (ø)` | | | [ubuntu-latest_3.7_mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `89.64% <ø> (ø)` | | | [ubuntu-latest_3.7_mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.39% <ø> (ø)` | | | [ubuntu-latest_3.7_mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `91.86% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.23% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.23% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.25% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.23% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.23% <ø> (ø)` | | | [ubuntu-latest_3.8_mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.23% <ø> (ø)` | | | [ubuntu-latest_3.8_mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.94% <ø> (ø)` | | | [ubuntu-latest_3.8_mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.31% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.10](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.07% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.11](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.07% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.4](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.09% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.5](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.07% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.6](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.07% <ø> (ø)` | | | [ubuntu-latest_3.9_mariadb-10.9](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.07% <ø> (ø)` | | | [ubuntu-latest_3.9_mysql-5.7](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `90.77% <ø> (ø)` | | | [ubuntu-latest_3.9_mysql-8.0](https://app.codecov.io/gh/aio-libs/aiomysql/pull/980/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs) | `92.15% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aio-libs#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.