Add docstring for instrument_connection() and tests for database drivers

[beijiez]

Description

Add docstring for instrument_connection() and tests for database drivers as it is missing. This will be useful to new database instrumentation efforts

DB driver docstrings updated:

[x] aiopg
[x] mysql-connector
[x] mysqlclient
[x] psycopg
[x] psycopg2
[x] pymysql
[x] sqlite3

Addresses #3089

How Has This Been Tested?

• Added tests for DB driver /tests if it was missing
• Tested Usage code locally
• tox -e spellcheck OK
• tox congratulations :)

Does This PR Require a Core Repo Change?

No

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: beijiez / name: Beijie Zhang (e11ec1a, 4369a05, db31f28, a0b0cb3, 2ab903a, c38ef19, 45f7ad3, 74b3636, 8adb093, dd5cd5d, 0cbd913, f288ed6, 1ec8fd0, 9d81680, 32f9638, eddb1f9)

[tammy-baylis-swi]

Thanks @beijiez ! I've requested one set of changes first.

There are a few CI formatting checks failing. Here are some more individual local commands if you could please run on your local:

1. tox -e ruff
2. tox -e lint-instrumentation-psycopg2
3. tox -e lint-instrumentation-sqlite3
4. tox -e docs <-- this might only work for Python 3.11 or 3.10

[beijiez]

Thanks @beijiez ! I've requested one set of changes first.

There are a few CI formatting checks failing. Here are some more individual local commands if you could please run on your local:

1. tox -e ruff
2. tox -e lint-instrumentation-psycopg2
3. tox -e lint-instrumentation-sqlite3
4. tox -e docs <-- this might only work for Python 3.11 or 3.10

Thank you for the fast review @tammy-baylis-swi! Updated and re-ran CI locally

tox -e ruff
tox -e lint-instrumentation-psycopg2
tox -e lint-instrumentation-sqlite3
tox -e lint-instrumentation-aiopg
tox -e docs [on a 3.11.0 pyvenv] 

[tammy-baylis-swi]

Thank you again @beijiez ! Nice to see all CI passing now. I've left more suggestions and a question when you have a moment.

[beijiez]

Thank you again @beijiez ! Nice to see all CI passing now. I've left more suggestions and a question when you have a moment.

Thank you for the detailed review @tammy-baylis-swi ! I responded to your question, re-verified CI, and pushed changes

[Kludex]

All the examples from the code-blocks don't run as they are written. Can we add the table creation before the insertion?

It saves time for those reading the docs when trying the code snippets.

[tammy-baylis-swi]

All the examples from the code-blocks don't run as they are written. Can we add the table creation before the insertion?

@Kludex could you provide a suggestion on one of the instrumentor scripts for how to do this?

[beijiez]

All the examples from the code-blocks don't run as they are written. Can we add the table creation before the insertion?

It saves time for those reading the docs when trying the code snippets.

Good callout, sqlite3 currently has a working example with table creation. Can add it to rest of the docstrings

cursor.execute("CREATE TABLE test (testField INTEGER)")

[tammy-baylis-swi]

All the examples from the code-blocks don't run as they are written. Can we add the table creation before the insertion?
It saves time for those reading the docs when trying the code snippets.

Good callout, sqlite3 currently has a working example with table creation. Can add it to rest of the docstrings

cursor.execute("CREATE TABLE test (testField INTEGER)")

Ah, I see. I was thinking docs/formatting tables instead of db tables. 😅

[Kludex]

Yeah, I updated the sqlite3 one last week. 😁

That would be great. Thanks!

[beijiez]

Yeah, I updated the sqlite3 one last week. 😁

That would be great. Thanks!

Done. Added cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)") to each to allow idempotent table creation in the example docstrings

[tammy-baylis-swi]

Lgtm, thank you for all the work!

This will be checked by the Maintainers next.