cubicweb: comparison devtools/devctl.py

equal deleted inserted replaced

-:b4ca544ceff0
+:e89f71a41e20
 # *ctl module should limit the number of import to be imported as quickly as
 # possible (for cubicweb-ctl reactivity, necessary for instance for usable bash
 # completion). So import locally in command helpers.
 import sys
 from datetime import datetime
-from os import mkdir, chdir
+from os import mkdir, chdir, listdir, path as osp
-from os.path import join, exists, abspath, basename, normpath, split, isdir
 from warnings import warn
 from logilab.common import STD_BLACKLIST
 from cubicweb.__pkginfo__ import version as cubicwebversion
 from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
 from cubicweb.cwctl import CWCTL
-from cubicweb.toolsutils import (SKEL_EXCLUDE, Command,
+from cubicweb.toolsutils import (SKEL_EXCLUDE, Command, copy_skeleton,
-copy_skeleton, underline_title)
+underline_title)
 from cubicweb.web.webconfig import WebConfiguration
 from cubicweb.server.serverconfig import ServerConfiguration
 class DevConfiguration(ServerConfiguration, WebConfiguration):
 notice that relation definitions description and static vocabulary
 should be marked using '_' and extracted using xgettext
 """
 from cubicweb.cwvreg import CubicWebVRegistry
 if cubedir:
-cube = split(cubedir)[-1]
+cube = osp.split(cubedir)[-1]
 config = DevConfiguration(cube)
 depcubes = list(config._cubes)
 depcubes.remove(cube)
 libconfig = DevConfiguration(*depcubes)
 else:
 from copy import deepcopy
 from cubicweb.i18n import add_msg
 from cubicweb.web import uicfg
 from cubicweb.schema import META_RTYPES, SYSTEM_RTYPES, CONSTRAINTS
 no_context_rtypes = META_RTYPES | SYSTEM_RTYPES
-w('# schema pot file, generated on %s\n' % datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
+w('# schema pot file, generated on %s\n'
+% datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
 w('# \n')
 w('# singular and plural forms for each entity type\n')
 w('\n')
 vregdone = set()
 if libconfig is not None:
 add_msg(w, 'add a %s' % tschema,
 'inlined:%s.%s.%s' % (etype, rschema, role))
 add_msg(w, str(tschema),
 'inlined:%s.%s.%s' % (etype, rschema, role))
 if appearsin_addmenu.etype_get(eschema, rschema, role, tschema):
-if libconfig is not None and libappearsin_addmenu.etype_get(eschema, rschema, role, tschema):
+if libconfig is not None and libappearsin_addmenu.etype_get(
+eschema, rschema, role, tschema):
 if eschema in libschema and tschema in libschema:
 continue
 if role == 'subject':
 label = 'add %s %s %s %s' % (eschema, rschema,
 tschema, role)
 w('# (no object form for final or symmetric relation types)\n')
 w('\n')
 for rschema in sorted(schema.relations()):
 rtype = rschema.type
 if rtype not in libschema:
-# bw compat, necessary until all translation of relation are done properly...
+# bw compat, necessary until all translation of relation are done
+# properly...
 add_msg(w, rtype)
 if rschema.description and rschema.description not in done:
 done.add(rschema.description)
 add_msg(w, rschema.description)
 done.add(rtype)
 libobjects = librschema and librschema.objects() or ()
 for objschema in rschema.objects():
 if not objschema in libobjects:
 add_msg(w, '%s_object' % rtype, objschema.type)
 if rtype not in libschema:
-# bw compat, necessary until all translation of relation are done properly...
+# bw compat, necessary until all translation of relation are
+# done properly...
 add_msg(w, '%s_object' % rtype)
 for objid in _iter_vreg_objids(vreg, vregdone):
 add_msg(w, '%s_description' % objid)
 add_msg(w, objid)
 yield objid
 done.add(objid)
 break
-LANGS = ('en', 'fr', 'es')
-I18NDIR = join(BASEDIR, 'i18n')
 DEFAULT_POT_HEAD = r'''msgid ""
 msgstr ""
 "Project-Id-Version: cubicweb %s\n"
 "PO-Revision-Date: 2008-03-28 18:14+0100\n"
 "Last-Translator: Logilab Team <contact@logilab.fr>\n"
 "Generated-By: cubicweb-devtools\n"
 "Plural-Forms: nplurals=2; plural=(n > 1);\n"
 ''' % cubicwebversion
+def cw_languages():
+for fname in listdir(osp.join(WebConfiguration.i18n_lib_dir())):
+if fname.endswith('.po'):
+yield osp.splitext(fname)[0]
 class UpdateCubicWebCatalogCommand(Command):
 """Update i18n catalogs for cubicweb library.
 It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
 files to add translations of newly added messages.
 """
 name = 'i18ncubicweb'
+min_args = max_args = 0
 def run(self, args):
 """run the command with its specific arguments"""
-if args:
-raise BadCommandUsage('Too many arguments')
 import shutil
 import tempfile
 import yams
 from logilab.common.fileutils import ensure_fs_mode
 from logilab.common.shellutils import globfind, find, rm
 from logilab.common.modutils import get_module_files
 from cubicweb.i18n import extract_from_tal, execute
 tempdir = tempfile.mkdtemp()
-potfiles = [join(I18NDIR, 'static-messages.pot')]
+cwi18ndir = WebConfiguration.i18n_lib_dir()
 print '-> extract schema messages.'
-schemapot = join(tempdir, 'schema.pot')
+schemapot = osp.join(tempdir, 'schema.pot')
+potfiles = [schemapot]
 potfiles.append(schemapot)
 # explicit close necessary else the file may not be yet flushed when
 # we'll using it below
 schemapotstream = file(schemapot, 'w')
 generate_schema_pot(schemapotstream.write, cubedir=None)
 schemapotstream.close()
 print '-> extract TAL messages.'
-tali18nfile = join(tempdir, 'tali18n.py')
+tali18nfile = osp.join(tempdir, 'tali18n.py')
-extract_from_tal(find(join(BASEDIR, 'web'), ('.py', '.pt')), tali18nfile)
+extract_from_tal(find(osp.join(BASEDIR, 'web'), ('.py', '.pt')),
+tali18nfile)
 print '-> generate .pot files.'
-for id, files, lang in [('pycubicweb', get_module_files(BASEDIR) + list(globfind(join(BASEDIR, 'misc', 'migration'), '*.py')), None),
+pyfiles = get_module_files(BASEDIR)
-('schemadescr', globfind(join(BASEDIR, 'schemas'), '*.py'), None),
+pyfiles += globfind(osp.join(BASEDIR, 'misc', 'migration'), '*.py')
+schemafiles = globfind(osp.join(BASEDIR, 'schemas'), '*.py')
+jsfiles = globfind(osp.join(BASEDIR, 'web'), 'cub*.js')
+for id, files, lang in [('pycubicweb', pyfiles, None),
+('schemadescr', schemafiles, None),
 ('yams', get_module_files(yams.__path__[0]), None),
 ('tal', [tali18nfile], None),
-('js', globfind(join(BASEDIR, 'web'), 'cub*.js'), 'java'),
+('js', jsfiles, 'java'),
 ]:
 cmd = 'xgettext --no-location --omit-header -k_ -o %s %s'
 if lang is not None:
 cmd += ' -L %s' % lang
-potfile = join(tempdir, '%s.pot' % id)
+potfile = osp.join(tempdir, '%s.pot' % id)
 execute(cmd % (potfile, ' '.join('"%s"' % f for f in files)))
-if exists(potfile):
+if osp.exists(potfile):
 potfiles.append(potfile)
 else:
 print '-> WARNING: %s file was not generated' % potfile
 print '-> merging %i .pot files' % len(potfiles)
-cubicwebpot = join(tempdir, 'cubicweb.pot')
+cubicwebpot = osp.join(tempdir, 'cubicweb.pot')
-execute('msgcat -o %s %s' % (cubicwebpot, ' '.join('"%s"' % f for f in potfiles)))
+execute('msgcat -o %s %s'
+% (cubicwebpot, ' '.join('"%s"' % f for f in potfiles)))
 print '-> merging main pot file with existing translations.'
-chdir(I18NDIR)
+chdir(cwi18ndir)
 toedit = []
-for lang in LANGS:
+for lang in cw_languages():
 target = '%s.po' % lang
-execute('msgmerge -N --sort-output -o "%snew" "%s" "%s"' % (target, target, cubicwebpot))
+execute('msgmerge -N --sort-output -o "%snew" "%s" "%s"'
+% (target, target, cubicwebpot))
 ensure_fs_mode(target)
 shutil.move('%snew' % target, target)
-toedit.append(abspath(target))
+toedit.append(osp.abspath(target))
 # cleanup
 rm(tempdir)
 # instructions pour la suite
 print '-> regenerated CubicWeb\'s .po catalogs.'
 print '\nYou can now edit the following files:'
 if args:
 cubes = [DevConfiguration.cube_dir(cube) for cube in args]
 else:
 cubes = [DevConfiguration.cube_dir(cube)
 for cube in DevConfiguration.available_cubes()]
-cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
+cubes = [cubepath for cubepath in cubes
+if osp.exists(osp.join(cubepath, 'i18n'))]
 update_cubes_catalogs(cubes)
 def update_cubes_catalogs(cubes):
 for cubedir in cubes:
-if not isdir(cubedir):
+if not osp.isdir(cubedir):
 print '-> ignoring %s that is not a directory.' % cubedir
 continue
 try:
 toedit = update_cube_catalogs(cubedir)
 except Exception:
 import shutil
 import tempfile
 from logilab.common.fileutils import ensure_fs_mode
 from logilab.common.shellutils import find, rm
 from cubicweb.i18n import extract_from_tal, execute
-cube = basename(normpath(cubedir))
+cube = osp.basename(osp.normpath(cubedir))
 tempdir = tempfile.mkdtemp()
 print underline_title('Updating i18n catalogs for cube %s' % cube)
 chdir(cubedir)
-if exists(join('i18n', 'entities.pot')):
+if osp.exists(osp.join('i18n', 'entities.pot')):
 warn('entities.pot is deprecated, rename file to static-messages.pot (%s)'
-% join('i18n', 'entities.pot'), DeprecationWarning)
+% osp.join('i18n', 'entities.pot'), DeprecationWarning)
-potfiles = [join('i18n', 'entities.pot')]
+potfiles = [osp.join('i18n', 'entities.pot')]
-elif exists(join('i18n', 'static-messages.pot')):
+elif osp.exists(osp.join('i18n', 'static-messages.pot')):
-potfiles = [join('i18n', 'static-messages.pot')]
+potfiles = [osp.join('i18n', 'static-messages.pot')]
 else:
 potfiles = []
 print '-> extract schema messages'
-schemapot = join(tempdir, 'schema.pot')
+schemapot = osp.join(tempdir, 'schema.pot')
 potfiles.append(schemapot)
 # explicit close necessary else the file may not be yet flushed when
 # we'll using it below
 schemapotstream = file(schemapot, 'w')
 generate_schema_pot(schemapotstream.write, cubedir)
 schemapotstream.close()
 print '-> extract TAL messages'
-tali18nfile = join(tempdir, 'tali18n.py')
+tali18nfile = osp.join(tempdir, 'tali18n.py')
-extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
+ptfiles = find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',))
+extract_from_tal(ptfiles, tali18nfile)
 print '-> extract Javascript messages'
-jsfiles =  [jsfile for jsfile in find('.', '.js') if basename(jsfile).startswith('cub')]
+jsfiles =  [jsfile for jsfile in find('.', '.js')
+if osp.basename(jsfile).startswith('cub')]
 if jsfiles:
-tmppotfile = join(tempdir, 'js.pot')
+tmppotfile = osp.join(tempdir, 'js.pot')
-execute('xgettext --no-location --omit-header -k_ -L java --from-code=utf-8 -o %s %s'
+execute('xgettext --no-location --omit-header -k_ -L java '
-% (tmppotfile, ' '.join(jsfiles)))
+'--from-code=utf-8 -o %s %s' % (tmppotfile, ' '.join(jsfiles)))
 # no pot file created if there are no string to translate
-if exists(tmppotfile):
+if osp.exists(tmppotfile):
 potfiles.append(tmppotfile)
 print '-> create cube-specific catalog'
-tmppotfile = join(tempdir, 'generated.pot')
+tmppotfile = osp.join(tempdir, 'generated.pot')
 cubefiles = find('.', '.py', blacklist=STD_BLACKLIST+('test',))
 cubefiles.append(tali18nfile)
 execute('xgettext --no-location --omit-header -k_ -o %s %s'
 % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
-if exists(tmppotfile): # doesn't exists of no translation string found
+if osp.exists(tmppotfile): # doesn't exists of no translation string found
 potfiles.append(tmppotfile)
-potfile = join(tempdir, 'cube.pot')
+potfile = osp.join(tempdir, 'cube.pot')
 print '-> merging %i .pot files:' % len(potfiles)
 execute('msgcat -o %s %s' % (potfile,
 ' '.join('"%s"' % f for f in potfiles)))
-if not exists(potfile):
+if not osp.exists(potfile):
 print 'no message catalog for cube', cube, 'nothing to translate'
 # cleanup
 rm(tempdir)
 return ()
 print '-> merging main pot file with existing translations:'
 chdir('i18n')
 toedit = []
-for lang in LANGS:
+for lang in cw_languages():
 print '-> language', lang
 cubepo = '%s.po' % lang
-if not exists(cubepo):
+if not osp.exists(cubepo):
 shutil.copy(potfile, cubepo)
 else:
 execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
 ensure_fs_mode(cubepo)
 shutil.move('%snew' % cubepo, cubepo)
-toedit.append(abspath(cubepo))
+toedit.append(osp.abspath(cubepo))
 # cleanup
 rm(tempdir)
 return toedit
 <cubename>
 the name of the new cube. It should be a valid python module name.
 """
 name = 'newcube'
 arguments = '<cubename>'
+min_args = max_args = 1
 options = (
 ("layout",
 {'short': 'L', 'type' : 'choice', 'metavar': '<cube layout>',
 'default': 'simple', 'choices': ('simple', 'full'),
 'help': 'cube layout. You\'ll get a minimal cube with the "simple" \
 }
 def run(self, args):
 import re
 from logilab.common.shellutils import ASK
-if len(args) != 1:
-raise BadCommandUsage("exactly one argument (cube name) is expected")
 cubename = args[0]
 if not re.match('[_A-Za-z][_A-Za-z0-9]*$', cubename):
-raise BadCommandUsage("cube name should be a valid python module name")
+raise BadCommandUsage(
+'cube name must be a valid python module name')
 verbose = self.get('verbose')
 cubesdir = self.get('directory')
 if not cubesdir:
 cubespath = ServerConfiguration.cubes_search_path()
 if len(cubespath) > 1:
-raise BadCommandUsage("can't guess directory where to put the new cube."
+raise BadCommandUsage(
-" Please specify it using the --directory option")
+"can't guess directory where to put the new cube."
+" Please specify it using the --directory option")
 cubesdir = cubespath[0]
-if not isdir(cubesdir):
+if not osp.isdir(cubesdir):
 print "-> creating cubes directory", cubesdir
 try:
 mkdir(cubesdir)
 except OSError, err:
-self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
+self.fail("failed to create directory %r\n(%s)"
-cubedir = join(cubesdir, cubename)
+% (cubesdir, err))
-if exists(cubedir):
+cubedir = osp.join(cubesdir, cubename)
-self.fail("%s already exists !" % (cubedir))
+if osp.exists(cubedir):
-skeldir = join(BASEDIR, 'skeleton')
+self.fail("%s already exists !" % cubedir)
+skeldir = osp.join(BASEDIR, 'skeleton')
 default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
 if verbose:
-distname = raw_input('Debian name for your cube ? [%s]): ' % default_name).strip()
+distname = raw_input('Debian name for your cube ? [%s]): '
+% default_name).strip()
 if not distname:
 distname = default_name
 elif not distname.startswith('cubicweb-'):
 if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
 distname = 'cubicweb-' + distname
 else:
 distname = default_name
 if not re.match('[a-z][-a-z0-9]*$', distname):
-raise BadCommandUsage("cube distname should be a valid debian package name")
+raise BadCommandUsage(
-longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
+'cube distname should be a valid debian package name')
+longdesc = shortdesc = raw_input(
+'Enter a short description for your cube: ')
 if verbose:
-longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
+longdesc = raw_input(
+'Enter a long description (leave empty to reuse the short one): ')
 dependencies = {'cubicweb': '>= %s' % cubicwebversion}
 if verbose:
 dependencies.update(self._ask_for_dependencies())
 context = {'cubename' : cubename,
 'distname' : distname,
 chances are the lines at the top are the ones that will bring the higher
 benefit after optimisation. Start there.
 """
 arguments = 'rql.log'
 name = 'exlog'
-options = (
+options = ()
-)
 def run(self, args):
 import re
 requests = {}
 for filepath in args:
 class GenerateSchema(Command):
 """Generate schema image for the given cube"""
 name = "schema"
 arguments = '<cube>'
 min_args = max_args = 1
-options = [('output-file', {'type':'file', 'default': None,
+options = [
-'metavar': '<file>', 'short':'o', 'help':'output image file',
+('output-file',
-'input':False}),
+{'type':'file', 'default': None,
-('viewer', {'type': 'string', 'default':None,
+'metavar': '<file>', 'short':'o', 'help':'output image file',
-'short': "d", 'metavar':'<cmd>',
+'input':False,
-'help':'command use to view the generated file (empty for none)'}
+}),
-),
+('viewer',
-('show-meta', {'action': 'store_true', 'default':False,
+{'type': 'string', 'default':None,
-'short': "m", 'metavar': "<yN>",
+'short': "d", 'metavar':'<cmd>',
-'help':'include meta and internal entities in schema'}
+'help':'command use to view the generated file (empty for none)',
-),
+}),
-('show-workflow', {'action': 'store_true', 'default':False,
+('show-meta',
-'short': "w", 'metavar': "<yN>",
+{'action': 'store_true', 'default':False,
-'help':'include workflow entities in schema'}
+'short': "m", 'metavar': "<yN>",
-),
+'help':'include meta and internal entities in schema',
-('show-cw-user', {'action': 'store_true', 'default':False,
+}),
-'metavar': "<yN>",
+('show-workflow',
-'help':'include cubicweb user entities in schema'}
+{'action': 'store_true', 'default':False,
-),
+'short': "w", 'metavar': "<yN>",
-('exclude-type', {'type':'string', 'default':'',
+'help':'include workflow entities in schema',
-'short': "x", 'metavar': "<types>",
+}),
-'help':'coma separated list of entity types to remove from view'}
+('show-cw-user',
-),
+{'action': 'store_true', 'default':False,
-('include-type', {'type':'string', 'default':'',
+'metavar': "<yN>",
-'short': "i", 'metavar': "<types>",
+'help':'include cubicweb user entities in schema',
-'help':'coma separated list of entity types to include in view'}
+}),
-),
+('exclude-type',
-]
+{'type':'string', 'default':'',
+'short': "x", 'metavar': "<types>",
+'help':'coma separated list of entity types to remove from view',
+}),
+('include-type',
+{'type':'string', 'default':'',
+'short': "i", 'metavar': "<types>",
+'help':'coma separated list of entity types to include in view',
+}),
+]
 def run(self, args):
 from subprocess import Popen
 from tempfile import NamedTemporaryFile
 from logilab.common.textutils import splitstrip

branch	stable
changeset 6356	e89f71a41e20
parent 6138	65f5e488f983
child 6443	a5bed0cd3956
child 6749	48f468f33704