Version 2 (modified by trac, 10 months ago) ( diff )

--

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: 666 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 666 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 362 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5166 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1069 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4319 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4094 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18500 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1028 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35150 [[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: 48 [[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: #35927, #26355, #35925 [[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

1984 / 1985
Bug

10062 / 10404
New feature

3660 / 4051
Cleanup/optimization

5196 / 5489

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#35927 invalid utils/encoding.py force_string, smart_string, force_bytes, and smart_bytes should verify encoding parameter is not None Derek Knowlton Derek M. Knowlton
Description

Overview

The force_str(), force_bytes(), smart_str(), smart_bytes() functions in django/utils/encoding.py currently doesn't verify that the encoding parameter is not None. When None is passed as the encoding parameter and the input is bytes, it results in a TypeError from Python's built-in str() function rather than providing a clear validation error.

Reproduction

from django.utils.encoding import force_str

# This raises TypeError: str() argument 'encoding' must be str, not None
result = force_str(b'test', encoding=None)

Behaviors

Current Behavior:

  • When encoding=None is passed by input, a TypeError is raised by Python's built-in str() function
  • The error message from this specific error does not indicate that the error originated from utils/encoding.py, or that the error comes from an incorrect value passed to the functions inside utils/encoding.py
  • No upfront validation is performed on the encoding parameter

Expected Behavior:

  • Early detection of invalid encoding parameter
  • Custom TypeError with a descriptive message if None is passed
  • Follows explicit parameter validation principles

Suggested Fix

if encoding is None:
    raise TypeError("{{function name}}: encoding parameter cannot be None")

Summary

Though this change is small, it would improve developer experience by increasing the accuracy of error handling. This change is backwards compatible as it does not change the functionality of the code as passing None was never valid.

#35926 wontfix Support capturing the remainder of a command-line arguments in BaseCommand Daniel Quinn
Description

I wanted to write a management command that would accept a few known arguments and then capture the remaining arbitrary arguments passed as a separate value. For example: 

./manage.py mycommand --expected=argument --something-arbitrary -x -y -z

So --expected-argument would be defined in .add_arguments(), but the other args would just be available as something like options["remainder"] or whatever.

This is usually done by calling parse_known_args() rather than the more common .parse_args(), but unfortunately there's currently no way to cleanly indicate this with BaseCommand. The only way seems to be to copy/paste the entirety of BaseCommand.run_from_argv() and then change where.parse_args() is invoked: 

    def run_from_argv(self, argv):
        """
        Copypasta from the parent class, so I can change `.parse_args()` to
        `.parse_known_args()`.
        """

        self._called_from_command_line = True
        parser = self.create_parser(argv[0], argv[1])

        # Change --------------------------------------------------------------
        options, remainder = parser.parse_known_args(argv[2:])
        cmd_options = vars(options)
        cmd_options["remainder"] = remainder
        # /Change -------------------------------------------------------------

        # Move positional args out of options to mimic legacy optparse
        args = cmd_options.pop("args", ())
        handle_default_options(options)
        try:
            self.execute(*args, **cmd_options)
        except CommandError as e:
            if options.traceback:
                raise

            # SystemCheckError takes care of its own formatting.
            if isinstance(e, SystemCheckError):
                self.stderr.write(str(e), lambda x: x)
            else:
                self.stderr.write("%s: %s" % (e.__class__.__name__, e))
            sys.exit(e.returncode)
        finally:
            try:
                connections.close_all()
            except ImproperlyConfigured:
                # Ignore if connections aren't setup at this point (e.g. no
                # configured settings).
                pass

Obviously that's not ideal.

One option might be to just use .parse_known_args() and then allow the user to indicate whether they want to capture the remainder or not, and if so, as what attribute, but I have no strong feelings about implementation.

#35923 wontfix Test settings for running Django tests with PostgreSQL are not present Raphael Gaschignard
Description

If I check out Django and want to run its tests, there's no settings file for running them with PostgreSQL.

There _is_ one for sqlite (tests/test_sqlite.py), which requires no moving parts of course.

There is a settings file that gets copied to tests/test_postgres.py by a handful of jobs configured in Github Actions. 

      - name: Create PostgreSQL settings file
        run: mv ./.github/workflows/data/test_postgres.py.tpl ./tests/test_postgres.py

On top of this, a Jenkins job seems to copy over its own test_postgres.py file for its testing purposes (along with many other configuration files). 

+ cp -r /home/jenkins/djangodata/oracle19.env /home/jenkins/djangodata/oragis19.env /home/jenkins/djangodata/runtests_jenkins.sh /home/jenkins/djangodata/test_mysql.py /home/jenkins/djangodata/test_mysql_gis.py /home/jenkins/djangodata/test_oracle19.py /home/jenkins/djangodata/test_oracle19_host.py /home/jenkins/djangodata/test_oragis19.py /home/jenkins/djangodata/test_postgis.py /home/jenkins/djangodata/test_postgres.py /home/jenkins/djangodata/test_spatialite.py /home/jenkins/djangodata/test_sqlite3.py .

While the Jenkins config is private, this comment on GH (​https://github.com/django/django/pull/18827/files#r1849925192) seemed to indicate that the Jenkins settings file is quite similar.

I think we should check in tests/test_postgres.py in tests. Working on Django locally I feel like I shouldn't need to create an off-tree source file for test settings when there's already one in the tree (just as the template file, hidden away in .github).

If there is a concern about the DB name being hardcoded, environment variables feels like the canonical way of doing it.

Not having that file in the source tree means that any issue with PG, if I want to describe the issue I first have to share a config (see #35921).

My maximalist position is I think that since Jenkins is private, then as much of it as possible should be checked into Django proper, so that any sort of CI failure could be investigated with confidence, and rely less on forensics. I have a really hard time imagining what could be in test settings files that couldn't live in tests (or tests/settings/ if one is unhappy with filling up the top level directory with settings files). I haven't thought about this deeply, though.

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

See also: TracQuery, TracTickets, TracReports

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