Source code for ffcx.options

# Copyright (C) 2005-2020 Anders Logg, Michal Habera, Jack S. Hale
# This file is part of FFCx. (
# SPDX-License-Identifier:    LGPL-3.0-or-later

import functools
import json
import logging
import os
import os.path
import pprint
from pathlib import Path
from typing import Any, Dict, Optional

logger = logging.getLogger("ffcx")

        (1e-14, "Machine precision, used for dropping zero terms in tables"),
        ("double", """Scalar type used in generated code. Any of real or complex C floating-point types, e.g.
                      float, double, float _Complex, double _Complex, ..."""),
        (1e-6, "Relative precision to use when comparing finite element table values for table reuse."),
        (1e-9, "Absolute precision to use when comparing finite element table values for reuse."),
        (30, "Logger verbosity. Follows standard logging library levels, i.e. INFO=20, DEBUG=10, etc.")

def _load_options():
    """Load options from JSON files."""
    user_config_file = os.getenv("XDG_CONFIG_HOME", default=Path.home().joinpath(".config")) \
        / Path("ffcx", "ffcx_options.json")
        with open(user_config_file) as f:
            user_options = json.load(f)
    except FileNotFoundError:
        user_options = {}

    pwd_config_file = Path.cwd().joinpath("ffcx_options.json")
        with open(pwd_config_file) as f:
            pwd_options = json.load(f)
    except FileNotFoundError:
        pwd_options = {}

    return (user_options, pwd_options)

[docs]def get_options(priority_options: Optional[dict] = None) -> dict: """Return (a copy of) the merged option values for FFCX. Options ---------- priority_options: take priority over all other option values (see notes) Returns ------- dict: merged option values Notes ----- This function sets the log level from the merged option values prior to returning. The `ffcx_options.json` files are cached on the first call. Subsequent calls to this function use this cache. Priority ordering of options from highest to lowest is: - **priority_options** (API and command line options) - **$PWD/ffcx_options.json** (local options) - **$XDG_CONFIG_HOME/ffcx/ffcx_options.json** (user options) - **FFCX_DEFAULT_OPTIONS** in `ffcx.options` `XDG_CONFIG_HOME` is `~/.config/` if the environment variable is not set. Example `ffcx_options.json` file: { "epsilon": 1e-7 } """ options: Dict[str, Any] = {} for opt, (value, _) in FFCX_DEFAULT_OPTIONS.items(): options[opt] = value # NOTE: _load_options uses functools.lru_cache user_options, pwd_options = _load_options() options.update(user_options) options.update(pwd_options) if priority_options is not None: options.update(priority_options) logger.setLevel(options["verbosity"])"Final option values") return options