utils Package

utils Package

webnotes.utils.add_days(date, days)

Adds days to the given string_date

webnotes.utils.add_months(string_date, months)

webnotes.utils.add_years(string_date, years)

webnotes.utils.cint(s)

Convert to integer

webnotes.utils.clear_recycle_bin()

webnotes.utils.cstr(s)

Convert to string

webnotes.utils.date_diff(string_ed_date, string_st_date=None)

webnotes.utils.db_exists(dt, dn)

webnotes.utils.dict_to_str(args, sep='&')

Converts a dictionary to URL

webnotes.utils.flt(s)

Convert to float (ignore commas)

webnotes.utils.fmt_money(amount, fmt='%.2f')

Convert to string with commas for thousands, millions etc

webnotes.utils.formatdate(string_date)

Convers the given string date to user_format

webnotes.utils.generate_hash()

Generates reandom hash for session id

webnotes.utils.getCSVelement(v)

Returns the CSV value of v, For example:

• apple becomes “apple”
• hi”there becomes “hi”“there”

webnotes.utils.getTraceback()

Returns the traceback of the Exception

webnotes.utils.get_defaults(key=None)

Get dictionary of default values from the Control Panel, or a value if key is passed

webnotes.utils.get_first_day(dt, d_years=0, d_months=0)

Returns the first day of the month for the date specified by date object Also adds d_years and d_months if specified

webnotes.utils.get_last_day(dt)

Returns last day of the month using: get_first_day(dt, 0, 1) + datetime.timedelta(-1)

webnotes.utils.getdate(string_date)

Coverts string date (yyyy-mm-dd) to datetime.date object

webnotes.utils.global_date_format(date)

webnotes.utils.has_common(l1, l2)

Returns true if there are common elements in lists l1 and l2

webnotes.utils.in_words(integer)

Returns string in words for the given integer.

webnotes.utils.isNull(v)

Returns true if v=’’ or v is None

webnotes.utils.load_json(arg)

webnotes.utils.log(event, details)

webnotes.utils.money_in_words(number, main_currency=None, fraction_currency=None)

Returns string in words with currency and fraction currency.

webnotes.utils.now()

Returns time.strftime(‘%Y-%m-%d %H:%M:%S’)

webnotes.utils.now_datetime()

webnotes.utils.nowdate()

Returns time.strftime(‘%Y-%m-%d’)

webnotes.utils.parse_val(v)

Converts to simple datatypes from SQL query results

webnotes.utils.pprint_dict(d, level=1)

webnotes.utils.replace_newlines(s)

Replace newlines by ‘<br>’

webnotes.utils.send_error_report()

webnotes.utils.sendmail(recipients, sender='', msg='', subject='[No Subject]', parts=[], cc=[], attach=[])

Send an email. For more details see email_lib.sendmail()

webnotes.utils.set_default(key, val)

Set / add a default value to Control Panel

webnotes.utils.str_esc_quote(s)

Escape quotes

webnotes.utils.timestamps_equal(t1, t2)

Returns true if same the two string timestamps are same

webnotes.utils.user_format

User format specified in Control Panel

Examples:

• dd-mm-yyyy
• mm-dd-yyyy
• dd/mm/yyyy

webnotes.utils.validate_email_add(email_str)

Validates the email string

archive Module

backups Module

cache Module

Simple Caching:

Stores key-value pairs in database and enables simple caching

get_item(key).get() returns the cached value if not expired (else returns null) get_item(key).set(interval = 60000) sets a value to cache, expiring after x seconds get_item(key).clear() clears an old value setup() sets up cache

class webnotes.utils.cache.CacheItem(key)

clear()

clear the item

get()

get value

set(value, interval=6000)

set a new value, with interval

webnotes.utils.cache.get_item(key)

returns get CacheItem object

webnotes.utils.cache.setup()

encrypt Module

XTEA Block Encryption Algorithm Author: Paul Chakravarti (paul_dot_chakravarti_at_gmail_dot_com) License: Public Domain

webnotes.utils.encrypt.crypt(key, data, iv='\x00\x00\x00\x00\x00\x00\x00\x00', n=32)

webnotes.utils.encrypt.decrypt(data, encryption_key=None)

webnotes.utils.encrypt.encrypt(data, encryption_key=None)

webnotes.utils.encrypt.get_key()

webnotes.utils.encrypt.xtea_decrypt(key, block, n=32, endian='!')

webnotes.utils.encrypt.xtea_encrypt(key, block, n=32, endian='!')

file_manager Module

webnotes.utils.file_manager.convert_to_files(verbose=0)

webnotes.utils.file_manager.delete_file(fname, verbose=0)

webnotes.utils.file_manager.get_file(fname)

webnotes.utils.file_manager.get_file_system_name(fname)

webnotes.utils.file_manager.make_thumbnail(blob, size)

webnotes.utils.file_manager.save_file(fname, content, module=None)

webnotes.utils.file_manager.save_uploaded(js_okay='window.parent.msgprint("File Upload Successful")', js_fail='')

webnotes.utils.file_manager.upload()

webnotes.utils.file_manager.write_file(fid, content)

jsmin Module

class webnotes.utils.jsmin.JavascriptMinify

Bases: object

minify(instream, outstream)

exception webnotes.utils.jsmin.UnterminatedComment

Bases: exceptions.Exception

exception webnotes.utils.jsmin.UnterminatedRegularExpression

Bases: exceptions.Exception

exception webnotes.utils.jsmin.UnterminatedStringLiteral

Bases: exceptions.Exception

webnotes.utils.jsmin.isAlphanum(c)

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

webnotes.utils.jsmin.jsmin(js)

nestedset Module

webnotes.utils.nestedset.rebuild_node(doctype, parent, left, parent_field)

webnotes.utils.nestedset.rebuild_tree(doctype, parent_field)

webnotes.utils.nestedset.update_add_node(doctype, name, parent, parent_field)

webnotes.utils.nestedset.update_nsm(doc_obj)

webnotes.utils.nestedset.update_remove_node(doctype, name)

scheduler Module

Simple Scheduler

This scheduler is used to fire events across multiple databases. A database master_scheduler is maintained with one event and one log table

Events are added by different databases in the master scheduler using the set_event method and they are executed by the cron.

__main__ will call run

To install:

python install_lib.py [root] [password] master_scheduler

In cron:

python [path]webnotes/utils/scheduler.py

class webnotes.utils.scheduler.Scheduler

clear(db_name, event)

Clears the event

connect()

execute(db_name, event)

Executes event in the specifed db

get_events(db_name=None)

Returns list of upcoming events

get_log(db_name=None)

Returns log of events

log(db_name, event, traceback)

Log an event error

run()

Run scheduled (due) events and reset time for recurring events

set(event, interval, recurring, db_name=None)

Add an event to the Event table in the master scheduler

webnotes.utils.scheduler.cancel_event(event)

Cancels an event

webnotes.utils.scheduler.set_event(event, interval=86400, recurring=1)

Adds an event to the master scheduler

sitemap Module

webnotes.utils.sitemap.generate_xml(conn, site_prefix)

transfer Module

class webnotes.utils.transfer.UpdateDocType(in_doclist)

Bases: webnotes.utils.transfer.UpdateDocumentMerge

add_section_breaks_and_renum()

child_exists(d)

clear_section_breaks()

fix_extra_fields(extra)

get_extra_fields()

get_id(d)

get_orignal_values(d)

on_save()

renum()

to_udpate(d)

class webnotes.utils.transfer.UpdateDocTypeMapper(in_doclist)

Bases: webnotes.utils.transfer.UpdateDocumentMerge

get_id(d)

get_orignal_values(d)

class webnotes.utils.transfer.UpdateDocument(in_doclist=[])

delete_existing()

is_modified()

run_on_update()

save()

save_children()

save_one_doc(df, as_new=1)

sync()

update_modified()

class webnotes.utils.transfer.UpdateDocumentMerge(in_doclist)

Bases: webnotes.utils.transfer.UpdateDocument

child_exists(d)

delete_existing()

get_id(d)

keep_values(d)

on_save()

save()

save_children()

to_update(d)

class webnotes.utils.transfer.UpdateModuleDef(in_doclist)

Bases: webnotes.utils.transfer.UpdateDocumentMerge

get_id(d)

get_orignal_values(d)

to_update(d)

webnotes.utils.transfer.set_doc(doclist, ovr=0, ignore=1, onupdate=1)

webservice Module

class webnotes.utils.webservice.FrameworkServer(remote_host, path, user='', password='', account='', cookies=None, opts=None, https=0)

Connect to a remote server via HTTP (webservice).

• remote_host is the the address of the remote server
• path is the path of the Framework (excluding index.cgi)

http_get_response(method, args)

Run a method on the remote server, with the given arguments

run_method(method, args)

runserverobj(doctype, docname, method, arg='')

Returns the response of a remote method called on a system object specified by doctype and docname

Subpackages

• email_lib Package
  • email_lib Package
  • form_email Module
  • html2text Module
  • receive Module
  • send Module