Mercurial > p > roundup > code
view setup.py @ 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 | fe1bd8f12a9f |
| children | df3f553fa414 |
line wrap: on
line source
#! /usr/bin/env python # -*- coding: utf-8 -*- # # 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. # from __future__ import print_function from roundup.dist.command.build_doc import build_doc from roundup.dist.command.build_scripts import build_scripts from roundup.dist.command.build import build, list_message_files from roundup.dist.command.bdist_rpm import bdist_rpm from roundup.dist.command.install_lib import install_lib # FIXME: setuptools breaks the --manifest-only option to setup.py and # doesn't seem to generate a MANIFEST file. Since I'm not familiar with # the way setuptools handles the files to include I'm commenting this # for now -- Ralf Schlatterbeck #try: # from setuptools import setup #except ImportError: from distutils.core import setup import sys, os from glob import glob def include(d, e): """Generate a pair of (directory, file-list) for installation. 'd' -- A directory 'e' -- A glob pattern""" return (d, [f for f in glob('%s/%s'%(d, e)) if os.path.isfile(f)]) def scriptname(path): """ Helper for building a list of script names from a list of module files. """ script = os.path.splitext(os.path.basename(path))[0] script = script.replace('_', '-') return script def main(): # template munching packages = [ 'roundup', 'roundup.anypy', 'roundup.cgi', 'roundup.cgi.PageTemplates', 'roundup.cgi.TAL', 'roundup.cgi.ZTUtils', 'roundup.backends', 'roundup.scripts', ] # build list of scripts from their implementation modules scripts = [scriptname(f) for f in glob('roundup/scripts/[!_]*.py')] data_files = [ ('share/roundup/cgi-bin', ['frontends/roundup.cgi']), ] # install man pages on POSIX platforms if os.name == 'posix': data_files.append(include('share/man/man1', '*')) # add the templates to the data files lists from roundup.init import listTemplates templates = [t['path'] for t in listTemplates('share/roundup/templates').values()] for tdir in templates: for idir in '. detectors extensions html html/layout static'.split(): data_files.append(include(os.path.join(tdir, idir), '*')) # add message files for (_dist_file, _mo_file) in list_message_files(): data_files.append((os.path.dirname(_mo_file), [os.path.join("build", _mo_file)])) # add docs data_files.append(include('share/doc/roundup/html', '*')) data_files.append(include('share/doc/roundup/html/_images', '*')) data_files.append(include('share/doc/roundup/html/_sources', '*')) data_files.append(include('share/doc/roundup/html/_static', '*')) # perform the setup action from roundup import __version__ # long_description may not contain non-ascii characters. Distutils # will produce an non-installable installer on linux *and* we can't # run the bdist_wininst on Linux if there are non-ascii characters # because the distutils installer will try to use the mbcs codec # which isn't available on non-windows platforms. See also # http://bugs.python.org/issue10945 long_description=open('doc/announcement.txt').read() try: # attempt to interpret string as 'ascii' long_description.encode('ascii') except UnicodeEncodeError as cause: print("doc/announcement.txt contains non-ascii: %s" % cause, file=sys.stderr) sys.exit(42) setup(name='roundup', version=__version__, author="Richard Jones", author_email="richard@users.sourceforge.net", maintainer="Ralf Schlatterbeck", maintainer_email="rsc@runtux.com", description="A simple-to-use and -install issue-tracking system" " with command-line, web and e-mail interfaces. Highly" " customisable.", long_description=long_description, url='http://www.roundup-tracker.org', download_url='https://pypi.python.org/pypi/roundup', classifiers=['Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Environment :: Web Environment', 'Intended Audience :: End Users/Desktop', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: MIT License', 'Operating System :: MacOS :: MacOS X', 'Operating System :: Microsoft :: Windows', 'Operating System :: POSIX', 'Programming Language :: Python', 'Programming Language :: Python :: 2 :: Only', 'Topic :: Communications :: Email', 'Topic :: Office/Business', 'Topic :: Software Development :: Bug Tracking', ], # Override certain command classes with our own ones cmdclass= {'build_doc': build_doc, 'build_scripts': build_scripts, 'build': build, 'bdist_rpm': bdist_rpm, 'install_lib': install_lib, }, packages=packages, scripts=scripts, data_files=data_files) if __name__ == '__main__': os.chdir(os.path.dirname(__file__) or '.') main() # vim: set filetype=python sts=4 sw=4 et si :
