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: 564 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 564 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 520 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5288 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1086 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4410 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4240 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 19056 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1084 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 36162 [[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: 52 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 26 [[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: 34 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 34 [[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: #36948, #36949, #36509 [[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

2037 / 2038
Bug

10504 / 10876
New feature

3855 / 4239
Cleanup/optimization

5467 / 5793

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36937 fixed Add missing positive test cases for @permission_required in test_client saishmungase saishmungase
#36935 fixed ContentType.app_labeled_name fallback omits app label when model_class() is None Marco Aurélio da Rosa Haubrich Marco Aurélio da Rosa Haubrich
#36934 fixed BuiltinLookup.as_sql breaks with params-as-a-tuple Jacob Walls Stefan Bühler
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 35078)

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36937 fixed Add missing positive test cases for @permission_required in test_client saishmungase saishmungase
Description

In tests/test_client/tests.py, the test_view_with_permissions and test_view_with_method_permissions methods contain TODO comments indicating missing positive test coverage. The tests successfully verify the negative paths (302 redirects for unauthorized users) but fail to verify the 200 OK path for authorized users.

Upon implementing the positive test cases, it became clear that the dummy views in tests/test_client/views.py were decorated with a malformed permission string ("permission_not_granted"). Because this string lacks a standard app_label.codename format, Django's standard ModelBackend fails to parse it during the has_perm() check. This made it impossible to test standard permission assignment properly without relying on workarounds like the is_superuser flag.

This patch:

  1. Updates the dummy views in tests/test_client/views.py to use a standard, valid permission string ("auth.add_user").
  2. Resolves the TODO comments in tests/test_client/tests.py by assigning the real auth.add_user permission to the test user and asserting the successful 200 OK response.

I have the patch ready and will submit a Pull Request shortly.

#36935 fixed ContentType.app_labeled_name fallback omits app label when model_class() is None Marco Aurélio da Rosa Haubrich Marco Aurélio da Rosa Haubrich
Description

ContentType.app_labeled_name fallback omits app label when model_class() is None

Environment

  • Django version: 5.0 (also reproduced on latest main as of 2026‑02‑18)
  • Python: 3.x
  • Database: Oracle (others likely affected)

Summary

django.contrib.contenttypes.models.ContentType.app_labeled_name is intended to provide a human‑readable label combining the app label and model name, typically used in admin UIs and other tooling to disambiguate models with the same name.

Its current implementation is roughly: 

@property
def app_labeled_name(self):
    model = self.model_class()
    if not model:
        return self.model
    return '%s | %s' % (model._meta.app_label, model._meta.verbose_name)

When model_class() returns a model, this works as expected and returns: 

<app_label> | <model verbose_name>

However, when model_class() returns None (for example, for stale or external content types), the property falls back to returning only self.model, which drops the app label and makes the label ambiguous. In projects with many apps, this makes it hard to distinguish entries that share the same model name. It is also inconsistent with the name *app_labeled_name*, which suggests that the app label is always present.

This degraded behaviour can be seen in admin UI elements or APIs that rely on app_labeled_name when the underlying content type cannot be resolved to a concrete model.

Steps to reproduce

  1. Create a ContentType whose model cannot be resolved in the current project (for example, by creating a content type for an app/model that is no longer installed, or by inserting a row with a bogus model name).
  2. In a Django shell, access that instance’s app_labeled_name.
  3. Use that ContentType in any UI or API that displays app_labeled_name (for example, a custom admin widget or permission management screen).

Example (simplified): 

from django.contrib.contenttypes.models import ContentType

ct = ContentType.objects.create(
    app_label='external_app',
    model='externalmodel',
)

ct.model_class()      # returns None
ct.app_labeled_name  # returns 'externalmodel'

Actual behavior

For content types whose model_class() is None, app_labeled_name returns only the raw model string: 

'externalmodel'

The app label is omitted, which makes the label ambiguous in UIs that list many models from many apps.

Expected behavior

Even when model_class() is None, app_labeled_name should still include the app label so that the label remains informative and consistent with its name. A more helpful and still backwards‑compatible fallback would be: 

@property
def app_labeled_name(self):
    model = self.model_class()
    if not model:
        return '%s | %s' % (self.app_label, self.model)
    return '%s | %s' % (model._meta.app_label, model._meta.verbose_name)

This keeps the current behaviour when the model exists (using the translated verbose_name) and improves the fallback when it does not, by returning: 

'external_app | externalmodel'

This matches the intent of ticket #16027 (Include app_label in ContentType.__str__()) to disambiguate models with the same name by always including the app label.

Rationale / backwards compatibility

  • For existing, valid content types (model_class() not None), behaviour is unchanged.
  • For invalid/stale/external content types, behaviour becomes *more* informative; currently they return just the model name, which is rarely desirable in user‑facing lists.
  • The change is therefore backwards compatible and strictly improves the degraded code path.

Possible patch

If this proposal is accepted, a patch could:

  • Update ContentType.app_labeled_name as shown above.
  • Add tests for both cases:
    • A content type with a real model (assert the current behaviour is preserved).
    • A content type whose model_class() is None (assert that app_labeled_name returns 'app_label | model').

I’m happy to submit a pull request with implementation and tests once there is agreement on the desired behaviour.

#36934 fixed BuiltinLookup.as_sql breaks with params-as-a-tuple Jacob Walls Stefan Bühler
Description

Hi,

BuiltinLookup violates the new policy and returns a list of params from process_lhs and expects a list in as_sql (uses .extend).

Lookup classes that inherit from (or mixed into) BuiltinLookup and overwrite process_lhs in a way that doesn't return a list of params (e.g. calling Col.as_sql through compiler.compile(self.lhs) are broken.

Example: django-netfields: ​https://github.com/jimfunk/django-postgresql-netfields/blob/f7529f2c97995dbc5b27ea7abcf0f2966269fd96/netfields/lookups.py#L27-L59

The new policy: ​https://docs.djangoproject.com/en/6.0/releases/6.0/#custom-orm-expressions-should-return-params-as-a-tuple

​https://github.com/django/django/pull/20005 looks like it should fix this, and should be packported.

1 2 3 4 5 6 7 8 9 10 11 →

See also: TracQuery, TracTickets, TracReports

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