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: 599 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 599 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 470 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5275 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1086 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4397 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4224 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18968 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1069 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 36010 [[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: 38 [[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: #36700, #36513, #36740 [[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

2027 / 2027
Bug

10445 / 10819
New feature

3831 / 4213
Cleanup/optimization

5423 / 5735

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36797 wontfix Implement fully async-capable support for django.middleware.common.CommonMiddleware Mykhailo Havelia
Description

From the Django documentation:

You will only get the benefits of a fully asynchronous request stack if you have no synchronous middleware loaded into your site.

Currently, all of Django's internal middleware uses MiddlewareMixin and relies on sync_to_async under the hood. This makes it difficult for end users to have a fully async request flow, because they would need to copy and adapt all internal logic for each middleware, and maintain it across Django releases.

Some internal middleware only performs CPU-bound operations and does not require async/AIO logic, so it could safely be used in both sync and async contexts without sync_to_async.

Options to solve this

  • Implement __acall__ without sync_to_async

Not recommended. Can lead to subtle bugs if users subclass and customize the middleware: 

class CustomCommonMiddleware(CommonMiddleware):
    def process_response(self, request, response):
        # custom logic
        return super().process_response(request, response)

In an async context, this custom logic would be ignored or behave unexpectedly.

  • Rewrite middlewares using sync_and_async_middleware decorator

Safe and straightforward. Breaking change: would break all existing custom middleware that inherits from the internal middleware.

  • Implement separate async middleware (AsyncCommonMiddleware)

Compromise solution. Safe for users: they can explicitly replace CommonMiddleware with AsyncCommonMiddleware in async setups. When MiddlewareMixin is eventually removed, we can rename AsyncCommonMiddleware -> CommonMiddleware without breaking changes.

I'm going to start by implementing an async version of CommonMiddleware as a test case for this approach. Once we validate it, the plan is to extend the same pattern to:

  • django.contrib.auth.middleware.AuthenticationMiddleware
  • django.middleware.locale.LocaleMiddleware
  • django.middleware.security.SecurityMiddleware

If you have any thoughts or concerns about this approach, especially regarding edge cases or backward compatibility, please share them.

#36792 duplicate Add support for virtual generated columns (PostgreSQL 18+) in GeneratedField Paolo Melchiorre
Description

Background

PostgreSQL 18 introduces virtual generated columns: columns declared with GENERATED ALWAYS AS ( <generation_expr> ) VIRTUAL are computed at query time and do not occupy storage. PostgreSQL 18 also makes VIRTUAL the default for generated columns while continuing to support STORED (materialized) generated columns. See the PostgreSQL 18 release notes: ​PostgreSQL 18 release notes.

Motivation

Django's GeneratedField support currently targets databases that support STORED (materialized) generated columns. With PostgreSQL 18, users should be able to declare GeneratedFields that are VIRTUAL (computed at query time) and have Django generate the correct DDL and perform correct introspection and migration autogeneration.

Goals

  • Add support in Django's PostgreSQL backend to emit the VIRTUAL keyword in CREATE TABLE and ALTER TABLE statements for generated columns when targeting PostgreSQL 18 or newer.
  • Extend PostgreSQL introspection to detect whether an existing generated column is STORED or VIRTUAL and populate migration state accordingly so autogeneration can produce correct AddField / AlterField operations.
  • Ensure migration operations handle switching between STORED and VIRTUAL where supported by the server, and emit clear errors or warnings when not supported by the connected server version.
  • Add tests and documentation; skip/guard tests on PostgreSQL servers older than 18.

Implementation notes and suggestions

  • Server gating: use the existing server_version_int checks (treat PostgreSQL 18 as the cutoff, e.g. 180000) so that DDL including VIRTUAL is only emitted on servers that support it.
  • DDL generation: update the PostgreSQL schema editor (schema creation/alter) to emit either "VIRTUAL" or "STORED" based on field metadata and server version. If the field model exposes a stored boolean, emit STORED when True and VIRTUAL when False (and server >= 18).
  • Introspection: extend postgresql introspection to read the generation expression and the storage type (stored vs virtual) from information_schema and/or pg_catalog and expose those details in the field_info consumed by the migration autogenerator.
  • Migrations: ensure AlterField and AddField include the storage attribute and that migration autogeneration treats changes in stored/virtual as schema changes. If the connected server does not support VIRTUAL, raise a clear error during migration planning/execution.
  • Tests: add backend tests that:
    • create a model with a GeneratedField stored=True (STORED) and stored=False (VIRTUAL),
    • introspect an existing table with VIRTUAL columns,
    • autogenerate migrations for switching between STORED and VIRTUAL,
    • ensure tests are skipped on PostgreSQL < 18.
  • Documentation: update GeneratedField docs to describe the stored vs virtual option and PostgreSQL version requirements (PG 18+ for VIRTUAL). Recommend keeping DB versions consistent across environments.

Examples

SQL (PG18+): 

CREATE TABLE example (
    a integer,
    b integer GENERATED ALWAYS AS (a + 1) VIRTUAL
);

Stored column: 

CREATE TABLE example (
    a integer,
    b integer GENERATED ALWAYS AS (a + 1) STORED
);

Django (draft API): 

class MyModel(models.Model):
    width = models.IntegerField()
    area = models.GeneratedField(models.F('width') * 2, stored=False)  # VIRTUAL on PG18+

Backward-compatibility and migration considerations

  • Emit VIRTUAL only when connected to PG 18+; otherwise use STORED or raise a clear error.
  • Autogenerated migrations created on PG18 that include VIRTUAL should be documented or guarded to avoid failures on older servers.
  • Recommend teams keep DB versions consistent across dev/test/prod if they plan to use VIRTUAL columns.
#36790 wontfix Add a generic error view handler Wes P.
Description

In a PR review discussion (see: ​https://github.com/django/django/pull/17960/files) which was reviewing ticket #35281 (adding a new handler for 413 errors) it was expressed that there should be a better way to allow developers to access handlers instead of creating handlers for every kind of 4xx or 5xx error: a generic method. Ticket #35281 switched from being about a 413 handler (fairly easy) to refactoring error view handlers.

I would like ticket #35281 to revert to being about handling 413 errors (which was accepted) and for this ticket to be about refactoring error view handlers to be generic. I would also recommend that we preserve backward compatibility without deprecating the existing handlers.

Documentation for error views: ​https://docs.djangoproject.com/en/6.0/ref/views/#error-views

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

See also: TracQuery, TracTickets, TracReports

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