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: 635 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 635 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 440 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5246 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1079 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4365 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4194 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18790 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1075 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35737 [[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: 30 [[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: #36511, #36513, #36498 [[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

2020 / 2021

Bug

10321 / 10694

New feature

3770 / 4161

Cleanup/optimization

5336 / 5645

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#36517 wontfix Add Native Vector Support for Oracle: VectorField, VectorIndex, and VectorDistance SAVAN SONI
Description

This feature adds native support for the Oracle Database’s Vector data type introduced in Oracle 23c. It enables AI and ML applications to store and query high-dimensional data directly in the database using a new VectorField model field, VectorIndex support for similarity search, and ORM expressions for vector operations.

Features Included:

VectorField model field:

  1. Accepts optional dimensions, storage_format, and storage_type arguments.
  1. Supports Dense and Sparse vector storage.
  1. Auto-converts lists, NumPy arrays, and oracledb.SparseVector for insert/update.

Vector Index support:

  1. VectorIndex class using Meta.indexes.
  1. Support for HNSW and IVF index types.
  1. Optional parameters: distance, accuracy, parallel, etc.

Vector distance expressions and lookups:

  1. Custom Func class VectorDistance for VECTOR_DISTANCE(lhs, rhs, metric)
  1. CosineDistance, EuclideanDistance, and NegativeDotProduct etc. as lookups.
  1. Query syntax via filter() and order_by() for similarity search.

Testing:

  1. Dense and Sparse vector insert/query tests added.
  1. Stress test scripts for repeated inserts/queries included.

Example:

from django.db import models
VectorIndex = model.VectorIndex
VectorDistanceType = models.VectorDistanceType
VectorIndexType = models.VectorIndexType
class Product(models.Model):
    name = models.CharField(max_length=100)
    embedding = models.VectorField(dim=3, storage_format=VectorStorageFormat.FLOAT32, storage_type=VectorStorageType.DENSE)
    class Meta:
        indexes = [
            VectorIndex(
                fields=["embedding"],
                name="vec_idx_product",
                index_type=VectorIndexType.HNSW,
                distance=VectorDistanceType.COSINE,
            )
        ]

And a Similarity search can be performed

query_vector = array.array("f", [1.0, 2.0, 3.0])
    products = Product.objects.annotate(
        score=VectorDistance(
            "embedding",
            query_vector,
            metric=VectorDistanceType.COSINE,
        )
    ).order_by("score")[:5]

Implementation Status

We have already implemented:

  1. Custom VectorField with support for DENSE and SPARSE formats
  1. Automatic SQL generation for model/table creation
  1. VectorIndex support with customizable parameters and distance metrics
  1. ORM expressions and lookups for vector distance queries (e.g., CosineDistance, EuclideanDistance)
  1. Basic tests for dense vector creation, insertion, indexing, and querying
  1. Integration with Oracle’s Python driver (oracledb) for runtime behavior

PR Readiness

We have finalized the major components of this feature and are ready to open a public pull request after community feedback or approval of this feature proposal.

#36515 duplicate test_parsing_errors() fails with Fedora's Python 3.14 pre-release Michel Lind
Description

Hi,

I'm a Fedora packager that co-maintains our Django packages. When building 5.2.4 in Rawhide (the upcoming Fedora 43 release) that currently has Python 3.14b4, in addition to strip_tags() that our openSUSE colleague has reported (https://code.djangoproject.com/ticket/36499), test_parsing_errors also fails:

======================================================================
FAIL: test_parsing_errors (test_utils.tests.HTMLEqualTests.test_parsing_errors)
----------------------------------------------------------------------
AssertionError: &lt; div&gt; != <div>
- &lt; div&gt;   
+ <div>   

I'm currently conditionally disabling the test when building with Python >= 3.14, but hopefully this can be fixed.

#36514 wontfix Improve ALLOWED_HOSTS error message: show both values Klaas van Schelven
Description

When Django rejects a request because the Host header doesn't match ALLOWED_HOSTS, the resulting error message shows only the incoming header value:

Invalid HTTP_HOST header: 'localhost:8000'. You may need to add 'localhost' to ALLOWED_HOSTS.

This makes it harder to determine whether the problem is a misconfigured proxy (not setting the correct Host) or simply a missing hostname in ALLOWED_HOSTS. In many cases, the advice to "add localhost" is actively unhelpful: production deployments rarely serve requests at localhost, and the real fix is usually to configure the proxy correctly.

I’ve implemented a more helpful version of this logic in Bugsink (a Django app installed by users who may not be Django developers). I describe that implementation in more detail in [this blog post about improving Django’s ALLOWED_HOSTS error messages](https://www.bugsink.com/blog/better-allowed-hosts/#better-error-messages). In the "bugsink approach" the error:

  • shows the actual Host header and the configured ALLOWED_HOSTS
  • suggests the likely cause
  • avoids pointing users towards "add localhost" as the default fix

Some of what I did in Bugsink likely goes beyond what Django should adopt by default (e.g. showing the error in the browser), but the idea of displaying both values (the incoming host and the configured list) would be a broadly useful change on its own.

If desired, the message could also give more specific advice depending on the values (e.g. distinguish between loopback and public domains), but that can be considered separately.

Security considerations

Showing both the incoming Host header and the configured ALLOWED_HOSTS reveals limited information:

  • The Host header is attacker-controlled — the client already knows what they sent.
  • _or_ The Host header is simply a misconfiguration (in which case it's on-broken-deploy only)
  • ALLOWED_HOSTS reveals the expected hostname(s). In most deployments, this is already visible in the TLS certificate.
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

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