cubicweb: comparison cwconfig.py

equal deleted inserted replaced

-:b6753521129d
+:1294a6bdf3bf
 from smtplib import SMTP
 from threading import Lock
 from os.path import exists, join, expanduser, abspath, normpath, basename, isdir
 from logilab.common.decorators import cached
+from logilab.common.deprecation import deprecated_function
 from logilab.common.logging_ext import set_log_methods, init_log
 from logilab.common.configuration import (Configuration, Method,
 ConfigurationMixIn, merge_options)
 from cubicweb import CW_SOFTWARE_ROOT, CW_MIGRATION_MAP, ConfigurationError
 {'type' : 'csv', 'default': (),
 'help': 'comma separated list of identifiers of application objects (<registry>.<oid>) to disable',
 'group': 'appobjects', 'inputlevel': 2,
 }),
 )
-# static and class methods used to get application independant resources ##
+# static and class methods used to get instance independant resources ##
 @staticmethod
 def cubicweb_version():
 """return installed cubicweb version"""
 from logilab.common.changelog import Version
 return join(CW_SOFTWARE_ROOT, 'web')
 return cls.cube_dir('shared')
 @classmethod
 def i18n_lib_dir(cls):
-"""return application's i18n directory"""
+"""return instance's i18n directory"""
 if cls.mode in ('dev', 'test') and not os.environ.get('APYCOT_ROOT'):
 return join(CW_SOFTWARE_ROOT, 'i18n')
 return join(cls.shared_dir(), 'i18n')
 @classmethod
 cube_vobject_path = set(['entities'])
 @classmethod
 def build_vregistry_path(cls, templpath, evobjpath=None, tvobjpath=None):
 """given a list of directories, return a list of sub files and
-directories that should be loaded by the application objects registry.
+directories that should be loaded by the instance objects registry.
 :param evobjpath:
 optional list of sub-directories (or files without the .py ext) of
 the cubicweb library that should be tested and added to the output list
 if they exists. If not give, default to `cubicweb_vobject_path` class
 RUNTIME_DIR = '/var/run/cubicweb/'
 MIGRATION_DIR = '/usr/share/cubicweb/migration/'
 # for some commands (creation...) we don't want to initialize gettext
 set_language = True
-# set this to true to avoid false error message while creating an application
+# set this to true to avoid false error message while creating an instance
 creating = False
 # set this to true to allow somethings which would'nt be possible
 repairing = False
 options = CubicWebNoAppConfiguration.options + (
 'help': 'listening port of the SMTP mail server',
 'group': 'email', 'inputlevel': 1,
 }),
 ('sender-name',
 {'type' : 'string',
-'default': Method('default_application_id'),
+'default': Method('default_instance_id'),
 'help': 'name used as HELO name for outgoing emails from the \
 repository.',
 'group': 'email', 'inputlevel': 2,
 }),
 ('sender-addr',
 """cubicweb migration scripts directory"""
 return env_path('CW_MIGRATION_DIR', cls.MIGRATION_DIR, 'migration')
 @classmethod
 def config_for(cls, appid, config=None):
-"""return a configuration instance for the given application identifier
+"""return a configuration instance for the given instance identifier
 """
-config = config or guess_configuration(cls.application_home(appid))
+config = config or guess_configuration(cls.instance_home(appid))
 configcls = configuration_cls(config)
 return configcls(appid)
 @classmethod
 def possible_configurations(cls, appid):
 """return the name of possible configurations for the given
-application id
+instance id
 """
-home = cls.application_home(appid)
+home = cls.instance_home(appid)
 return possible_configurations(home)
 @classmethod
-def application_home(cls, appid):
+def instance_home(cls, appid):
-"""return the home directory of the application with the given
+"""return the home directory of the instance with the given
-application id
+instance id
 """
 home = join(cls.registry_dir(), appid)
 if not exists(home):
-raise ConfigurationError('no such application %s (check it exists with "cubicweb-ctl list")' % appid)
+raise ConfigurationError('no such instance %s (check it exists with "cubicweb-ctl list")' % appid)
 return home
 MODES = ('common', 'repository', 'Any', 'web')
 MCOMPAT = {'all-in-one': MODES,
 'repository': ('common', 'repository', 'Any'),
 #assert mode in cls.MODES, mode
 return mode in cls.MCOMPAT[cls.name]
 # default configuration methods ###########################################
-def default_application_id(self):
+def default_instance_id(self):
-"""return the application identifier, useful for option which need this
+"""return the instance identifier, useful for option which need this
 as default value
 """
 return self.appid
 def default_log_file(self):
-"""return default path to the log file of the application'server"""
+"""return default path to the log file of the instance'server"""
 if self.mode == 'dev':
 basepath = '/tmp/%s-%s' % (basename(self.appid), self.name)
 path = basepath + '.log'
 i = 1
 while exists(path) and i < 100: # arbitrary limit to avoid infinite loop
 i += 1
 return path
 return '/var/log/cubicweb/%s-%s.log' % (self.appid, self.name)
 def default_pid_file(self):
-"""return default path to the pid file of the application'server"""
+"""return default path to the pid file of the instance'server"""
 return join(self.runtime_dir(), '%s-%s.pid' % (self.appid, self.name))
-# instance methods used to get application specific resources #############
+# instance methods used to get instance specific resources #############
 def __init__(self, appid):
 self.appid = appid
 CubicWebNoAppConfiguration.__init__(self)
 self._cubes = None
 if not isinstance(cubes, list):
 cubes = list(cubes)
 self._cubes = self.reorder_cubes(list(self._cubes) + cubes)
 def main_config_file(self):
-"""return application's control configuration file"""
+"""return instance's control configuration file"""
 return join(self.apphome, '%s.conf' % self.name)
 def save(self):
 """write down current configuration"""
 self.generate_config(open(self.main_config_file(), 'w'))
 version = self.cube_version(pkg)
 infos.append('%s-%s' % (pkg, version))
 return md5.new(';'.join(infos)).hexdigest()
 def load_site_cubicweb(self):
-"""load (web?) application's specific site_cubicweb file"""
+"""load instance's specific site_cubicweb file"""
 for path in reversed([self.apphome] + self.cubes_path()):
 sitefile = join(path, 'site_cubicweb.py')
 if exists(sitefile) and not sitefile in self._site_loaded:
 self._load_site_cubicweb(sitefile)
 self._site_loaded.add(sitefile)
 if context.get('options'):
 self.register_options(context['options'])
 self.load_defaults()
 def load_configuration(self):
-"""load application's configuration files"""
+"""load instance's configuration files"""
 super(CubicWebConfiguration, self).load_configuration()
 if self.apphome and self.set_language:
 # init gettext
 self._set_language()
 logconfig = join(self.apphome, 'logging.conf')
 if exists(logconfig):
 logging.fileConfig(logconfig)
 def available_languages(self, *args):
-"""return available translation for an application, by looking for
+"""return available translation for an instance, by looking for
 compiled catalog
 take *args to be usable as a vocabulary method
 """
 from glob import glob
 finally:
 SMTP_LOCK.release()
 set_log_methods(CubicWebConfiguration, logging.getLogger('cubicweb.configuration'))
-# alias to get a configuration instance from an application id
+# alias to get a configuration instance from an instance id
-application_configuration = CubicWebConfiguration.config_for
+instance_configuration = CubicWebConfiguration.config_for
+application_configuration = deprecated_function(instance_configuration, 'use instance_configuration')

changeset 2476	1294a6bdf3bf
parent 2473	490f88fb99b6
child 2613	5e19c2bb370e