Refactorize options (again)

Now it's possible to create an option which will ignore
None (NULL) values on assignation.

Also use some extra argparse features (like mutual exclusion)
so it's possible to load options from file first and then
check new ones set from the command line.

Author: boriel

src/api/config.py

@@ -19,7 +19,7 @@
 from . import options
 from . import global_
 
-from .options import ANYTYPE, Actions
+from .options import ANYTYPE, Action
 
 
 # ------------------------------------------------------
@@ -86,7 +86,7 @@ class OPTION:
 
 def load_config_from_file(filename: str, section: str, options_: options.Options = None, stop_on_error=True) -> bool:
     """ Opens file and read options from the given section. If stop_on_error is set,
-    the program stop. Otherwise the result of the operation will be
+    the program stop if any error is found. Otherwise the result of the operation will be
     returned (True on success, False on failure)
     """
     if options_ is None:
@@ -166,63 +166,55 @@ def save_config_into_file(filename: str, section: str, options_: options.Options
 
 
 def init():
+    """ Default Options and Compilation Flags
     """
-    Default Options and Compilation Flags
-
-    optimization -- Optimization level. Use -O flag to change.
-    case_insensitive -- Whether user identifiers are case insensitive
-                             or not
-    array_base -- Default array lower bound
-    param_byref --Default parameter passing. TRUE => By Reference
-    """
-
-    OPTIONS(Actions.CLEAR)
+    OPTIONS(Action.CLEAR)
 
-    OPTIONS(Actions.ADD, name=OPTION.OUTPUT_FILENAME, type=str)
-    OPTIONS(Actions.ADD, name=OPTION.INPUT_FILENAME, type=str)
-    OPTIONS(Actions.ADD, name=OPTION.STDERR_FILENAME, type=str)
-    OPTIONS(Actions.ADD, name=OPTION.DEBUG, type=int, default=0)
+    OPTIONS(Action.ADD, name=OPTION.OUTPUT_FILENAME, type=str)
+    OPTIONS(Action.ADD, name=OPTION.INPUT_FILENAME, type=str)
+    OPTIONS(Action.ADD, name=OPTION.STDERR_FILENAME, type=str, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.DEBUG, type=int, default=0, ignore_none=True)
 
     # Default console redirections
-    OPTIONS(Actions.ADD, name=OPTION.STDIN, type=ANYTYPE, default=sys.stdin)
-    OPTIONS(Actions.ADD, name=OPTION.STDOUT, type=ANYTYPE, default=sys.stdout)
-    OPTIONS(Actions.ADD, name=OPTION.STDERR, type=ANYTYPE, default=sys.stderr)
+    OPTIONS(Action.ADD, name=OPTION.STDIN, type=ANYTYPE, default=sys.stdin)
+    OPTIONS(Action.ADD, name=OPTION.STDOUT, type=ANYTYPE, default=sys.stdout)
+    OPTIONS(Action.ADD, name=OPTION.STDERR, type=ANYTYPE, default=sys.stderr)
 
-    OPTIONS(Actions.ADD, name=OPTION.O_LEVEL, type=int, default=global_.DEFAULT_OPTIMIZATION_LEVEL)
-    OPTIONS(Actions.ADD, name=OPTION.CASE_INS, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.ARRAY_BASE, type=int, default=0)
-    OPTIONS(Actions.ADD, name=OPTION.DEFAULT_BYREF, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.MAX_SYN_ERRORS, type=int, default=global_.DEFAULT_MAX_SYNTAX_ERRORS)
-    OPTIONS(Actions.ADD, name=OPTION.STR_BASE, type=int, default=0)
-    OPTIONS(Actions.ADD, name=OPTION.MEMORY_MAP, type=str, default=None)
-    OPTIONS(Actions.ADD, name=OPTION.FORCE_ASM_BRACKET, type=bool, default=False)
+    OPTIONS(Action.ADD, name=OPTION.O_LEVEL, type=int, default=global_.DEFAULT_OPTIMIZATION_LEVEL, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.CASE_INS, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.ARRAY_BASE, type=int, default=0, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.DEFAULT_BYREF, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.MAX_SYN_ERRORS, type=int, default=global_.DEFAULT_MAX_SYNTAX_ERRORS)
+    OPTIONS(Action.ADD, name=OPTION.STR_BASE, type=int, default=0, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.MEMORY_MAP, type=str, default=None, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.FORCE_ASM_BRACKET, type=bool, default=False, ignore_none=True)
 
-    OPTIONS(Actions.ADD, name=OPTION.USE_BASIC_LOADER, type=bool, default=False)  # Whether to use a loader
+    OPTIONS(Action.ADD, name=OPTION.USE_BASIC_LOADER, type=bool, default=False)  # Whether to use a loader
 
     # Whether to add autostart code (needs basic loader = true)
-    OPTIONS(Actions.ADD, name=OPTION.AUTORUN, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.OUTPUT_FILE_TYPE, type=str, default='bin')  # bin, tap, tzx etc...
-    OPTIONS(Actions.ADD, name=OPTION.INCLUDE_PATH, type=str, default='')  # Include path, like '/var/lib:/var/include'
-
-    OPTIONS(Actions.ADD, name=OPTION.CHECK_MEMORY, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.STRICT_BOOL, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.CHECK_ARRAYS, type=bool, default=False)
-
-    OPTIONS(Actions.ADD, name=OPTION.ENABLE_BREAK, type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.EMIT_BACKEND, type=bool, default=False)
-    OPTIONS(Actions.ADD, name='__DEFINES', type=dict, default={})
-    OPTIONS(Actions.ADD, name=OPTION.EXPLICIT, type=bool, default=False)
-    OPTIONS(Actions.ADD, name='sinclair', type=bool, default=False)
-    OPTIONS(Actions.ADD, name=OPTION.STRICT, type=bool, default=False)  # True to force type checking
-    OPTIONS(Actions.ADD, name=OPTION.ASM_ZXNEXT, type=bool, default=False)  # True to enable ZX Next ASM opcodes
-    OPTIONS(Actions.ADD, name=OPTION.ARCH, type=str, default=None)  # Architecture
-    OPTIONS(Actions.ADD, name=OPTION.EXPECTED_WARNINGS, type=int, default=0)  # Expected Warnings that will be silenced
+    OPTIONS(Action.ADD, name=OPTION.AUTORUN, type=bool, default=False)
+    OPTIONS(Action.ADD, name=OPTION.OUTPUT_FILE_TYPE, type=str, default='bin')  # bin, tap, tzx etc...
+    OPTIONS(Action.ADD, name=OPTION.INCLUDE_PATH, type=str, default='')  # Include path, like '/var/lib:/var/include'
+
+    OPTIONS(Action.ADD, name=OPTION.CHECK_MEMORY, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.STRICT_BOOL, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.CHECK_ARRAYS, type=bool, default=False, ignore_none=True)
+
+    OPTIONS(Action.ADD, name=OPTION.ENABLE_BREAK, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name=OPTION.EMIT_BACKEND, type=bool, default=False)
+    OPTIONS(Action.ADD, name='__DEFINES', type=dict, default={})
+    OPTIONS(Action.ADD, name=OPTION.EXPLICIT, type=bool, default=False, ignore_none=True)
+    OPTIONS(Action.ADD, name='sinclair', type=bool, default=False)
+    OPTIONS(Action.ADD, name=OPTION.STRICT, type=bool, default=False, ignore_none=True)  # True to force type checking
+    OPTIONS(Action.ADD, name=OPTION.ASM_ZXNEXT, type=bool, default=False, ignore_none=True)  # Enable ZX Next ASM
+    OPTIONS(Action.ADD, name=OPTION.ARCH, type=str, default=None, ignore_none=True)  # Architecture
+    OPTIONS(Action.ADD, name=OPTION.EXPECTED_WARNINGS, type=int, default=0, ignore_none=True)
 
     # Whether to show WXXX warning codes or not
-    OPTIONS(Actions.ADD, name=OPTION.HIDE_WARNING_CODES, type=bool, default=False)
+    OPTIONS(Action.ADD, name=OPTION.HIDE_WARNING_CODES, type=bool, default=False, ignore_none=True)
 
-    OPTIONS(Actions.ADD, name=OPTION.PROJECT_FILENAME, type=str, default=os.path.join(os.path.abspath(os.path.curdir),
-                                                                                      'project.ini'))
+    OPTIONS(Action.ADD, name=OPTION.PROJECT_FILENAME, type=str, default=os.path.join(os.path.abspath(os.path.curdir),
+                                                                                     'project.ini'))
 
 
 init()

src/api/options.py

@@ -17,7 +17,7 @@
 
 from .errors import Error
 
-__all__ = ['Option', 'Options', 'ANYTYPE', 'Actions']
+__all__ = ['Option', 'Options', 'ANYTYPE', 'Action']
 
 
 class ANYTYPE:
@@ -98,9 +98,11 @@ class Option:
     """ A simple container for options with optional type checking
     on vale assignation.
     """
-    def __init__(self, name: str, type_, value=None):
+    def __init__(self, name: str, type_, value=None, ignore_none=False):
         self.name = name
         self.type = type_
+        self.ignore_none = ignore_none
+        self.__value = None
         self.value = value
         self.stack: List[Any] = []  # An option stack
 
@@ -110,6 +112,9 @@ def value(self) -> Any:
 
     @value.setter
     def value(self, value):
+        if value is None and self.ignore_none:
+            return
+
         if value is not None and self.type is not None and not isinstance(value, self.type):
             try:
                 if isinstance(value, str) and self.type == bool:
@@ -156,7 +161,7 @@ def pop(self) -> Any:
 # ----------------------------------------------------------------------
 # Options commands
 # ----------------------------------------------------------------------
-class Actions:
+class Action:
     ADD = 'add'
     ADD_IF_NOT_DEFINED = 'add_if_not_defined'
     CLEAR = 'clear'
@@ -182,7 +187,7 @@ def __init__(self, init_value=None):
             else:
                 raise InvalidConfigInitialization(invalid_value=init_value)
 
-    def __add_option(self, name, type_=None, default=None):
+    def __add_option(self, name, type_=None, default=None, ignore_none=False):
         if name in self._options:
             raise DuplicatedOptionError(name)
 
@@ -191,12 +196,12 @@ def __add_option(self, name, type_=None, default=None):
         elif type_ is ANYTYPE:
             type_ = None
 
-        self._options[name] = Option(name, type_, default)
+        self._options[name] = Option(name, type_, default, ignore_none)
 
-    def __add_option_if_not_defined(self, name, type_=None, default=None):
+    def __add_option_if_not_defined(self, name, type_=None, default=None, ignore_none=False):
         if name in self._options:
             return
-        self.__add_option(name, type_, default)
+        self.__add_option(name, type_, default, ignore_none)
 
     def __delattr__(self, item: str):
         del self[item]
@@ -250,33 +255,39 @@ def check_allowed_args(action: str, kwargs_, allowed_args, required_args=None):
 
         # With no parameters
         if not kwargs:
-            if not args or args == (Actions.LIST, ):
+            if not args or args == (Action.LIST,):
                 return {x: y for x, y in self._options.items()}
 
-        assert args, f"Missing one action of {', '.join(Actions.allowed)}"
-        assert len(args) == 1 and args[0] in Actions.allowed, \
-            f"Only one action of {', '.join(Actions.allowed)} can be specified"
+        assert args, f"Missing one action of {', '.join(Action.allowed)}"
+        assert len(args) == 1 and args[0] in Action.allowed, \
+            f"Only one action of {', '.join(Action.allowed)} can be specified"
 
         # clear
-        if args[0] == Actions.CLEAR:
-            check_allowed_args(Actions.CLEAR, kwargs, {})
+        if args[0] == Action.CLEAR:
+            check_allowed_args(Action.CLEAR, kwargs, {})
             self._options.clear()
             return
 
         # list
-        if args[0] == Actions.LIST:
-            check_allowed_args(Actions.LIST, kwargs, {'options'})
+        if args[0] == Action.LIST:
+            check_allowed_args(Action.LIST, kwargs, {'options'})
             options = set(kwargs['options'])
             return {x: y for x, y in self._options.items() if x in options}
 
-        if args[0] == Actions.ADD:
+        if args[0] == Action.ADD:
             kwargs['type'] = kwargs.get('type')
             kwargs['default'] = kwargs.get('default')
-            check_allowed_args(Actions.ADD, kwargs, {'name', 'type', 'default'}, ['name'])
-            self.__add_option(kwargs['name'], kwargs['type'], kwargs['default'])
+            kwargs['ignore_none'] = kwargs.get('ignore_none', False)
+            check_allowed_args(Action.ADD, kwargs, {'name', 'type', 'default', 'ignore_none'}, ['name'])
+            kwargs['type_'] = kwargs['type']
+            del kwargs['type']
+            self.__add_option(**kwargs)
 
-        if args[0] == Actions.ADD_IF_NOT_DEFINED:
+        if args[0] == Action.ADD_IF_NOT_DEFINED:
             kwargs['type'] = kwargs.get('type')
             kwargs['default'] = kwargs.get('default')
-            check_allowed_args(Actions.ADD, kwargs, {'name', 'type', 'default'}, ['name'])
-            self.__add_option_if_not_defined(kwargs['name'], kwargs['type'], kwargs['default'])
+            kwargs['ignore_none'] = kwargs.get('ignore_none', False)
+            check_allowed_args(Action.ADD, kwargs, {'name', 'type', 'default', 'ignore_none'}, ['name'])
+            kwargs['type_'] = kwargs['type']
+            del kwargs['type']
+            self.__add_option_if_not_defined(**kwargs)

src/arch/zx48k/backend/__init__.py

@@ -95,7 +95,7 @@
 # External functions
 from ..optimizer.helpers import HI16, LO16
 from src.arch.zx48k.optimizer.asm import Asm
-from src.api.config import OPTIONS, Actions
+from src.api.config import OPTIONS, Action
 from src.arch.zx48k.peephole import engine
 
 import src.api.fp
@@ -134,10 +134,10 @@
 FLAG_end_emitted = False
 
 # Default code ORG
-OPTIONS(Actions.ADD_IF_NOT_DEFINED, name='org', type=int, default=32768)
+OPTIONS(Action.ADD_IF_NOT_DEFINED, name='org', type=int, default=32768)
 
 # Default HEAP SIZE (Dynamic memory) in bytes
-OPTIONS(Actions.ADD_IF_NOT_DEFINED, name='heap_size', type=int, default=4768)  # A bit more than 4K
+OPTIONS(Action.ADD_IF_NOT_DEFINED, name='heap_size', type=int, default=4768)  # A bit more than 4K
 
 # List of modules (in alphabetical order) that, if included, should call MEM_INIT
 MEMINITS = {
@@ -196,15 +196,15 @@ def init():
     FLAG_end_emitted = False
 
     # Default code ORG
-    OPTIONS(Actions.ADD, name='org', type=int, default=32768)
+    OPTIONS(Action.ADD, name='org', type=int, default=32768)
     # Default HEAP SIZE (Dynamic memory) in bytes
-    OPTIONS(Actions.ADD, name='heap_size', type=int, default=4768)  # A bit more than 4K
+    OPTIONS(Action.ADD, name='heap_size', type=int, default=4768, ignore_none=True)  # A bit more than 4K
     # Labels for HEAP START (might not be used if not needed)
-    OPTIONS(Actions.ADD, name='heap_start_label', type=str, default=f'{NAMESPACE}.ZXBASIC_MEM_HEAP')
+    OPTIONS(Action.ADD, name='heap_start_label', type=str, default=f'{NAMESPACE}.ZXBASIC_MEM_HEAP')
     # Labels for HEAP SIZE (might not be used if not needed)
-    OPTIONS(Actions.ADD, name='heap_size_label', type=str, default=f'{NAMESPACE}.ZXBASIC_HEAP_SIZE')
+    OPTIONS(Action.ADD, name='heap_size_label', type=str, default=f'{NAMESPACE}.ZXBASIC_HEAP_SIZE')
     # Flag for headerless mode (No prologue / epilogue)
-    OPTIONS(Actions.ADD, name='headerless', type=bool, default=False)
+    OPTIONS(Action.ADD, name='headerless', type=bool, default=False, ignore_none=True)
 
     engine.main()  # inits the optimizer
 

src/zxbc/args_config.py

@@ -52,7 +52,7 @@ def parse_options(args: List[str] = None):
     OPTIONS.sinclair = options.sinclair
     OPTIONS.heap_size = options.heap_size
     OPTIONS.memory_check = options.debug_memory
-    OPTIONS.strict_bool = options.strict_bool or OPTIONS.sinclair
+    OPTIONS.strict_bool = options.strict_bool
     OPTIONS.array_check = options.debug_array
     OPTIONS.emit_backend = options.emit_backend
     OPTIONS.enable_break = options.enable_break
@@ -88,9 +88,9 @@ def parse_options(args: List[str] = None):
 
     # endregion
 
-    OPTIONS.org = src.api.utils.parse_int(options.org)
+    OPTIONS.org = OPTIONS.org if options.org is None else src.api.utils.parse_int(options.org)
     if OPTIONS.org is None:
-        parser.error("Invalid --org option '{}'".format(options.org))
+        parser.error(f"Invalid --org option '{options.org}'")
 
     if options.defines:
         for i in options.defines:
@@ -106,16 +106,9 @@ def parse_options(args: List[str] = None):
         OPTIONS.strictBool = True
         OPTIONS.case_insensitive = True
 
-    if options.ignore_case:
-        OPTIONS.case_insensitive = True
-
+    OPTIONS.case_insensitive = options.ignore_case
     debug.ENABLED = OPTIONS.debug_level > 0
 
-    if int(options.tzx) + int(options.tap) + int(options.asm) + int(options.emit_backend) + \
-            int(options.parse_only) > 1:
-        parser.error("Options --tap, --tzx, --emit-backend, --parse-only and --asm are mutually exclusive")
-        return 3
-
     if options.basic and not options.tzx and not options.tap:
         parser.error('Option --BASIC and --autorun requires --tzx or tap format')
         return 4