view detectors/README.txt @ 5525:bb7865241f8a

Make CSV import/export compatible across Python versions (also RDBMS journals) (issue 2550976, issue 2550975). The roundup-admin export and import commands are used for migrating between different database backends. It is desirable that they should be usable also for migrations between Python 2 and Python 3, and in some cases (e.g. with the anydbm backend) this may be required. To be usable for such migrations, the format of the generated CSV files needs to be stable, meaning the same as currently used with Python 2. The export process uses repr() to produce the fields in the CSV files and eval() to convert them back to Python data structures. repr() of strings with non-ASCII characters produces different results for Python 2 and Python 3. This patch adds repr_export and eval_import functions to roundup/anypy/strings.py which provide the required operations that are just repr() and eval() in Python 2, but are more complicated in Python 3 to use data representations compatible with Python 2. These functions are then used in the required places for export and import. repr() and eval() are also used in storing the dict of changed values in the journal for the RDBMS backends. It is similarly desirable that the database be compatible between Python 2 and Python 3, so that export and import do not need to be used for a migration between Python versions for non-anydbm back ends. Thus, this patch changes rdbms_common.py in the places involved in storing journals in the database, not just in those involved in import/export. Given this patch, import/export with non-ASCII characters appear based on some limited testing to work across Python versions, and an instance using the sqlite backend appears to be compatible between Python versions without needing import/export, *if* the sessions/otks databases (which use anydbm) are deleted when changing Python version.
author Joseph Myers <jsm@polyomino.org.uk>
date Sun, 02 Sep 2018 23:48:04 +0000
parents ec06bd6ea156
children b2eb59ada444
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:

   http://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/