Mercurial Repository: p/roundup/code: roundup/configuration.py comparison

comparison roundup/configuration.py @ 6004:55f5060e0508

flake8 formatting fixes; use isinstance rather than type equality.

author	John Rouillard <rouilj@ieee.org>
date	Sat, 28 Dec 2019 13:01:14 -0500
parents	71c68961d9f4
children	380dec305c28

comparison

equal deleted inserted replaced

-:48a1f919f894
+:55f5060e0508
 # Python 2: <https://pypi.org/project/configparser/>.  That breaks
 # Roundup if used with Python 2 because it generates unicode objects
 # where not expected by the Python code.  Thus, a version check is
 # used here instead of try/except.
 import sys
-if sys.version_info[0] > 2:
-import configparser			# Python 3
-else:
-import ConfigParser as configparser	# Python 2
 import getopt
 import imp
 import logging, logging.config
 import os
 import re
 import roundup.anypy.random_ as random_
 import binascii
 from roundup.backends import list_backends
+if sys.version_info[0] > 2:
+import configparser			 # Python 3
+else:
+import ConfigParser as configparser  # Python 2
 # XXX i don't think this module needs string translation, does it?
 ### Exceptions
 class ConfigurationError(BaseException):
 pass
 class NoConfigError(ConfigurationError):
 """Raised when configuration loading fails
 """
 def __str__(self):
 return "No valid configuration files found in directory %s" \
 % self.args[0]
 class InvalidOptionError(ConfigurationError, KeyError, AttributeError):
 """Attempted access to non-existing configuration option
 """
 def __str__(self):
 return "Unsupported configuration option: %s" % self.args[0]
 class OptionValueError(ConfigurationError, ValueError):
 """Raised upon attempt to assign an invalid value to config option
 "option": _args[0].name, "value": _args[1]}
 if len(_args) > 2:
 _rv += "\n".join(("",) + _args[2:])
 return _rv
 class OptionUnsetError(ConfigurationError):
 """Raised when no Option value is available - neither set, nor default
 Constructor parameters: Option instance.
 """
 def __str__(self):
 return "%s is not set and has no default" % self.args[0].name
 class UnsetDefaultValue:
 """Special object meaning that default value for Option is not specified"""
 def __str__(self):
 return "NO DEFAULT"
 NODEFAULT = UnsetDefaultValue()
 def create_token(size=32):
 return b2s(binascii.b2a_base64(random_.token_bytes(size)).strip())
 ### Option classes
 class Option:
 """Single configuration option.
 """
 class_description = None
 def __init__(self, config, section, setting,
-default=NODEFAULT, description=None, aliases=None
+default=NODEFAULT, description=None, aliases=None):
-):
 self.config = config
 self.section = section
 self.setting = setting.lower()
 self.default = default
 self.description = description
 for _name in self.aliases:
 if hasattr(config, _name):
 self.set(getattr(config, _name))
 break
 class BooleanOption(Option):
 """Boolean option: yes or no"""
 class_description = "Allowed values: yes, no"
 return "yes"
 else:
 return "no"
 def str2value(self, value):
-if type(value) == type(""):
+if isinstance(value, type("")):
 _val = value.lower()
 if _val in ("yes", "true", "on", "1"):
 _val = 1
 elif _val in ("no", "false", "off", "0"):
 _val = 0
 raise OptionValueError(self, value, self.class_description)
 else:
 _val = value and 1 or 0
 return _val
 class WordListOption(Option):
 """List of strings"""
 class_description = "Allowed values: comma-separated list of words"
 def _value2str(self, value):
 return ','.join(value)
 def str2value(self, value):
 return value.split(',')
 class RunDetectorOption(Option):
 """When a detector is run: always, never or for new items only"""
 if _val in ("yes", "no", "new"):
 return _val
 else:
 raise OptionValueError(self, value, self.class_description)
 class CsrfSettingOption(Option):
 """How should a csrf measure be enforced: required, yes, logfailure, no"""
 class_description = "Allowed values: required, yes, logfailure, no"
 if _val in ("required", "yes", "logfailure", "no"):
 return _val
 else:
 raise OptionValueError(self, value, self.class_description)
 class SameSiteSettingOption(Option):
 """How should the SameSite cookie setting be set: strict, lax
 or should it not be added (none)"""
 _val = value.lower()
 if _val in ("strict", "lax", "none"):
 return _val.capitalize()
 else:
 raise OptionValueError(self, value, self.class_description)
 class DatabaseBackend(Option):
 """handle exact text of backend and make sure it's available"""
-class_description = "Available backends: %s"%", ".join(list_backends())
+class_description = "Available backends: %s" % ", ".join(list_backends())
 def str2value(self, value):
 _val = value.lower()
 if _val in list_backends():
 return _val
 else:
 raise OptionValueError(self, value, self.class_description)
 class HtmlToTextOption(Option):
-"""What module should be used to convert emails with only text/html parts into text for display in roundup. Choose from beautifulsoup 4, dehtml - the internal code or none to disable html to text conversion. If beautifulsoup chosen but not available, dehtml will be used."""
+"""What module should be used to convert emails with only text/html
+parts into text for display in roundup. Choose from beautifulsoup
+4, dehtml - the internal code or none to disable html to text
+conversion. If beautifulsoup chosen but not available, dehtml will
+be used.
+"""
 class_description = "Allowed values: beautifulsoup, dehtml, none"
 def str2value(self, value):
 _val = value.lower()
 if _val in ("beautifulsoup", "dehtml", "none"):
 return _val
 else:
 raise OptionValueError(self, value, self.class_description)
 class EmailBodyOption(Option):
-"""When to replace message body or strip quoting: always, never or for new items only"""
+"""When to replace message body or strip quoting: always, never
+or for new items only"""
 class_description = "Allowed values: yes, no, new"
 def str2value(self, value):
 _val = value.lower()
 if _val in ("yes", "no", "new"):
 return _val
 else:
 raise OptionValueError(self, value, self.class_description)
 class IsolationOption(Option):
 """Database isolation levels"""
 allowed = ['read uncommitted', 'read committed', 'repeatable read',
 'serializable']
-class_description = "Allowed values: %s" % ', '.join ("'%s'" % a
+class_description = "Allowed values: %s" % ', '.join("'%s'" % a
 for a in allowed)
 def str2value(self, value):
 _val = value.lower()
 if _val in self.allowed:
 return _val
 raise OptionValueError(self, value, self.class_description)
 class MailAddressOption(Option):
 """Email address
 Email addresses may be either fully qualified or local.
 _val = Option.get(self)
 if "@" not in _val:
 _val = "@".join((_val, self.config["MAIL_DOMAIN"]))
 return _val
 class FilePathOption(Option):
 """File or directory path name
 Paths may be either absolute or relative to the HOME.
 _val = Option.get(self)
 if _val and not os.path.isabs(_val):
 _val = os.path.join(self.config["HOME"], _val)
 return _val
 class MultiFilePathOption(Option):
 """List of space seperated File or directory path name
 Paths may be either absolute or relative to the HOME. None
 is returned if there are no elements.
 """
-class_description = "The space separated paths may be either absolute or\n" \
+class_description = "The space separated paths may be either absolute\n" \
-"relative to the directory containing this config file."
+"or relative to the directory containing this config file."
 def get(self):
 pathlist = []
 _val = Option.get(self)
 for elem in _val.split():
 if pathlist:
 return pathlist
 else:
 return None
 class FloatNumberOption(Option):
 """Floating point numbers"""
 def str2value(self, value):
 try:
 return float(value)
 except ValueError:
 raise OptionValueError(self, value,
 "Floating point number required")
 def _value2str(self, value):
 _val = str(value)
 # strip fraction part from integer numbers
 if _val.endswith(".0"):
 _val = _val[:-2]
 return _val
 class IntegerNumberOption(Option):
 """Integer numbers"""
 def str2value(self, value):
 try:
 return int(value)
 except ValueError:
 raise OptionValueError(self, value, "Integer number required")
 class IntegerNumberGeqZeroOption(Option):
 """Integer numbers greater than or equal to zero."""
 if v < 0:
 raise OptionValueError(self, value,
 "Integer number greater than or equal to zero required")
 return v
 except OptionValueError:
-raise # pass through subclass
+raise  # pass through subclass
 except ValueError:
 raise OptionValueError(self, value, "Integer number required")
 class OctalNumberOption(Option):
 """Octal Integer numbers"""
 def str2value(self, value):
 try:
 return int(value, 8)
 except ValueError:
-raise OptionValueError(self, value, "Octal Integer number required")
+raise OptionValueError(self, value,
+"Octal Integer number required")
 def _value2str(self, value):
 return oct(value)
 class MandatoryOption(Option):
 """Option must not be empty"""
 def str2value(self, value):
 if not value:
-raise OptionValueError(self,value,"Value must not be empty.")
+raise OptionValueError(self, value, "Value must not be empty.")
 else:
 return value
 class WebUrlOption(Option):
 """URL MUST start with http/https scheme and end with '/'"""
 def str2value(self, value):
 if not value:
-raise OptionValueError(self,value,"Value must not be empty.")
+raise OptionValueError(self, value, "Value must not be empty.")
 error_msg = ''
 if not value.startswith(('http://', 'https://')):
 error_msg = "Value must start with http:// or https://.\n"
 if not value.endswith('/'):
 error_msg += "Value must end with /."
 if error_msg:
-raise OptionValueError(self,value,error_msg)
+raise OptionValueError(self, value, error_msg)
 else:
 return value
 class NullableOption(Option):
 """Option that is set to None if its string value is one of NULL strings
 """
 NULL_STRINGS = ("",)
 def __init__(self, config, section, setting,
 default=NODEFAULT, description=None, aliases=None,
-null_strings=NULL_STRINGS
+null_strings=NULL_STRINGS):
-):
 self.null_strings = list(null_strings)
 Option.__init__(self, config, section, setting, default,
 description, aliases)
 def str2value(self, value):
 if value in self.null_strings:
 return None
 else:
 def _value2str(self, value):
 if value is None:
 return self.null_strings[0]
 else:
 return value
 class NullableFilePathOption(NullableOption, FilePathOption):
 # .get() and class_description are from FilePathOption,
 get = FilePathOption.get
 class_description = FilePathOption.class_description
 # everything else taken from NullableOption (inheritance order)
 class TimezoneOption(Option):
 class_description = \
 "If pytz module is installed, value may be any valid\n" \
 except KeyError:
 raise OptionValueError(self, value,
 "Timezone name or numeric hour offset required")
 return value
 class RegExpOption(Option):
 """Regular Expression option (value is Regular Expression Object)"""
 class_description = "Value is Python Regular Expression (UTF8-encoded)."
 RE_TYPE = type(re.compile(""))
 def __init__(self, config, section, setting,
 default=NODEFAULT, description=None, aliases=None,
-flags=0,
+flags=0):
-):
 self.flags = flags
 Option.__init__(self, config, section, setting, default,
 description, aliases)
 def _value2str(self, value):
 assert isinstance(value, self.RE_TYPE)
 return value.pattern
 # is a sequence containing class name and constructor
 # parameters, starting from the setting name:
 # setting, default, [description, [aliases]]
 # Note: aliases should only exist in historical options for backwards
 # compatibility - new options should *not* have aliases!
 SETTINGS = (
 ("main", (
 (FilePathOption, "database", "db", "Database directory path."),
 (Option, "template_engine", "zopetal",
 "Templating engine to use.\n"
 "Roles that a user gets when they register"
 " with Email Gateway.\n"
 "This is a comma-separated string of role names"
 " (e.g. 'Admin,User')."),
 (Option, "obsolete_history_roles", "Admin",
-	    "On schema changes, properties or classes in the history may\n"
+"On schema changes, properties or classes in the history may\n"
-	    "become obsolete.  Since normal access permissions do not apply\n"
+"become obsolete.  Since normal access permissions do not apply\n"
-	    "(we don't know if a user should see such a property or class)\n"
+"(we don't know if a user should see such a property or class)\n"
-	    "a list of roles is specified here that are allowed to see\n"
+"a list of roles is specified here that are allowed to see\n"
-	    "these obsolete properties in the history. By default only the\n"
+"these obsolete properties in the history. By default only the\n"
-	    "admin role may see these history entries, you can make them\n"
+"admin role may see these history entries, you can make them\n"
-	    "visible to all users by adding, e.g., the 'User' role here."),
+"visible to all users by adding, e.g., the 'User' role here."),
 (Option, "error_messages_to", "user",
 # XXX This description needs better wording,
 #   with explicit allowed values list.
 "Send error message emails to the dispatcher, user, or both?\n"
 "The dispatcher is configured using the DISPATCHER_EMAIL"
 "address. This allows email exchanges to occur outside of\n"
 "the view of roundup and exposes the address of the person\n"
 "who updated the issue, but it could be useful in some\n"
 "unusual circumstances.\n"
 "If set to some other value, the value is used as the reply-to\n"
-"address. It must be a valid RFC2822 address or people will not be\n"
+"address. It must be a valid RFC2822 address or people will not\n"
-"able to reply."),
+"be able to reply."),
 (NullableOption, "language", "",
 "Default locale name for this tracker.\n"
 "If this option is not set, the language is determined\n"
 "by OS environment variable LANGUAGE, LC_ALL, LC_MESSAGES,\n"
 "or LANG, in that order of preference."),
 (BooleanOption, 'registration_prevalidate_username', "no",
 "When registering a user, check that the username\n"
 "is available before sending confirmation email.\n"
 "Usually a username conflict is detected when\n"
 "confirming the registration. Disabled by default as\n"
-"it can be used for guessing existing usernames.\n" ),
+"it can be used for guessing existing usernames.\n"),
 (SameSiteSettingOption, 'samesite_cookie_setting', "Lax",
 """Set the mode of the SameSite cookie option for
 the session cookie. Choices are 'Lax' or
 'Strict'. 'None' can be used to suppress the
 option. Strict mode provides additional security
 additional REST-API parameters after the roundup web url configured in
 the tracker section. If this variable is set to 'no', the rest path has
 no special meaning and will yield an error message."""),
 (IntegerNumberGeqZeroOption, 'api_calls_per_interval', "0",
 "Limit API calls per api_interval_in_sec seconds to\n"
 "this number.\n"
 "Determines the burst rate and the rate that new api\n"
 "calls will be made available. If set to 360 and\n"
 "api_intervals_in_sec is set to 3600, the 361st call in\n"
 "10 seconds results in a 429 error to the caller. It\n"
 "tells them to wait 10 seconds (360/3600) before making\n"
 "This is used to generate/validate json web tokens (jwt).\n"
 "Even if you don't use jwts it must not be empty.\n"
 "If less than 256 bits (32 characters) in length it will\n"
 "disable use of jwt. Changing this invalidates all jwts\n"
 "issued by the roundup instance requiring *all* users to\n"
-"generate new jwts. This is experimental and disabled by default.\n"
+"generate new jwts. This is experimental and disabled by\n"
-"It must be persistent across application restarts.\n"),
+"default. It must be persistent across application restarts.\n"),
 )),
 ("rdbms", (
 (DatabaseBackend, 'backend', NODEFAULT,
 "Database backend."),
 (Option, 'name', 'roundup',
 "Add the mail address of the author to the author information at\n"
 "the top of all messages.\n"
 "If this is false but add_authorinfo is true, only the name\n"
 "of the actor is added which protects the mail address of the\n"
 "actor from being exposed at mail archives, etc."),
-), "Outgoing email options.\nUsed for nosy messages and approval requests"),
+), "Outgoing email options.\n"
+"Used for nosy messages and approval requests"),
 ("mailgw", (
 (EmailBodyOption, "keep_quoted_text", "yes",
 "Keep email citations when accepting messages.\n"
 "Setting this to \"no\" strips out \"quoted\" text\n"
 "from the message. Setting this to \"new\" keeps quoted\n"
 ), "Nosy messages sending"),
 )
 ### Configuration classes
 class Config:
 """Base class for configuration objects.
 Configuration options may be accessed as attributes or items
 # make the option known under all of its A.K.A.s
 for _name in option.aliases:
 self.options[_name] = option
 def update_option(self, name, klass,
-default=NODEFAULT, description=None
+default=NODEFAULT, description=None):
-):
 """Override behaviour of early created option.
 Parameters:
 name:
 option name
 if description is None:
 description = option.description
 value = option.value2str(current=1)
 # resurrect the option
 option = klass(self, option.section, option.setting,
 default=default, description=description)
 # apply the value
 option.set(value)
 # incorporate new option
 del self[name]
 self.add_option(option)
 # Meant for commandline tools.
 # Allows automatic creation of configuration files like this:
 #  roundup-server -p 8017 -u roundup --save-config
 def getopt(self, args, short_options="", long_options=(),
-config_load_options=("C", "config"), **options
+config_load_options=("C", "config"), **options):
-):
 """Apply options specified in command line arguments.
 Parameters:
 args:
 command line to parse (sys.argv[1:])
 optlist.remove(option)
 break
 # apply options
 extra_options = []
 for (opt, arg) in optlist:
-if (opt in booleans): # and not arg
+if (opt in booleans):  # and not arg
 arg = "yes"
 try:
 name = cfg_names[opt]
 except KeyError:
 extra_options.append((opt, arg))
 for section, options in need_set.items():
 _fp.write("#  [%s]: %s\n" % (section, ", ".join(options)))
 for section in self.sections:
 comment = self.section_descriptions.get(section, None)
 if comment:
-_fp.write("\n# ".join([""] + comment.split("\n")) +"\n")
+_fp.write("\n# ".join([""] + comment.split("\n")) + "\n")
 else:
 # no section comment - just leave a blank line between sections
 _fp.write("\n")
 _fp.write("[%s]\n" % section)
 for option in self._get_section_options(section):
 because it is builtin pseudo-option, not a real Option
 object loaded from or saved to .ini file.
 """
 return [self.options[(_section, _name)]
 for _section in self.sections
-for _name in self._get_section_options(_section)
+for _name in self._get_section_options(_section)]
-]
 def keys(self):
 """Return the list of "canonical" names of the options
 Unlike .items(), this list also includes HOME
 # Note: __getattr__ is not symmetric to __setattr__:
 #   self.__dict__ lookup is done before calling this method
 def __getattr__(self, name):
 return self[name]
 class UserConfig(Config):
 """Configuration for user extensions.
 # see what options are already defined and add missing ones
 preset = [(option.section, option.setting) for option in self.items()]
 for section in config.sections():
 for name in config.options(section):
 if ((section, name) not in preset) \
 and (name not in defaults):
 self.add_option(Option(self, section, name))
 class CoreConfig(Config):
 """Roundup instance configuration.

Mercurial > p > roundup > code

comparison roundup/configuration.py @ 6004:55f5060e0508