Typing / Protocol for DBAPI-compatible connections and cursors

John Stevenson - BGS <[email protected]> Fri, 2 Dec 2022 17:47:46 +0000
Newsgroups gmane.comp.python.db
Message-ID <LO2P123MB514203FEEAAC521DA226843581179@LO2P123MB5142.GBRP123.PROD.OUTLOOK.COM>
--===============3811690827299570646==
Content-Language: en-US
Content-Type: multipart/alternative;
	boundary="_000_LO2P123MB514203FEEAAC521DA226843581179LO2P123MB5142GBRP_"

--_000_LO2P123MB514203FEEAAC521DA226843581179LO2P123MB5142GBRP_
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

Hi,

Is there a way to do type hints for a generic DBAPI-compatible connection a=
nd cursor?  Our ETL Helper tool uses cx_Oracle, psycopg2 and sqlite3 connec=
tions interchangeably and it would be useful to have a generic type instead=
 explicitly using the classes from each driver.

As far as I can see from Google, one way to achieve this would by using Pro=
tocols, as defined in PEP 544 (https://peps.python.org/pep-0544/).  Is ther=
e an "official" PEP 249 DBA API 2.0 protocol anywhere?

Thanks,
John

p.s. ETL Helper is a library we developed to make it easier for our DBAs to=
 use Python to transfer data. https://pypi.org/project/etlhelper/


This email and any attachments are intended solely for the use of the named=
 recipients. If you are not the intended recipient you must not use, disclo=
se, copy or distribute this email or any of its attachments and should noti=
fy the sender immediately and delete this email from your system. UK Resear=
ch and Innovation (UKRI) has taken every reasonable precaution to minimise =
risk of this email or any attachments containing viruses or malware but the=
 recipient should carry out its own virus and malware checks before opening=
 the attachments. UKRI does not accept any liability for any losses or dama=
ges which the recipient may sustain due to presence of any viruses.


--_000_LO2P123MB514203FEEAAC521DA226843581179LO2P123MB5142GBRP_
Content-Type: text/html; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

<html xmlns:v=3D"urn:schemas-microsoft-com:vml" xmlns:o=3D"urn:schemas-micr=
osoft-com:office:office" xmlns:w=3D"urn:schemas-microsoft-com:office:word" =
xmlns:m=3D"http://schemas.microsoft.com/office/2004/12/omml" xmlns=3D"http:=
//www.w3.org/TR/REC-html40">
<head>
<meta http-equiv=3D"Content-Type" content=3D"text/html; charset=3Dus-ascii"=
>
<meta name=3D"Generator" content=3D"Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
	{font-family:"Cambria Math";
	panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
	{font-family:Calibri;
	panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
	{margin:0cm;
	font-size:11.0pt;
	font-family:"Calibri",sans-serif;
	mso-fareast-language:EN-US;}
a:link, span.MsoHyperlink
	{mso-style-priority:99;
	color:#0563C1;
	text-decoration:underline;}
span.EmailStyle17
	{mso-style-type:personal-compose;
	font-family:"Calibri",sans-serif;
	color:windowtext;}
.MsoChpDefault
	{mso-style-type:export-only;
	font-family:"Calibri",sans-serif;
	mso-fareast-language:EN-US;}
@page WordSection1
	{size:612.0pt 792.0pt;
	margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
	{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext=3D"edit" spidmax=3D"1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext=3D"edit">
<o:idmap v:ext=3D"edit" data=3D"1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang=3D"EN-GB" link=3D"#0563C1" vlink=3D"#954F72" style=3D"word-wrap:=
break-word">
<div class=3D"WordSection1">
<p class=3D"MsoNormal">Hi,<o:p></o:p></p>
<p class=3D"MsoNormal"><o:p>&nbsp;</o:p></p>
<p class=3D"MsoNormal">Is there a way to do type hints for a generic DBAPI-=
compatible connection and cursor?&nbsp; Our ETL Helper tool uses cx_Oracle,=
 psycopg2 and sqlite3 connections interchangeably and it would be useful to=
 have a generic type instead explicitly
 using the classes from each driver.<o:p></o:p></p>
<p class=3D"MsoNormal"><o:p>&nbsp;</o:p></p>
<p class=3D"MsoNormal">As far as I can see from Google, one way to achieve =
this would by using Protocols, as defined in PEP 544 (<a href=3D"https://pe=
ps.python.org/pep-0544/">https://peps.python.org/pep-0544/</a>).&nbsp; Is t=
here an &#8220;official&#8221; PEP 249 DBA API 2.0 protocol
 anywhere?<br>
<br>
Thanks,<o:p></o:p></p>
<p class=3D"MsoNormal">John<o:p></o:p></p>
<p class=3D"MsoNormal"><o:p>&nbsp;</o:p></p>
<p class=3D"MsoNormal">p.s. ETL Helper is a library we developed to make it=
 easier for our DBAs to use Python to transfer data.
<a href=3D"https://pypi.org/project/etlhelper/">https://pypi.org/project/et=
lhelper/</a><o:p></o:p></p>
</div>
<br>
<br>
This email and any attachments are intended solely for the use of the named=
 recipients. If you are not the intended recipient you must not use, disclo=
se, copy or distribute this email or any of its attachments and should noti=
fy the sender immediately and delete
 this email from your system. UK Research and Innovation (UKRI) has taken e=
very reasonable precaution to minimise risk of this email or any attachment=
s containing viruses or malware but the recipient should carry out its own =
virus and malware checks before
 opening the attachments. UKRI does not accept any liability for any losses=
 or damages which the recipient may sustain due to presence of any viruses.=
<br>
<br>
</body>
</html>

--_000_LO2P123MB514203FEEAAC521DA226843581179LO2P123MB5142GBRP_--

--===============3811690827299570646==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
DB-SIG maillist  -  [email protected]
https://mail.python.org/mailman/listinfo/db-sig

--===============3811690827299570646==--