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: 608 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 608 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 457 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5263 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1082 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4386 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4214 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18917 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1065 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35916 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1488 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 2 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 25 [[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: 33 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 33 [[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: #36703, #34417, #36702 [[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

2025 / 2026

Bug

10406 / 10780

New feature

3813 / 4196

Cleanup/optimization

5392 / 5698

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:

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 34851)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#36699 duplicate Clarify behavior and documentation for login (404) and logout (405) routes yydsjkl
Description

During university software testing using Django, we encountered two issues that might confuse new users:

  1. Accessing /login/ returns a 404 because Django doesn’t create a default login route.
  2. Accessing /logout/ returns a 405 (Method Not Allowed) because LogoutView only allows POST.

While these are not actual bugs, they can be confusing for beginners. The documentation could be improved to explain:

  • Why these responses occur.
  • How to properly configure LoginView and LogoutView manually.

Suggested improvement: Add a clarification in the Django authentication documentation (https://docs.djangoproject.com/en/stable/topics/auth/default/) showing that:

  • /login/ is not created automatically.
  • /logout/ requires POST by design for CSRF protection.
  • Example code:
  from django.contrib.auth import views as auth_views
  urlpatterns = [
      path('login/', auth_views.LoginView.as_view(template_name='login.html')),
      path('logout/', auth_views.LogoutView.as_view(next_page='/')),
  ]
#36698 duplicate isinstance() arg 2 must be a type, a tuple of types, or a union when using Oracle DB drussca
Description

I have a Django project that uses and Oracle DB. Django version: 5.2.7.

I've had to modify .../django/db/backends/oracle/base.py to make the setup work as I was getting:

  File "/home/.../lib/python3.12/site-packages/django/db/backends/oracle/base.py", line 441, in __init__
    elif isinstance(param, (Database.Binary, datetime.timedelta)):
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: isinstance() arg 2 must be a type, a tuple of types, or a union

After this most things work, EXCEPT when I try to do something like this:

someobjects = someclass.somerelatedobject.filter(effdate__lte=reference_date)
someobjectssubset = someobjects.filter(expirdate__gte=reference_date)
otherobjectssubset = someobjects .filter(rlexpirdate__isnull=True)

For this I still get the isinstance() arg 2 must be a type, a tuple of types, or a union error.

#36697 fixed black need to be installed to launch the full test suite and it's not in the requirements Pierre Sassoulas
Description

When first starting to contribute to django, 205 test errors out (FAILED (errors=205, skipped=1827, expected failures=5) ) with the following stacktrace:

ERROR: test_makemessages_no_settings (i18n.test_extraction.NoSettingsExtractionTests.test_makemessages_no_settings)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 58, in testPartExecutor
    yield
  File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 651, in run
    self._callTestMethod(testMethod)
    
  File "/home/pierre/.local/share/uv/python/cpython-3.13.1-linux-x86_64-gnu/lib/python3.13/unittest/case.py", line 606, in _callTestMethod
    if method() is not None:
    ^^^^^^^^^^^^^^^
  File "/home/pierre/git/django/tests/i18n/test_extraction.py", line 1131, in test_makemessages_no_settings
    out, err = self.run_django_admin(["makemessages", "-l", "en", "-v", "0"])
    ^^^^^^^^^^^^^^^
  File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 167, in run_django_admin
    return self.run_test(
    ^^^^^^^^^^^^^^^
  File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 152, in run_test
    test_environ["PATH"] = self.path_without_formatters
    ^^^^^^^^^^^
  File "/home/pierre/git/django/django/utils/functional.py", line 47, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
    ^^^^^^^^^^^^^^^
  File "/home/pierre/git/django/tests/admin_scripts/tests.py", line 123, in path_without_formatters
    if os.path.commonpath([path_component, formatter_path]) == os.sep
    ^^^^^^^
  File "<frozen posixpath>", line 536, in commonpath
TypeError: expected str, bytes or os.PathLike object, not NoneType

When find_formatters return a black_path that is None (shutil.which("black") is None, meaning black is not installed).

I suggest raising a better error message by catching this in find_formatters directly and/or adding black to tests/requirements/py3.py.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

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