view roundup/anypy/README.txt @ 4781:6e9b9743de89

Implementation for: http://issues.roundup-tracker.org/issue2550731 Add mechanism for the detectors to be able to tell the source of the data changes. Support for tx_Source property on database handle. Can be used by detectors to find out the source of a change in an auditor to block changes arriving by unauthenticated mechanisms (e.g. plain email where headers can be faked). The property db.tx_Source has the following values: * None - Default value set to None. May be valid if it's a script that is created by the user. Otherwise it's an error and indicates that some code path is not properly setting the tx_Source property. * "cli" - this string value is set when using roundup-admin and supplied scripts. * "web" - this string value is set when using any web based technique: html interface, xmlrpc .... * "email" - this string value is set when using an unauthenticated email based technique. * "email-sig-openpgp" - this string value is set when email with a valid pgp signature is used. (*NOTE* the testing for this mode is incomplete. If you have a pgp infrastructure you should test and verify that this is properly set.) This also includes some (possibly incomplete) tests cases for the modes above and an example of using ts_Source in the customization.txt document.
author John Rouillard <rouilj@ieee.org>
date Tue, 23 Apr 2013 23:06:09 -0400
parents eddb82d0964c
children 9ba03348f923
line wrap: on
line source

roundup.anypy package - Python version compatibility layer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Roundup currently supports Python 2.3 to 2.6; however, some modules
have been introduced, while others have been deprecated.  The modules
in this package provide the functionalities which are used by Roundup

- adapting the most recent Python usage
- using new built-in functionality
- avoiding deprecation warnings

Use the modules in this package to preserve Roundup's compatibility.

sets_: sets compatibility module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Since Python 2.4, there is a built-in type 'set'; therefore, the 'sets'
module is deprecated since version 2.6.  As far as Roundup is concerned,
the usage is identical; see 
http://docs.python.org/library/sets.html#comparison-to-the-built-in-set-types

Uses the built-in type 'set' if available, and thus avoids
deprecation warnings. Simple usage:

Change all::
  from sets import Set

to::
  from roundup.anypy.sets_ import set

and use 'set' instead of 'Set' (or sets.Set, respectively).
To avoid unnecessary imports, you can::

  try:
      set
  except NameError:
      from roundup.anypy.sets_ import set

hashlib_: md5/sha/hashlib compatibility
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The md5 and sha modules are deprecated since Python 2.6; the hashlib
module, introduced with Python 2.5, is recommended instead.

Change all::
  import md5
  md5.md5(), md5.new()
  import sha
  sha.sha(), sha.new()

to::
  from roundup.anypy.hashlib_ import md5
  md5()
  from roundup.anypy.hashlib_ import sha1
  sha1()

# vim: si

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