Chat

This package contains all models for the author and user chats

Attachment Map

class integreat_cms.cms.models.chat.attachment_map.AttachmentMap(*args, **kwargs)

Bases: AbstractBaseModel

A model for a mapping a random hash to a Zammad attachment ID

Parameters:

• id (BigAutoField) – Primary key: ID

• random_hash (CharField) – Random hash

• article_id (IntegerField) – Article id

• attachment_id (IntegerField) – Attachment id

• mime_type (CharField) – Mime type

Relationship fields:

Parameters:

user_chat (ForeignKey to UserChat) – User chat (related name: attachments)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

article_id

Type: IntegerField

Article id

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

attachment_id

Type: IntegerField

Attachment id

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_repr() → str

This overwrites the default Django __repr__() method which would return <AttachmentMap: AttachmentMap object (id)>. It is used for logging.

Returns:

The canonical string representation of the attachment map

Return type:

str

id

Type: BigAutoField

Primary key: ID

mime_type

Type: CharField

Mime type

objects = <django.db.models.Manager object>

property pk

prepare_database_save(field)

random_hash

Type: CharField

Random hash

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

unique_error_message(model_class, unique_check)

user_chat

Type: ForeignKey to UserChat

User chat (related name: attachments)

user_chat_id

Internal field, use user_chat instead.

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

integreat_cms.cms.models.chat.attachment_map.generate_random_hash() → str

Generate a random hash. Produces output of length 64.

Returns:

The generated random hash

Return type:

str

Chat Message

class integreat_cms.cms.models.chat.chat_message.ChatHistoryManager(*args, **kwargs)

Bases: Manager

Custom manager for returning the chat history of the last x days (as configured in AUTHOR_CHAT_HISTORY_DAYS)

__init__()

aaggregate(*args, **kwargs)

abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

abulk_update(objs, fields, batch_size=None)

acontains(obj)

acount()

acreate(**kwargs)

aearliest(*fields)

aexists()

aexplain(*, format=None, **options)

afirst()

aget(*args, **kwargs)

aget_or_create(defaults=None, **kwargs)

aggregate(*args, **kwargs)

Return a dictionary containing the calculations (aggregation) over the current queryset.

If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.

ain_bulk(id_list=None, *, field_name='pk')

aiterator(chunk_size=2000)

An asynchronous iterator over the results from applying this QuerySet to the database.

alast()

alatest(*fields)

alias(*args, **kwargs)

Return a query set with added aliases for extra data or aggregations.

all()

annotate(*args, **kwargs)

Return a query set in which the returned objects have been annotated with extra data or aggregations.

aupdate(**kwargs)

aupdate_or_create(defaults=None, **kwargs)

auto_created = False

bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.

bulk_update(objs, fields, batch_size=None)

Update the given fields in each of the given objects in the database.

check(**kwargs)

complex_filter(filter_obj)

Return a new QuerySet instance with filter_obj added to the filters.

filter_obj can be a Q object or a dictionary of keyword lookup arguments.

This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.

contains(obj)

Return True if the QuerySet contains the provided obj, False otherwise.

contribute_to_class(cls, name)

count()

Perform a SELECT COUNT() and return the number of records as an integer.

If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.

create(**kwargs)

Create a new object with the given kwargs, saving it to the database and returning the created object.

creation_counter = 53

dates(field_name, kind, order='ASC')

Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.

datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)

Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.

property db

db_manager(using=None, hints=None)

deconstruct()

Return a 5-tuple of the form (as_manager (True), manager_class, queryset_class, args, kwargs).

Raise a ValueError if the manager is dynamically generated.

defer(*fields)

Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.

difference(*other_qs)

distinct(*field_names)

Return a new QuerySet instance that will select only distinct results.

earliest(*fields)

exclude(*args, **kwargs)

Return a new QuerySet instance with NOT (args) ANDed to the existing set.

exists()

Return True if the QuerySet would have any results, False otherwise.

explain(*, format=None, **options)

Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

Add extra SQL fragments to the query.

filter(*args, **kwargs)

Return a new QuerySet instance with the args ANDed to the existing set.

first()

Return the first object of a query or None if no match is found.

classmethod from_queryset(queryset_class, class_name=None)

get(*args, **kwargs)

Perform the query and return a single object matching the given keyword arguments.

get_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.

get_queryset() → QuerySet

Custom queryset with applied filters to return the chat messages of the last x days

Returns:

The QuerySet of the most recent chat history

Return type:

QuerySet

in_bulk(id_list=None, *, field_name='pk')

Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.

intersection(*other_qs)

iterator(chunk_size=None)

An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.

last()

Return the last object of a query or None if no match is found.

latest(*fields)

Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.

none()

Return an empty QuerySet.

only(*fields)

Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.

order_by(*field_names)

Return a new QuerySet instance with the ordering changed.

prefetch_related(*lookups)

Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.

When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.

raw(raw_query, params=(), translations=None, using=None)

reverse()

Reverse the ordering of the QuerySet.

select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)

Return a new QuerySet instance that will select objects with a FOR UPDATE lock.

select_related(*fields)

Return a new QuerySet instance that will select related objects.

If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.

If select_related(None) is called, clear the list.

union(*other_qs, all=False)

update(**kwargs)

Update all elements in the current QuerySet, setting all the given fields to the appropriate values.

update_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, updating one with defaults if it exists, otherwise create a new one. Return a tuple (object, created), where created is a boolean specifying whether an object was created.

use_in_migrations = False

If set to True the manager will be serialized into migrations and will thus be available in e.g. RunPython operations.

using(alias)

Select which database this QuerySet should execute against.

values(*fields, **expressions)

values_list(*fields, flat=False, named=False)

class integreat_cms.cms.models.chat.chat_message.ChatMessage(*args, **kwargs)

Bases: AbstractBaseModel

A model for a message in the author chat

Parameters:

• id (BigAutoField) – Primary key: ID

• text (TextField) – Content

• sent_datetime (DateTimeField) – Sent date

Relationship fields:

Parameters:

sender (ForeignKey to User) – Sender (related name: chat_messages)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_sent_datetime(*, field=<django.db.models.DateTimeField: sent_datetime>, is_next=True, **kwargs)

Finds next instance based on sent_datetime. See get_next_by_FOO() for more information.

get_previous_by_sent_datetime(*, field=<django.db.models.DateTimeField: sent_datetime>, is_next=False, **kwargs)

Finds previous instance based on sent_datetime. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <ChatMessage: ChatMessage object (id)>. It is used for logging.

Returns:

The canonical string representation of the chat message

Return type:

str

history = <integreat_cms.cms.models.chat.chat_message.ChatHistoryManager object>

Django manager to access the ORM Use ChatMessage.objects.all() to fetch all objects.

A manager for the most recent chat history

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

Django manager to access the ORM Use ChatMessage.objects.all() to fetch all objects.

The default manager

property pk

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

sender

Type: ForeignKey to User

Sender (related name: chat_messages)

sender_id

Internal field, use sender instead.

sent_datetime

Type: DateTimeField

Sent date

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

text

Type: TextField

Content

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

User Chat

class integreat_cms.cms.models.chat.user_chat.ABTester(*args, **kwargs)

Bases: AbstractBaseModel

A helper model for keeping track of A/B testers for the chat feature

Parameters:

• id (BigAutoField) – Primary key: ID

• device_id (CharField) – Device id

• is_tester (BooleanField) – Is tester

Relationship fields:

Parameters:

region (ForeignKey to Region) – Region (related name: abtester)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

device_id

Type: CharField

Device id

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_repr() → str

This overwrites the default Django __repr__() method which would return <ABTester: ABTester object (id)>. It is used for logging.

Returns:

The canonical string representation of the ab tester

Return type:

str

id

Type: BigAutoField

Primary key: ID

is_tester

Type: BooleanField

Is tester

objects = <django.db.models.Manager object>

property pk

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

region

Type: ForeignKey to Region

Region (related name: abtester)

region_id

Internal field, use region instead.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

class integreat_cms.cms.models.chat.user_chat.UserChat(*args, **kwargs)

Bases: AbstractBaseModel

A model for a user (app) chat, mapping a device ID to a Zammad ticket ID

Parameters:

• id (BigAutoField) – Primary key: ID

• device_id (CharField) – Device id

• zammad_id (IntegerField) – Zammad id

• most_recent_hits (TextField) – Most recent hits

Relationship fields:

Parameters:

• region (ForeignKey to Region) – Region for Chat (related name: chats)

• language (ForeignKey to Language) – Language of chat app user (related name: chats)

Reverse relationships:

Parameters:

attachments (Reverse ForeignKey from AttachmentMap) – All attachments of this user chat (related name of user_chat)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

attachments

Type: Reverse ForeignKey from AttachmentMap

All attachments of this user chat (related name of user_chat)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

device_id

Type: CharField

Device id

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_repr() → str

This overwrites the default Django __repr__() method which would return <UserChat: UserChat object (id)>. It is used for logging.

Returns:

The canonical string representation of the user chat

Return type:

str

id

Type: BigAutoField

Primary key: ID

language

Type: ForeignKey to Language

Language of chat app user (related name: chats)

language_id

Internal field, use language instead.

most_recent_hits

Type: TextField

Most recent hits

objects = <integreat_cms.cms.models.chat.user_chat.UserChatManager object>

property pk

prepare_database_save(field)

ratelimit_exceeded() → bool

Decide if the rate limit for this chat has been exceeded

Returns:

if the rate limit has been exceeded

Return type:

bool

record_hit() → None

Record the timestamp of accesses for ratelimiting purposes

Return type:

None

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

region

Type: ForeignKey to Region

Region for Chat (related name: chats)

region_id

Internal field, use region instead.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

zammad_id

Type: IntegerField

Zammad id

class integreat_cms.cms.models.chat.user_chat.UserChatManager(*args, **kwargs)

Bases: Manager

custom manager providing function to get the current chat

__init__()

aaggregate(*args, **kwargs)

abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

abulk_update(objs, fields, batch_size=None)

acontains(obj)

acount()

acreate(**kwargs)

aearliest(*fields)

aexists()

aexplain(*, format=None, **options)

afirst()

aget(*args, **kwargs)

aget_or_create(defaults=None, **kwargs)

aggregate(*args, **kwargs)

Return a dictionary containing the calculations (aggregation) over the current queryset.

If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.

ain_bulk(id_list=None, *, field_name='pk')

aiterator(chunk_size=2000)

An asynchronous iterator over the results from applying this QuerySet to the database.

alast()

alatest(*fields)

alias(*args, **kwargs)

Return a query set with added aliases for extra data or aggregations.

all()

annotate(*args, **kwargs)

Return a query set in which the returned objects have been annotated with extra data or aggregations.

aupdate(**kwargs)

aupdate_or_create(defaults=None, **kwargs)

auto_created = False

bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.

bulk_update(objs, fields, batch_size=None)

Update the given fields in each of the given objects in the database.

check(**kwargs)

complex_filter(filter_obj)

Return a new QuerySet instance with filter_obj added to the filters.

filter_obj can be a Q object or a dictionary of keyword lookup arguments.

This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.

contains(obj)

Return True if the QuerySet contains the provided obj, False otherwise.

contribute_to_class(cls, name)

count()

Perform a SELECT COUNT() and return the number of records as an integer.

If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.

create(**kwargs)

Create a new object with the given kwargs, saving it to the database and returning the created object.

creation_counter = 53

current_chat(device_id: str, **kwargs: Any) → UserChat

Return only the newest (i.e. current) chat for a given device_id

Parameters:

• device_id (str) – the device id for which we want the current chat

• **kwargs (Any) – The supplied kwargs

Returns:

the current chat for the given device_id

Return type:

UserChat

dates(field_name, kind, order='ASC')

Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.

datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)

Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.

property db

db_manager(using=None, hints=None)

deconstruct()

Return a 5-tuple of the form (as_manager (True), manager_class, queryset_class, args, kwargs).

Raise a ValueError if the manager is dynamically generated.

defer(*fields)

Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.

difference(*other_qs)

distinct(*field_names)

Return a new QuerySet instance that will select only distinct results.

earliest(*fields)

exclude(*args, **kwargs)

Return a new QuerySet instance with NOT (args) ANDed to the existing set.

exists()

Return True if the QuerySet would have any results, False otherwise.

explain(*, format=None, **options)

Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

Add extra SQL fragments to the query.

filter(*args, **kwargs)

Return a new QuerySet instance with the args ANDed to the existing set.

first()

Return the first object of a query or None if no match is found.

classmethod from_queryset(queryset_class, class_name=None)

get(*args, **kwargs)

Perform the query and return a single object matching the given keyword arguments.

get_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.

get_queryset()

Return a new QuerySet object. Subclasses can override this method to customize the behavior of the Manager.

in_bulk(id_list=None, *, field_name='pk')

Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.

intersection(*other_qs)

iterator(chunk_size=None)

An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.

last()

Return the last object of a query or None if no match is found.

latest(*fields)

Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.

none()

Return an empty QuerySet.

only(*fields)

Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.

order_by(*field_names)

Return a new QuerySet instance with the ordering changed.

prefetch_related(*lookups)

Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.

When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.

raw(raw_query, params=(), translations=None, using=None)

reverse()

Reverse the ordering of the QuerySet.

select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)

Return a new QuerySet instance that will select objects with a FOR UPDATE lock.

select_related(*fields)

Return a new QuerySet instance that will select related objects.

If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.

If select_related(None) is called, clear the list.

union(*other_qs, all=False)

update(**kwargs)

Update all elements in the current QuerySet, setting all the given fields to the appropriate values.

update_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, updating one with defaults if it exists, otherwise create a new one. Return a tuple (object, created), where created is a boolean specifying whether an object was created.

use_in_migrations = False

If set to True the manager will be serialized into migrations and will thus be available in e.g. RunPython operations.

using(alias)

Select which database this QuerySet should execute against.

values(*fields, **expressions)

values_list(*fields, flat=False, named=False)