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: 665 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 665 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 392 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5186 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1071 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4332 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4131 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18586 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1057 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35338 [[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: 70 [[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: #32193, #13883, #36117 [[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

1997 / 1997
Bug

10124 / 10489
New feature

3701 / 4093
Cleanup/optimization

5243 / 5542

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36115 wontfix Add a link to navigate to the related object for ForeignKey and OneToOneField values in list_display Antoliny Antoliny
Description

Currently, admin list view displays ForeignKey and OneToOneField values as plain text. However, in the change page, admin provides icons for ForeignKey and OneToOneField that allow additional operations on the corresponding objects and models. How about adding links for ForeignKey and OneToOneField in the list page? I think provide to navigation to the related object by clicking the link, it would be better in terms of accessibility.

#36113 duplicate Enhancement Proposal: Support for Nested App Creation with `startapp` Command in Django Jerin Kachirackal
Description

Summary:

Django's startapp command currently creates a new app at the root level of the project. Developers often adopt different project structures, and many prefer organizing apps within subdirectories for better modularity and clarity. A common structure might look like this: 

|-- ./
|-- ./apps/<app name>
|-- ./apps/<app name>/apis/
|-- ./apps/dashboard/<app name>
|-- ./manage.py

To achieve this structure, developers currently need to:

  1. Run python manage.py startapp <app-name>.
  2. Manually move the generated app into the desired directory.
  3. Update the apps.py configuration to reflect the new structure.

This process is tedious, error-prone, and does not contribute to creating a "structured" project, particularly for first-time users.

Proposed Enhancement:

Enhance the startapp command to support nested app creation directly by specifying the full path. Proposed Comand:

For Linux / Mac 

python manage.py startapp apps/dashboard/user

(or for Windows with a \ instead of / as we expect)

Proposed Changes: This command should:

  • Automatically create the nested directory structure apps/dashboard/user. * '[Clarification1]
  • Populate apps/dashboard/user/apps.py with the correct configuration for apps.dashboard.user. using the classname AppsDashboardUserConfig and name as apps.dashboard.user 
    from django.apps import AppConfig


class AppsDashboardUserConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'apps.dashboard.user'
  • Provide a log message or output suggesting the exact string to add to INSTALLED_APPS, e.g.,: 
    $ user@host: proj % django-admin startapp user apps/dashboard/user
App added to following directory : `apps.dashboard.user` 
To integrate this app with your project, please add the following line in your `settings.INSTALLED_APPS`.
"""
INSTALLED_APPS = [
    ...,
    'apps.dashboard.user.apps.AppsDashboardUserConfig',
    ...,
]
"""

$ user@host: proj %

Benefits:

  • Simplifies app creation for projects with nested or modular structures.
  • Reduces manual steps and the risk of configuration errors.
  • Enhances the developer experience, particularly for newcomers to Django.
  • Keeping developer actions DRY and productive with minimum commands.

Compatibility:

The proposed change should maintain backward compatibility, allowing the current behavior (creating apps in the root directory) to remain unchanged when the provided path does not include subdirectories.

Clarifications [Clarification1]: Django currently requires directories to be created manually. Respecting this, the proposal suggests creating the directory (if the user has permission). For projects requiring structured apps, this enhancement reduces repetitive bugs and increases efficiency.

A Note from Reporter: I am working with django for last 7 years, introducing the same from startups to saas, - and would like to add such a contribution from my end, if this can be assigned to me. Even else, the feature expects to be a simple and wish to find as a part of django.

Thank You!

#36110 wontfix Unable to customize kwargs passed to PasswordResetForm EmailMultiAlternatives Antoliny Claude Paroz
Description

Use case: you'd like to add a Reply-To header to the password reset message.

To do that currently, you have no other choice than to rewrite the whole PasswordResetForm.send_mail method. I think a hook is needed to be able to define any other EmailMultiAlternatives init arguments.

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

See also: TracQuery, TracTickets, TracReports

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