modules Package

modules Package

Utilities for using modules

webnotes.modules.get_file_timestamp(fn)

Returns timestamp of the given file

webnotes.modules.get_item_file(module, dt, dn)

Returns the path of the item file

webnotes.modules.get_item_timestamp(module, dt, dn)

Return ths timestamp of the given item (if exists)

webnotes.modules.get_module_path(module)

Returns path of the given module (imports it and reads it from __file__)

webnotes.modules.scrub(txt)

webnotes.modules.scrub_dt_and_dn(dt, dn)

Returns in lowercase and code friendly names of doctype and name for certain types

webnotes.modules.switch_module(dt, dn, to, frm=None, export=None)

Change the module of the given doctype, if export is true, then also export txt and copy code files from src

compress Module

Load compressed .js page scripts

Will also replace $import(page) or $import(module.page) with the relevant js files

class webnotes.modules.compress.JavascriptMinify

Bases: object

minify(instream, outstream)

exception webnotes.modules.compress.UnterminatedComment

Bases: exceptions.Exception

exception webnotes.modules.compress.UnterminatedRegularExpression

Bases: exceptions.Exception

exception webnotes.modules.compress.UnterminatedStringLiteral

Bases: exceptions.Exception

webnotes.modules.compress.compress(src, comp)

webnotes.modules.compress.get_doctype_js(dt)

Returns the client-side (js) code of the DocType. Adds custom script and replaces $import(dt) with the code of that DocType

webnotes.modules.compress.get_js_code(fn, extn='js')

Get js code from a file (uncompressed)

webnotes.modules.compress.get_page_js(page, module=None)

Returns the js code of a page. Will replace $import (page) or $import(module.page) with the code from the file

webnotes.modules.compress.isAlphanum(c)

return true if the character is a letter, digit, underscore, dollar sign, or non-ASCII character.

webnotes.modules.compress.jsmin(js)

webnotes.modules.compress.sub_get_doctype_js(match)

webnotes.modules.compress.sub_get_page_js(match)

export_module Module

webnotes.modules.export_module.clear_code_fields(doclist, folder, code_type)

webnotes.modules.export_module.create_folder(module, dt, dn)

webnotes.modules.export_module.create_init_py(modules_path, module, dt, dn)

webnotes.modules.export_module.export_to_files(record_list=[], record_module=None, verbose=0)

webnotes.modules.export_module.get_module_name(doclist, record_module=None)

webnotes.modules.export_module.write_document_file(doclist, record_module=None)

import_module Module

Imports Documents from modules (.txt) files in the filesystem

webnotes.modules.import_module.accept_module(super_doclist)

webnotes.modules.import_module.get_all_doclist(folder_list)

webnotes.modules.import_module.get_doclist(path, doctype, docname)

returns a doclist (list of dictionaries) of multiple records for the given parameters

webnotes.modules.import_module.get_folder_paths(modules, record_list)

webnotes.modules.import_module.import_attachments(m)

webnotes.modules.import_module.import_file(module, doctype, docname, path=None)

imports a given file into the database

webnotes.modules.import_module.import_from_files(modules=[], record_list=[], sync_cp=0, target_db=None, target_ac=None)

webnotes.modules.import_module.import_module(module, verbose=0)

imports the all the records and files from the given module

webnotes.modules.import_module.listfolders(path, only_name=0)

returns the list of folders (with paths) in the given path, if only_name is set, it returns only the folder names

webnotes.modules.import_module.update_module_timestamp(mod)

webnotes.modules.import_module.update_module_timestamp_query(mod, timestamp)

module_manager Module

webnotes.modules.module_manager.get_doc_list(dt)

returns the list of records and their last update times from the table if the column _last_update does not exist, it will add it to the table

webnotes.modules.module_manager.get_last_update_for(mod)

webnotes.modules.module_manager.get_modified(dt, dn)

webnotes.modules.module_manager.get_module_details(m)

webnotes.modules.module_manager.get_module_items_from_files(m)

webnotes.modules.module_manager.get_modules_from_filesystem()

webnotes.modules.module_manager.init_db_login(ac_name, db_name)

webnotes.modules.module_manager.reload_doc(module, dt, dn)

alias for webnotes.modules.import_module.import_file

webnotes.modules.module_manager.sync_meta()

webnotes.modules.module_manager.sync_one_doc(d, dt, ts)

patch Module

webnotes.modules.patch.run(log_exception=1)

webnotes.modules.patch.write_log()