AlekSIS

Table Of Contents

Extensible models

In AlekSIS you can use ExtensibleModels to add model fields to other apps models.

If you want to make your apps models extensible, use the ExtensibleModel class as parent class of your models.

class aleksis.core.mixins.AdvancedCreateView(**kwargs)

class aleksis.core.mixins.AdvancedDeleteView(**kwargs)

Common confirm view for deleting.

Warning

Using this view, objects are deleted permanently after confirming. We recommend to include the mixin reversion.views.RevisionMixin from django-reversion to enable soft-delete.

delete(request, *args, **kwargs)

Call the delete() method on the fetched object and then redirect to the success URL.

class aleksis.core.mixins.AdvancedEditView(**kwargs)

class aleksis.core.mixins.BaseModelAdmin(model, admin_site)

A base class for ModelAdmin combining django-guardian and rules.

class aleksis.core.mixins.ExtensibleForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

Base model for extensible forms.

This mixin adds functionality which allows - apps to add layout nodes to the layout used by django-material

Add layout nodes

from material import Fieldset

from aleksis.core.forms import ExampleForm

node = Fieldset("field_name")
ExampleForm.add_node_to_layout(node)

classmethod add_node_to_layout(node)

Add a node to layout attribute.

Parameters

node (LayoutNode) – django-material layout node (Fieldset, Row etc.)

class aleksis.core.mixins.ExtensibleModel(*args, **kwargs)

Base model for all objects in AlekSIS apps.

This base model ensures all objects in AlekSIS apps fulfill the following properties:

• versions property to retrieve all versions of the model from reversion

• Allow injection of fields and code from AlekSIS apps to extend model functionality.

After all apps have been loaded, the code in the model_extensions module in every app is executed. All code that shall be injected into a model goes there.

Example

from datetime import date, timedelta

from jsonstore import CharField

from aleksis.core.models import Person

@Person.property
def is_cool(self) -> bool:
    return True

@Person.property
def age(self) -> timedelta:
    return self.date_of_birth - date.today()

Person.field(shirt_size=CharField())

For a more advanced example, using features from the ORM, see AlekSIS-App-Chronos and AlekSIS-App-Alsijil.

Date

2019-11-07

Authors

• Dominik George <dominik.george@teckids.org>

Parameters

• site (ForeignKey to Site) – Site

• extended_data (JSONField) – Extended data

classmethod add_permission(name, verbose_name)

Dynamically add a new permission to a model.

classmethod class_method(func, name=None)

Add the passed callable as a classmethod.

Return type

None

classmethod field(**kwargs)

Add the passed jsonstore field. Must be one of the fields in django-jsonstore.

Accepts exactly one keyword argument, with the name being the desired model field name and the value the field instance.

Return type

None

classmethod foreign_key(field_name, to, to_field='pk', to_field_type=<class 'jsonstore.fields.IntegerField'>, related_name=None)

Add a virtual ForeignKey.

This works by storing the primary key (or any field passed in the to_field argument) and adding a property that queries the desired model.

If the foreign model also is an ExtensibleModel, a reverse mapping is also added under the related_name passed as argument, or this model’s default related name.

Return type

None

get_absolute_url()

Get the URL o a view representing this model instance.

Return type

str

classmethod get_filter_fields()

Get names of all text-searchable fields of this model.

Return type

List[str]

classmethod method(func, name=None)

Add the passed callable as a method.

Return type

None

classmethod property_(func, name=None)

Add the passed callable as a property.

Return type

None

save(*args, **kwargs)

Ensure all functionality of our extensions that needs saving gets it.

set_object_permission_checker(checker)

Annotate a ObjectPermissionChecker for use with permission system.

classmethod syncable_fields(recursive=True, exclude_remotes=[])

Collect all fields that can be synced on a model.

If recursive is True, it recurses into related models and generates virtual proxy fields to access fields in related models.

Return type

list[Field]

classmethod syncable_fields_choices()

Collect all fields that can be synced on a model.

Return type

tuple[tuple[str, str]]

classmethod syncable_fields_choices_lazy()

Collect all fields that can be synced on a model.

Return type

Callable[[], tuple[tuple[str, str]]]

property versions

Get all versions of this object from django-reversion.

Includes diffs to previous version.

Return type

list[tuple[str, tuple[Any, Any]]]

class aleksis.core.mixins.ExtensiblePolymorphicModel(*args, **kwargs)

Model class for extensible, polymorphic models.

Parameters

• polymorphic_ctype (ForeignKey to ContentType) – Polymorphic ctype

• site (ForeignKey to Site) – Site

• extended_data (JSONField) – Extended data

class aleksis.core.mixins.GlobalPermissionModel(*args, **kwargs)

Base model for global permissions.

This base model ensures that global permissions are not managed.

class aleksis.core.mixins.PublicFilePreferenceMixin(registry=None)

Uploads a file to the public namespace.

class aleksis.core.mixins.PureDjangoModel

No-op mixin to mark a model as deliberately not using ExtensibleModel.

class aleksis.core.mixins.SchoolTermRelatedExtensibleForm(*args, **kwargs)

Extensible form for school term related data.

Warning

This doesn’t automatically include the field school_term in fields or layout, it just sets an initial value.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

class aleksis.core.mixins.SchoolTermRelatedExtensibleModel(*args, **kwargs)

Add relation to school term.

Parameters

• site (ForeignKey to Site) – Site

• extended_data (JSONField) – Extended data

• school_term (ForeignKey to SchoolTerm) – Linked school term

class aleksis.core.mixins.SuccessMessageMixin

form_valid(form)

If the form is valid, save the associated model.

Return type

HttpResponse

arrow_back

Previous

Materialize templates

arrow_forward

Next

Merging of app settings