Version 8 (modified by trac, 12 years ago) ( diff )

--

Trac Ticket Queries

Table of Contents

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page the default filter will display tickets relevant to you:

  • If logged in then all open tickets it will display open tickets assigned to you.
  • If not logged in but you have specified a name or email address in the preferences then it will display all open tickets where your email (or name if email not defined) is in the CC list.
  • If not logged and no name/email defined in the preferences then all open issues are displayed.

Current filters can be removed by clicking the button to the left with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box ('And' conditions on the left, 'Or' conditions on the right). Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

Once you've edited your filters click the Update button to refresh your results.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which were edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.

Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page. 

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria (see Query Language).

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character: 

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Using the [[TicketQuery]] Macro

The ​TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example: 

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

This is displayed as:

No results

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language. This also allows displaying the link and description of a single ticket: 

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

A more compact representation without the ticket summaries is also available: 

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

This is displayed as:

No results

Finally, if you wish to receive only the number of defects that match the query, use the count parameter. 

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

This is displayed as:

0

Customizing the table format

You can also customize the columns displayed in the table format (format=table) by using col=<field> - you can specify multiple fields and what order they are displayed by placing pipes (|) between the columns like below: 

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

This is displayed as:

Results (1 - 3 of 35077)

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 also have full rows by using rows=<field> like below: 

[[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 35077)

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 →

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (&). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values. To include a literal & or | in a value, escape the character with a backslash (\).

The available operators are:

= the field content exactly matches one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide

Note: See TracWiki for help on using the wiki.
Back to Top