view detectors/README.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 b2eb59ada444
children e738377b4ffe
line wrap: on
line source

This directory has some detector examples that you can use to get
ideas on implementing your own detectors.

These are provides on an as-is basis. When they were added, they
worked for somebody and were considered a useful example.

The roundup team will attempt to keep them up to date with major
changes as they happen, but there are no guarantees that these will
work out of the box. If you find them out of date and have patches to
make them work against newer versions of roundup, please open an issue
at:

   https://issues.roundup-tracker.org

The current inventory is:

creator_resolution.py - only allow the creator of the issue to resolve it

emailauditor.py - Rename .eml files (from email multi-part bodies) to
                  .mht so they can be downloaded/viewed in Internet Explorer.

irker.py - communicate with irkerd to allow roundtup to send announcements
           to an IRC channel.

newissuecopy.py - notify a team email address (hardcoded in the script)
		  when a new issue arrives.

newitemcopy.py - email the DISPATCHER address when new issues, users,
                 keywords etc. are created. Kind of an expanded version
		 of newissuecopy.

Roundup Issue Tracker: http://roundup-tracker.org/