Quickstart: Herhaalbare implementaties met het mssql-python-stuurprogramma voor Python

In deze quickstart gebruik je uv om projectafhankelijkheden en omgevingen te beheren voor een Python-script dat verbinding maakt met een database die je hebt gemaakt en met voorbeeldgegevens hebt gevuld. Je gebruikt de mssql-python driver van Python om verbinding te maken met je database en basisbewerkingen uit te voeren, zoals het lezen en schrijven van data.

Het mssql-python stuurprogramma vereist geen externe afhankelijkheden op Windows-computers. Het stuurprogramma installeert alles wat het nodig heeft met één pip installatie, zodat u de nieuwste versie van het stuurprogramma voor nieuwe scripts kunt gebruiken zonder dat andere scripts die u niet hoeft te upgraden en te testen, worden onderbroken.

documentatie | mssql-python-broncode | Pakket (PyPI) | Uv

Vereiste voorwaarden

Installeer vereisten voor het besturingssysteem

Installeer eenmalige vereisten voor het besturingssysteem. Windows-gebruikers kunnen deze stap overslaan. Voor volledige platformdetails, zie Install mssql-python.

apk add libtool krb5-libs krb5-dev libstdc++

Een SQL-database maken

Maak een SQL-database aan of maak verbinding met een van de volgende platforms:

Het project maken en de code uitvoeren

Een nieuw project maken

  1. Open een opdrachtprompt in uw ontwikkelingsmap. Als je er geen hebt, maak dan een nieuwe map aan, zoals python of scripts. Vermijd mappen op je OneDrive, want synchronisatie kan het beheer van je virtuele omgeving verstoren.

  2. Maak een nieuw project met uv.

    uv init mssql-python-repeatable-qs
cd mssql-python-repeatable-qs

Afhankelijkheden toevoegen

Installeer in dezelfde map de mssql-python, python-dotenven rich pakketten.

uv add mssql-python python-dotenv rich

Visual Studio Code starten

Voer in dezelfde map de volgende opdracht uit.

code .

Pyproject.toml bijwerken

  1. Open het pyproject.toml bestand in de editor. Dit bestand bevat de metadata van je project.

  2. Controleer de inhoud van het bestand. Deze moet vergelijkbaar zijn met dit voorbeeld. Let op de Python-versie en afhankelijkheid voor mssql-python; gebruik >= om een minimumversie te definiëren. Als u de voorkeur geeft aan een exacte versie, wijzigt u de >= voor het versienummer in ==. De opgeloste versies van elk pakket worden opgeslagen in uv.lock. Het lockfile zorgt ervoor dat ontwikkelaars die aan het project werken consistente pakketversies gebruiken. Het zorgt er ook voor dat dezelfde set pakketversies wordt gebruikt bij het distribueren van uw pakket naar eindgebruikers. Commit zowel pyproject.toml als uv.lock, bekijk lockfile-wijzigingen in pull requests en voer een door de organisatie goedgekeurde afhankelijkheidsscanner uit in CI. Bewerk het uv.lock bestand niet direct.

    [project]
name = "mssql-python-repeatable-qs"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
    "mssql-python>=1.16.0",
    "python-dotenv>=1.1.1",
    "rich>=14.1.0",
]

  3. Werk de description waarde bij.

    description = "Connects to a SQL database using mssql-python"

  4. Sla het bestand op en sluit het.

Main.py bijwerken

  1. Open het bestand met de naam main.py. Deze moet vergelijkbaar zijn met dit voorbeeld.

    def main():
    print("Hello from mssql-python-repeatable-qs!")

if __name__ == "__main__":
    main()

  2. Voeg bovenaan het bestand de volgende imports toe vóór de regel met def main().

    Aanbeveling

    Als Visual Studio Code problemen ondervindt bij het oplossen van pakketten, moet u de interpreter bijwerken om de virtuele omgeving te gebruiken.

    from os import getenv
from dotenv import load_dotenv
from mssql_python import connect, Connection, Cursor
from rich.console import Console
from rich.progress import Progress, SpinnerColumn, TextColumn
from rich.table import Table
from argparse import ArgumentParser
from time import sleep

  3. Voeg tussen de importbewerkingen en de regel met def main()de volgende code toe.

    def get_results(sleep_time: int = 0) -> None:
    with Progress(
        SpinnerColumn(),
        TextColumn("[progress.description]{task.description}"),
        transient=True,
    ) as progress:
        task = progress.add_task(description="Connecting to SQL...")

        cursor = query_sql()

        # Simulate a slow connection for demo purposes
        sleep(sleep_time)

        progress.update(task, description="Formatting results...")

        table = Table(title="Orders by Customer")
        # https://rich.readthedocs.io/en/stable/appendix/colors.html
        table.add_column("Customer ID", style="bright_blue", justify="center")
        table.add_column("Company Name", style="bright_white", justify="left")
        table.add_column("Order Count", style="bold green", justify="right")

        records = cursor.fetchall()
        for r in records:
            table.add_row(f"{r.CustomerID}", f"{r.CompanyName}", f"{r.OrderCount}")

        if cursor:
            cursor.close()

        # Simulate a slow connection for demo purposes
        sleep(sleep_time)

        progress.stop()

        Console().print(table)

  4. Voeg deze code toe tussen de imports en def get_results(sleep_time: int = 0) -> None:.

    _connection = None

def get_connection() -> Connection:
    global _connection
    if not _connection:
        load_dotenv()
        _connection = connect(getenv("SQL_CONNECTION_STRING"))  # type: ignore
    return _connection

def query_sql() -> Cursor:
    SQL_QUERY = """
    SELECT TOP 5
        c.CustomerID,
        c.CompanyName,
        COUNT(soh.SalesOrderID) AS OrderCount
    FROM SalesLT.Customer AS c
    LEFT OUTER JOIN SalesLT.SalesOrderHeader AS soh
        ON c.CustomerID = soh.CustomerID
    GROUP BY
        c.CustomerID,
        c.CompanyName
    ORDER BY OrderCount DESC;
    """

    conn = get_connection()
    cursor = conn.cursor()
    cursor.execute(SQL_QUERY)
    return cursor

  5. Zoek deze code.

    def main():
    print("Hello from mssql-python-repeatable-qs!")

  6. Vervang deze door deze code.

    def main() -> None:
    parser = ArgumentParser()
    parser.add_argument("--sleep-time", type=int, default=0,
                        help="Time to sleep in seconds to simulate slow connection")
    args = parser.parse_args()

    if args.sleep_time > 0:
        get_results(args.sleep_time)
    else:
        get_results()

    if _connection:
        _connection.close()

  7. Opslaan en sluiten main.py.

De verbindingsreeks opslaan

  1. Open het .gitignore bestand en voeg een uitsluiting toe voor .env bestanden. Je dossier zou vergelijkbaar moeten zijn met het volgende voorbeeld.

    # Python-generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info

# Virtual environments
.venv

# Connection strings and secrets
.env

  2. Opslaan en sluiten .gitignore.

  3. Maak in de huidige map een nieuw bestand met de naam .env.

  4. Voeg in het .env bestand een vermelding toe voor de verbindingsreeks met de naam SQL_CONNECTION_STRING. Vervang de tijdelijke aanduidingen door de werkelijke waarden.

    SQL_CONNECTION_STRING="Server=<server>;Database=<database>;Encrypt=yes;TrustServerCertificate=no;Authentication=ActiveDirectoryInteractive"

    Important

    Blijf .env lokaal en buiten bronbeheer. Voor CI en gedeployte omgevingen injecteer je de verbindingsreeks of de componentgeheimen ervan uit je platformgeheime opslag in plaats van te kopiëren .env tussen machines.

    De verbindingsreeks hangt af van het type SQL-database waarmee je verbinding maakt. Voor Azure SQL Database of SQL Database in Fabric gebruik je de ODBC-verbindingsreeks van het tabblad verbindingsreekss en pas je het authenticatietype aan voor jouw situatie. Voor meer informatie over de syntaxis van verbindingsreeks, zie Connection strings voor mssql-python.

    Aanbeveling

    In macOS werken beide ActiveDirectoryInteractive en ActiveDirectoryDefault voor Microsoft Entra-verificatie. ActiveDirectoryInteractive u wordt gevraagd u aan te melden telkens wanneer u het script uitvoert. Om herhaalde aanmeldprompts te vermijden, log je één keer in met het Azure CLI-commandoaz login en gebruik je ActiveDirectoryDefault. ActiveDirectoryDefault Hergebruikt de gecachte inloggegevens.

Gebruik uv run om het script uit te voeren

  1. Voer in het terminalvenster van vóór, of een nieuw terminalvenster dat is geopend in dezelfde map, de volgende opdracht uit.

    uv run main.py

  2. Voer het script opnieuw uit met vertraging zodat je beide statusupdates kunt zien.

    uv run main.py --sleep-time 5

    Dit is de verwachte uitvoer wanneer het script is voltooid.

                             Orders by Customer
┏━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃ Customer ID ┃ Company Name                   ┃ Order Count ┃
┡━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│    29485    │ Professional Sales and Service │           1 │
│    29531    │ Remarkable Bike Store          │           1 │
│    29546    │ Bulk Discount Store            │           1 │
│    29568    │ Coalition Bike Company         │           1 │
│    29584    │ Futuristic Bikes               │           1 │
└─────────────┴────────────────────────────────┴─────────────┘

  3. Om je script naar een andere machine te deployen, kopieer je de projectbestanden, inclusief pyproject.toml en uv.lock, maar niet de .venv map of een lokaal .env bestand. Creëer de virtuele omgeving bij de eerste uitvoering opnieuw en lever geheimen aan via de doelomgeving.

Verwante onderwerpen

  • Laatst bijgewerkt om