Mercurial > p > roundup > code
view roundup/__init__.py @ 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 | ed2bc951277b |
| children | 68ad91f5905d |
line wrap: on
line source
# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # '''Roundup - issue tracking for knowledge workers. This is a simple-to-use and -install issue-tracking system with command-line, web and e-mail interfaces. Roundup manages a number of issues (with properties such as "description", "priority", and so on) and provides the ability to (a) submit new issues, (b) find and edit existing issues, and (c) discuss issues with other participants. The system will facilitate communication among the participants by managing discussions and notifying interested parties when issues are edited. Roundup's structure is that of a cake:: _________________________________________________________________________ | E-mail Client | Web Browser | Detector Scripts | Shell | |------------------+-----------------+----------------------+-------------| | E-mail User | Web User | Detector | Command | |-------------------------------------------------------------------------| | Roundup Database Layer | |-------------------------------------------------------------------------| | Hyperdatabase Layer | |-------------------------------------------------------------------------| | Storage Layer | ------------------------------------------------------------------------- 1. The first layer represents the users (chocolate). 2. The second layer is the Roundup interface to the users (vanilla). 3. The third and fourth layers are the internal Roundup database storage mechanisms (strawberry). 4. The final, lowest layer is the underlying database storage (rum). These are implemented in the code in the following manner:: E-mail User: roundup-mailgw and roundup.mailgw Web User: cgi-bin/roundup.cgi or roundup-server over roundup.cgi.client and roundup.cgi.template Detector: roundup.roundupdb and templates/<template>/detectors Command: roundup-admin Roundup DB: roundup.roundupdb Hyper DB: roundup.hyperdb, roundup.date Storage: roundup.backends.* Additionally, there is a directory of unit tests in "test". For more information, see the original overview and specification documents written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a much prettier cake :) ''' __docformat__ = 'restructuredtext' __version__ = '2.3.0' # vim: set filetype=python ts=4 sw=4 et si