chore: Harmonize imports of sqlalchemy module, use sa where applicable
#10
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
==========================================
- Coverage 82.23% 82.12% -0.11%
==========================================
Files 7 7
Lines 681 677 -4
==========================================
- Hits 560 556 -4
Misses 121 121
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| import sqlalchemy | ||
| import sqlalchemy as sa | ||
| from crate.client.sqlalchemy.types import ObjectType, ObjectTypeImpl, _ObjectArray |
There was a problem hiding this comment.
That we need to import both ObjectType and ObjectTypeImpl here, and use them correspondingly, clearly indicates something is not optimal, and should be addressed on behalf of improvements to the type definitions of the CrateDB SQLAlchemy dialect in crate-python.
It follows a convention to import SQLAlchemy like `import sqlalchemy as sa`. In this spirit, all references, even simple ones like symbols to SQLAlchemy base types like `TEXT`, or `BIGINT`, will be referenced by `sa.TEXT`, `sa.BIGINT`, etc., so it is easy to tell them apart when harmonizing type definitions coming from SA's built-in dialects vs. type definitions coming from 3rd-party dialects.
amotl
force-pushed
the
harmonize-sqlalchemy
branch
from
74296f7 to
ab563dc
Compare
- Enforce `import typing as t` alias - Ban imports such as `from typing import Any`
|
Interesting comment by @edgarrmondragon at MeltanoLabs/target-postgres#255 (comment):
I didn't know about this detail of Ruff yet, thanks! 3e3c6ec adds the corresponding snippet. |
About
The patch follows a convention to import SQLAlchemy like
import sqlalchemy as sa.In this spirit, all references, even simple ones like symbols to SQLAlchemy base types like
TEXT, orBIGINT, will be referenced bysa.TEXT,sa.BIGINT, etc., so it is easy to tell them apart when harmonizing type definitions coming from SA's built-in dialects vs. type definitions coming from 3rd-party dialects.References
sawhere applicable MeltanoLabs/target-postgres#255