webnotes Package

webnotes Package

exception webnotes.ValidationError

Bases: exceptions.Exception

webnotes.add_cookies

Dictionary of additional cookies appended by custom code

webnotes.conn

The database connection webnotes.db.Database setup by auth

webnotes.create_folder(path)

Wrapper function for os.makedirs (does not throw exception if directory exists)

webnotes.debug_log

List of exceptions to be shown in the Error Console

webnotes.errprint(msg)

Append to the debug log

webnotes.form

The cgi.FieldStorage() object (Dictionary representing the formdata from the URL)

webnotes.getTraceback()

webnotes.get_env_vars(env_var)

webnotes.get_files_path()

webnotes.get_index_path()

webnotes.is_apache_user()

webnotes.is_testing

Flag to identify if system is in Testing Mode

webnotes.message_log

List of messages to be shown to the user in a popup box at the end of the request

webnotes.msgprint(msg, small=0, raise_exception=0)

Append to the message_log

webnotes.response

The JSON response object. Default is:

{'message':'', 'exc':''}

webnotes.session

Global session dictionary.

• session[‘user’] - Current user
• session[‘data’] - Returns a dictionary of the session cache

webnotes.set_as_account_master()

webnotes.set_as_admin(db_name=None, ac_name=None)

webnotes.set_as_admin_session()

webnotes.set_as_administrator()

webnotes.setup_logging()

webnotes.version

“v170”

auth Module

class webnotes.auth.CookieManager

get_incoming_cookies()

set_cookies()

set_remember_me()

class webnotes.auth.HTTPRequest

get_ac_name()

set_db(ac_name=None)

setup_profile()

class webnotes.auth.LoginManager

authenticate(user=None, pwd=None)

call_on_logout_event()

load_control_panel()

login_as_guest()

logout(arg='')

post_login()

run_trigger(method='on_login')

validate_ip_address()

class webnotes.auth.Session(user=None)

add_status_column()

check_expired()

get_ipinfo()

insert_session_record()

load()

resume()

start()

update()

db Module

class webnotes.db.Database(host='', user='', password='', ac_name='', use_default=0)

Open a database connection with the given parmeters, if use_default is True, use the login details from defs.py. This is called by the request handler and is accessible using the conn global variable. the sql method is also global to run queries

add_multi_tenant_condition(query)

begin()

check_transaction_status(query)

Update in_transaction and check if “START TRANSACTION” is not called twice

close()

Close my connection

commit()

connect()

Connect to a database

convert_to_lists(res, formatted=0)

Convert the given result set to a list of lists (with cleaned up dates and decimals)

convert_to_simple_type(v, formatted=0)

exists(dt, dn)

Returns true if the record exists

fetch_as_dict(formatted=0)

Internal - get results as dictionary

field_exists(dt, fn)

Returns True if fn exists in DocType dt

get_db_login(ac_name)

get_description()

Get metadata of the last query

get_global(key, user='__global')

get_testing_tables()

Get list of all tables for which tab is to be replaced by test before a query is executed

get_value(doctype, docname, fieldname)

Get a single / multiple value from a record.

For Single DocType, let docname be = None

replace_tab_by_test(query)

Relace all tab + doctype to test + doctype

rollback()

set(doc, field, val)

set_global(key, val, user='__global')

set_value(dt, dn, field, val)

sql(query, values=(), as_dict=0, as_list=0, formatted=0, ignore_no_table=1, debug=0)

• Execute a query, with given values
• returns as a dictionary if as_dict = 1
• returns as a list of lists (with cleaned up dates and decimals) if as_list = 1

use(db_name)

USE db_name

validate_query(q)

defs Module

defs_template Module

handler Module

webnotes.handler.backupdb(form_dict, session)

webnotes.handler.cleanup_docs()

webnotes.handler.compressBuf(buf)

webnotes.handler.dt_map()

webnotes.handler.get_file()

webnotes.handler.get_graph()

webnotes.handler.get_template()

webnotes.handler.import_csv()

webnotes.handler.load_month_events()

webnotes.handler.logout()

webnotes.handler.reset_password()

webnotes.handler.resume_session()

webnotes.handler.runserverobj(arg=None)

webnotes.handler.startup()

webnotes.handler.upload_many()

webnotes.handler.uploadfile()

webnotes.handler.validate_cmd(cmd)

profile Module

class webnotes.profile.Profile(name='')

A profile object is created at the beginning of every request with details of the use. The global profile object is webnotes.user

get_allow_list(key)

Internal - get list of DocType where key is allowed. Key is either ‘read’, ‘write’ or ‘create’

get_create_list()

Get list of DocTypes the user can create. Will filter DocTypes tagged with ‘not_in_create’ and table

get_defaults()

Get the user’s default values based on user and role profile

get_hide_tips()

get_home_page()

Get the name of the user’s home page from the Control Panel

get_random_password()

Generate a random password

get_read_list()

Get list of DocTypes the user can read

get_report_list()

get_roles()

get list of roles

get_write_list()

Get list of DocTypes the user can write

load_from_session(d)

Setup the user profile from the dictionary saved in the session (generated by load_profile)

load_profile()

Return a dictionary of user properites to be stored in the session

reset_password()

Reset the user’s password and send an email

send_email(subj, mess, email)

update_recent(dt, dn)

Update the user’s Recent list with the given dt and dn

webnotes.profile.get_user_img()

session_cache Module

webnotes.session_cache.build()

webnotes.session_cache.clear()

webnotes.session_cache.clear_cache(user='')

webnotes.session_cache.dump(sd, country)

webnotes.session_cache.get()

webnotes.session_cache.get_letter_heads()

webnotes.session_cache.load(country)

webnotes.session_cache.load_startup(cp)

webnotes.session_cache.make_cache_table()

tests Module

Run tests from modules. Sets up database connection, modules path and session before running test

Usage: from shell, run

python tests.py [test modules]

Options:

test modules: list of modules separated by space

if no modules are specified, it will run all “tests.py” files from all modules

webnotes.tests.get_tests()

Returns list of test modules identified by “tests.py”

webnotes.tests.setup()

Sets up connection and session

Subpackages

• install_lib Package
  • db_init Module
  • install Module
• model Package
  • model Package
  • code Module
  • db_schema Module
  • doc Module
  • doclist Module
  • doctype Module
    • DocType module
  • import_docs Module
  • meta Module
  • modules Module
  • triggers Module
• modules Package
  • modules Package
  • compress Module
  • export_module Module
  • import_module Module
  • module_manager Module
  • patch Module
• multi_tenant Package
  • multi_tenant Package
  • query_parser Module
  • setup Module
• utils Package
  • utils Package
  • archive Module
  • backups Module
  • cache Module
  • encrypt Module
  • file_manager Module
  • jsmin Module
  • nestedset Module
  • scheduler Module
    • To install:
    • In cron:
  • sitemap Module
  • transfer Module
  • webservice Module
  • Subpackages
    • email_lib Package
      • email_lib Package
      • form_email Module
      • html2text Module
      • receive Module
      • send Module
• widgets Package
  • auto_master Module
  • event Module
  • follow Module
  • form Module
  • menus Module
  • page Module
  • page_body Module
  • query_builder Module
  • search Module
  • tags Module
  • todo Module