seitime-frappe/frappe/docs/current/api/utils/frappe.utils.file_manager.html
2015-10-29 18:46:04 +05:30

385 lines
No EOL
11 KiB
HTML

<!-- title: frappe.utils.file_manager --><div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.6.1</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/v6.6.1/frappe/utils/file_manager.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<h3 style="font-weight: normal;">Class <b>MaxFileSizeReachedError</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
</div>
<hr>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.check_max_file_size" href="#frappe.utils.file_manager.check_max_file_size" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>check_max_file_size</b>
<i class="text-muted">(content)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.delete_file" href="#frappe.utils.file_manager.delete_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>delete_file</b>
<i class="text-muted">(path)</i>
</p>
<div class="docs-attr-desc"><p>Delete file from <code>public folder</code></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.delete_file_data_content" href="#frappe.utils.file_manager.delete_file_data_content" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>delete_file_data_content</b>
<i class="text-muted">(doc, only_thumbnail=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.delete_file_from_filesystem" href="#frappe.utils.file_manager.delete_file_from_filesystem" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>delete_file_from_filesystem</b>
<i class="text-muted">(doc, only_thumbnail=False)</i>
</p>
<div class="docs-attr-desc"><p>Delete file, thumbnail from File document</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.extract_images_from_doc" href="#frappe.utils.file_manager.extract_images_from_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>extract_images_from_doc</b>
<i class="text-muted">(doc, fieldname)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.extract_images_from_html" href="#frappe.utils.file_manager.extract_images_from_html" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>extract_images_from_html</b>
<i class="text-muted">(doc, content)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_content_hash" href="#frappe.utils.file_manager.get_content_hash" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_content_hash</b>
<i class="text-muted">(content)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_file" href="#frappe.utils.file_manager.get_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_file</b>
<i class="text-muted">(fname)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_file_data_from_hash" href="#frappe.utils.file_manager.get_file_data_from_hash" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_file_data_from_hash</b>
<i class="text-muted">(content_hash)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_file_name" href="#frappe.utils.file_manager.get_file_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_file_name</b>
<i class="text-muted">(fname, optional_suffix)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_file_url" href="#frappe.utils.file_manager.get_file_url" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_file_url</b>
<i class="text-muted">(file_data_name)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_random_filename" href="#frappe.utils.file_manager.get_random_filename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_random_filename</b>
<i class="text-muted">(extn=None, content_type=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.get_uploaded_content" href="#frappe.utils.file_manager.get_uploaded_content" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>get_uploaded_content</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.remove_all" href="#frappe.utils.file_manager.remove_all" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>remove_all</b>
<i class="text-muted">(dt, dn)</i>
</p>
<div class="docs-attr-desc"><p>remove all files in a transaction</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.remove_file" href="#frappe.utils.file_manager.remove_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>remove_file</b>
<i class="text-muted">(fid, attached_to_doctype=None, attached_to_name=None)</i>
</p>
<div class="docs-attr-desc"><p>Remove file and File entry</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.remove_file_by_url" href="#frappe.utils.file_manager.remove_file_by_url" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>remove_file_by_url</b>
<i class="text-muted">(file_url, doctype=None, name=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.save_file" href="#frappe.utils.file_manager.save_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>save_file</b>
<i class="text-muted">(fname, content, dt, dn, folder=None, decode=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.save_file_on_filesystem" href="#frappe.utils.file_manager.save_file_on_filesystem" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>save_file_on_filesystem</b>
<i class="text-muted">(fname, content, content_type=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.save_uploaded" href="#frappe.utils.file_manager.save_uploaded" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>save_uploaded</b>
<i class="text-muted">(dt, dn, folder)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.save_url" href="#frappe.utils.file_manager.save_url" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>save_url</b>
<i class="text-muted">(file_url, dt, dn, folder)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.upload" href="#frappe.utils.file_manager.upload" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>upload</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.file_manager.write_file" href="#frappe.utils.file_manager.write_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.file_manager.<b>write_file</b>
<i class="text-muted">(content, file_path, fname)</i>
</p>
<div class="docs-attr-desc"><p>write file to disk with a random name (to compare)</p>
</div>
<br>
<!-- autodoc -->