Files
tryton/modules/stock_package_shipping/stock.py
T
Maxime Richez bc7a3cc07c Decorate pack button of customer shipment when extending it for shipping
Closes #13131
(grafted from 710bafa013393a2ebd3731d890fad427c75df1f1)

--HG--
branch : 6.0
2024-04-15 16:20:31 +02:00

359 lines
11 KiB
Python

# This file is part of Tryton. The COPYRIGHT file at the top level of
# this repository contains the full copyright notices and license terms.
from sql import Column
from trytond.config import config
from trytond.i18n import gettext
from trytond.model import Workflow, ModelView, fields
from trytond.model.exceptions import AccessError
from trytond.pool import PoolMeta, Pool
from trytond.pyson import Eval, Bool, Id
from trytond.transaction import Transaction
from trytond.wizard import Wizard, StateTransition
from .exceptions import PackWarning
if config.getboolean('stock_package_shipping', 'filestore', default=False):
file_id = 'shipping_label_id'
store_prefix = config.get(
'stock_package_shipping', 'store_prefix', default=None)
else:
file_id = store_prefix = None
class DimensionsMixin(object):
__slots__ = ()
length = fields.Float('Length', digits=(16, Eval('length_digits', 2)),
depends=['length_digits'])
length_uom = fields.Many2One('product.uom', 'Length Unit',
domain=[
('category', '=', Id('product', 'uom_cat_length')),
],
states={
'required': Bool(Eval('length')),
},
depends=['length', 'length_digits'])
length_digits = fields.Function(fields.Integer('Length Digits'),
'on_change_with_length_digits')
height = fields.Float('Height', digits=(16, Eval('height_digits', 2)),
depends=['height_digits'])
height_uom = fields.Many2One('product.uom', 'Height Unit',
domain=[
('category', '=', Id('product', 'uom_cat_length')),
],
states={
'required': Bool(Eval('height')),
},
depends=['height', 'height_digits'])
height_digits = fields.Function(fields.Integer('Height Digits'),
'on_change_with_height_digits')
width = fields.Float('Width', digits=(16, Eval('width_digits', 2)),
depends=['width_digits'])
width_uom = fields.Many2One('product.uom', 'Width Unit',
domain=[
('category', '=', Id('product', 'uom_cat_length')),
],
states={
'required': Bool(Eval('width')),
},
depends=['width', 'width_digits'])
width_digits = fields.Function(fields.Integer('Width Digits'),
'on_change_with_width_digits')
@fields.depends('length_uom')
def on_change_with_length_digits(self, name=None):
return (self.length_uom.digits if self.length_uom
else self.default_length_digits())
@fields.depends('height_uom')
def on_change_with_height_digits(self, name=None):
return (self.height_uom.digits if self.height_uom
else self.default_height_digits())
@fields.depends('width_uom')
def on_change_with_width_digits(self, name=None):
return (self.width_uom.digits if self.width_uom
else self.default_width_digits())
@classmethod
def default_length_digits(cls):
return 2
@classmethod
def default_height_digits(cls):
return 2
@classmethod
def default_width_digits(cls):
return 2
class PackageType(DimensionsMixin, metaclass=PoolMeta):
__name__ = 'stock.package.type'
class Package(DimensionsMixin, metaclass=PoolMeta):
__name__ = 'stock.package'
shipping_reference = fields.Char('Shipping Reference',
states={
'readonly': Eval('_parent_shipment', {}).get('carrier', False),
})
shipping_label = fields.Binary(
"Shipping Label", readonly=True,
file_id=file_id, store_prefix=store_prefix)
shipping_label_id = fields.Char("Shipping Label ID", readonly=True)
shipping_tracking_url = fields.Function(
fields.Char(
"Shipping Tracking URL",
states={
'invisible': ~Eval('shipping_tracking_url'),
}),
'get_shipping_tracking_url')
def get_shipping_tracking_url(self, name):
return
@classmethod
def __register__(cls, module_name):
pool = Pool()
PackageType = pool.get('stock.package.type')
cursor = Transaction().connection.cursor()
table = cls.__table__()
package_type = PackageType.__table__()
table_h = cls.__table_handler__(module_name)
dimension_columns = [
'length', 'length_uom',
'height', 'height_uom',
'width', 'width_uom']
dimension_exists = any(
table_h.column_exist(c) for c in dimension_columns)
super().__register__(module_name)
# Migration from 5.8: Update dimensions on package from package_type
if not dimension_exists:
columns = []
values = []
for c in dimension_columns:
columns.append(Column(table, c))
values.append(package_type.select(
Column(package_type, c),
where=package_type.id == table.type))
cursor.execute(*table.update(
columns=columns,
values=values))
@classmethod
def search_rec_name(cls, name, clause):
_, operator, value = clause
if operator.startswith('!') or operator.startswith('not '):
bool_op = 'AND'
else:
bool_op = 'OR'
domain = super(Package, cls).search_rec_name(name, clause)
return [bool_op,
domain,
('shipping_reference', *clause[1:]),
]
@fields.depends('type')
def on_change_type(self):
super().on_change_type()
if self.type:
self.length = self.type.length
self.length_uom = self.type.length_uom
self.height = self.type.height
self.height_uom = self.type.height_uom
self.width = self.type.width
self.width_uom = self.type.width_uom
@classmethod
def copy(cls, packages, default=None):
if default is None:
default = {}
else:
default = default.copy()
default.setdefault('shipping_reference', None)
default.setdefault('shipping_label', None)
return super(Package, cls).copy(packages, default=default)
class ShippingMixin:
shipping_description = fields.Char('Shipping Description',
states={
'readonly': Eval('state').in_(['done', 'packed'])
},
depends=['state'])
@classmethod
def __setup__(cls):
super().__setup__()
cls._buttons.update({
'create_shipping': {
'invisible': (Eval('reference', False)
| ~Eval('carrier', False)),
'readonly': (Eval('reference', False)
| ~Eval('root_packages', False)
| ~Eval('carrier', False)
| ~Eval('state').in_(['packed', 'done'])),
'depends': ['state', 'carrier', 'reference',
'root_packages'],
},
})
@classmethod
def search_rec_name(cls, name, clause):
_, operator, value = clause
if operator.startswith('!') or operator.startswith('not '):
bool_op = 'AND'
else:
bool_op = 'OR'
domain = super().search_rec_name(name, clause)
return [bool_op,
domain,
('reference', *clause[1:]),
]
@classmethod
def validate(cls, shipments):
super().validate(shipments)
for shipment in shipments:
if shipment.carrier and shipment.carrier.shipping_service:
method_name = ('validate_packing_%s'
% shipment.carrier.shipping_service)
validator = getattr(shipment, method_name)
validator()
@classmethod
def check_no_carrier(cls, shipments):
pool = Pool()
Warning = pool.get('res.user.warning')
for shipment in shipments:
if not shipment.carrier:
name = 'shipment_out_no_carrier_%s' % shipment
if Warning.check(name):
raise PackWarning(name,
gettext('stock_package_shipping'
'.msg_shipment_without_carrier',
shipment=shipment.rec_name))
@classmethod
@ModelView.button_action(
'stock_package_shipping.act_create_shipping_wizard')
def create_shipping(cls, shipments):
for shipment in shipments:
if shipment.state not in shipment.shipping_allowed:
raise AccessError(
gettext('stock_package_shipping.msg_shipment_not_packed',
shipment=shipment.rec_name))
@property
def shipping_allowed(self):
raise NotImplementedError
@property
def shipping_warehouse(self):
raise NotImplementedError
@property
def shipping_to(self):
raise NotImplementedError
@property
def shipping_to_address(self):
raise NotImplementedError
class ShipmentOut(ShippingMixin, metaclass=PoolMeta):
__name__ = 'stock.shipment.out'
@classmethod
def __register__(cls, module):
pool = Pool()
ModelData = pool.get('ir.model.data')
model_data = ModelData.__table__()
cursor = Transaction().connection.cursor()
super(ShipmentOut, cls).__register__(module)
# Migration from 4.6: rename create_shipping xml id
if module == 'stock_package_shipping':
cursor.execute(*model_data.update(
[model_data.fs_id],
['shipment_out_create_shipping_button'],
where=(model_data.module == module)
& (model_data.model == 'ir.model.button')
& (model_data.fs_id == 'create_shipping_button')))
@classmethod
@ModelView.button
@Workflow.transition('packed')
def pack(cls, shipments):
super().pack(shipments)
cls.check_no_carrier(shipments)
@property
def shipping_allowed(self):
return {'packed', 'done'}
@property
def shipping_warehouse(self):
return self.warehouse
@property
def shipping_to(self):
return self.customer
@property
def shipping_to_address(self):
return self.delivery_address
class ShipmentInReturn(ShippingMixin, metaclass=PoolMeta):
__name__ = 'stock.shipment.in.return'
carrier = fields.Many2One(
'carrier', "Carrier",
states={
'readonly': ~Eval('state').in_(['draft', 'waiting', 'assigned']),
},
depends=['state'])
@classmethod
@ModelView.button
@Workflow.transition('done')
def done(cls, shipments):
super().done(shipments)
cls.check_no_carrier(shipments)
@property
def shipping_allowed(self):
return {'assigned', 'done'}
@property
def shipping_warehouse(self):
return self.from_location.warehouse
@property
def shipping_to(self):
return self.supplier
@property
def shipping_to_address(self):
return self.delivery_address
class CreateShipping(Wizard):
'Create Shipping'
__name__ = 'stock.shipment.create_shipping'
start = StateTransition()
def transition_start(self):
shipping_service = self.record.carrier.shipping_service
method_name = 'validate_packing_%s' % shipping_service
getattr(self.record, method_name)()
return 'end'