seitime-frappe/frappe/docs/current/api/frappe.translate.html

<!-- title: frappe.translate --><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/translate.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.translate._get_messages_from_page_or_report" href="#frappe.translate._get_messages_from_page_or_report" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>_get_messages_from_page_or_report</b>
        <i class="text-muted">(doctype, name, module=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.translate.add_lang_dict" href="#frappe.translate.add_lang_dict" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>add_lang_dict</b>
        <i class="text-muted">(code)</i>
    </p>
	<div class="docs-attr-desc"><p>Extracts messages and returns Javascript code snippet to be appened at the end
of the given script</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>code</code></strong> -  Javascript code snippet to which translations needs to be appended.</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.clear_cache" href="#frappe.translate.clear_cache" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>clear_cache</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>Clear all translation assets from :meth:<code>frappe.cache</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.deduplicate_messages" href="#frappe.translate.deduplicate_messages" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>deduplicate_messages</b>
        <i class="text-muted">(messages)</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.translate.extract_messages_from_code" href="#frappe.translate.extract_messages_from_code" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>extract_messages_from_code</b>
        <i class="text-muted">(code, is_py=False)</i>
    </p>
	<div class="docs-attr-desc"><p>Extracts translatable srings from a code file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>code</code></strong> -  code from which translatable files are to be extracted</li>
<li><strong><code>is_py</code></strong> -  include messages in triple quotes e.g. <code>_('''message''')</code></li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_all_languages" href="#frappe.translate.get_all_languages" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_all_languages</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all language codes ar, ch etc</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_all_messages_from_js_files" href="#frappe.translate.get_all_messages_from_js_files" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_all_messages_from_js_files</b>
        <i class="text-muted">(app_name=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Extracts all translatable strings from app <code>.js</code> files</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_bench_dir" href="#frappe.translate.get_bench_dir" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_bench_dir</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.translate.get_dict" href="#frappe.translate.get_dict" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_dict</b>
        <i class="text-muted">(fortype, name=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns translation dict for a type of object.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fortype</code></strong> -  must be one of <code>doctype</code>, <code>page</code>, <code>report</code>, <code>include</code>, <code>jsfile</code>, <code>boot</code></li>
<li><strong><code>name</code></strong> -  name of the document for which assets are to be returned.</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_dict_from_hooks" href="#frappe.translate.get_dict_from_hooks" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_dict_from_hooks</b>
        <i class="text-muted">(fortype, 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.translate.get_full_dict" href="#frappe.translate.get_full_dict" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_full_dict</b>
        <i class="text-muted">(lang)</i>
    </p>
	<div class="docs-attr-desc"><p>Load and return the entire translations dictionary for a language from :meth:<code>frape.cache</code></p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> -  Language Code, e.g. <code>hi</code></li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_lang_dict" href="#frappe.translate.get_lang_dict" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_lang_dict</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all languages in dict format, full name is the key e.g. <code>{"english":"en"}</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_lang_info" href="#frappe.translate.get_lang_info" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_lang_info</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>Returns a listified version of <code>apps/languages.txt</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_lang_js" href="#frappe.translate.get_lang_js" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_lang_js</b>
        <i class="text-muted">(fortype, name)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns code snippet to be appended at the end of a JS script.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fortype</code></strong> -  Type of object, e.g. <code>DocType</code></li>
<li><strong><code>name</code></strong> -  Document name</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_language_from_code" href="#frappe.translate.get_language_from_code" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_language_from_code</b>
        <i class="text-muted">(lang)</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.translate.get_messages_for_app" href="#frappe.translate.get_messages_for_app" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_for_app</b>
        <i class="text-muted">(app)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all messages (list) for a specified <code>app</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_messages_from_doctype" href="#frappe.translate.get_messages_from_doctype" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_from_doctype</b>
        <i class="text-muted">(name)</i>
    </p>
	<div class="docs-attr-desc"><p>Extract all translatable messages for a doctype. Includes labels, Python code,
Javascript code, html templates</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_messages_from_file" href="#frappe.translate.get_messages_from_file" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_from_file</b>
        <i class="text-muted">(path)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns a list of transatable strings from a code file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> -  path of the code file</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_messages_from_include_files" href="#frappe.translate.get_messages_from_include_files" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_from_include_files</b>
        <i class="text-muted">(app_name=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns messages from js files included at time of boot like desk.min.js for desk and web</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_messages_from_page" href="#frappe.translate.get_messages_from_page" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_from_page</b>
        <i class="text-muted">(name)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all translatable strings from a :class:<code>frappe.core.doctype.Page</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_messages_from_report" href="#frappe.translate.get_messages_from_report" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_messages_from_report</b>
        <i class="text-muted">(name)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all translatable strings from a :class:<code>frappe.core.doctype.Report</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_server_messages" href="#frappe.translate.get_server_messages" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_server_messages</b>
        <i class="text-muted">(app)</i>
    </p>
	<div class="docs-attr-desc"><p>Extracts all translatable strings (tagged with :func:<code>frappe._</code>) from Python modules inside an app</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_untranslated" href="#frappe.translate.get_untranslated" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_untranslated</b>
        <i class="text-muted">(lang, untranslated_file, get_all=False)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns all untranslated strings for a language and writes in a file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> -  Language code.</li>
<li><strong><code>untranslated_file</code></strong> -  Output file path.</li>
<li><strong><code>get_all</code></strong> -  Return all strings, translated or not.</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.get_user_lang" href="#frappe.translate.get_user_lang" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>get_user_lang</b>
        <i class="text-muted">(user=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Set frappe.local.lang from user preferences on session beginning or resumption</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.guess_language" href="#frappe.translate.guess_language" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>guess_language</b>
        <i class="text-muted">(lang_list=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Set <code>frappe.local.lang</code> from HTTP headers at beginning of request</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.is_translatable" href="#frappe.translate.is_translatable" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>is_translatable</b>
        <i class="text-muted">(m)</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.translate.load_lang" href="#frappe.translate.load_lang" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>load_lang</b>
        <i class="text-muted">(lang, apps=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Combine all translations from <code>.csv</code> files in all <code>apps</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.make_dict_from_messages" href="#frappe.translate.make_dict_from_messages" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>make_dict_from_messages</b>
        <i class="text-muted">(messages, full_dict=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns translated messages as a dict in Language specified in <code>frappe.local.lang</code></p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>messages</code></strong> -  List of untranslated messages</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.pos_to_line_no" href="#frappe.translate.pos_to_line_no" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>pos_to_line_no</b>
        <i class="text-muted">(messages, code)</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.translate.read_csv_file" href="#frappe.translate.read_csv_file" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>read_csv_file</b>
        <i class="text-muted">(path)</i>
    </p>
	<div class="docs-attr-desc"><p>Read CSV file and return as list of list</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> -  File path</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.rebuild_all_translation_files" href="#frappe.translate.rebuild_all_translation_files" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>rebuild_all_translation_files</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>Rebuild all translation files: <code>[app]/translations/[lang].csv</code>.</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.rename_language" href="#frappe.translate.rename_language" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>rename_language</b>
        <i class="text-muted">(old_name, new_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.translate.send_translations" href="#frappe.translate.send_translations" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>send_translations</b>
        <i class="text-muted">(translation_dict)</i>
    </p>
	<div class="docs-attr-desc"><p>Append translated dict in <code>frappe.local.response</code></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.set_default_language" href="#frappe.translate.set_default_language" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>set_default_language</b>
        <i class="text-muted">(language)</i>
    </p>
	<div class="docs-attr-desc"><p>Set Global default language</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.update_translations" href="#frappe.translate.update_translations" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>update_translations</b>
        <i class="text-muted">(lang, untranslated_file, translated_file)</i>
    </p>
	<div class="docs-attr-desc"><p>Update translations from a source and target file for a given language.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> -  Language code (e.g. <code>en</code>).</li>
<li><strong><code>untranslated_file</code></strong> -  File path with the messages in English.</li>
<li><strong><code>translated_file</code></strong> -  File path with messages in language to be updated.</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.write_csv_file" href="#frappe.translate.write_csv_file" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>write_csv_file</b>
        <i class="text-muted">(path, app_messages, lang_dict)</i>
    </p>
	<div class="docs-attr-desc"><p>Write translation CSV file.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> -  File path, usually <code>[app]/translations</code>.</li>
<li><strong><code>app_messages</code></strong> -  Translatable strings for this app.</li>
<li><strong><code>lang_dict</code></strong> -  Full translated dict.</li>
</ul>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.translate.write_translations_file" href="#frappe.translate.write_translations_file" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.translate.<b>write_translations_file</b>
        <i class="text-muted">(app, lang, full_dict=None, app_messages=None)</i>
    </p>
	<div class="docs-attr-desc"><p>Write a translation file for a given language.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>app</code></strong> -  <code>app</code> for which translations are to be written.</li>
<li><strong><code>lang</code></strong> -  Language code.</li>
<li><strong><code>full_dict</code></strong> -  Full translated langauge dict (optional).</li>
<li><strong><code>app_messages</code></strong> -  Source strings (optional).</li>
</ul>
</div>
	<br>

	



<!-- autodoc -->