cubicweb: comparison cubicweb/toolsutils.py

equal deleted inserted replaced

-:e460eac6e648
+:ca3fe2f275eb
 # with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
 """some utilities for cubicweb command line tools"""
 from __future__ import print_function
 # XXX move most of this in logilab.common (shellutils ?)
 import io
-import os, sys
+import os
+import sys
 import subprocess
-from os import listdir, makedirs, environ, chmod, walk, remove
+from os import listdir, makedirs, chmod, walk, remove
-from os.path import exists, join, abspath, normpath
+from os.path import exists, join, normpath
 import re
 from rlcompleter import Completer
 try:
 import readline
-except ImportError: # readline not available, no completion
+except ImportError:  # readline not available, no completion
 pass
 try:
 from os import symlink
 except ImportError:
 def symlink(*args):
 from six import add_metaclass
 from logilab.common.clcommands import Command as BaseCommand
 from logilab.common.shellutils import ASK
-from cubicweb import warning # pylint: disable=E0611
+from cubicweb import warning  # pylint: disable=E0611
 from cubicweb import ConfigurationError, ExecutionError
 def underline_title(title, car='-'):
-return title+'\n'+(car*len(title))
+return title + '\n' + (car * len(title))
 def iter_dir(directory, condition_file=None, ignore=()):
 """iterate on a directory"""
 for sub in listdir(directory):
 if sub in ('CVS', '.svn', '.hg'):
 continue
 if condition_file is not None and \
 not exists(join(directory, sub, condition_file)):
 continue
 if sub in ignore:
 continue
 yield sub
 def create_dir(directory):
 """create a directory if it doesn't exist yet"""
 try:
 makedirs(directory)
 import errno
 if ex.errno != errno.EEXIST:
 raise
 print('-> no need to create existing directory %s' % directory)
 def create_symlink(source, target):
 """create a symbolic link"""
 if exists(target):
 remove(target)
 symlink(source, target)
 print('[symlink] %s <-- %s' % (target, source))
 def create_copy(source, target):
 import shutil
 print('[copy] %s <-- %s' % (target, source))
 shutil.copy2(source, target)
 def rm(whatever):
 import shutil
 shutil.rmtree(whatever)
 print('-> removed %s' % whatever)
 def show_diffs(appl_file, ref_file, askconfirm=True):
 """interactivly replace the old file with the new file according to
 user decision
 """
 copy.close()
 print('keep current version, the new file has been written to', copy_file)
 else:
 print('no diff between %s and %s' % (appl_file, ref_file))
 SKEL_EXCLUDE = ('*.py[co]', '*.orig', '*~', '*_flymake.py')
 def copy_skeleton(skeldir, targetdir, context,
 exclude=SKEL_EXCLUDE, askconfirm=False):
 import shutil
 from fnmatch import fnmatch
 skeldir = normpath(skeldir)
 else:
 tfpath = join(tdirpath, fname)
 if fname.endswith('.tmpl'):
 tfpath = tfpath[:-5]
 if not askconfirm or not exists(tfpath) or \
 ASK.confirm('%s exists, overwrite?' % tfpath):
 fill_templated_file(fpath, tfpath, context)
 print('[generate] %s <-- %s' % (tfpath, fpath))
 elif exists(tfpath):
 show_diffs(tfpath, fpath, askconfirm)
 else:
 shutil.copyfile(fpath, tfpath)
 shutil.copymode(fpath, tfpath)
 def fill_templated_file(fpath, tfpath, context):
 with io.open(fpath, encoding='ascii') as fobj:
 template = fobj.read()
 with io.open(tfpath, 'w', encoding='ascii') as fobj:
 fobj.write(template % context)
 def restrict_perms_to_user(filepath, log=None):
 """set -rw------- permission on the given file"""
 if log:
 log('set permissions to 0600 for %s', filepath)
 option = line.strip().lower()
 if option[0] == '[':
 # start a section
 section = option[1:-1]
 assert section not in config, \
 'Section %s is defined more than once' % section
 config[section] = current = {}
 continue
 sys.stderr.write('ignoring malformed line\n%r\n' % line)
 continue
 option = option.strip().replace(' ', '_')
 return config
 _HDLRS = {}
 class metacmdhandler(type):
 def __new__(mcs, name, bases, classdict):
 cls = super(metacmdhandler, mcs).__new__(mcs, name, bases, classdict)
 if getattr(cls, 'cfgname', None) and getattr(cls, 'cmdname', None):
 _HDLRS.setdefault(cls.cmdname, []).append(cls)
 @add_metaclass(metacmdhandler)
 class CommandHandler(object):
 """configuration specific helper for cubicweb-ctl commands"""
 def __init__(self, config):
 self.config = config
 class Command(BaseCommand):
 sys.exit(1)
 CONNECT_OPTIONS = (
 ("user",
-{'short': 'u', 'type' : 'string', 'metavar': '<user>',
+{'short': 'u', 'type': 'string', 'metavar': '<user>',
 'help': 'connect as <user> instead of being prompted to give it.',
 }
 ),
 ("password",
-{'short': 'p', 'type' : 'password', 'metavar': '<password>',
+{'short': 'p', 'type': 'password', 'metavar': '<password>',
 'help': 'automatically give <password> for authentication instead of \
 being prompted to give it.',
 }),
 ("host",
-{'short': 'H', 'type' : 'string', 'metavar': '<hostname>',
+{'short': 'H', 'type': 'string', 'metavar': '<hostname>',
 'default': None,
 'help': 'specify the name server\'s host name. Will be detected by \
 broadcast if not provided.',
 }),
 )
-## cwshell helpers #############################################################
+# cwshell helpers #############################################################
 class AbstractMatcher(object):
 """Abstract class for CWShellCompleter's matchers.
 A matcher should implement a ``possible_matches`` method. This
 'func_prefix': func_prefix,
 # offset of rql query
 'rql_offset': len(func_prefix) + 2,
 # incomplete rql query
 'rql_query': parameters_text,
 }
 def possible_matches(self, text):
 """call ``rql.suggestions`` component to complete user's input.
 """
 # readline will only send last token, but we need the entire user's input
 class DefaultMatcher(AbstractMatcher):
 """Default matcher: delegate to standard's `rlcompleter.Completer`` class
 """
 def __init__(self, local_ctx):
 self.completer = Completer(local_ctx)
 def possible_matches(self, text):
 if "." in text:
 matches = matcher.possible_matches(text)
 if matches:
 self.matches = matches
 break
 else:
-return None # no matcher able to handle `text`
+return None  # no matcher able to handle `text`
 try:
 return self.matches[state]
 except IndexError:
 return None

branch	3.26
changeset 12422	ca3fe2f275eb
parent 12321	e116275bf1ac
child 12567	26744ad37953