TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 703 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 703 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 276 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5056 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1060 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4270 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4028 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18295 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 979 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 34640 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1489 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 65 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 24 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 32 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 32 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #35411, #35365, #35339 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 Jacob Adrian Holovaty
Summary Create architecture for anonymous sessions

Format: list

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

No results 

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

No results

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

0

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Uncategorized

1944 / 1944
Bug

9854 / 10186
New feature

3577 / 3956
Cleanup/optimization

5065 / 5332

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed in by placing pipes (|) between the columns: 

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 33661)

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#35410 invalid Can't Set a Default Value for ForeignKey Field in Custom User Model nobody Ebram Shehata
#35409 worksforme CheckbioxMultipleSelect widget is broken nobody Marc Gomillion
#35403 invalid URL path with optional parameter nobody Patrick Hintermayer
1 2 3 4 5 6 7 8 9 10 11 →

Full rows

In table format you can specify full rows using rows=<field>: 

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 33661)

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#35410 invalid Can't Set a Default Value for ForeignKey Field in Custom User Model nobody Ebram Shehata
Description

Hello,

So, I'm trying to add a ForeignKey field with a default value in a custom user model. The use case is that each user should be assigned to a department. But all new users should have a default department with name 'UNASSIGNED'.

  • How to reproduce:
  1. Create a blank Django project.
  2. Create a new 'profiles' app.
  3. Register the app in settings.py and point AUTH_USER_MODEL to "profiles.UserProfile". 
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    "profiles"
]
AUTH_USER_MODEL = "profiles.UserProfile"
  1. Add the following models to profiles/models.py: 
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin

from django.db import models


class Department(models.Model):
    name = models.CharField(max_length=256, unique=True)


def unassigned_department():
    return Department.objects.get_or_create(name="UNASSIGNED")[0].pk


class UserProfile(AbstractBaseUser, PermissionsMixin):
    department = models.ForeignKey(
        Department,
        on_delete=models.CASCADE,
        default=unassigned_department,
        related_name="user_profiles",
    )
    username = models.CharField(max_length=256, unique=True)

    is_active = models.BooleanField(default=True, null=False)
    is_superuser = models.BooleanField(default=False, null=False)
    is_staff = models.BooleanField(default=False, null=False)

    USERNAME_FIELD = "username"
  1. Run python manage.py makemigrations.

You'll get the following error: django.db.utils.OperationalError: no such table: profiles_department

Django versions I tried: 4.2.7 and 5.0.4.

I also noticed that if I inherit from django.db.models.Model in UserProfile de-register it from AUTH_USER_MODEL setting, I can create migrations successfully and migrate the database too! I also could create instances that have the default department as expected.

Here's the full traceback: 

Traceback (most recent call last):
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 105, in _execute
    return self.cursor.execute(sql, params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/sqlite3/base.py", line 329, in execute
    return super().execute(query, params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
sqlite3.OperationalError: no such table: profiles_department

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/SOME-DIR/blank_django/src/blanked/manage.py", line 22, in <module>
    main()
  File "/SOME-DIR/blank_django/src/blanked/manage.py", line 18, in main
    execute_from_command_line(sys.argv)
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/management/base.py", line 413, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/management/base.py", line 454, in execute
    self.check()
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/management/base.py", line 486, in check
    all_issues = checks.run_checks(
                 ^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/core/checks/registry.py", line 88, in run_checks
    new_errors = check(app_configs=app_configs, databases=databases)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/contrib/auth/checks.py", line 84, in check_user_model
    if isinstance(cls().is_anonymous, MethodType):
                  ^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/base.py", line 535, in __init__
    val = field.get_default()
          ^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/fields/related.py", line 1134, in get_default
    field_default = super().get_default()
                    ^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/fields/__init__.py", line 1021, in get_default
    return self._get_default()
           ^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/blanked/profiles/models.py", line 11, in unassigned_department
    return Department.objects.get_or_create(name="UNASSIGNED")[0].pk
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/manager.py", line 87, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/query.py", line 948, in get_or_create
    return self.get(**kwargs), False
           ^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/query.py", line 645, in get
    num = len(clone)
          ^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/query.py", line 382, in __len__
    self._fetch_all()
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/query.py", line 1928, in _fetch_all
    self._result_cache = list(self._iterable_class(self))
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/query.py", line 91, in __iter__
    results = compiler.execute_sql(
              ^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/models/sql/compiler.py", line 1562, in execute_sql
    cursor.execute(sql, params)
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 122, in execute
    return super().execute(sql, params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 79, in execute
    return self._execute_with_wrappers(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 92, in _execute_with_wrappers
    return executor(sql, params, many, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 100, in _execute
    with self.db.wrap_database_errors:
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/utils.py", line 91, in __exit__
    raise dj_exc_value.with_traceback(traceback) from exc_value
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/utils.py", line 105, in _execute
    return self.cursor.execute(sql, params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/SOME-DIR/blank_django/src/venv/lib/python3.11/site-packages/django/db/backends/sqlite3/base.py", line 329, in execute
    return super().execute(query, params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
django.db.utils.OperationalError: no such table: profiles_department
#35409 worksforme CheckbioxMultipleSelect widget is broken nobody Marc Gomillion
Description

My application has an emailer page with a list of recipients that can be edited as follows.

In the form definition: 

recipients = forms.MultipleChoiceField(widget=forms.CheckboxSelectMultiple)

In __init__: 

self.fields['recipients'].choices = recipient_choices

This has worked since 2009, but Django 4.2.x has broken it as it does not insert line breaks between the recipients and the list is a jumbled mess. I've coded around it by using the SelectMultiple widget, which still allows editing of the list, but not in obvious ways to my users, and is thus unacceptable.

I've attached images of the list using Django 3.2 and 4.2.

#35403 invalid URL path with optional parameter nobody Patrick Hintermayer
Description

I sometimes have a class based view which has a GET and a POST method, for example a ListView which shows some objects with a POST form to create something out of it.

In the documentation (​https://docs.djangoproject.com/en/5.0/topics/http/urls/) I did not find a simple way of doing that. Asking GitHub Copilot suggested me adding a question mark at the end to mark a parameter as optional which does not work.

I found myself 2 solutions:

  1. using regex which looks cumbersome just for marking something as optional:

    Code highlighting: 

    re_path(
      r"^activate/(?P<activation_token>[^/]+)?$",
      views.UserActivationView.as_view(),
      name="user_activation",
  )

  1. using 2 paths: one without a parameter and one with a parameter:

    Code highlighting: 

    path(
      "activate/",
      views.UserActivationView.as_view(),
      name="user_activation",
  ),
  path(
      "activate/<str:activation_token>/",
      views.UserActivationView.as_view(),
      name="user_activation",
  )

For this ticket, I want to suggest a) improve the documentation with a simple example how to do that and/or b) can this be simplified in django by adding for example a question mark at the end like "/<int:some_id?>/" or "/<int?:some_id>/":

Code highlighting: 

path(
      "activate/<str:activation_token?>/",
      views.UserActivationView.as_view(),
      name="user_activation",
  )
1 2 3 4 5 6 7 8 9 10 11 →

See also: TracQuery, TracTickets, TracReports

Last modified 3 months ago Last modified on Jan 24, 2024, 9:58:09 AM
Note: See TracWiki for help on using the wiki.
Back to Top