refactor(backend): split domain-specific settings (#13290)

* add collection mechanism

* move stock settings

* move report settings

* move pricing settings

* move part settings

* move order settings

* move build settings

* cleanup

* delay model import

* fix import snag
This commit is contained in:
Matthias Mair authored and GitHub committed 2026-11-15 16:59:15 +11:00
1 parent b2a9218cfb
commit a14ce3dde6
15 files changed
+929 -797

No files matched your search

@@ -0,0 +1,76 @@
"""System settings for build app."""
from django.utils.translation import gettext_lazy as _
import build.validators
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'BUILDORDER_REFERENCE_PATTERN': {
'name': _('Build Order Reference Pattern'),
'description': _('Required pattern for generating Build Order reference field'),
'default': 'BO-{ref:04d}',
'validator': build.validators.validate_build_order_reference_pattern,
},
'BUILDORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_ACTIVE_PART': {
'name': _('Require Active Part'),
'description': _('Prevent build order creation for inactive parts'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_LOCKED_PART': {
'name': _('Require Locked Part'),
'description': _('Prevent build order creation for unlocked parts'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_VALID_BOM': {
'name': _('Require Valid BOM'),
'description': _('Prevent build order creation unless BOM has been validated'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_CLOSED_CHILDS': {
'name': _('Require Closed Child Orders'),
'description': _(
'Prevent build order completion until all child orders are closed'
),
'default': False,
'validator': bool,
},
'BUILDORDER_EXTERNAL_BUILDS': {
'name': _('External Build Orders'),
'description': _('Enable external build order functionality'),
'default': False,
'validator': bool,
},
'BUILDORDER_EXTERNAL_REQUIRED': {
'name': _('Require External Build Orders'),
'description': _(
'Require an external build order when ordering assembled parts from an external supplier'
),
'default': False,
'validator': bool,
},
'PREVENT_BUILD_COMPLETION_HAVING_INCOMPLETED_TESTS': {
'name': _('Block Until Tests Pass'),
'description': _(
'Prevent build outputs from being completed until all required tests pass'
),
'default': False,
'validator': bool,
},
'BUILDORDER_ENABLED': {
'name': _('Enable Build Orders'),
'description': _('Enable build order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
}
+2
View File
@@ -21,9 +21,11 @@ class CommonConfig(AppConfig):
def ready(self):
"""Initialize restart flag clearance on startup."""
from common.setting.system import collect_system_settings
from InvenTree.ready import setAppLoaded
setAppLoaded(self.name)
collect_system_settings()
if InvenTree.ready.isRunningMigrations(): # pragma: no cover
return
+35 -733
View File
@@ -2,22 +2,18 @@
import json
import os
import re
import uuid
from importlib import import_module
from importlib.util import find_spec
from django.apps import apps
from django.conf import settings as django_settings
from django.contrib.auth.models import Group
from django.core.exceptions import FieldDoesNotExist, ValidationError
from django.core.validators import MaxValueValidator, MinValueValidator, URLValidator
from django.core.exceptions import ValidationError
from django.core.validators import MinValueValidator, URLValidator
from django.utils.translation import gettext_lazy as _
from jinja2.sandbox import SandboxedEnvironment
import build.validators
import common.currency
import common.validators
import order.validators
import report.helpers
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
@@ -39,45 +35,6 @@ def validate_internal_company(value):
})
def validate_part_name_format(value):
"""Validate part name format.
Make sure that each template container has a field of Part Model
"""
# Make sure that the field_name exists in Part model
from part.models import Part
jinja_template_regex = re.compile(r'{{.*?}}')
field_name_regex = re.compile(r'(?<=part\.)[A-z]+')
for jinja_template in jinja_template_regex.findall(str(value)):
# make sure at least one and only one field is present inside the parser
field_names = field_name_regex.findall(jinja_template)
if len(field_names) < 1:
raise ValidationError({
'value': 'At least one field must be present inside a jinja template container i.e {{}}'
})
for field_name in field_names:
try:
Part._meta.get_field(field_name)
except FieldDoesNotExist:
raise ValidationError({
'value': f'{field_name} does not exist in Part Model'
})
# Attempt to render the template with a dummy Part instance
# Use pk=1 to ensure conditional checks like {% if part.pk %} are evaluated
p = Part(pk=1, name='test part', description='some test part')
try:
SandboxedEnvironment().from_string(value).render({'part': p})
except Exception as exc:
raise ValidationError({'value': str(exc)})
return True
def _get_site_object():
"""Return the first site object, or None if it doesn't exist."""
if not django_settings.SITE_MULTI:
@@ -102,13 +59,6 @@ def update_instance_name(setting):
site_obj.save()
def reset_part_name_format(setting):
"""Clear the cached Part 'full_name' template when PART_NAME_FORMAT changes."""
from part.helpers import reset_full_name_template
reset_full_name_template()
def update_instance_url(setting):
"""Update the first site objects domain to url."""
if site_obj := _get_site_object():
@@ -118,6 +68,8 @@ def update_instance_url(setting):
def settings_group_options():
"""Build up group tuple for settings based on your choices."""
from django.contrib.auth.models import Group
return [('', _('No group')), *[(str(a.pk), str(a)) for a in Group.objects.all()]]
@@ -452,307 +404,6 @@ SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'choices': barcode_plugins,
'default': 'inventreebarcode',
},
'PART_ENABLE_LOCKING': {
'name': _('Part Locking'),
'description': _('Enable locking of parts to prevent modification'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'PART_ENABLE_REVISION': {
'name': _('Part Revisions'),
'description': _('Enable revision field for Part'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'PART_REVISION_ASSEMBLY_ONLY': {
'name': _('Assembly Revision Only'),
'description': _('Only allow revisions for assembly parts'),
'validator': bool,
'default': False,
},
'PART_ALLOW_DELETE_FROM_ASSEMBLY': {
'name': _('Allow Deletion from Assembly'),
'description': _('Allow deletion of parts which are used in an assembly'),
'validator': bool,
'default': False,
},
'PART_IPN_REGEX': {
'name': _('IPN Regex'),
'description': _('Regular expression pattern for matching Part IPN'),
},
'PART_ALLOW_DUPLICATE_IPN': {
'name': _('Allow Duplicate IPN'),
'description': _('Allow multiple parts to share the same IPN'),
'default': True,
'validator': bool,
},
'PART_ALLOW_EDIT_IPN': {
'name': _('Allow Editing IPN'),
'description': _('Allow changing the IPN value while editing a part'),
'default': True,
'validator': bool,
},
'PART_COPY_BOM': {
'name': _('Copy Part BOM Data'),
'description': _('Copy BOM data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_COPY_PARAMETERS': {
'name': _('Copy Part Parameter Data'),
'description': _('Copy parameter data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_COPY_TESTS': {
'name': _('Copy Part Test Data'),
'description': _('Copy test data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_CATEGORY_PARAMETERS': {
'name': _('Copy Category Parameter Templates'),
'description': _('Copy category parameter templates when creating a part'),
'default': True,
'validator': bool,
},
'PART_TEMPLATE': {
'name': _('Template'),
'description': _('Parts are templates by default'),
'default': False,
'validator': bool,
},
'PART_ASSEMBLY': {
'name': _('Assembly'),
'description': _('Parts can be assembled from other components by default'),
'default': False,
'validator': bool,
},
'PART_COMPONENT': {
'name': _('Component'),
'description': _('Parts can be used as sub-components by default'),
'default': True,
'validator': bool,
},
'PART_PURCHASEABLE': {
'name': _('Purchaseable'),
'description': _('Parts are purchaseable by default'),
'default': True,
'validator': bool,
},
'PART_SALABLE': {
'name': _('Salable'),
'description': _('Parts are salable by default'),
'default': False,
'validator': bool,
},
'PART_TRACKABLE': {
'name': _('Trackable'),
'description': _('Parts are trackable by default'),
'default': False,
'validator': bool,
},
'PART_VIRTUAL': {
'name': _('Virtual'),
'description': _('Parts are virtual by default'),
'default': False,
'validator': bool,
},
'PART_SHOW_RELATED': {
'name': _('Show related parts'),
'description': _('Display related parts for a part'),
'default': True,
'validator': bool,
},
'PART_CREATE_INITIAL': {
'name': _('Initial Stock Data'),
'description': _('Allow creation of initial stock when adding a new part'),
'default': False,
'validator': bool,
},
'PART_CREATE_SUPPLIER': {
'name': _('Initial Supplier Data'),
'description': _(
'Allow creation of initial supplier data when adding a new part'
),
'default': True,
'validator': bool,
},
'PART_NAME_FORMAT': {
'name': _('Part Name Display Format'),
'description': _('Format to display the part name'),
'default': "{{ part.IPN if part.IPN }}{{ ' | ' if part.IPN }}{{ part.name }}{{ ' | ' if part.revision }}"
'{{ part.revision if part.revision }}',
'validator': validate_part_name_format,
'after_save': reset_part_name_format,
},
'PART_CATEGORY_DEFAULT_ICON': {
'name': _('Part Category Default Icon'),
'description': _('Part category default icon (empty means no icon)'),
'default': '',
'validator': common.validators.validate_icon,
},
'PRICING_DECIMAL_PLACES_MIN': {
'name': _('Minimum Pricing Decimal Places'),
'description': _(
'Minimum number of decimal places to display when rendering pricing data'
),
'default': 0,
'validator': [
int,
MinValueValidator(0),
MaxValueValidator(4),
common.validators.validate_decimal_places_min,
],
},
'PRICING_DECIMAL_PLACES': {
'name': _('Maximum Pricing Decimal Places'),
'description': _(
'Maximum number of decimal places to display when rendering pricing data'
),
'default': 6,
'validator': [
int,
MinValueValidator(2),
MaxValueValidator(6),
common.validators.validate_decimal_places_max,
],
},
'PRICING_USE_SUPPLIER_PRICING': {
'name': _('Use Supplier Pricing'),
'description': _(
'Include supplier price breaks in overall pricing calculations'
),
'default': True,
'validator': bool,
},
'PRICING_PURCHASE_HISTORY_OVERRIDES_SUPPLIER': {
'name': _('Purchase History Override'),
'description': _(
'Historical purchase order pricing overrides supplier price breaks'
),
'default': False,
'validator': bool,
},
'PRICING_USE_STOCK_PRICING': {
'name': _('Use Stock Item Pricing'),
'description': _(
'Use pricing from manually entered stock data for pricing calculations'
),
'default': True,
'validator': bool,
},
'PRICING_STOCK_ITEM_AGE_DAYS': {
'name': _('Stock Item Pricing Age'),
'description': _(
'Exclude stock items older than this number of days from pricing calculations'
),
'default': 0,
'units': _('days'),
'validator': [int, MinValueValidator(0)],
},
'PRICING_USE_VARIANT_PRICING': {
'name': _('Use Variant Pricing'),
'description': _('Include variant pricing in overall pricing calculations'),
'default': True,
'validator': bool,
},
'PRICING_ACTIVE_VARIANTS': {
'name': _('Active Variants Only'),
'description': _(
'Only use active variant parts for calculating variant pricing'
),
'default': False,
'validator': bool,
},
'PRICING_AUTO_UPDATE': {
'name': _('Auto Update Pricing'),
'description': _(
'Automatically update part pricing when internal data changes'
),
'default': True,
'validator': bool,
},
'PRICING_UPDATE_DAYS': {
'name': _('Pricing Rebuild Interval'),
'description': _('Number of days before part pricing is automatically updated'),
'units': _('days'),
'default': 30,
'validator': [int, MinValueValidator(0)],
},
'PART_INTERNAL_PRICE': {
'name': _('Internal Prices'),
'description': _('Enable internal prices for parts'),
'default': False,
'validator': bool,
},
'PART_BOM_USE_INTERNAL_PRICE': {
'name': _('Internal Price Override'),
'description': _(
'If available, internal prices override price range calculations'
),
'default': False,
'validator': bool,
},
'PART_BOM_ALLOW_ZERO_QUANTITY': {
'name': _('Allow BOM Zero Quantity'),
'description': _(
'Accept a zero quantity for BOM item for part. Enables using setup quantity to define a quantity required per build, independent of build quantity'
),
'default': False,
'validator': bool,
},
'LABEL_ENABLE': {
'name': _('Enable label printing'),
'description': _('Enable label printing from the web interface'),
'default': True,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'LABEL_DPI': {
'name': _('Label Image DPI'),
'description': _(
'DPI resolution when generating image files to supply to label printing plugins'
),
'default': 300,
'validator': [int, MinValueValidator(100)],
},
'REPORT_ENABLE': {
'name': _('Enable Reports'),
'description': _('Enable generation of reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'REPORT_DEBUG_MODE': {
'name': _('Debug Mode'),
'description': _('Generate reports in debug mode (HTML output)'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_FETCH_URLS': {
'name': _('Report URL Fetching'),
'description': _('Allow fetching of remote URLs when generating reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_LOG_ERRORS': {
'name': _('Log Report Errors'),
'description': _('Log errors which occur when generating reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_DEFAULT_PAGE_SIZE': {
'name': _('Page Size'),
'description': _('Default page size for PDF reports'),
'default': 'A4',
'choices': report.helpers.report_page_size_options,
},
'PARAMETER_ENFORCE_UNITS': {
'name': _('Enforce Parameter Units'),
'description': _(
@@ -767,321 +418,6 @@ SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'default': False,
'validator': bool,
},
'STOCK_DELETE_DEPLETED_DEFAULT': {
'name': _('Delete Depleted Stock'),
'description': _('Determines default behavior when a stock item is depleted'),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_EDIT_SERIAL': {
'name': _('Allow Edit Serial Number'),
'description': _('Allow editing of serial number for stock items'),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_DELETE_SERIALIZED': {
'name': _('Delete Serialized Stock'),
'description': _('Allow deletion of stock items which have a serial number'),
'default': True,
'validator': bool,
},
'STOCK_BATCH_CODE_TEMPLATE': {
'name': _('Batch Code Template'),
'description': _('Template for generating default batch codes for stock items'),
'default': '',
},
'STOCK_ENABLE_EXPIRY': {
'name': _('Stock Expiry'),
'description': _('Enable stock expiry functionality'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'STOCK_ALLOW_EXPIRED_SALE': {
'name': _('Sell Expired Stock'),
'description': _('Allow sale of expired stock'),
'default': False,
'validator': bool,
},
'STOCK_STALE_DAYS': {
'name': _('Stock Stale Time'),
'description': _(
'Number of days stock items are considered stale before expiring'
),
'default': 0,
'units': _('days'),
'validator': [int],
},
'STOCK_ALLOW_EXPIRED_BUILD': {
'name': _('Build Expired Stock'),
'description': _('Allow building with expired stock'),
'default': False,
'validator': bool,
},
'STOCK_OWNERSHIP_CONTROL': {
'name': _('Stock Ownership Control'),
'description': _('Enable ownership control over stock locations and items'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'STOCK_LOCATION_DEFAULT_ICON': {
'name': _('Stock Location Default Icon'),
'description': _('Stock location default icon (empty means no icon)'),
'default': '',
'validator': common.validators.validate_icon,
},
'STOCK_SHOW_INSTALLED_ITEMS': {
'name': _('Show Installed Stock Items'),
'description': _('Display installed stock items in stock tables'),
'default': False,
'validator': bool,
},
'STOCK_ENFORCE_BOM_INSTALLATION': {
'name': _('Check BOM when installing items'),
'description': _(
'Installed stock items must exist in the BOM for the parent part'
),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_OUT_OF_STOCK_TRANSFER': {
'name': _('Allow Out of Stock Transfer'),
'description': _(
'Allow stock items which are not in stock to be transferred between stock locations'
),
'default': False,
'validator': bool,
},
'STOCK_MERGE_ON_TRANSFER': {
'name': _('Merge stock with existing stock on transfer by default'),
'description': _(
'Default state for merge stock on transfer behaviour. (Can be changed per transfer if desired)'
),
'default': False,
'validator': bool,
},
'BUILDORDER_REFERENCE_PATTERN': {
'name': _('Build Order Reference Pattern'),
'description': _('Required pattern for generating Build Order reference field'),
'default': 'BO-{ref:04d}',
'validator': build.validators.validate_build_order_reference_pattern,
},
'BUILDORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_ACTIVE_PART': {
'name': _('Require Active Part'),
'description': _('Prevent build order creation for inactive parts'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_LOCKED_PART': {
'name': _('Require Locked Part'),
'description': _('Prevent build order creation for unlocked parts'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_VALID_BOM': {
'name': _('Require Valid BOM'),
'description': _('Prevent build order creation unless BOM has been validated'),
'default': False,
'validator': bool,
},
'BUILDORDER_REQUIRE_CLOSED_CHILDS': {
'name': _('Require Closed Child Orders'),
'description': _(
'Prevent build order completion until all child orders are closed'
),
'default': False,
'validator': bool,
},
'BUILDORDER_EXTERNAL_BUILDS': {
'name': _('External Build Orders'),
'description': _('Enable external build order functionality'),
'default': False,
'validator': bool,
},
'BUILDORDER_EXTERNAL_REQUIRED': {
'name': _('Require External Build Orders'),
'description': _(
'Require an external build order when ordering assembled parts from an external supplier'
),
'default': False,
'validator': bool,
},
'PREVENT_BUILD_COMPLETION_HAVING_INCOMPLETED_TESTS': {
'name': _('Block Until Tests Pass'),
'description': _(
'Prevent build outputs from being completed until all required tests pass'
),
'default': False,
'validator': bool,
},
'RETURNORDER_ENABLED': {
'name': _('Enable Return Orders'),
'description': _('Enable return order functionality in the user interface'),
'validator': bool,
'default': False,
'flags': [SettingFlag.TOGGLE],
},
'RETURNORDER_REFERENCE_PATTERN': {
'name': _('Return Order Reference Pattern'),
'description': _(
'Required pattern for generating Return Order reference field'
),
'default': 'RMA-{ref:04d}',
'validator': order.validators.validate_return_order_reference_pattern,
},
'RETURNORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'RETURNORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Return Orders'),
'description': _(
'Allow editing of return orders after they have been completed'
),
'default': False,
'validator': bool,
},
'SALESORDER_REFERENCE_PATTERN': {
'name': _('Sales Order Reference Pattern'),
'description': _('Required pattern for generating Sales Order reference field'),
'default': 'SO-{ref:04d}',
'validator': order.validators.validate_sales_order_reference_pattern,
},
'SALESORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'SALESORDER_DEFAULT_SHIPMENT': {
'name': _('Sales Order Default Shipment'),
'description': _('Enable creation of default shipment with sales orders'),
'default': False,
'validator': bool,
},
'SALESORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Sales Orders'),
'description': _(
'Allow editing of sales orders after they have been shipped or completed'
),
'default': False,
'validator': bool,
},
'SALESORDER_SHIPMENT_REQUIRES_CHECK': {
'name': _('Shipment Requires Checking'),
'description': _(
'Prevent completion of shipments until items have been checked'
),
'default': False,
'validator': bool,
},
'SALESORDER_SHIP_COMPLETE': {
'name': _('Mark Shipped Orders as Complete'),
'description': _(
'Sales orders marked as shipped will automatically be completed, bypassing the "shipped" status'
),
'default': False,
'validator': bool,
},
'TRANSFERORDER_ENABLED': {
'name': _('Enable Transfer Orders'),
'description': _('Enable transfer order functionality in the user interface'),
'validator': bool,
'default': False,
'flags': [SettingFlag.TOGGLE],
},
'TRANSFERORDER_REFERENCE_PATTERN': {
'name': _('Transfer Order Reference Pattern'),
'description': _(
'Required pattern for generating Transfer Order reference field'
),
'default': 'TO-{ref:04d}',
'validator': order.validators.validate_transfer_order_reference_pattern,
},
'TRANSFERORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'TRANSFERORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Transfer Orders'),
'description': _(
'Allow editing of transfer orders after they have been completed'
),
'default': False,
'validator': bool,
},
'SALESORDER_BLOCK_INCOMPLETE_ITEM_TESTS': {
'name': _('Block Incomplete Item Tests'),
'description': _(
'Prevent allocation of stock items to sales orders if required item tests are incomplete'
),
'default': False,
'validator': bool,
},
'PURCHASEORDER_REFERENCE_PATTERN': {
'name': _('Purchase Order Reference Pattern'),
'description': _(
'Required pattern for generating Purchase Order reference field'
),
'default': 'PO-{ref:04d}',
'validator': order.validators.validate_purchase_order_reference_pattern,
},
'PURCHASEORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'PURCHASEORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Purchase Orders'),
'description': _(
'Allow editing of purchase orders after they have been shipped or completed'
),
'default': False,
'validator': bool,
},
'PURCHASEORDER_CONVERT_CURRENCY': {
'name': _('Convert Currency'),
'description': _('Convert item value to base currency when receiving stock'),
'default': False,
'validator': bool,
},
'PURCHASEORDER_AUTO_COMPLETE': {
'name': _('Auto Complete Purchase Orders'),
'description': _(
'Automatically mark purchase orders as complete when all line items are received'
),
'default': True,
'validator': bool,
},
'PURCHASEORDER_MERGE_LINE_ITEMS': {
'name': _('Merge Purchase Order Line Items'),
'description': _(
'Merge new purchase order line items with existing lines that share the same part, destination, and target date'
),
'default': True,
'validator': bool,
},
'PURCHASEORDER_DEFAULT_RECEIVE_LOCATION': {
'name': _('Default Receive Location'),
'description': _(
'Default destination location for received goods on new purchase orders'
),
'default': '',
'model': 'stock.stocklocation',
'model_filters': {'structural': False},
},
# login / SSO
'LOGIN_ENABLE_PWD_FORGOT': {
'name': _('Enable password forgot'),
@@ -1284,47 +620,6 @@ SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'STOCKTAKE_ENABLE': {
'name': _('Enable Stocktake'),
'description': _(
'Enable functionality for recording historical stock levels and value'
),
'flags': [SettingFlag.TOGGLE],
'validator': bool,
'default': False,
},
'STOCKTAKE_EXCLUDE_EXTERNAL': {
'name': _('Exclude External Locations'),
'description': _(
'Exclude stock items in external locations from stocktake calculations'
),
'validator': bool,
'default': False,
},
'STOCKTAKE_AUTO_DAYS': {
'name': _('Automatic Stocktake Period'),
'description': _('Number of days between automatic stocktake recording'),
'validator': [int, MinValueValidator(1)],
'default': 7,
'units': _('days'),
},
'STOCKTAKE_DELETE_OLD_ENTRIES': {
'name': _('Delete Old Stocktake Entries'),
'description': _(
'Delete stocktake entries older than the specified number of days'
),
'default': False,
'validator': bool,
},
'STOCKTAKE_DELETE_DAYS': {
'name': _('Stocktake Deletion Interval'),
'description': _(
'Stocktake entries will be deleted after specified number of days'
),
'default': 365,
'units': _('days'),
'validator': [int, MinValueValidator(30)],
},
'AUDIT_LOG_ENABLED': {
'name': _('Enable Audit Log'),
'description': _('Record a history of changes made to supported models'),
@@ -1406,25 +701,32 @@ SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'default': True,
'validator': bool,
},
'SALESORDER_ENABLED': {
'name': _('Enable Sales Orders'),
'description': _('Enable sales order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'PURCHASEORDER_ENABLED': {
'name': _('Enable Purchase Orders'),
'description': _('Enable purchase order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'BUILDORDER_ENABLED': {
'name': _('Enable Build Orders'),
'description': _('Enable build order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
}
_settings_collected = False
def collect_system_settings() -> None:
"""Collect the domain-specific system settings from built-in apps."""
global _settings_collected
if _settings_collected:
return
_settings_collected = True
for app in apps.get_app_configs():
module_name = f'{app.name}.system_settings'
try:
if find_spec(module_name) is None:
continue
except ModuleNotFoundError: # pragma: no cover
continue
settings = import_module(module_name).SYSTEM_SETTINGS
duplicates = sorted(SYSTEM_SETTINGS.keys() & settings.keys())
if duplicates:
raise ValueError(f'Duplicate system settings in {app.name}: {duplicates}')
SYSTEM_SETTINGS.update(settings)
+18 -31
View File
@@ -1,45 +1,32 @@
"""Tests for the various validators in the settings."""
from unittest import mock
from django.core.exceptions import ValidationError
from django.test import TestCase, override_settings
import common.setting.system
from common.setting.system import SYSTEM_SETTINGS, collect_system_settings
class SettingsValidatorTests(TestCase):
"""Tests settings validators."""
class SettingsTests(TestCase):
"""Tests settings behaviour."""
def test_validate_part_name_format(self):
"""Test error cases for validate_part_name_format."""
# No field
with self.assertRaises(ValidationError) as err:
common.setting.system.validate_part_name_format('abc{{}}')
self.assertEqual(
err.exception.messages[0],
'At least one field must be present inside a jinja template container i.e {{}}',
)
def test_collection(self):
"""Test collection of system settings."""
# old keys are still there
for key in ['STOCKTAKE_ENABLE', 'STOCK_STALE_DAYS', 'PRICING_DECIMAL_PLACES']:
self.assertIn(key, SYSTEM_SETTINGS)
# Wrong field name
with self.assertRaises(ValidationError) as err:
common.setting.system.validate_part_name_format('{{part.wrong}}')
self.assertEqual(
err.exception.messages[0], 'wrong does not exist in Part Model'
)
# Re-run causes no issues
count = len(SYSTEM_SETTINGS)
collect_system_settings()
self.assertEqual(len(SYSTEM_SETTINGS), count)
# Broken templates
with self.assertRaises(ValidationError) as err:
common.setting.system.validate_part_name_format('{{')
self.assertEqual(err.exception.messages[0], "unexpected 'end of template'")
with self.assertRaises(ValidationError) as err:
common.setting.system.validate_part_name_format(None)
self.assertEqual(err.exception.messages[0], "Can't compile non template nodes")
# Correct template
self.assertTrue(
common.setting.system.validate_part_name_format('{{part.name}}'),
'test part',
)
# Duplicates cause an error
with mock.patch('common.setting.system._settings_collected', False):
with self.assertRaises(ValueError):
collect_system_settings()
def test_update_instance_name_no_multi(self):
"""Test valid cases for update_instance_name."""
-7
View File
@@ -135,10 +135,3 @@ def set_global_warning(key: str, options: Optional[dict] = None) -> bool:
SystemSetId.GLOBAL_WARNING, global_dict_val, change_user=None, create=True
)
return True
def stock_expiry_enabled():
"""Returns True if the stock expiry feature is enabled."""
from common.models import InvenTreeSetting
return InvenTreeSetting.get_setting('STOCK_ENABLE_EXPIRY', False, create=False)
@@ -130,30 +130,6 @@ def validate_attachment_file(attachment):
raise ValidationError(_('Invalid file name'))
def validate_decimal_places_min(value):
"""Validator for PRICING_DECIMAL_PLACES_MIN setting."""
try:
value = int(value)
places_max = int(get_global_setting('PRICING_DECIMAL_PLACES', create=False))
except Exception:
return
if value > places_max:
raise ValidationError(_('Minimum places cannot be greater than maximum places'))
def validate_decimal_places_max(value):
"""Validator for PRICING_DECIMAL_PLACES_MAX setting."""
try:
value = int(value)
places_min = int(get_global_setting('PRICING_DECIMAL_PLACES_MIN', create=False))
except Exception:
return
if value < places_min:
raise ValidationError(_('Maximum places cannot be less than minimum places'))
def validate_email_domains(setting):
"""Validate the email domains setting."""
if not setting.value:
@@ -0,0 +1,188 @@
"""System settings for order app."""
from django.utils.translation import gettext_lazy as _
import order.validators
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
# RO
'RETURNORDER_ENABLED': {
'name': _('Enable Return Orders'),
'description': _('Enable return order functionality in the user interface'),
'validator': bool,
'default': False,
'flags': [SettingFlag.TOGGLE],
},
'RETURNORDER_REFERENCE_PATTERN': {
'name': _('Return Order Reference Pattern'),
'description': _(
'Required pattern for generating Return Order reference field'
),
'default': 'RMA-{ref:04d}',
'validator': order.validators.validate_return_order_reference_pattern,
},
'RETURNORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'RETURNORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Return Orders'),
'description': _(
'Allow editing of return orders after they have been completed'
),
'default': False,
'validator': bool,
},
# SO
'SALESORDER_REFERENCE_PATTERN': {
'name': _('Sales Order Reference Pattern'),
'description': _('Required pattern for generating Sales Order reference field'),
'default': 'SO-{ref:04d}',
'validator': order.validators.validate_sales_order_reference_pattern,
},
'SALESORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'SALESORDER_DEFAULT_SHIPMENT': {
'name': _('Sales Order Default Shipment'),
'description': _('Enable creation of default shipment with sales orders'),
'default': False,
'validator': bool,
},
'SALESORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Sales Orders'),
'description': _(
'Allow editing of sales orders after they have been shipped or completed'
),
'default': False,
'validator': bool,
},
'SALESORDER_SHIPMENT_REQUIRES_CHECK': {
'name': _('Shipment Requires Checking'),
'description': _(
'Prevent completion of shipments until items have been checked'
),
'default': False,
'validator': bool,
},
'SALESORDER_SHIP_COMPLETE': {
'name': _('Mark Shipped Orders as Complete'),
'description': _(
'Sales orders marked as shipped will automatically be completed, bypassing the "shipped" status'
),
'default': False,
'validator': bool,
},
'SALESORDER_BLOCK_INCOMPLETE_ITEM_TESTS': {
'name': _('Block Incomplete Item Tests'),
'description': _(
'Prevent allocation of stock items to sales orders if required item tests are incomplete'
),
'default': False,
'validator': bool,
},
'SALESORDER_ENABLED': {
'name': _('Enable Sales Orders'),
'description': _('Enable sales order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
# TO
'TRANSFERORDER_ENABLED': {
'name': _('Enable Transfer Orders'),
'description': _('Enable transfer order functionality in the user interface'),
'validator': bool,
'default': False,
'flags': [SettingFlag.TOGGLE],
},
'TRANSFERORDER_REFERENCE_PATTERN': {
'name': _('Transfer Order Reference Pattern'),
'description': _(
'Required pattern for generating Transfer Order reference field'
),
'default': 'TO-{ref:04d}',
'validator': order.validators.validate_transfer_order_reference_pattern,
},
'TRANSFERORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'TRANSFERORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Transfer Orders'),
'description': _(
'Allow editing of transfer orders after they have been completed'
),
'default': False,
'validator': bool,
},
# PO
'PURCHASEORDER_REFERENCE_PATTERN': {
'name': _('Purchase Order Reference Pattern'),
'description': _(
'Required pattern for generating Purchase Order reference field'
),
'default': 'PO-{ref:04d}',
'validator': order.validators.validate_purchase_order_reference_pattern,
},
'PURCHASEORDER_REQUIRE_RESPONSIBLE': {
'name': _('Require Responsible Owner'),
'description': _('A responsible owner must be assigned to each order'),
'default': False,
'validator': bool,
},
'PURCHASEORDER_EDIT_COMPLETED_ORDERS': {
'name': _('Edit Completed Purchase Orders'),
'description': _(
'Allow editing of purchase orders after they have been shipped or completed'
),
'default': False,
'validator': bool,
},
'PURCHASEORDER_CONVERT_CURRENCY': {
'name': _('Convert Currency'),
'description': _('Convert item value to base currency when receiving stock'),
'default': False,
'validator': bool,
},
'PURCHASEORDER_AUTO_COMPLETE': {
'name': _('Auto Complete Purchase Orders'),
'description': _(
'Automatically mark purchase orders as complete when all line items are received'
),
'default': True,
'validator': bool,
},
'PURCHASEORDER_MERGE_LINE_ITEMS': {
'name': _('Merge Purchase Order Line Items'),
'description': _(
'Merge new purchase order line items with existing lines that share the same part, destination, and target date'
),
'default': True,
'validator': bool,
},
'PURCHASEORDER_DEFAULT_RECEIVE_LOCATION': {
'name': _('Default Receive Location'),
'description': _(
'Default destination location for received goods on new purchase orders'
),
'default': '',
'model': 'stock.stocklocation',
'model_filters': {'structural': False},
},
'PURCHASEORDER_ENABLED': {
'name': _('Enable Purchase Orders'),
'description': _('Enable purchase order functionality in the user interface'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
}
@@ -0,0 +1,224 @@
"""System settings for part app."""
from django.core.validators import MinValueValidator
from django.utils.translation import gettext_lazy as _
import common.validators
import part.validators
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
def reset_part_name_format(setting):
"""Clear the cached Part 'full_name' template when PART_NAME_FORMAT changes."""
from part.helpers import reset_full_name_template
reset_full_name_template()
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'PART_ENABLE_LOCKING': {
'name': _('Part Locking'),
'description': _('Enable locking of parts to prevent modification'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'PART_ENABLE_REVISION': {
'name': _('Part Revisions'),
'description': _('Enable revision field for Part'),
'validator': bool,
'default': True,
'flags': [SettingFlag.TOGGLE],
},
'PART_REVISION_ASSEMBLY_ONLY': {
'name': _('Assembly Revision Only'),
'description': _('Only allow revisions for assembly parts'),
'validator': bool,
'default': False,
},
'PART_ALLOW_DELETE_FROM_ASSEMBLY': {
'name': _('Allow Deletion from Assembly'),
'description': _('Allow deletion of parts which are used in an assembly'),
'validator': bool,
'default': False,
},
'PART_IPN_REGEX': {
'name': _('IPN Regex'),
'description': _('Regular expression pattern for matching Part IPN'),
},
'PART_ALLOW_DUPLICATE_IPN': {
'name': _('Allow Duplicate IPN'),
'description': _('Allow multiple parts to share the same IPN'),
'default': True,
'validator': bool,
},
'PART_ALLOW_EDIT_IPN': {
'name': _('Allow Editing IPN'),
'description': _('Allow changing the IPN value while editing a part'),
'default': True,
'validator': bool,
},
'PART_COPY_BOM': {
'name': _('Copy Part BOM Data'),
'description': _('Copy BOM data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_COPY_PARAMETERS': {
'name': _('Copy Part Parameter Data'),
'description': _('Copy parameter data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_COPY_TESTS': {
'name': _('Copy Part Test Data'),
'description': _('Copy test data by default when duplicating a part'),
'default': True,
'validator': bool,
},
'PART_CATEGORY_PARAMETERS': {
'name': _('Copy Category Parameter Templates'),
'description': _('Copy category parameter templates when creating a part'),
'default': True,
'validator': bool,
},
'PART_TEMPLATE': {
'name': _('Template'),
'description': _('Parts are templates by default'),
'default': False,
'validator': bool,
},
'PART_ASSEMBLY': {
'name': _('Assembly'),
'description': _('Parts can be assembled from other components by default'),
'default': False,
'validator': bool,
},
'PART_COMPONENT': {
'name': _('Component'),
'description': _('Parts can be used as sub-components by default'),
'default': True,
'validator': bool,
},
'PART_PURCHASEABLE': {
'name': _('Purchaseable'),
'description': _('Parts are purchaseable by default'),
'default': True,
'validator': bool,
},
'PART_SALABLE': {
'name': _('Salable'),
'description': _('Parts are salable by default'),
'default': False,
'validator': bool,
},
'PART_TRACKABLE': {
'name': _('Trackable'),
'description': _('Parts are trackable by default'),
'default': False,
'validator': bool,
},
'PART_VIRTUAL': {
'name': _('Virtual'),
'description': _('Parts are virtual by default'),
'default': False,
'validator': bool,
},
'PART_SHOW_RELATED': {
'name': _('Show related parts'),
'description': _('Display related parts for a part'),
'default': True,
'validator': bool,
},
'PART_CREATE_INITIAL': {
'name': _('Initial Stock Data'),
'description': _('Allow creation of initial stock when adding a new part'),
'default': False,
'validator': bool,
},
'PART_CREATE_SUPPLIER': {
'name': _('Initial Supplier Data'),
'description': _(
'Allow creation of initial supplier data when adding a new part'
),
'default': True,
'validator': bool,
},
'PART_NAME_FORMAT': {
'name': _('Part Name Display Format'),
'description': _('Format to display the part name'),
'default': "{{ part.IPN if part.IPN }}{{ ' | ' if part.IPN }}{{ part.name }}{{ ' | ' if part.revision }}"
'{{ part.revision if part.revision }}',
'validator': part.validators.validate_part_name_format,
'after_save': reset_part_name_format,
},
'PART_CATEGORY_DEFAULT_ICON': {
'name': _('Part Category Default Icon'),
'description': _('Part category default icon (empty means no icon)'),
'default': '',
'validator': common.validators.validate_icon,
},
'PART_INTERNAL_PRICE': {
'name': _('Internal Prices'),
'description': _('Enable internal prices for parts'),
'default': False,
'validator': bool,
},
'PART_BOM_USE_INTERNAL_PRICE': {
'name': _('Internal Price Override'),
'description': _(
'If available, internal prices override price range calculations'
),
'default': False,
'validator': bool,
},
'PART_BOM_ALLOW_ZERO_QUANTITY': {
'name': _('Allow BOM Zero Quantity'),
'description': _(
'Accept a zero quantity for BOM item for part. Enables using setup quantity to define a quantity required per build, independent of build quantity'
),
'default': False,
'validator': bool,
},
'STOCKTAKE_ENABLE': {
'name': _('Enable Stocktake'),
'description': _(
'Enable functionality for recording historical stock levels and value'
),
'flags': [SettingFlag.TOGGLE],
'validator': bool,
'default': False,
},
'STOCKTAKE_EXCLUDE_EXTERNAL': {
'name': _('Exclude External Locations'),
'description': _(
'Exclude stock items in external locations from stocktake calculations'
),
'validator': bool,
'default': False,
},
'STOCKTAKE_AUTO_DAYS': {
'name': _('Automatic Stocktake Period'),
'description': _('Number of days between automatic stocktake recording'),
'validator': [int, MinValueValidator(1)],
'default': 7,
'units': _('days'),
},
'STOCKTAKE_DELETE_OLD_ENTRIES': {
'name': _('Delete Old Stocktake Entries'),
'description': _(
'Delete stocktake entries older than the specified number of days'
),
'default': False,
'validator': bool,
},
'STOCKTAKE_DELETE_DAYS': {
'name': _('Stocktake Deletion Interval'),
'description': _(
'Stocktake entries will be deleted after specified number of days'
),
'default': 365,
'units': _('days'),
'validator': [int, MinValueValidator(30)],
},
}
@@ -0,0 +1,41 @@
"""Unit tests for part app validators."""
from django.core.exceptions import ValidationError
from django.test import TestCase
import part.validators
class PartValidatorTests(TestCase):
"""Tests for part validators."""
def test_validate_part_name_format(self):
"""Test error cases for validate_part_name_format."""
# No field
with self.assertRaises(ValidationError) as err:
part.validators.validate_part_name_format('abc{{}}')
self.assertEqual(
err.exception.messages[0],
'At least one field must be present inside a jinja template container i.e {{}}',
)
# Wrong field name
with self.assertRaises(ValidationError) as err:
part.validators.validate_part_name_format('{{part.wrong}}')
self.assertEqual(
err.exception.messages[0], 'wrong does not exist in Part Model'
)
# Broken templates
with self.assertRaises(ValidationError) as err:
part.validators.validate_part_name_format('{{')
self.assertEqual(err.exception.messages[0], "unexpected 'end of template'")
with self.assertRaises(ValidationError) as err:
part.validators.validate_part_name_format(None)
self.assertEqual(err.exception.messages[0], "Can't compile non template nodes")
# Correct template
self.assertTrue(
part.validators.validate_part_name_format('{{part.name}}'), 'test part'
)
+46
View File
@@ -0,0 +1,46 @@
"""Validators for part app."""
import re
from django.core.exceptions import FieldDoesNotExist, ValidationError
from jinja2.sandbox import SandboxedEnvironment
def validate_part_name_format(value):
"""Validate part name format.
Make sure that each template container has a field of Part Model
"""
# Make sure that the field_name exists in Part model
from part.models import Part
jinja_template_regex = re.compile(r'{{.*?}}')
field_name_regex = re.compile(r'(?<=part\.)[A-z]+')
for jinja_template in jinja_template_regex.findall(str(value)):
# make sure at least one and only one field is present inside the parser
field_names = field_name_regex.findall(jinja_template)
if len(field_names) < 1:
raise ValidationError({
'value': 'At least one field must be present inside a jinja template container i.e {{}}'
})
for field_name in field_names:
try:
Part._meta.get_field(field_name)
except FieldDoesNotExist:
raise ValidationError({
'value': f'{field_name} does not exist in Part Model'
})
# Attempt to render the template with a dummy Part instance
# Use pk=1 to ensure conditional checks like {% if part.pk %} are evaluated
p = Part(pk=1, name='test part', description='some test part')
try:
SandboxedEnvironment().from_string(value).render({'part': p})
except Exception as exc:
raise ValidationError({'value': str(exc)})
return True
@@ -0,0 +1,98 @@
"""System settings for the pricing app."""
from django.core.validators import MaxValueValidator, MinValueValidator
from django.utils.translation import gettext_lazy as _
import pricing.validators
from common.setting.type import InvenTreeSettingsKeyType
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'PRICING_DECIMAL_PLACES_MIN': {
'name': _('Minimum Pricing Decimal Places'),
'description': _(
'Minimum number of decimal places to display when rendering pricing data'
),
'default': 0,
'validator': [
int,
MinValueValidator(0),
MaxValueValidator(4),
pricing.validators.validate_decimal_places_min,
],
},
'PRICING_DECIMAL_PLACES': {
'name': _('Maximum Pricing Decimal Places'),
'description': _(
'Maximum number of decimal places to display when rendering pricing data'
),
'default': 6,
'validator': [
int,
MinValueValidator(2),
MaxValueValidator(6),
pricing.validators.validate_decimal_places_max,
],
},
'PRICING_USE_SUPPLIER_PRICING': {
'name': _('Use Supplier Pricing'),
'description': _(
'Include supplier price breaks in overall pricing calculations'
),
'default': True,
'validator': bool,
},
'PRICING_PURCHASE_HISTORY_OVERRIDES_SUPPLIER': {
'name': _('Purchase History Override'),
'description': _(
'Historical purchase order pricing overrides supplier price breaks'
),
'default': False,
'validator': bool,
},
'PRICING_USE_STOCK_PRICING': {
'name': _('Use Stock Item Pricing'),
'description': _(
'Use pricing from manually entered stock data for pricing calculations'
),
'default': True,
'validator': bool,
},
'PRICING_STOCK_ITEM_AGE_DAYS': {
'name': _('Stock Item Pricing Age'),
'description': _(
'Exclude stock items older than this number of days from pricing calculations'
),
'default': 0,
'units': _('days'),
'validator': [int, MinValueValidator(0)],
},
'PRICING_USE_VARIANT_PRICING': {
'name': _('Use Variant Pricing'),
'description': _('Include variant pricing in overall pricing calculations'),
'default': True,
'validator': bool,
},
'PRICING_ACTIVE_VARIANTS': {
'name': _('Active Variants Only'),
'description': _(
'Only use active variant parts for calculating variant pricing'
),
'default': False,
'validator': bool,
},
'PRICING_AUTO_UPDATE': {
'name': _('Auto Update Pricing'),
'description': _(
'Automatically update part pricing when internal data changes'
),
'default': True,
'validator': bool,
},
'PRICING_UPDATE_DAYS': {
'name': _('Pricing Rebuild Interval'),
'description': _('Number of days before part pricing is automatically updated'),
'units': _('days'),
'default': 30,
'validator': [int, MinValueValidator(0)],
},
}
@@ -0,0 +1,30 @@
"""Validators for pricing app."""
from django.core.exceptions import ValidationError
from django.utils.translation import gettext_lazy as _
from common.settings import get_global_setting
def validate_decimal_places_min(value):
"""Validator for PRICING_DECIMAL_PLACES_MIN setting."""
try:
value = int(value)
places_max = int(get_global_setting('PRICING_DECIMAL_PLACES', create=False))
except Exception:
return
if value > places_max:
raise ValidationError(_('Minimum places cannot be greater than maximum places'))
def validate_decimal_places_max(value):
"""Validator for PRICING_DECIMAL_PLACES_MAX setting."""
try:
value = int(value)
places_min = int(get_global_setting('PRICING_DECIMAL_PLACES_MIN', create=False))
except Exception:
return
if value < places_min:
raise ValidationError(_('Maximum places cannot be less than minimum places'))
@@ -0,0 +1,59 @@
"""System settings for the report app."""
from django.core.validators import MinValueValidator
from django.utils.translation import gettext_lazy as _
import report.helpers
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'LABEL_ENABLE': {
'name': _('Enable label printing'),
'description': _('Enable label printing from the web interface'),
'default': True,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'LABEL_DPI': {
'name': _('Label Image DPI'),
'description': _(
'DPI resolution when generating image files to supply to label printing plugins'
),
'default': 300,
'validator': [int, MinValueValidator(100)],
},
'REPORT_ENABLE': {
'name': _('Enable Reports'),
'description': _('Enable generation of reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'REPORT_DEBUG_MODE': {
'name': _('Debug Mode'),
'description': _('Generate reports in debug mode (HTML output)'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_FETCH_URLS': {
'name': _('Report URL Fetching'),
'description': _('Allow fetching of remote URLs when generating reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_LOG_ERRORS': {
'name': _('Log Report Errors'),
'description': _('Log errors which occur when generating reports'),
'default': False,
'validator': bool,
'flags': [SettingFlag.SECURITY],
},
'REPORT_DEFAULT_PAGE_SIZE': {
'name': _('Page Size'),
'description': _('Default page size for PDF reports'),
'default': 'A4',
'choices': report.helpers.report_page_size_options,
},
}
+2 -2
View File
@@ -21,7 +21,6 @@ from rest_framework.serializers import ValidationError
import common.filters
import common.models
import common.settings
import InvenTree.helpers
import InvenTree.permissions
import stock.serializers as StockSerializers
@@ -65,6 +64,7 @@ from stock.models import (
StockLocationType,
)
from stock.status_codes import StockHistoryCode, StockStatus
from stock.system_settings import stock_expiry_enabled
from users.permissions import check_user_permission
@@ -756,7 +756,7 @@ class StockFilter(FilterSet):
def filter_expired(self, queryset, name, value):
"""Filter by whether or not the stock item has expired."""
if not common.settings.stock_expiry_enabled():
if not stock_expiry_enabled():
return queryset
if str2bool(value):
@@ -0,0 +1,110 @@
"""System settings for the stock app."""
from django.utils.translation import gettext_lazy as _
import common.validators
from common.setting.type import InvenTreeSettingsKeyType, SettingFlag
SYSTEM_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
'STOCK_DELETE_DEPLETED_DEFAULT': {
'name': _('Delete Depleted Stock'),
'description': _('Determines default behavior when a stock item is depleted'),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_EDIT_SERIAL': {
'name': _('Allow Edit Serial Number'),
'description': _('Allow editing of serial number for stock items'),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_DELETE_SERIALIZED': {
'name': _('Delete Serialized Stock'),
'description': _('Allow deletion of stock items which have a serial number'),
'default': True,
'validator': bool,
},
'STOCK_BATCH_CODE_TEMPLATE': {
'name': _('Batch Code Template'),
'description': _('Template for generating default batch codes for stock items'),
'default': '',
},
'STOCK_ENABLE_EXPIRY': {
'name': _('Stock Expiry'),
'description': _('Enable stock expiry functionality'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'STOCK_ALLOW_EXPIRED_SALE': {
'name': _('Sell Expired Stock'),
'description': _('Allow sale of expired stock'),
'default': False,
'validator': bool,
},
'STOCK_STALE_DAYS': {
'name': _('Stock Stale Time'),
'description': _(
'Number of days stock items are considered stale before expiring'
),
'default': 0,
'units': _('days'),
'validator': [int],
},
'STOCK_ALLOW_EXPIRED_BUILD': {
'name': _('Build Expired Stock'),
'description': _('Allow building with expired stock'),
'default': False,
'validator': bool,
},
'STOCK_OWNERSHIP_CONTROL': {
'name': _('Stock Ownership Control'),
'description': _('Enable ownership control over stock locations and items'),
'default': False,
'validator': bool,
'flags': [SettingFlag.TOGGLE],
},
'STOCK_LOCATION_DEFAULT_ICON': {
'name': _('Stock Location Default Icon'),
'description': _('Stock location default icon (empty means no icon)'),
'default': '',
'validator': common.validators.validate_icon,
},
'STOCK_SHOW_INSTALLED_ITEMS': {
'name': _('Show Installed Stock Items'),
'description': _('Display installed stock items in stock tables'),
'default': False,
'validator': bool,
},
'STOCK_ENFORCE_BOM_INSTALLATION': {
'name': _('Check BOM when installing items'),
'description': _(
'Installed stock items must exist in the BOM for the parent part'
),
'default': True,
'validator': bool,
},
'STOCK_ALLOW_OUT_OF_STOCK_TRANSFER': {
'name': _('Allow Out of Stock Transfer'),
'description': _(
'Allow stock items which are not in stock to be transferred between stock locations'
),
'default': False,
'validator': bool,
},
'STOCK_MERGE_ON_TRANSFER': {
'name': _('Merge stock with existing stock on transfer by default'),
'description': _(
'Default state for merge stock on transfer behaviour. (Can be changed per transfer if desired)'
),
'default': False,
'validator': bool,
},
}
def stock_expiry_enabled():
"""Returns True if the stock expiry feature is enabled."""
from common.models import InvenTreeSetting
return InvenTreeSetting.get_setting('STOCK_ENABLE_EXPIRY', False, create=False)