style: format code with black
diff --git a/erpnext/setup/install.py b/erpnext/setup/install.py
index 1d95ddb..2b055d2 100644
--- a/erpnext/setup/install.py
+++ b/erpnext/setup/install.py
@@ -19,7 +19,7 @@
def after_install():
- frappe.get_doc({'doctype': "Role", "role_name": "Analytics"}).insert()
+ frappe.get_doc({"doctype": "Role", "role_name": "Analytics"}).insert()
set_single_defaults()
create_print_setting_custom_fields()
add_all_roles_to("Administrator")
@@ -34,17 +34,26 @@
def check_setup_wizard_not_completed():
- if cint(frappe.db.get_single_value('System Settings', 'setup_complete') or 0):
+ if cint(frappe.db.get_single_value("System Settings", "setup_complete") or 0):
message = """ERPNext can only be installed on a fresh site where the setup wizard is not completed.
You can reinstall this site (after saving your data) using: bench --site [sitename] reinstall"""
- frappe.throw(message) # nosemgrep
+ frappe.throw(message) # nosemgrep
def set_single_defaults():
- for dt in ('Accounts Settings', 'Print Settings', 'HR Settings', 'Buying Settings',
- 'Selling Settings', 'Stock Settings'):
- default_values = frappe.db.sql("""select fieldname, `default` from `tabDocField`
- where parent=%s""", dt)
+ for dt in (
+ "Accounts Settings",
+ "Print Settings",
+ "HR Settings",
+ "Buying Settings",
+ "Selling Settings",
+ "Stock Settings",
+ ):
+ default_values = frappe.db.sql(
+ """select fieldname, `default` from `tabDocField`
+ where parent=%s""",
+ dt,
+ )
if default_values:
try:
b = frappe.get_doc(dt, dt)
@@ -60,121 +69,140 @@
setup_currency_exchange()
+
def setup_currency_exchange():
- ces = frappe.get_single('Currency Exchange Settings')
+ ces = frappe.get_single("Currency Exchange Settings")
try:
- ces.set('result_key', [])
- ces.set('req_params', [])
+ ces.set("result_key", [])
+ ces.set("req_params", [])
ces.api_endpoint = "https://frankfurter.app/{transaction_date}"
- ces.append('result_key', {'key': 'rates'})
- ces.append('result_key', {'key': '{to_currency}'})
- ces.append('req_params', {'key': 'base', 'value': '{from_currency}'})
- ces.append('req_params', {'key': 'symbols', 'value': '{to_currency}'})
+ ces.append("result_key", {"key": "rates"})
+ ces.append("result_key", {"key": "{to_currency}"})
+ ces.append("req_params", {"key": "base", "value": "{from_currency}"})
+ ces.append("req_params", {"key": "symbols", "value": "{to_currency}"})
ces.save()
except frappe.ValidationError:
pass
+
def create_print_setting_custom_fields():
- create_custom_field('Print Settings', {
- 'label': _('Compact Item Print'),
- 'fieldname': 'compact_item_print',
- 'fieldtype': 'Check',
- 'default': 1,
- 'insert_after': 'with_letterhead'
- })
- create_custom_field('Print Settings', {
- 'label': _('Print UOM after Quantity'),
- 'fieldname': 'print_uom_after_quantity',
- 'fieldtype': 'Check',
- 'default': 0,
- 'insert_after': 'compact_item_print'
- })
- create_custom_field('Print Settings', {
- 'label': _('Print taxes with zero amount'),
- 'fieldname': 'print_taxes_with_zero_amount',
- 'fieldtype': 'Check',
- 'default': 0,
- 'insert_after': 'allow_print_for_cancelled'
- })
+ create_custom_field(
+ "Print Settings",
+ {
+ "label": _("Compact Item Print"),
+ "fieldname": "compact_item_print",
+ "fieldtype": "Check",
+ "default": 1,
+ "insert_after": "with_letterhead",
+ },
+ )
+ create_custom_field(
+ "Print Settings",
+ {
+ "label": _("Print UOM after Quantity"),
+ "fieldname": "print_uom_after_quantity",
+ "fieldtype": "Check",
+ "default": 0,
+ "insert_after": "compact_item_print",
+ },
+ )
+ create_custom_field(
+ "Print Settings",
+ {
+ "label": _("Print taxes with zero amount"),
+ "fieldname": "print_taxes_with_zero_amount",
+ "fieldtype": "Check",
+ "default": 0,
+ "insert_after": "allow_print_for_cancelled",
+ },
+ )
def create_default_cash_flow_mapper_templates():
for mapper in DEFAULT_MAPPERS:
- if not frappe.db.exists('Cash Flow Mapper', mapper['section_name']):
+ if not frappe.db.exists("Cash Flow Mapper", mapper["section_name"]):
doc = frappe.get_doc(mapper)
doc.insert(ignore_permissions=True)
+
def create_default_success_action():
for success_action in get_default_success_action():
- if not frappe.db.exists('Success Action', success_action.get("ref_doctype")):
+ if not frappe.db.exists("Success Action", success_action.get("ref_doctype")):
doc = frappe.get_doc(success_action)
doc.insert(ignore_permissions=True)
+
def create_default_energy_point_rules():
for rule in get_default_energy_point_rules():
# check if any rule for ref. doctype exists
- rule_exists = frappe.db.exists('Energy Point Rule', {
- 'reference_doctype': rule.get('reference_doctype')
- })
- if rule_exists: continue
+ rule_exists = frappe.db.exists(
+ "Energy Point Rule", {"reference_doctype": rule.get("reference_doctype")}
+ )
+ if rule_exists:
+ continue
doc = frappe.get_doc(rule)
doc.insert(ignore_permissions=True)
+
def add_company_to_session_defaults():
settings = frappe.get_single("Session Default Settings")
- settings.append("session_defaults", {
- "ref_doctype": "Company"
- })
+ settings.append("session_defaults", {"ref_doctype": "Company"})
settings.save()
+
def add_standard_navbar_items():
navbar_settings = frappe.get_single("Navbar Settings")
erpnext_navbar_items = [
{
- 'item_label': 'Documentation',
- 'item_type': 'Route',
- 'route': 'https://erpnext.com/docs/user/manual',
- 'is_standard': 1
+ "item_label": "Documentation",
+ "item_type": "Route",
+ "route": "https://erpnext.com/docs/user/manual",
+ "is_standard": 1,
},
{
- 'item_label': 'User Forum',
- 'item_type': 'Route',
- 'route': 'https://discuss.erpnext.com',
- 'is_standard': 1
+ "item_label": "User Forum",
+ "item_type": "Route",
+ "route": "https://discuss.erpnext.com",
+ "is_standard": 1,
},
{
- 'item_label': 'Report an Issue',
- 'item_type': 'Route',
- 'route': 'https://github.com/frappe/erpnext/issues',
- 'is_standard': 1
- }
+ "item_label": "Report an Issue",
+ "item_type": "Route",
+ "route": "https://github.com/frappe/erpnext/issues",
+ "is_standard": 1,
+ },
]
current_navbar_items = navbar_settings.help_dropdown
- navbar_settings.set('help_dropdown', [])
+ navbar_settings.set("help_dropdown", [])
for item in erpnext_navbar_items:
- current_labels = [item.get('item_label') for item in current_navbar_items]
- if not item.get('item_label') in current_labels:
- navbar_settings.append('help_dropdown', item)
+ current_labels = [item.get("item_label") for item in current_navbar_items]
+ if not item.get("item_label") in current_labels:
+ navbar_settings.append("help_dropdown", item)
for item in current_navbar_items:
- navbar_settings.append('help_dropdown', {
- 'item_label': item.item_label,
- 'item_type': item.item_type,
- 'route': item.route,
- 'action': item.action,
- 'is_standard': item.is_standard,
- 'hidden': item.hidden
- })
+ navbar_settings.append(
+ "help_dropdown",
+ {
+ "item_label": item.item_label,
+ "item_type": item.item_type,
+ "route": item.route,
+ "action": item.action,
+ "is_standard": item.is_standard,
+ "hidden": item.hidden,
+ },
+ )
navbar_settings.save()
+
def add_app_name():
- frappe.db.set_value('System Settings', None, 'app_name', 'ERPNext')
+ frappe.db.set_value("System Settings", None, "app_name", "ERPNext")
+
def add_non_standard_user_types():
user_types = get_user_types_data()
@@ -183,91 +211,95 @@
for user_type, data in user_types.items():
user_type_limit.setdefault(frappe.scrub(user_type), 20)
- update_site_config('user_type_doctype_limit', user_type_limit)
+ update_site_config("user_type_doctype_limit", user_type_limit)
for user_type, data in user_types.items():
create_custom_role(data)
create_user_type(user_type, data)
+
def get_user_types_data():
return {
- 'Employee Self Service': {
- 'role': 'Employee Self Service',
- 'apply_user_permission_on': 'Employee',
- 'user_id_field': 'user_id',
- 'doctypes': {
+ "Employee Self Service": {
+ "role": "Employee Self Service",
+ "apply_user_permission_on": "Employee",
+ "user_id_field": "user_id",
+ "doctypes": {
# masters
- 'Holiday List': ['read'],
- 'Employee': ['read', 'write'],
+ "Holiday List": ["read"],
+ "Employee": ["read", "write"],
# payroll
- 'Salary Slip': ['read'],
- 'Employee Benefit Application': ['read', 'write', 'create', 'delete'],
+ "Salary Slip": ["read"],
+ "Employee Benefit Application": ["read", "write", "create", "delete"],
# expenses
- 'Expense Claim': ['read', 'write', 'create', 'delete'],
- 'Employee Advance': ['read', 'write', 'create', 'delete'],
+ "Expense Claim": ["read", "write", "create", "delete"],
+ "Employee Advance": ["read", "write", "create", "delete"],
# leave and attendance
- 'Leave Application': ['read', 'write', 'create', 'delete'],
- 'Attendance Request': ['read', 'write', 'create', 'delete'],
- 'Compensatory Leave Request': ['read', 'write', 'create', 'delete'],
+ "Leave Application": ["read", "write", "create", "delete"],
+ "Attendance Request": ["read", "write", "create", "delete"],
+ "Compensatory Leave Request": ["read", "write", "create", "delete"],
# tax
- 'Employee Tax Exemption Declaration': ['read', 'write', 'create', 'delete'],
- 'Employee Tax Exemption Proof Submission': ['read', 'write', 'create', 'delete'],
+ "Employee Tax Exemption Declaration": ["read", "write", "create", "delete"],
+ "Employee Tax Exemption Proof Submission": ["read", "write", "create", "delete"],
# projects
- 'Timesheet': ['read', 'write', 'create', 'delete', 'submit', 'cancel', 'amend'],
+ "Timesheet": ["read", "write", "create", "delete", "submit", "cancel", "amend"],
# trainings
- 'Training Program': ['read'],
- 'Training Feedback': ['read', 'write', 'create', 'delete', 'submit', 'cancel', 'amend'],
+ "Training Program": ["read"],
+ "Training Feedback": ["read", "write", "create", "delete", "submit", "cancel", "amend"],
# shifts
- 'Shift Request': ['read', 'write', 'create', 'delete', 'submit', 'cancel', 'amend'],
+ "Shift Request": ["read", "write", "create", "delete", "submit", "cancel", "amend"],
# misc
- 'Employee Grievance': ['read', 'write', 'create', 'delete'],
- 'Employee Referral': ['read', 'write', 'create', 'delete'],
- 'Travel Request': ['read', 'write', 'create', 'delete']
- }
+ "Employee Grievance": ["read", "write", "create", "delete"],
+ "Employee Referral": ["read", "write", "create", "delete"],
+ "Travel Request": ["read", "write", "create", "delete"],
+ },
}
}
+
def create_custom_role(data):
- if data.get('role') and not frappe.db.exists('Role', data.get('role')):
- frappe.get_doc({
- 'doctype': 'Role',
- 'role_name': data.get('role'),
- 'desk_access': 1,
- 'is_custom': 1
- }).insert(ignore_permissions=True)
+ if data.get("role") and not frappe.db.exists("Role", data.get("role")):
+ frappe.get_doc(
+ {"doctype": "Role", "role_name": data.get("role"), "desk_access": 1, "is_custom": 1}
+ ).insert(ignore_permissions=True)
+
def create_user_type(user_type, data):
- if frappe.db.exists('User Type', user_type):
- doc = frappe.get_cached_doc('User Type', user_type)
+ if frappe.db.exists("User Type", user_type):
+ doc = frappe.get_cached_doc("User Type", user_type)
doc.user_doctypes = []
else:
- doc = frappe.new_doc('User Type')
- doc.update({
- 'name': user_type,
- 'role': data.get('role'),
- 'user_id_field': data.get('user_id_field'),
- 'apply_user_permission_on': data.get('apply_user_permission_on')
- })
+ doc = frappe.new_doc("User Type")
+ doc.update(
+ {
+ "name": user_type,
+ "role": data.get("role"),
+ "user_id_field": data.get("user_id_field"),
+ "apply_user_permission_on": data.get("apply_user_permission_on"),
+ }
+ )
create_role_permissions_for_doctype(doc, data)
doc.save(ignore_permissions=True)
+
def create_role_permissions_for_doctype(doc, data):
- for doctype, perms in data.get('doctypes').items():
- args = {'document_type': doctype}
+ for doctype, perms in data.get("doctypes").items():
+ args = {"document_type": doctype}
for perm in perms:
args[perm] = 1
- doc.append('user_doctypes', args)
+ doc.append("user_doctypes", args)
+
def update_select_perm_after_install():
if not frappe.flags.update_select_perm_after_migrate:
return
frappe.flags.ignore_select_perm = False
- for row in frappe.get_all('User Type', filters= {'is_standard': 0}):
- print('Updating user type :- ', row.name)
- doc = frappe.get_doc('User Type', row.name)
+ for row in frappe.get_all("User Type", filters={"is_standard": 0}):
+ print("Updating user type :- ", row.name)
+ doc = frappe.get_doc("User Type", row.name)
doc.save()
frappe.flags.update_select_perm_after_migrate = False