{"title":"How to create PDF files","version":"5.1","locale":"pt-br","docname":"howto/outputting-pdf","url":"/pt-br/5.1/howto/outputting-pdf/","canonical":"https://djangodocs.dev/pt-br/5.1/howto/outputting-pdf/","summary":"Este documnto explica como gerar arquivos PDF dinamicamente usando “views” Django. Isso é possível através da excelente, biblioteca Python de código-aberto…","html":"<h1>How to create PDF files<a class=\"heading-anchor\" href=\"#how-to-create-pdf-files\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Este documnto explica como gerar arquivos PDF dinamicamente usando “views” Django. Isso é possível através da excelente, biblioteca Python de código-aberto <a class=\"reference external\" href=\"https://docs.reportlab.com/\">RepostLab</a> .</p>\n<p>A vantagem de gerar arquivos PDF dinamicamente é que você pode criar PDFs personalizados para diferentes propósitos – vamos dizer, para diferentes usuários ou diferentes partes de conteúdo.</p>\n<p>Por exemplo, o DJango foi usado no <a class=\"reference external\" href=\"https://www2.kusports.com/\">kusports.com</a> para gerar relatórios personalizados, prontos para impressão, de pontuação de torneio da NCAA, como arquivos PDF, para pessoas que participam do concurso March Madness.</p>\n<section id=\"install-reportlab\">\n<h2>Instalar o ReportLab<a class=\"heading-anchor\" href=\"#install-reportlab\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The ReportLab library is <a class=\"extlink-pypi reference external\" href=\"https://pypi.org/project/reportlab/\">available on PyPI</a>. A <a class=\"reference external\" href=\"https://www.reportlab.com/docs/reportlab-userguide.pdf\">user guide</a>\n(not coincidentally, a PDF file) is also available for download.\nYou can install ReportLab with <code class=\"docutils literal notranslate\"><span class=\"pre\">pip</span></code>:</p>\n<div class=\"console\" data-console><div class=\"console-panel\" data-platform=\"unix\"><p class=\"console-label\" id=\"console-0-unix-label\">Linux / macOS</p><div class=\"code-block\" data-language=\"console\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Shell</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Shell code\"><code><span class=\"gp\">$ </span>python<span class=\"w\"> </span>-m<span class=\"w\"> </span>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>reportlab\n</code></pre></div>\n</div><div class=\"console-panel\" data-platform=\"windows\"><p class=\"console-label\" id=\"console-0-windows-label\">Windows</p><div class=\"code-block\" data-language=\"doscon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Windows</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Windows shell\"><code><span class=\"gp\">...\\&gt;</span> py -m pip install reportlab\n</code></pre></div></div></div>\n<p>Test your installation by importing it in the Python interactive interpreter:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">import</span><span class=\"w\"> </span><span class=\"nn\">reportlab</span>\n</code></pre></div>\n<p>Se o comando não emitir nenhum erro, a instalação funciona.</p>\n</section>\n<section id=\"write-your-view\">\n<h2>Escreva sua “view”<a class=\"heading-anchor\" href=\"#write-your-view\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>A chave para gerar PDFs dinamicamente com Django é que a API do ReportLab atua em objetos tipo arquivo, e objetos da classe do Django <a class=\"reference internal\" href=\"/pt-br/5.1/ref/request-response/#django.http.FileResponse\" title=\"django.http.FileResponse\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">FileResponse</span></code></a> aceitam objetivos tipo arquivo.</p>\n<p>Aqui um exemplo “Hello World”:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">import</span><span class=\"w\"> </span><span class=\"nn\">io</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.http</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">FileResponse</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">reportlab.pdfgen</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">canvas</span>\n\n\n<span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">some_view</span><span class=\"p\">(</span><span class=\"n\">request</span><span class=\"p\">):</span>\n    <span class=\"c1\"># Create a file-like buffer to receive PDF data.</span>\n    <span class=\"n\">buffer</span> <span class=\"o\">=</span> <span class=\"n\">io</span><span class=\"o\">.</span><span class=\"n\">BytesIO</span><span class=\"p\">()</span>\n\n    <span class=\"c1\"># Create the PDF object, using the buffer as its &quot;file.&quot;</span>\n    <span class=\"n\">p</span> <span class=\"o\">=</span> <span class=\"n\">canvas</span><span class=\"o\">.</span><span class=\"n\">Canvas</span><span class=\"p\">(</span><span class=\"n\">buffer</span><span class=\"p\">)</span>\n\n    <span class=\"c1\"># Draw things on the PDF. Here&#39;s where the PDF generation happens.</span>\n    <span class=\"c1\"># See the ReportLab documentation for the full list of functionality.</span>\n    <span class=\"n\">p</span><span class=\"o\">.</span><span class=\"n\">drawString</span><span class=\"p\">(</span><span class=\"mi\">100</span><span class=\"p\">,</span> <span class=\"mi\">100</span><span class=\"p\">,</span> <span class=\"s2\">&quot;Hello world.&quot;</span><span class=\"p\">)</span>\n\n    <span class=\"c1\"># Close the PDF object cleanly, and we&#39;re done.</span>\n    <span class=\"n\">p</span><span class=\"o\">.</span><span class=\"n\">showPage</span><span class=\"p\">()</span>\n    <span class=\"n\">p</span><span class=\"o\">.</span><span class=\"n\">save</span><span class=\"p\">()</span>\n\n    <span class=\"c1\"># FileResponse sets the Content-Disposition header so that browsers</span>\n    <span class=\"c1\"># present the option to save the file.</span>\n    <span class=\"n\">buffer</span><span class=\"o\">.</span><span class=\"n\">seek</span><span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">)</span>\n    <span class=\"k\">return</span> <span class=\"n\">FileResponse</span><span class=\"p\">(</span><span class=\"n\">buffer</span><span class=\"p\">,</span> <span class=\"n\">as_attachment</span><span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span> <span class=\"n\">filename</span><span class=\"o\">=</span><span class=\"s2\">&quot;hello.pdf&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n<p>O código e comentário devem ser auto-explanaveis, mas algumas coisas merecem uma menção.</p>\n<ul class=\"simple\">\n<li><p>The response will automatically set the MIME type <em class=\"mimetype\">application/pdf</em>\nbased on the filename extension. This tells browsers that the document is a\nPDF file, rather than an HTML file or a generic\n<em class=\"mimetype\">application/octet-stream</em> binary content.</p></li>\n<li><p>When <code class=\"docutils literal notranslate\"><span class=\"pre\">as_attachment=True</span></code> is passed to <code class=\"docutils literal notranslate\"><span class=\"pre\">FileResponse</span></code>, it sets the\nappropriate <code class=\"docutils literal notranslate\"><span class=\"pre\">Content-Disposition</span></code> header and that tells web browsers to\npop-up a dialog box prompting/confirming how to handle the document even if a\ndefault is set on the machine. If the <code class=\"docutils literal notranslate\"><span class=\"pre\">as_attachment</span></code> parameter is omitted,\nbrowsers will handle the PDF using whatever program/plugin they’ve been\nconfigured to use for PDFs.</p></li>\n<li><p>Você pode fornecer um parâmetro <code class=\"docutils literal notranslate\"><span class=\"pre\">filename</span></code> arbitrário. Ele será usado para os navegadores na caixa de diálogo “Salvar como…”.</p></li>\n<li><p>You can hook into the ReportLab API: The same buffer passed as the first\nargument to <code class=\"docutils literal notranslate\"><span class=\"pre\">canvas.Canvas</span></code> can be fed to the\n<a class=\"reference internal\" href=\"/pt-br/5.1/ref/request-response/#django.http.FileResponse\" title=\"django.http.FileResponse\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">FileResponse</span></code></a> class.</p></li>\n<li><p>Note que todas os methods de geração de PDF subsequentes são chamados no objeto PDF (nesse caso, <code class=\"docutils literal notranslate\"><span class=\"pre\">p</span></code>) – não no <code class=\"docutils literal notranslate\"><span class=\"pre\">buffer</span></code>.</p></li>\n<li><p>E finalmente, é importante chamar <code class=\"docutils literal notranslate\"><span class=\"pre\">showPage()</span></code> e o  <code class=\"docutils literal notranslate\"><span class=\"pre\">save()</span></code> no arquivo PDF.</p></li>\n</ul>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Nota</p>\n<p>O ReposrtLab não tem mecanismos de segurança para ser usado de maneira concorrente, ou não é thread-safe. Alguns de nossos usuários tem relatado problemas ímpares ao gerar PDF em “views” Django que são acessadas por muitos usuários ao mesmo tempo.</p>\n</aside>\n</section>\n<section id=\"other-formats\">\n<h2>Outros formatos<a class=\"heading-anchor\" href=\"#other-formats\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Note que não tem muito nestes exemplos que seja especificamente sobre PDF – apenas as partes usando <code class=\"docutils literal notranslate\"><span class=\"pre\">reportlab</span></code>. Você pode usar técnicas similares para gerar qualquer outro formato arbitrário para a qual você encontre uma bilioteca Python. Veja também <a class=\"reference internal\" href=\"/pt-br/5.1/howto/outputting-csv/\"><span class=\"doc\">How to create CSV output</span></a> para outro exemplo e algumas técnicas que você pode usar quando quiser gerar fomatos baseados em texto.</p>\n<aside class=\"admonition admonition-seealso\">\n<p class=\"admonition-title\">Ver também</p>\n<p>O Django Packages fornece uma ferramenta para <a class=\"reference external\" href=\"https://djangopackages.org/grids/g/pdf/\">comparação de pacotes</a> que auxiliam a geração de arquivos PDF com o Django</p>\n</aside>\n</section>","rootId":"how-to-create-pdf-files","toc":[{"title":"Instalar o ReportLab","anchor":"install-reportlab","children":[]},{"title":"Escreva sua “view”","anchor":"write-your-view","children":[]},{"title":"Outros formatos","anchor":"other-formats","children":[]}],"breadcrumbs":[{"docname":"howto/index","title":"How-to guides","url":"/pt-br/5.1/howto/"}],"prev":{"docname":"howto/outputting-csv","title":"How to create CSV output","url":"/pt-br/5.1/howto/outputting-csv/"},"next":{"docname":"howto/overriding-templates","title":"How to override templates","url":"/pt-br/5.1/howto/overriding-templates/"},"formats":{"html":"/pt-br/5.1/howto/outputting-pdf/","markdown":"/pt-br/5.1/howto/outputting-pdf.md","json":"/pt-br/5.1/howto/outputting-pdf.json"},"source":"https://github.com/django/django/blob/stable/5.1.x/docs/howto/outputting-pdf.txt","official":"https://docs.djangoproject.com/pt-br/5.1/howto/outputting-pdf/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}