seitime-frappe/frappe/docs/current/api/utils/frappe.utils.html
Ashish Acharya c651ed05fa Sync images
2015-12-01 12:33:47 +05:30

727 lines
No EOL
18 KiB
HTML

<!-- title: frappe.utils --><div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.10.1</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/utils.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p class="docs-attr-name">
<a name="frappe.utils.call_hook_method" href="#frappe.utils.call_hook_method" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>call_hook_method</b>
<i class="text-muted">(hook)</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.decode_dict" href="#frappe.utils.decode_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>decode_dict</b>
<i class="text-muted">(d, encoding=utf-8)</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.dict_to_str" href="#frappe.utils.dict_to_str" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>dict_to_str</b>
<i class="text-muted">(args, sep=&)</i>
</p>
<div class="docs-attr-desc"><p>Converts a dictionary to URL</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.encode_dict" href="#frappe.utils.encode_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>encode_dict</b>
<i class="text-muted">(d, encoding=utf-8)</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.esc" href="#frappe.utils.esc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>esc</b>
<i class="text-muted">(s, esc_chars)</i>
</p>
<div class="docs-attr-desc"><p>Escape special characters</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.execute_in_shell" href="#frappe.utils.execute_in_shell" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>execute_in_shell</b>
<i class="text-muted">(cmd, verbose=0)</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.extract_email_id" href="#frappe.utils.extract_email_id" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>extract_email_id</b>
<i class="text-muted">(email)</i>
</p>
<div class="docs-attr-desc"><p>fetch only the email part of the email id</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.getCSVelement" href="#frappe.utils.getCSVelement" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>getCSVelement</b>
<i class="text-muted">(v)</i>
</p>
<div class="docs-attr-desc"><p>Returns the CSV value of <code>v</code>, For example:</p>
<ul>
<li>apple becomes "apple"</li>
<li>hi"there becomes "hi""there"</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_backups_path" href="#frappe.utils.get_backups_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_backups_path</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.get_bench_path" href="#frappe.utils.get_bench_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_bench_path</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.get_common" href="#frappe.utils.get_common" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_common</b>
<i class="text-muted">(d1, d2)</i>
</p>
<div class="docs-attr-desc"><p>returns (list of keys) the common part of two dicts</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_common_dict" href="#frappe.utils.get_common_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_common_dict</b>
<i class="text-muted">(d1, d2)</i>
</p>
<div class="docs-attr-desc"><p>return common dictionary of d1 and d2</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_defaults" href="#frappe.utils.get_defaults" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_defaults</b>
<i class="text-muted">(key=None)</i>
</p>
<div class="docs-attr-desc"><p>Get dictionary of default values from the defaults, or a value if key is passed</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_diff_dict" href="#frappe.utils.get_diff_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_diff_dict</b>
<i class="text-muted">(d1, d2)</i>
</p>
<div class="docs-attr-desc"><p>return common dictionary of d1 and d2</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_disk_usage" href="#frappe.utils.get_disk_usage" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_disk_usage</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>get disk usage of files folder</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_file_timestamp" href="#frappe.utils.get_file_timestamp" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_file_timestamp</b>
<i class="text-muted">(fn)</i>
</p>
<div class="docs-attr-desc"><p>Returns timestamp of the given file</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_files_path" href="#frappe.utils.get_files_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_files_path</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.get_formatted_email" href="#frappe.utils.get_formatted_email" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_formatted_email</b>
<i class="text-muted">(user)</i>
</p>
<div class="docs-attr-desc"><p>get email id of user formatted as: John Doe <a href="m&#97;i&#108;&#x74;&#111;&#x3a;j&#111;&#x68;&#110;&#x64;&#x6f;&#x65;&#x40;e&#x78;&#97;&#109;&#x70;&#x6c;&#101;&#46;&#x63;&#111;&#x6d;">j&#111;&#x68;&#110;&#x64;&#x6f;&#x65;&#x40;e&#x78;&#97;&#109;&#x70;&#x6c;&#101;&#46;&#x63;&#111;&#x6d;</a></p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_fullname" href="#frappe.utils.get_fullname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_fullname</b>
<i class="text-muted">(user=None)</i>
</p>
<div class="docs-attr-desc"><p>get the full name (first name + last name) of the user from User</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.get_gravatar" href="#frappe.utils.get_gravatar" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_gravatar</b>
<i class="text-muted">(email)</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.get_hook_method" href="#frappe.utils.get_hook_method" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_hook_method</b>
<i class="text-muted">(hook_name, fallback=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.get_html_format" href="#frappe.utils.get_html_format" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_html_format</b>
<i class="text-muted">(print_path)</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.get_path" href="#frappe.utils.get_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_path</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.get_request_session" href="#frappe.utils.get_request_session" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_request_session</b>
<i class="text-muted">(max_retries=3)</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.get_request_site_address" href="#frappe.utils.get_request_site_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_request_site_address</b>
<i class="text-muted">(full_address=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.get_site_base_path" href="#frappe.utils.get_site_base_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_site_base_path</b>
<i class="text-muted">(sites_dir=None, hostname=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.get_site_name" href="#frappe.utils.get_site_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_site_name</b>
<i class="text-muted">(hostname)</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.get_site_path" href="#frappe.utils.get_site_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_site_path</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.get_sites" href="#frappe.utils.get_sites" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_sites</b>
<i class="text-muted">(sites_path=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.get_test_client" href="#frappe.utils.get_test_client" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_test_client</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.get_traceback" href="#frappe.utils.get_traceback" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_traceback</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns the traceback of the Exception</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.is_markdown" href="#frappe.utils.is_markdown" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>is_markdown</b>
<i class="text-muted">(text)</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.log" href="#frappe.utils.log" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>log</b>
<i class="text-muted">(event, details)</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.make_esc" href="#frappe.utils.make_esc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>make_esc</b>
<i class="text-muted">(esc_chars)</i>
</p>
<div class="docs-attr-desc"><p>Function generator for Escaping special characters</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.pprint_dict" href="#frappe.utils.pprint_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>pprint_dict</b>
<i class="text-muted">(d, level=1, no_blanks=True)</i>
</p>
<div class="docs-attr-desc"><p>Pretty print a dictionary with indents</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.random_string" href="#frappe.utils.random_string" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>random_string</b>
<i class="text-muted">(length)</i>
</p>
<div class="docs-attr-desc"><p>generate a random string</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.remove_blanks" href="#frappe.utils.remove_blanks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>remove_blanks</b>
<i class="text-muted">(d)</i>
</p>
<div class="docs-attr-desc"><p>Returns d with empty ('' or None) values stripped</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.set_default" href="#frappe.utils.set_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>set_default</b>
<i class="text-muted">(key, val)</i>
</p>
<div class="docs-attr-desc"><p>Set / add a default value to defaults`</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.split_emails" href="#frappe.utils.split_emails" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>split_emails</b>
<i class="text-muted">(txt)</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.strip_html_tags" href="#frappe.utils.strip_html_tags" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>strip_html_tags</b>
<i class="text-muted">(text)</i>
</p>
<div class="docs-attr-desc"><p>Remove html tags from text</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.touch_file" href="#frappe.utils.touch_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>touch_file</b>
<i class="text-muted">(path)</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.unesc" href="#frappe.utils.unesc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>unesc</b>
<i class="text-muted">(s, esc_chars)</i>
</p>
<div class="docs-attr-desc"><p>UnEscape special characters</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.utils.update_progress_bar" href="#frappe.utils.update_progress_bar" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>update_progress_bar</b>
<i class="text-muted">(txt, i, l)</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.validate_email_add" href="#frappe.utils.validate_email_add" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>validate_email_add</b>
<i class="text-muted">(email_str, throw=False)</i>
</p>
<div class="docs-attr-desc"><p>Validates the email string</p>
</div>
<br>
<!-- autodoc -->