Mercurial > p > roundup > code
annotate doc/glossary.txt @ 7752:b2dbab2b34bc
fix(refactor): multiple fixups using ruff linter; more testing.
Converting to using the ruff linter and its rulesets. Fixed a number
of issues.
admin.py:
sort imports
use immutable tuples as default value markers for parameters where a
None value is valid.
reduced some loops to list comprehensions for performance
used ternary to simplify some if statements
named some variables to make them less magic
(e.g. _default_savepoint_setting = 1000)
fixed some tests for argument counts < 2 becomes != 2 so 3 is an
error.
moved exception handlers outside of loops for performance where
exception handler will abort loop anyway.
renamed variables called 'id' or 'dir' as they shadow builtin
commands.
fix translations of form _("string %s" % value) -> _("string %s") %
value so translation will be looked up with the key before
substitution.
end dicts, tuples with a trailing comma to reduce missing comma
errors if modified
simplified sorted(list(self.setting.keys())) to
sorted(self.setting.keys()) as sorted consumes whole list.
in if conditions put compared variable on left and threshold condition
on right. (no yoda conditions)
multiple noqa: suppression
removed unneeded noqa as lint rulesets are a bit different
do_get - refactor output printing logic: Use fast return if not
special formatting is requested; use isinstance with a tuple
rather than two isinstance calls; cleaned up flow and removed
comments on algorithm as it can be easily read from the code.
do_filter, do_find - refactor output printing logic. Reduce
duplicate code.
do_find - renamed variable 'value' that was set inside a loop. The
loop index variable was also named 'value'.
do_pragma - added hint to use list subcommand if setting was not
found. Replaced condition 'type(x) is bool' with 'isinstance(x,
bool)' for various types.
test_admin.py
added testing for do_list
better test coverage for do_get includes: -S and -d for multilinks,
error case for -d with non-link.
better testing for do_find including all output modes
better testing for do_filter including all output modes
fixed expected output for do_pragma that now includes hint to use
pragma list if setting not found.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 01 Mar 2024 14:53:18 -0500 |
| parents | 1a912887d704 |
| children | b4dfc68b7067 |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6270
diff
changeset
|
1 .. meta:: |
|
6774
e7b4ad2c57ac
landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
2 :description: |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6270
diff
changeset
|
3 Definitions of terms used in the Roundup Issue Tracker |
|
7287
648d5916c248
update description metadata
John Rouillard <rouilj@ieee.org>
parents:
6905
diff
changeset
|
4 documentation. Referenced by other documents. |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6270
diff
changeset
|
5 |
|
783
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
6 ================ |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 Roundup Glossary |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 ================ |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
10 .. glossary:: |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
11 :sorted: |
|
783
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
13 class |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
14 a definition of the properties and behavior of a set of items |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
15 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
16 classname |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
17 the name of a class. It must start with a letter, end with a letter |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
18 or "_", and only have alphanumerics and "_" in the middle. |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
19 |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
20 db |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
21 database used to store the data in the tracker. Roundup supports |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
22 4 databases: dbm (Berkeley DB/BDB), SQLite, PostgreSQL, MySQL/MariaDB. |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
23 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
24 definitional class |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
25 a class that exists to define a discrete set of values. For example |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
26 status or priority. |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
27 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
28 designator |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
29 a combined :term:`classname` + :term:`itemid` reference to any item |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
30 in the hyperdb. E.g. ``issue26``. Note that form values can include |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
31 something that looks like a designator composed of a classname, |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
32 a dash '-', and a number. E.g. ``file-1``. These are used to create |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
33 new instances of a class via the web interface. |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
34 |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
35 hyperdb |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
36 a software layer between the user and the underlying :term:`db`. |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
37 It is responsible for mutating the underlying db when the schema |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
38 changes. It also executes the detectors when items in the db change. |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
39 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
40 item |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
41 a collection of data that forms one entry in the hyperdb. |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
42 |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
43 itemid |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
44 an integer reference to a particular item of one |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
45 class. Internally it is stored as a string and not an integer |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
46 number. This results in a string not numeric sort by id in some |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
47 circumstances. |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
48 |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
49 property |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
50 one element of data that makes up an item. In Roundup, the set |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
51 of item properties may be changed as needed - even after the |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
52 tracker has been initialized and used in production. |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
53 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
54 schema |
|
7370
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
55 the definition of all the classes and properties that make up a |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
56 tracker. Contained in the file ``schema.py``. The permissions |
|
f37c1df6de34
Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents:
7369
diff
changeset
|
57 for the schema items are usually defined in the same file. |
|
7369
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
58 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
59 tracker |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
60 the schema and hyperdb that forms one issue tracker |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
61 |
|
15bb0d177632
use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents:
7349
diff
changeset
|
62 tracker home |
|
7504
1a912887d704
Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents:
7370
diff
changeset
|
63 the physical location on disk of a tracker. It has the |
|
1a912887d704
Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents:
7370
diff
changeset
|
64 ``config.ini``, ``schema.py`` files for the tracker. |
|
783
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
65 |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
66 |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
67 ----------------- |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
68 |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
69 Back to `Table of Contents`_ |
|
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
70 |
|
6905
9ca128103a3a
fix broken links to doc table of contents
John Rouillard <rouilj@ieee.org>
parents:
6774
diff
changeset
|
71 .. _`Table of Contents`: ../docs.html |
|
783
2f1c59a5bb88
Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
72 |
