{"title":"Cómo escribir una clase de almacenamiento personalizada","version":"5.2","locale":"es","docname":"howto/custom-file-storage","url":"/es/5.2/howto/custom-file-storage/","canonical":"https://djangodocs.dev/es/5.2/howto/custom-file-storage/","summary":"Si necesita proporcionar un almacenamiento de archivos personalizado -un ejemplo común es almacenar archivos en algún sistema de archivos remoto- puede hacerlo…","html":"<h1>Cómo escribir una clase de almacenamiento personalizada<a class=\"heading-anchor\" href=\"#how-to-write-a-custom-storage-class\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Si necesita proporcionar un almacenamiento de archivos personalizado -un ejemplo común es almacenar archivos en algún sistema de archivos remoto- puede hacerlo definiendo una clase de almacenamiento personalizada. Deberá seguir estos pasos:</p>\n<ol class=\"arabic\">\n<li><p>Su sistema de almacenamiento personalizado debe heredar de <code class=\"docutils literal notranslate\"><span class=\"pre\">django.core.files.storage.Storage</span></code>:</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\">from</span><span class=\"w\"> </span><span class=\"nn\">django.core.files.storage</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">Storage</span>\n\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">MyStorage</span><span class=\"p\">(</span><span class=\"n\">Storage</span><span class=\"p\">):</span> <span class=\"o\">...</span>\n</code></pre></div>\n</li>\n<li><p>Django debe ser capaz de crear una instancia de tu sistema de almacenamiento sin pasarle argumentos. Esto significa que cualquier ajuste debe ser tomado de <code class=\"docutils literal notranslate\"><span class=\"pre\">django.conf.settings</span></code>:</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\">from</span><span class=\"w\"> </span><span class=\"nn\">django.conf</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">settings</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.core.files.storage</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">Storage</span>\n\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">MyStorage</span><span class=\"p\">(</span><span class=\"n\">Storage</span><span class=\"p\">):</span>\n    <span class=\"k\">def</span><span class=\"w\"> </span><span class=\"fm\">__init__</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">,</span> <span class=\"n\">option</span><span class=\"o\">=</span><span class=\"kc\">None</span><span class=\"p\">):</span>\n        <span class=\"k\">if</span> <span class=\"ow\">not</span> <span class=\"n\">option</span><span class=\"p\">:</span>\n            <span class=\"n\">option</span> <span class=\"o\">=</span> <span class=\"n\">settings</span><span class=\"o\">.</span><span class=\"n\">CUSTOM_STORAGE_OPTIONS</span>\n        <span class=\"o\">...</span>\n</code></pre></div>\n</li>\n<li><p>La clase de almacenamiento deberá implementar los métodos <a class=\"reference internal\" href=\"#django.core.files.storage._open\" title=\"django.core.files.storage._open\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">_open()</span></code></a> y <a class=\"reference internal\" href=\"#django.core.files.storage._save\" title=\"django.core.files.storage._save\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">_save()</span></code></a>, junto con cualquier otro método apropiado para tu clase de almacenamiento. Consulte a continuación para obtener más información sobre estos métodos.</p>\n<p>Adicionalmente, si su clase proporciona almacenamiento local de archivos, debe redefinir el método <code class=\"docutils literal notranslate\"><span class=\"pre\">path()</span></code>.</p>\n</li>\n<li><p>La clase de almacenamiento debe ser <a class=\"reference internal\" href=\"/es/5.2/topics/migrations/#custom-deconstruct-method\"><span class=\"std std-ref\">deconstruible</span></a> para que pueda ser serializada al usarse en un campo en una migración. Siempre y cuando el campo tenga argumentos que sean <a class=\"reference internal\" href=\"/es/5.2/topics/migrations/#migration-serializing\"><span class=\"std std-ref\">serializables</span></a> por sí mismos, puedes usar el decorador de clase <code class=\"docutils literal notranslate\"><span class=\"pre\">django.utils.deconstruct.deconstructible</span></code> con este propósito (es lo que Django usa en FileSystemStorage).</p></li>\n</ol>\n<p>Por defecto, los siguientes métodos generan <code class=\"docutils literal notranslate\"><span class=\"pre\">NotImplementedError</span></code> y normalmente tienen que ser redefinidos:</p>\n<ul class=\"simple\">\n<li><p><a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.Storage.delete\" title=\"django.core.files.storage.Storage.delete\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Storage.delete()</span></code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.Storage.exists\" title=\"django.core.files.storage.Storage.exists\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Storage.exists()</span></code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.Storage.listdir\" title=\"django.core.files.storage.Storage.listdir\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Storage.listdir()</span></code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.Storage.size\" title=\"django.core.files.storage.Storage.size\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Storage.size()</span></code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.Storage.url\" title=\"django.core.files.storage.Storage.url\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Storage.url()</span></code></a></p></li>\n</ul>\n<p>Nóte sin embargo que no todos estos métodos son requeridos y pueden ser omitidos. Como suele ocurrir, es posible dejar cada método sin ser implementado y tener un Storage funcional.</p>\n<p>A modo de ejemplo, si listar los contenidos de ciertos backends de almacenamiento se vuelve costoso, puedes decidir no implementar `` Storage.listdir () “”.</p>\n<p>Otro ejemplo sería un backend que solo contemple la escritura de archivos. En este caso, no necesitaría implementar ninguno de los métodos de arriba.</p>\n<p>Por último, la implementación de estos métodos depende de usted. Dejar algunos métodos sin implementar darían una interfaz (posiblemente rota) parcial.</p>\n<p>Por lo general, también querrá utilizar hooks diseñados específicamente para objetos de almacenamiento personalizado. Estos son:</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.core.files.storage._open\">\n<span class=\"sig-name descname\"><span class=\"pre\">_open</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">name</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">mode</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">'rb'</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.core.files.storage._open\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p><strong>Requerido</strong></p>\n<p>Llamado por <code class=\"docutils literal notranslate\"><span class=\"pre\">Storage.open()</span></code>, este es el verdadero mecanismo que utiliza la clase de almacenamiento para abrir el archivo. Esto debería retornar un objeto <code class=\"docutils literal notranslate\"><span class=\"pre\">File</span></code>, aunque en la mayoría de casos, querrás retornar alguna subclases aquí que implemente una lógica específica para el sistema de almacenamiento backend. La excepción <a class=\"reference external\" href=\"https://docs.python.org/3/library/exceptions.html#FileNotFoundError\" title=\"(en Python versión 3.14)\"><code class=\"xref py py-exc docutils literal notranslate\"><span class=\"pre\">FileNotFoundError</span></code></a> debería generarse cuando un archivo no existe.</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.core.files.storage._save\">\n<span class=\"sig-name descname\"><span class=\"pre\">_save</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">name</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">content</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.core.files.storage._save\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Llamado por <code class=\"docutils literal notranslate\"><span class=\"pre\">Storage.save()</span></code>. El <code class=\"docutils literal notranslate\"><span class=\"pre\">name</span></code> ya habrá pasado por <code class=\"docutils literal notranslate\"><span class=\"pre\">get_valid_name()</span></code> y <code class=\"docutils literal notranslate\"><span class=\"pre\">get_available_name()</span></code>, y el content` será un objeto <code class=\"docutils literal notranslate\"><span class=\"pre\">File</span></code> por sí mismo.</p>\n<p>Debe devolver el nombre real del archivo guardado (generalmente el <code class=\"docutils literal notranslate\"><span class=\"pre\">nombre</span></code> ingresado, pero si el almacenamiento necesita cambiar el nombre del archivo, devuelve el nuevo nombre).</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.core.files.storage.get_valid_name\">\n<span class=\"sig-name descname\"><span class=\"pre\">get_valid_name</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">name</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.core.files.storage.get_valid_name\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Devuelve un nombre de archivo adecuado para su uso con el sistema de almacenamiento subyacente. El argumento <code class=\"docutils literal notranslate\"><span class=\"pre\">name</span></code> pasado a este método es el nombre de archivo original enviado al servidor o, si <code class=\"docutils literal notranslate\"><span class=\"pre\">upload_to</span></code> es invocable, el nombre de archivo devuelto por ese método después de eliminar cualquier información de ruta. Redefina esto para personalizar cómo se convierten los caracteres no estándar en nombres de archivos seguros.</p>\n<p>El código proporcionado en <code class=\"docutils literal notranslate\"><span class=\"pre\">Storage</span></code> conserva sólo caracteres alfanuméricos, puntos y guiones bajos del nombre de archivo original, eliminando todo lo demás.</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.core.files.storage.get_alternative_name\">\n<span class=\"sig-name descname\"><span class=\"pre\">get_alternative_name</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">file_root</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">file_ext</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.core.files.storage.get_alternative_name\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Devuelve un nombre de archivo alternativo basado en los parámetros <code class=\"docutils literal notranslate\"><span class=\"pre\">file_root</span></code> y <code class=\"docutils literal notranslate\"><span class=\"pre\">file_ext</span></code>. De forma predeterminada, se agrega un guión bajo más una cadena alfanumérica aleatoria de 7 caracteres al nombre del archivo antes de la extensión.</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.core.files.storage.get_available_name\">\n<span class=\"sig-name descname\"><span class=\"pre\">get_available_name</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">name</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">max_length</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.core.files.storage.get_available_name\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Devuelve un nombre de archivo que está disponible en el mecanismo de almacenamiento, posiblemente teniendo en cuenta el nombre de archivo proporcionado. El argumento <code class=\"docutils literal notranslate\"><span class=\"pre\">name</span></code> pasado a este método ya se habrá limpiado a un nombre de archivo válido para el sistema de almacenamiento, de acuerdo con el método <code class=\"docutils literal notranslate\"><span class=\"pre\">get_valid_name()</span></code> descrito anteriormente.</p>\n<p>La longitud del nombre del archivo no excederá <code class=\"docutils literal notranslate\"><span class=\"pre\">max_length</span></code>, si se proporciona. Si no se puede encontrar un nombre de archivo único y disponible, se genera una excepción <a class=\"reference internal\" href=\"/es/5.2/ref/exceptions/#django.core.exceptions.SuspiciousOperation\" title=\"django.core.exceptions.SuspiciousOperation\"><code class=\"xref py py-exc docutils literal notranslate\"><span class=\"pre\">SuspiciousFileOperation</span></code></a>.</p>\n<p>Si ya existe un archivo con <code class=\"docutils literal notranslate\"><span class=\"pre\">nombre</span></code>, se llama a <code class=\"docutils literal notranslate\"><span class=\"pre\">get_alternative_name()</span></code> para obtener un nombre alternativo.</p>\n<section id=\"use-your-custom-storage-engine\">\n<span id=\"using-custom-storage-engine\"></span><h2>Utilice su motor de almacenamiento personalizado<a class=\"heading-anchor\" href=\"#use-your-custom-storage-engine\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>El primer paso para usar un almacenamiento personalizado es indicarle a Django el backend de almacenamientos de archivo que se usará. Esto se hace a través del parámetro <a class=\"reference internal\" href=\"/es/5.2/ref/settings/#std-setting-STORAGES\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">STORAGES</span></code></a> de la configuración. Este parámetro mapea los aliases del almacenamiento, que es una forma de relacionar un almacenamiento específico dentro de Django a un diccionario de configuraciones para el backend de almacenamiento específico. Los parámetros para dicho diccionario están descritos en su totalidad en la documentación <a class=\"reference internal\" href=\"/es/5.2/ref/settings/#std-setting-STORAGES\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">STORAGES</span></code></a></p>\n<p>Storages are then accessed by alias from the\n<a class=\"reference internal\" href=\"/es/5.2/ref/files/storage/#django.core.files.storage.storages\" title=\"django.core.files.storage.storages\"><code class=\"xref py py-data docutils literal notranslate\"><span class=\"pre\">django.core.files.storage.storages</span></code></a> dictionary:</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\">from</span><span class=\"w\"> </span><span class=\"nn\">django.core.files.storage</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">storages</span>\n\n<span class=\"n\">example_storage</span> <span class=\"o\">=</span> <span class=\"n\">storages</span><span class=\"p\">[</span><span class=\"s2\">&quot;example&quot;</span><span class=\"p\">]</span>\n</code></pre></div>\n</section>","rootId":"how-to-write-a-custom-storage-class","toc":[{"title":"Utilice su motor de almacenamiento personalizado","anchor":"use-your-custom-storage-engine","children":[]}],"breadcrumbs":[{"docname":"howto/index","title":"How-to guides","url":"/es/5.2/howto/"}],"prev":{"docname":"howto/csrf","title":"Cómo utilizar la protección CSRF de Django","url":"/es/5.2/howto/csrf/"},"next":{"docname":"howto/custom-management-commands","title":"How to create custom django-admin commands","url":"/es/5.2/howto/custom-management-commands/"},"formats":{"html":"/es/5.2/howto/custom-file-storage/","markdown":"/es/5.2/howto/custom-file-storage.md","json":"/es/5.2/howto/custom-file-storage.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/howto/custom-file-storage.txt","official":"https://docs.djangoproject.com/es/5.2/howto/custom-file-storage/","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","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}