mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-28 03:26:45 +00:00
e8d16298a4
* Add skeleton for builtin label printing plugin * Force selection of plugin when printing labels * Enhance LabelPrintingMixin class - Add render_to_pdf method - Add render_to_html method * Enhance plugin mixin - Add class attribute to select blocking or non-blocking printing - Add render_to_png method - Add default method for printing multiple labels - Add method for offloding print job * Simplify print_label background function - All arguments now handled by specific plugin * Simplify label printing API - Simply pass data to the particular plugin - Check result type - Return result * Updated sample plugin * Working on client side code * Cleanup * Update sample plugin * Add new model type - LabelOutput model - Stores generated label file to the database - Makes available for download * Update label printing plugin mixin * Add background task to remove any old label outputs * Open file if response contains filename * Remove "default printer" option which does not specify a plugin * Delete old labels after 5 days * Remove debug statements * Update API version * Changed default behaviour to background printing * Update label plugin mixin docs * Provide default printer if none provided (legacy) * Update unit test * unit test updates * Further fixes for unit tests * unit test updates
63 lines
1.9 KiB
Python
63 lines
1.9 KiB
Python
"""Functions to print a label to a mixin printer."""
|
|
|
|
import logging
|
|
|
|
from django.conf import settings
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
import common.notifications
|
|
from InvenTree.exceptions import log_error
|
|
from plugin.registry import registry
|
|
|
|
logger = logging.getLogger('inventree')
|
|
|
|
|
|
def print_label(plugin_slug: str, **kwargs):
|
|
"""Print label with the provided plugin.
|
|
|
|
This task is nominally handled by the background worker.
|
|
If the printing fails (throws an exception) then the user is notified.
|
|
|
|
Arguments:
|
|
plugin_slug (str): The unique slug (key) of the plugin.
|
|
|
|
kwargs:
|
|
passed through to the plugin.print_label() method
|
|
"""
|
|
logger.info(f"Plugin '{plugin_slug}' is printing a label")
|
|
|
|
plugin = registry.get_plugin(plugin_slug)
|
|
|
|
if plugin is None: # pragma: no cover
|
|
logger.error(f"Could not find matching plugin for '{plugin_slug}'")
|
|
return
|
|
|
|
try:
|
|
plugin.print_label(**kwargs)
|
|
except Exception as e: # pragma: no cover
|
|
# Plugin threw an error - notify the user who attempted to print
|
|
ctx = {
|
|
'name': _('Label printing failed'),
|
|
'message': str(e),
|
|
}
|
|
|
|
user = kwargs.get('user', None)
|
|
|
|
if user:
|
|
# Log an error message to the database
|
|
log_error('plugin.print_label')
|
|
logger.error(f"Label printing failed: Sending notification to user '{user}'") # pragma: no cover
|
|
|
|
# Throw an error against the plugin instance
|
|
common.notifications.trigger_notification(
|
|
plugin.plugin_config(),
|
|
'label.printing_failed',
|
|
targets=[user],
|
|
context=ctx,
|
|
delivery_methods={common.notifications.UIMessageNotification, },
|
|
)
|
|
|
|
if settings.TESTING:
|
|
# If we are in testing mode, we want to know about this exception
|
|
raise e
|