Detta dokument förklarar hur man dynamiskt kan skriva ut PDF-filer med hjälp av Django-vyer. Detta möjliggörs av det utmärkta PDF-biblioteket ReportLab Python med öppen källkod.
\nFördelen med att generera PDF-filer dynamiskt är att du kan skapa anpassade PDF-filer för olika ändamål, t.ex. för olika användare eller olika delar av innehållet.
\nTill exempel användes Django på kusports.com för att generera anpassade, utskriftsvänliga NCAA-turneringsfästen som PDF-filer för personer som deltog i en March Madness-tävling.
\nReportLab-biblioteket är tillgängligt på PyPI. En användarhandledning (inte av en tillfällighet en PDF-fil) finns också tillgänglig för nedladdning. Du kan installera ReportLab med pip:
Linux / macOS
$ python -m pip install reportlab\nWindows
...\\> py -m pip install reportlab\nTesta din installation genom att importera den i Pythons interaktiva tolk:
\n>>> import reportlab\nOm kommandot inte ger några felmeddelanden har installationen fungerat.
\nNyckeln till att generera PDF-filer dynamiskt med Django är att ReportLab API agerar på filliknande objekt, och Djangos FileResponse-objekt accepterar filliknande objekt.
Här är ett exempel på ”Hello World”:
\nimport io\nfrom django.http import FileResponse\nfrom reportlab.pdfgen import canvas\n\n\ndef some_view(request):\n # Create a file-like buffer to receive PDF data.\n buffer = io.BytesIO()\n\n # Create the PDF object, using the buffer as its "file."\n p = canvas.Canvas(buffer)\n\n # Draw things on the PDF. Here's where the PDF generation happens.\n # See the ReportLab documentation for the full list of functionality.\n p.drawString(100, 100, "Hello world.")\n\n # Close the PDF object cleanly, and we're done.\n p.showPage()\n p.save()\n\n # FileResponse sets the Content-Disposition header so that browsers\n # present the option to save the file.\n buffer.seek(0)\n return FileResponse(buffer, as_attachment=True, filename="hello.pdf")\nKoden och kommentarerna borde vara självförklarande, men det finns några saker som förtjänar att nämnas:
\nSvaret kommer automatiskt att ställa in MIME-typen application/pdf baserat på filnamnstillägget. Detta talar om för webbläsare att dokumentet är en PDF-fil, snarare än en HTML-fil eller ett generiskt binärt innehåll av typen application/octet-stream.
När as_attachment=True skickas till FileResponse, anges lämplig Content-Disposition header och det säger till webbläsare att popa upp en dialogruta som frågar/bekräftar hur dokumentet ska hanteras även om en standard är inställd på maskinen. Om parametern as_attachment utelämnas kommer webbläsarna att hantera PDF-filen med hjälp av det program/plugin som de har konfigurerats för att använda för PDF-filer.
Du kan ange en godtycklig parameter för filnamn. Den kommer att användas av webbläsare i dialogrutan ”Spara som…”.
Du kan koppla in dig på ReportLab API: Samma buffert som skickas som det första argumentet till canvas.Canvas kan matas till FileResponse-klassen.
Observera att alla efterföljande PDF-genereringsmetoder anropas på PDF-objektet (i detta fall p) - inte på buffer.
Slutligen är det viktigt att anropa showPage() och save() på PDF-filen.
Lägg märke till att det inte finns mycket i dessa exempel som är PDF-specifikt - bara de delar som använder reportlab. Du kan använda en liknande teknik för att generera vilket godtyckligt format som helst som du kan hitta ett Python-bibliotek för. Se även Hur man skapar CSV-utdata för ett annat exempel och några tekniker som du kan använda när du genererar textbaserade format.