Skip to content

Instantly share code, notes, and snippets.



Last active Feb 12, 2019
What would you like to do?
Setting["key"] = "value" Setting["key"].of(Plant.objects.first()) = "value2" Setting["key"].of(table1, employee1) = "value2"
class SettingsMeta(ModelBase):
def __getitem__(self, name: str) -> Any:
return Setting.get_value(name)
def __setitem__(self, name: str, value) -> None:
Setting.set_value(name, value)
class TargetedSetting:
def __init__(self, employee: Optional[Employee] = None, obj=None):
self.obj = obj
# self.kwargs = kwargs
self.employee = employee
def __getitem__(self, name: str) -> Any:
return Setting.get_value(name, obj=self.obj, employee=self.employee)
def __setitem__(self, name: str, value) -> None:
Setting.set_value(name=name, value=value, employee=self.employee, obj=self.obj)
def __str__(self):
return f'TargetedSetting obj={self.obj} kwargs employee={self.employee}'
class Setting(StrAsDictMixin, models.Model, metaclass=SettingsMeta):
Arbitrary setting for Field/Journal/Table/Plant,
or any model related to them
name = models.CharField(max_length=128, verbose_name='Имя')
verbose_name = models.CharField(max_length=256, verbose_name='Название', blank=True)
value = models.BinaryField(max_length=4096, verbose_name='Значение')
employee = models.ForeignKey(Employee, null=True, on_delete=models.CASCADE, blank=True)
content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE,
null=True, related_name='settings',
related_query_name='setting', blank=True)
object_id = models.PositiveIntegerField(null=True, blank=True, db_index=True)
scope = GenericForeignKey('content_type', 'object_id')
class Meta:
# equivalent to unique_together = [name, employee, scope], but this works
verbose_name = 'Настройка'
verbose_name_plural = 'Настройки'
unique_together = (('name', 'employee', 'content_type', 'object_id'),)
indexes = [
models.Index(fields=['name', 'employee']),
models.Index(fields=['name', 'content_type', 'object_id']),
scopes_attrs = (
(Field, 'field'),
(Table, 'table'),
(Journal, 'journal'),
(Plant, 'plant'),
def get_value(name: str, obj=None, employee: Optional[Employee] = None) -> Any:
Returns setting value for object.
If object is not field/table/journal/plant,
get related field/table/journal/plant first
and than return most close setting.
qs = Setting.objects.filter(**{
'name': name,
'employee': employee,
@cached_as(qs, extra=obj)
def _cached_get_value(name: str, obj=None, employee: Optional[Employee] = None):
found_setting = None
for (scope, attr) in Setting.scopes_attrs:
if hasattr(obj, attr): # get parent object if it exists
obj = getattr(obj, attr)
if type(obj) == scope:
found_setting = Setting.objects.filter(**{
'name': name,
'employee': employee,
attr: obj
if found_setting:
return pickle.loads(found_setting.value)
else: # case of global setting
found_setting = Setting.objects.get(name=name, employee=employee)
return found_setting.val()
except: # if haven't found, we'll search father
# if no employee specific setting was found,
# search for global setting
if not found_setting and employee:
return Setting.get_value(name, obj)
# raise ValueError("No such setting")
return _cached_get_value(name, obj, employee)
def set_value(name: str, value, employee: Employee = None, obj=None) -> None:
defaults={'value': Setting._dumps(value)},
employee=employee, if obj else None,
content_type=ContentType.objects.get_for_model(obj) if obj else None)
def _dumps(value):
return pickletools.optimize(pickle.dumps(value, protocol=pickle.HIGHEST_PROTOCOL))
def val(self):
return pickle.loads(self.value)
def of(obj=None, employee: Optional[Employee] = None) -> TargetedSetting:
return TargetedSetting(employee=employee, obj=obj)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment