diff --git a/_sources/cli.rst.txt b/_sources/cli.rst.txt index fa469c1..4a67d6f 100644 --- a/_sources/cli.rst.txt +++ b/_sources/cli.rst.txt @@ -27,7 +27,7 @@ See :doc:`data-process` for detail. .. option:: --include=DIR, -I DIR Add search locations for item specified as relative paths. - See also :envvar:`YP_INCLUDE_PATHS`. + See also :envvar:`YP_INCLUDE_PATH`. .. option:: --define=KEY=VALUE, -D KEY=VALUE @@ -141,7 +141,7 @@ The following options apply to both :program:`yp-data`, Environment Variables --------------------- -.. envvar:: YP_INCLUDE_PATHS +.. envvar:: YP_INCLUDE_PATH Set the search path for include files (that are specified as relative locations). Expect a list of folders/directories in the same syntax as diff --git a/_static/documentation_options.js b/_static/documentation_options.js index dcd35d4..b189e14 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.5.3', + VERSION: '0.6.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/api.html b/api.html index 8f38c93..dde9dc7 100644 --- a/api.html +++ b/api.html @@ -4,7 +4,7 @@ - Python API — yamlprocessor 0.5.3 documentation + Python API — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + @@ -68,6 +68,7 @@
  • DataProcessor.load_file()
  • DataProcessor.load_file_schema()
  • DataProcessor.load_include_file()
    • +
  • DataProcessor.log_settings()
  • DataProcessor.process_data()
  • DataProcessor.process_variable()
  • DataProcessor.validate_data()
    • @@ -162,7 +163,7 @@

    Python API .include_paths: list

    Locations for searching include files. Default is the value of the -YP_INCLUDE_PATH environment variable split into a list.

    +YP_INCLUDE_PATH environment variable split into a list.

    @@ -273,6 +274,12 @@

    Python API +
    +log_settings()
    +

    Log (info) current settings of the processor.

    +

    +
    process_data(in_filenames: str | Iterable[str], out_filename: str) → None
    @@ -343,7 +350,7 @@

    Python API
    -yamlprocessor.dataprocess.configure_basic_logging()
    +yamlprocessor.dataprocess.configure_basic_logging(level=20)

    Configure basic logging, suitable for most CLI applications.

    Basic no-frill format. Stream handler prints message on STDERR.

    diff --git a/basic-usage.html b/basic-usage.html index 374450d..198d870 100644 --- a/basic-usage.html +++ b/basic-usage.html @@ -4,7 +4,7 @@ - Basic Usages — yamlprocessor 0.5.3 documentation + Basic Usages — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/cli.html b/cli.html index 31b2e4f..d3e5194 100644 --- a/cli.html +++ b/cli.html @@ -4,7 +4,7 @@ - Command Line Reference — yamlprocessor 0.5.3 documentation + Command Line Reference — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + @@ -111,7 +111,7 @@

    yp-data
    --include=DIR, -I DIR

    Add search locations for item specified as relative paths. -See also YP_INCLUDE_PATHS.

    +See also YP_INCLUDE_PATH.

    @@ -247,8 +247,8 @@

    Common Options

    Environment Variables

    -
    -YP_INCLUDE_PATHS
    +
    +YP_INCLUDE_PATH

    Set the search path for include files (that are specified as relative locations). Expect a list of folders/directories in the same syntax as a PATH like variable on the relevant platform. (E.g., a colon separated diff --git a/data-preprocessor.html b/data-preprocessor.html index 68b2d47..6833cae 100644 --- a/data-preprocessor.html +++ b/data-preprocessor.html @@ -4,7 +4,7 @@ - Data Pre-Processor — yamlprocessor 0.5.3 documentation + Data Pre-Processor — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/data-process.html b/data-process.html index 040a7a9..3321789 100644 --- a/data-process.html +++ b/data-process.html @@ -4,7 +4,7 @@ - Data Processor — yamlprocessor 0.5.3 documentation + Data Processor — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/genindex.html b/genindex.html index 7e0d336..235180a 100644 --- a/genindex.html +++ b/genindex.html @@ -3,7 +3,7 @@ - Index — yamlprocessor 0.5.3 documentation + Index — yamlprocessor 0.6.1 documentation @@ -13,7 +13,7 @@ - + @@ -293,9 +293,7 @@

    E

    -
  • YP_INCLUDE_PATH -
    • -
  • YP_INCLUDE_PATHS +
  • YP_INCLUDE_PATH, [1]
  • YP_SCHEMA_PREFIX, [1], [2], [3]
    • diff --git a/index.html b/index.html index 4841445..0387330 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - YAML Processor — yamlprocessor 0.5.3 documentation + YAML Processor — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/install.html b/install.html index ec49ed4..c91199a 100644 --- a/install.html +++ b/install.html @@ -4,7 +4,7 @@ - Installation — yamlprocessor 0.5.3 documentation + Installation — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/objects.inv b/objects.inv index 6d87a14..3e9fbb2 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index 3e8c624..3388cfc 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — yamlprocessor 0.5.3 documentation + Python Module Index — yamlprocessor 0.6.1 documentation @@ -13,7 +13,7 @@ - + diff --git a/schema-process.html b/schema-process.html index 2988839..ef62fb1 100644 --- a/schema-process.html +++ b/schema-process.html @@ -4,7 +4,7 @@ - Schema Processor — yamlprocessor 0.5.3 documentation + Schema Processor — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/search.html b/search.html index e85793a..ef3f999 100644 --- a/search.html +++ b/search.html @@ -3,7 +3,7 @@ - Search — yamlprocessor 0.5.3 documentation + Search — yamlprocessor 0.6.1 documentation @@ -14,7 +14,7 @@ - + diff --git a/searchindex.js b/searchindex.js index 67f557e..1c4f5f0 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Basic Usages": [[1, null]], "Cast Value Variable Substitution": [[4, "cast-value-variable-substitution"]], "Command Line Reference": [[2, null]], "Command line": [[1, "command-line"]], "Command line useage": [[3, "command-line-useage"]], "Common Options": [[2, "common-options"]], "Data Pre-Processor": [[3, null]], "Data Processor": [[4, null]], "Environment Variables": [[2, "environment-variables"]], "Examples": [[3, "examples"]], "Installation": [[6, null]], "Modularisation / Include": [[4, "modularisation-include"]], "Modularisation / Include with Merge": [[4, "modularisation-include-with-merge"]], "Modularisation / Include with Query": [[4, "modularisation-include-with-query"]], "Multiple Input Files Concatenation": [[4, "multiple-input-files-concatenation"]], "Python": [[1, "python"]], "Python API": [[0, null]], "Python useage": [[3, "python-useage"]], "Schema Processor": [[7, null]], "String Value Date-Time Substitution": [[4, "string-value-date-time-substitution"]], "String Value Variable Substitution": [[4, "string-value-variable-substitution"]], "Turn Off Processing": [[4, "turn-off-processing"]], "User Guide And Reference": [[5, "user-guide-and-reference"]], "Validation with JSON Schema": [[4, "validation-with-json-schema"]], "Variable Substitution Include Scope": [[4, "variable-substitution-include-scope"]], "YAML Processor": [[5, null]], "yamlprocessor.dataprocess": [[0, "module-yamlprocessor.dataprocess"]], "yamlprocessor.schemaprocess": [[0, "module-yamlprocessor.schemaprocess"]], "yp-data": [[2, "yp-data"]], "yp-preprocesor": [[2, "yp-preprocesor"]], "yp-schema": [[2, "yp-schema"]]}, "docnames": ["api", "basic-usage", "cli", "data-preprocessor", "data-process", "index", "install", "schema-process"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "basic-usage.rst", "cli.rst", "data-preprocessor.rst", "data-process.rst", "index.rst", "install.rst", "schema-process.rst"], "indexentries": {"--define": [[2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-preprocessor-define", false]], "--help": [[2, "cmdoption-yp-help", false]], "--include": [[2, "cmdoption-yp-data-include", false]], "--no-environment": [[2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-preprocessor-no-environment", false]], "--no-process-include": [[2, "cmdoption-yp-data-no-process-include", false]], "--no-process-variable": [[2, "cmdoption-yp-data-no-process-variable", false]], "--out-filename": [[2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "--schema-prefix": [[2, "cmdoption-yp-data-schema-prefix", false]], "--time-format": [[2, "cmdoption-yp-data-time-format", false]], "--time-ref": [[2, "cmdoption-yp-data-time-ref", false]], "--unbound-placeholder": [[2, "cmdoption-yp-data-unbound-placeholder", false]], "--undefine": [[2, "cmdoption-yp-data-undefine", false]], "--version": [[2, "cmdoption-yp-version", false]], "-d": [[2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-preprocessor-define", false]], "-h": [[2, "cmdoption-yp-help", false]], "-i": [[2, "cmdoption-yp-data-include", false], [2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-preprocessor-no-environment", false]], "-o": [[2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "-u": [[2, "cmdoption-yp-data-undefine", false]], "-v": [[2, "cmdoption-yp-version", false]], "config-file": [[2, "cmdoption-yp-schema-arg-CONFIG-FILE", false]], "configure_basic_logging() (in module yamlprocessor.dataprocess)": [[0, "yamlprocessor.dataprocess.configure_basic_logging", false]], "construct_yaml_timestamp() (in module yamlprocessor.dataprocess)": [[0, "yamlprocessor.dataprocess.construct_yaml_timestamp", false]], "dataprocessor (class in yamlprocessor.dataprocess)": [[0, "yamlprocessor.dataprocess.DataProcessor", false]], "environment variable": [[0, "index-0", false], [0, "index-1", false], [0, "index-2", false], [0, "index-3", false], [0, "index-4", false], [2, "envvar-YP_INCLUDE_PATHS", false], [2, "envvar-YP_SCHEMA_PREFIX", false], [2, "envvar-YP_TIME_FORMAT", false], [2, "envvar-YP_TIME_FORMAT_-NAME", false], [2, "envvar-YP_TIME_REF_VALUE", false], [2, "index-0", false], [2, "index-1", false], [2, "index-2", false], [2, "index-3", false], [2, "index-4", false], [4, "index-0", false], [4, "index-1", false], [4, "index-2", false]], "file-names": [[2, "cmdoption-yp-data-arg-file-names", false], [2, "cmdoption-yp-preprocessor-arg-file-names", false]], "get_filename() (yamlprocessor.dataprocess.dataprocessor method)": [[0, "yamlprocessor.dataprocess.DataProcessor.get_filename", false]], "get_represent_datetime() (in module yamlprocessor.dataprocess)": [[0, "yamlprocessor.dataprocess.get_represent_datetime", false]], "include_dict (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..include_dict", false]], "include_paths (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..include_paths", false]], "include_schema (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..INCLUDE_SCHEMA", false]], "is_process_include (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..is_process_include", false]], "is_process_variable (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..is_process_variable", false]], "load_file() (yamlprocessor.dataprocess.dataprocessor static method)": [[0, "yamlprocessor.dataprocess.DataProcessor.load_file", false]], "load_file_schema() (yamlprocessor.dataprocess.dataprocessor static method)": [[0, "yamlprocessor.dataprocess.DataProcessor.load_file_schema", false]], "load_include_file() (yamlprocessor.dataprocess.dataprocessor method)": [[0, "yamlprocessor.dataprocess.DataProcessor.load_include_file", false]], "module": [[0, "module-yamlprocessor.dataprocess", false], [0, "module-yamlprocessor.schemaprocess", false]], "name": [[0, "index-3", false], [2, "index-3", false]], "process_data() (yamlprocessor.dataprocess.dataprocessor method)": [[0, "yamlprocessor.dataprocess.DataProcessor.process_data", false]], "process_variable() (yamlprocessor.dataprocess.dataprocessor method)": [[0, "yamlprocessor.dataprocess.DataProcessor.process_variable", false]], "schema-file": [[2, "cmdoption-yp-schema-arg-SCHEMA-FILE", false]], "schema_prefix (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..schema_prefix", false]], "schema_process() (in module yamlprocessor.schemaprocess)": [[0, "yamlprocessor.schemaprocess.schema_process", false]], "strftime_with_colon_z() (in module yamlprocessor.dataprocess)": [[0, "yamlprocessor.dataprocess.strftime_with_colon_z", false]], "time_formats (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..time_formats", false]], "time_now (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..time_now", false]], "time_ref (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..time_ref", false]], "unbound_placeholder (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..unbound_placeholder", false]], "unboundvariableerror": [[0, "yamlprocessor.dataprocess.UnboundVariableError", false]], "validate_data() (yamlprocessor.dataprocess.dataprocessor method)": [[0, "yamlprocessor.dataprocess.DataProcessor.validate_data", false]], "variable_map (yamlprocessor.dataprocess.dataprocessor. attribute)": [[0, "yamlprocessor.dataprocess.DataProcessor..variable_map", false]], "yamlprocessor.dataprocess": [[0, "module-yamlprocessor.dataprocess", false]], "yamlprocessor.schemaprocess": [[0, "module-yamlprocessor.schemaprocess", false]], "yp-* command line option": [[2, "cmdoption-yp-help", false], [2, "cmdoption-yp-version", false]], "yp-data command line option": [[2, "cmdoption-yp-data-arg-file-names", false], [2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-data-include", false], [2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-data-no-process-include", false], [2, "cmdoption-yp-data-no-process-variable", false], [2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-data-schema-prefix", false], [2, "cmdoption-yp-data-time-format", false], [2, "cmdoption-yp-data-time-ref", false], [2, "cmdoption-yp-data-unbound-placeholder", false], [2, "cmdoption-yp-data-undefine", false]], "yp-preprocessor command line option": [[2, "cmdoption-yp-preprocessor-arg-file-names", false], [2, "cmdoption-yp-preprocessor-define", false], [2, "cmdoption-yp-preprocessor-no-environment", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "yp-schema command line option": [[2, "cmdoption-yp-schema-arg-CONFIG-FILE", false], [2, "cmdoption-yp-schema-arg-SCHEMA-FILE", false]], "yp_include_path": [[0, "index-0", false]], "yp_include_paths": [[2, "envvar-YP_INCLUDE_PATHS", false], [2, "index-0", false]], "yp_schema_prefix": [[0, "index-1", false], [0, "index-4", false], [2, "envvar-YP_SCHEMA_PREFIX", false], [2, "index-1", false], [4, "index-2", false]], "yp_time_format": [[0, "index-2", false], [2, "envvar-YP_TIME_FORMAT", false], [2, "index-2", false]], "yp_time_format[_]": [[4, "index-1", false]], "yp_time_format_": [[2, "envvar-YP_TIME_FORMAT_-NAME", false]], "yp_time_ref_value": [[2, "envvar-YP_TIME_REF_VALUE", false], [2, "index-4", false], [4, "index-0", false]]}, "objects": {"": [[2, 6, 1, "-", "YP_INCLUDE_PATHS"], [2, 6, 1, "-", "YP_SCHEMA_PREFIX"], [2, 6, 1, "-", "YP_TIME_FORMAT"], [2, 6, 1, "envvar-YP_TIME_FORMAT_-NAME", "YP_TIME_FORMAT_<NAME>"], [2, 6, 1, "-", "YP_TIME_REF_VALUE"]], "yamlprocessor": [[0, 0, 0, "-", "dataprocess"], [0, 0, 0, "-", "schemaprocess"]], "yamlprocessor.dataprocess": [[0, 1, 1, "", "DataProcessor"], [0, 4, 1, "", "UnboundVariableError"], [0, 5, 1, "", "configure_basic_logging"], [0, 5, 1, "", "construct_yaml_timestamp"], [0, 5, 1, "", "get_represent_datetime"], [0, 5, 1, "", "strftime_with_colon_z"]], "yamlprocessor.dataprocess.DataProcessor": [[0, 3, 1, "", "get_filename"], [0, 3, 1, "", "load_file"], [0, 3, 1, "", "load_file_schema"], [0, 3, 1, "", "load_include_file"], [0, 3, 1, "", "process_data"], [0, 3, 1, "", "process_variable"], [0, 3, 1, "", "validate_data"]], "yamlprocessor.dataprocess.DataProcessor.": [[0, 2, 1, "", "INCLUDE_SCHEMA"], [0, 2, 1, "", "include_dict"], [0, 2, 1, "", "include_paths"], [0, 2, 1, "", "is_process_include"], [0, 2, 1, "", "is_process_variable"], [0, 2, 1, "", "schema_prefix"], [0, 2, 1, "", "time_formats"], [0, 2, 1, "", "time_now"], [0, 2, 1, "", "time_ref"], [0, 2, 1, "", "unbound_placeholder"], [0, 2, 1, "", "variable_map"]], "yamlprocessor.schemaprocess": [[0, 5, 1, "", "schema_process"]], "yp-*": [[2, 7, 1, "cmdoption-yp-help", "--help"], [2, 7, 1, "cmdoption-yp-version", "--version"], [2, 7, 1, "cmdoption-yp-version", "-V"], [2, 7, 1, "cmdoption-yp-help", "-h"]], "yp-data": [[2, 7, 1, "cmdoption-yp-data-define", "--define"], [2, 7, 1, "cmdoption-yp-data-include", "--include"], [2, 7, 1, "cmdoption-yp-data-no-environment", "--no-environment"], [2, 7, 1, "cmdoption-yp-data-no-process-include", "--no-process-include"], [2, 7, 1, "cmdoption-yp-data-no-process-variable", "--no-process-variable"], [2, 7, 1, "cmdoption-yp-data-out-filename", "--out-filename"], [2, 7, 1, "cmdoption-yp-data-schema-prefix", "--schema-prefix"], [2, 7, 1, "cmdoption-yp-data-time-format", "--time-format"], [2, 7, 1, "cmdoption-yp-data-time-ref", "--time-ref"], [2, 7, 1, "cmdoption-yp-data-unbound-placeholder", "--unbound-placeholder"], [2, 7, 1, "cmdoption-yp-data-undefine", "--undefine"], [2, 7, 1, "cmdoption-yp-data-define", "-D"], [2, 7, 1, "cmdoption-yp-data-include", "-I"], [2, 7, 1, "cmdoption-yp-data-undefine", "-U"], [2, 7, 1, "cmdoption-yp-data-no-environment", "-i"], [2, 7, 1, "cmdoption-yp-data-out-filename", "-o"], [2, 7, 1, "cmdoption-yp-data-arg-file-names", "file-names"]], "yp-preprocessor": [[2, 7, 1, "cmdoption-yp-preprocessor-define", "--define"], [2, 7, 1, "cmdoption-yp-preprocessor-no-environment", "--no-environment"], [2, 7, 1, "cmdoption-yp-preprocessor-out-filename", "--out-filename"], [2, 7, 1, "cmdoption-yp-preprocessor-define", "-D"], [2, 7, 1, "cmdoption-yp-preprocessor-no-environment", "-i"], [2, 7, 1, "cmdoption-yp-preprocessor-out-filename", "-o"], [2, 7, 1, "cmdoption-yp-preprocessor-arg-file-names", "file-names"]], "yp-schema": [[2, 7, 1, "cmdoption-yp-schema-arg-CONFIG-FILE", "CONFIG-FILE"], [2, 7, 1, "cmdoption-yp-schema-arg-SCHEMA-FILE", "SCHEMA-FILE"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["std", "envvar", "environment variable"], "7": ["std", "cmdoption", "program option"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:exception", "5": "py:function", "6": "std:envvar", "7": "std:cmdoption"}, "terms": {"": 4, "0": 4, "00": 4, "00z": 4, "01t00": 4, "01t10": 4, "01t12": 4, "01t18": 4, "02": 4, "05": 4, "08": 4, "1": [0, 4, 7], "11": 4, "11z": 4, "12": 4, "12y": 4, "14": 4, "18z": 4, "1dt12h": 4, "1m2d": 4, "2": [0, 4], "2022": 4, "2024": 4, "20241225t231111z": 4, "24t11": 4, "25": 4, "25t11": 4, "25t17": 4, "3": 4, "30": 4, "4": 4, "41": 4, "45": 4, "8601": 2, "A": 4, "And": [4, 7], "But": 4, "For": [0, 4, 7], "If": [0, 3, 4], "In": [0, 4, 7], "It": [3, 4, 5, 7], "Its": 7, "On": [4, 7], "The": [0, 2, 3, 4, 5, 7], "Then": 4, "These": 2, "To": [6, 7], "_": [3, 4], "_at_t0h": 4, "_at_xxx": 4, "_minus_xxx": 4, "_plus_xxx": 4, "abbr": 4, "abov": [4, 7], "absolut": 0, "accept": 0, "accord": 0, "achiev": 4, "activ": 6, "ad": [4, 7], "add": [0, 2, 4], "add_replacements_map": 3, "addit": [0, 4], "against": [0, 4], "all": [0, 4], "allow": [0, 5], "alreadi": 4, "also": [0, 2, 4], "alwai": [0, 4], "an": [0, 2, 3, 4, 5, 7], "anchor": 4, "ani": [0, 4], "api": [1, 5], "appear": 4, "append": 4, "appli": [2, 4], "applic": 0, "ar": [0, 2, 4, 7], "argument": [0, 4], "arrai": 7, "associ": [0, 3, 4], "assum": 4, "assumpt": 4, "attempt": [0, 4], "attribut": 4, "autom": 5, "avail": 4, "avatar": 4, "b": 4, "bad": 4, "base": 5, "basic": [0, 5], "befor": [0, 4], "begin": 4, "behaviour": 4, "being": 0, "bool": [0, 4], "boolean": 4, "both": [2, 4, 7], "break": [0, 5], "build": 4, "built": 4, "call": [4, 7], "can": [0, 3, 4, 5, 6, 7], "cannot": 4, "car": 4, "case": [0, 4], "cast": 5, "castl": 4, "cat": [3, 4], "caus": 4, "cd": 6, "chang": [4, 7], "check": 6, "class": 0, "cli": 0, "clone": 6, "code": [0, 4, 6], "colon": 2, "com": 6, "combin": 0, "command": [4, 5, 7], "common": [4, 5], "compat": 0, "compliant": 2, "compliment": 5, "compos": 0, "concaten": [0, 3, 5], "conda": 6, "config": [2, 7], "config_filenam": 0, "configur": [0, 2, 4, 7], "configure_basic_log": 0, "consid": [3, 4, 7], "construct_yaml_timestamp": 0, "constructor": 0, "contain": [0, 3, 4], "content": [0, 3, 4], "copi": 4, "correct": [3, 4], "correctli": 6, "correspond": 0, "creat": 6, "ctime": 4, "current": [0, 4, 5, 7], "customis": [0, 1], "d": [2, 4], "dai": 4, "data": [0, 1, 5, 7], "datapreprocessor": 3, "dataprocess": [1, 4, 5], "dataprocessor": [0, 1, 4], "date": [0, 2, 5], "datetim": 0, "dec": 4, "default": [0, 2, 4, 7], "defin": [0, 2, 4, 5], "delta": 4, "denot": 4, "describ": 7, "detail": [1, 2, 3], "dict": [0, 4], "dictonari": 0, "differ": 4, "dinosaur": 4, "dir": [2, 4], "direct_includ": 3, "directori": [0, 2, 4, 5, 6, 7], "do": [0, 2, 4, 7], "document": [0, 4], "doe": 4, "dog": [3, 4], "dolphin": 4, "dt": 4, "dto": 0, "dulok": 4, "dump": 0, "durat": 4, "e": [2, 4], "each": [0, 4], "earth": [3, 4, 7], "earthl": 4, "either": 0, "endor": 4, "entri": 7, "env": 6, "environ": [0, 4, 5], "equal": 0, "error": [0, 4], "etc": 4, "even": 4, "ewok": 4, "exact": 4, "exampl": [4, 5, 6, 7], "except": 0, "exist": [0, 4], "exit": 2, "expand": 0, "expect": [0, 2, 3], "export": 4, "express": 0, "fail": 2, "fals": 4, "field": 4, "file": [0, 1, 2, 3, 5, 7], "filenam": [0, 2, 7], "final": [0, 4], "find": [0, 4], "fine": 4, "first": 4, "float": 4, "folder": [2, 4, 5], "follow": [2, 3, 4, 5], "form": 4, "format": [0, 2, 3, 4], "frill": 0, "from": [0, 1, 3, 4, 5, 6], "ft": [0, 4], "function": [4, 5, 7], "g": [2, 4], "gaseou": 4, "get": 4, "get_filenam": 0, "get_represent_datetim": 0, "getenv": 0, "git": 6, "github": 6, "give": 4, "gmt": 4, "good": 4, "greet": 4, "h": [2, 4], "ha": [4, 6], "handl": 0, "handler": 0, "have": [0, 4, 7], "hello": [3, 4, 7], "help": [1, 2, 3], "hh": 4, "holder": 4, "home": 4, "hour": 4, "how": 4, "howev": [4, 7], "http": [4, 6], "human": [3, 4], "i": [0, 2, 3, 4, 5, 7], "implement": 4, "import": [0, 1, 3, 4], "in_file_nam": [0, 1], "in_filenam": 0, "includ": [0, 2, 3, 5, 7], "include_dict": [0, 4], "include_path": [0, 4], "include_schema": 0, "index": 5, "indic": 0, "individu": 4, "info": 2, "initialis": [0, 4], "input": [0, 1, 2, 3, 5], "input_fil": 3, "insensit": 4, "insert": 4, "instal": 5, "instanc": [0, 1, 4], "instead": [2, 4], "instruct": [2, 4], "int": 4, "integ": 4, "intern": 6, "invok": 7, "involv": 4, "io": 0, "is_process_includ": [0, 4], "is_process_vari": [0, 4], "is_rocki": 4, "iso": 2, "item": [0, 2, 4, 7], "item_spe": 4, "item_vers": 4, "iter": 0, "its": 4, "jcsda": 6, "jmespath": [0, 4, 7], "json": [0, 2, 5, 7], "jupit": 4, "kei": [0, 2, 4], "keymap": 3, "keyword": 3, "languag": [0, 4], "lead": 4, "leav": [0, 2, 4], "let": 4, "like": [2, 4, 6, 7], "limit": 4, "line": [0, 4, 5, 7], "linux": 2, "list": [0, 1, 2, 3, 4, 5], "ll": [4, 7], "load": [0, 4], "load_fil": 0, "load_file_schema": 0, "load_include_fil": 0, "local": [0, 4], "locat": [0, 2, 3, 4, 7], "log": 0, "logic": 4, "look": [0, 3, 4, 7], "m": [4, 6], "mai": [0, 4, 7], "main": [4, 6], "manipul": 4, "map": [0, 2, 4], "mar": [4, 7], "martian": 4, "match": 4, "merg": 5, "messag": [0, 2], "method": 0, "miaow": 4, "minitem": 7, "minut": 4, "mm": 4, "modifi": 4, "modularis": [0, 2, 5], "monolith": 5, "month": 4, "more": [2, 4], "most": 0, "multipl": [0, 5], "must": [4, 7], "n": 6, "na": 4, "name": [0, 1, 2, 3, 4, 7], "natur": 4, "necessari": [0, 1, 4], "need": [4, 7], "nest": 4, "new": 4, "node": 0, "non": [0, 4], "none": 0, "normal": [0, 4], "note": [4, 7], "noth": 0, "notic": 7, "num2": 4, "num3": 4, "number": 4, "numer": 4, "nynmndtnhnmn": 4, "o": [0, 1, 2, 3, 4], "object": [0, 4, 7], "obvious": 7, "off": [0, 5], "one": 4, "oneof": 7, "onli": 4, "option": [0, 1, 3, 4, 5], "order": 4, "origin": [0, 2, 4], "other": [0, 4], "otherwis": 4, "out": [2, 3], "out_file_nam": [0, 1], "out_filenam": 0, "output": [0, 1, 2, 3, 4, 7], "output_fil": 3, "overrid": [2, 4], "own": 4, "pandora": 4, "paramet": 0, "parent": [0, 4], "parent_filenam": 0, "pars": [0, 3, 4], "parser": 0, "part": 4, "part1": 4, "part2": 4, "part3": 4, "pass": [3, 4], "path": [0, 2, 3, 4], "pip": 6, "place": [3, 4], "placehold": [2, 4], "planet": [3, 4], "platform": [2, 4], "point": [0, 3, 4], "popul": 4, "porsch": 4, "posit": 0, "possibl": 4, "pre": [2, 5], "preced": 4, "precis": 4, "prefix": [0, 2, 4], "preprocesor": 5, "preprocessor": [2, 3], "print": [0, 2], "process": [0, 2, 5], "process_data": [0, 1, 4], "process_vari": 0, "process_yaml": 3, "processor": [0, 1, 2], "project": 5, "properti": [4, 7], "provid": 5, "pypi": 6, "pytest": 6, "python": [4, 5], "python3": 6, "queri": 5, "rais": 0, "read": 4, "recognis": [0, 4], "ref": [2, 4, 7], "refer": [0, 1, 3, 4], "referenc": 7, "regardless": 4, "rel": [0, 2, 4], "relat": 7, "relev": [2, 4], "remov": 4, "repres": 0, "represent": 0, "requir": 7, "rest": 7, "result": [0, 3, 4, 7], "return": 0, "rocki": 4, "root": [0, 4, 7], "run": [3, 4, 6], "sai": 4, "sake": 4, "same": [2, 4], "saturn": 4, "save": 4, "scalar": 4, "schema": [0, 5], "schema_filenam": 0, "schema_loc": 0, "schema_prefix": [0, 4], "schema_process": 0, "schemaprocess": 5, "scheme": 4, "scope": [0, 5], "search": [0, 2, 4, 5], "see": [0, 1, 2, 3, 4], "select": [4, 5], "semi": 2, "separ": 2, "server": [0, 4], "set": [2, 4, 5, 7], "shell": 4, "short": 0, "show": [2, 4], "similar": 4, "similarli": 4, "simpl": 4, "simpli": [3, 4], "sinc": 4, "singl": [4, 5], "so": [4, 7], "some": [4, 7], "someth": 4, "sourc": 6, "space": 4, "special": 7, "specifi": [0, 2, 3, 4], "speed": 4, "split": [0, 7], "stack": 0, "standard": 3, "start": [0, 4], "static": 0, "stderr": 0, "stdin": 2, "stdout": 2, "str": 0, "stream": 0, "strftime": [0, 4], "strftime_with_colon_z": 0, "string": [0, 2, 5, 7], "structur": [0, 4, 5], "sub": [0, 5, 7], "subschema": [5, 7], "subset": 4, "substitut": [0, 2, 5], "substract": 4, "success": 0, "suffix": 4, "sugar": 4, "suitabl": 0, "suppli": 7, "support": [0, 4, 7], "suppos": 4, "sweet": 4, "sweet_hom": 4, "syntax": [0, 2, 4, 7], "system": 4, "t": [0, 4], "t12h30m": 4, "take": [3, 4], "target": [3, 4, 7], "tell": [4, 7], "test": 6, "text": [0, 4], "them": 4, "therefor": 4, "thi": [3, 4, 5, 6, 7], "those": 4, "time": [0, 2, 5], "time_format": [0, 4], "time_now": 0, "time_ref": [0, 4], "togeth": [0, 4], "trail": 4, "true": [4, 7], "tupl": 0, "turn": [0, 5], "two": [0, 5], "txt": 4, "type": [1, 3, 4, 7], "u": [2, 4], "unbound": [0, 2, 4], "unbound_origin": 0, "unbound_placehold": [0, 4], "unboundvariableerror": 0, "unchang": [0, 2, 4], "undefin": [2, 4], "uniqueitem": 7, "unix": 2, "unmap": 2, "up": [5, 7], "updat": 4, "uri": [0, 4], "us": [0, 2, 4, 5, 6, 7], "usag": [0, 2, 4, 5], "useag": 5, "utc": [0, 4], "util": [4, 5], "v": 2, "valid": [0, 2, 5, 7], "validate_data": 0, "valu": [0, 2, 5], "valueerror": 4, "variabl": [0, 5], "variable_map": [0, 4], "venu": 4, "versa": 4, "version": [2, 4], "vi": 4, "via": [4, 5], "vice": 4, "want": 4, "we": [4, 7], "wed": 4, "were": 4, "what": 4, "whatev": 4, "when": 4, "where": [0, 4, 7], "which": [2, 4, 7], "whole": 4, "window": 2, "within": 4, "won": 4, "woof": 4, "work": [0, 4, 7], "world": 4, "world_nam": 4, "wrap": 0, "written": 3, "xxx": 4, "xyz": 4, "y": 4, "yaml": [0, 3, 4, 7], "yamlprocessor": [1, 3, 4, 5, 6], "ye": 4, "year": 4, "yield": [3, 4], "you": [4, 7], "your": 4, "yp": [1, 3, 4, 5, 7], "yp_include_path": [0, 2, 4], "yp_origin": [2, 4], "yp_schema_prefix": [0, 2, 4], "yp_time_": 0, "yp_time_format": [0, 2, 4], "yp_time_format_": [0, 2], "yp_time_format_abbr": 4, "yp_time_format_ctim": 4, "yp_time_now": 4, "yp_time_now_at_t0h0m0": 4, "yp_time_now_at_t0h0m0s_plus_t12h": 4, "yp_time_ref": 4, "yp_time_ref_at_1dt18h": 4, "yp_time_ref_format_ctim": 4, "yp_time_ref_minus_1d": 4, "yp_time_ref_plus_t12h_format_abbr": 4, "yp_time_ref_plus_t6h30m": 4, "yp_time_ref_valu": [2, 4], "z": [0, 4], "zone": 4}, "titles": ["Python API", "Basic Usages", "Command Line Reference", "Data Pre-Processor", "Data Processor", "YAML Processor", "Installation", "Schema Processor"], "titleterms": {"And": 5, "api": 0, "basic": 1, "cast": 4, "command": [1, 2, 3], "common": 2, "concaten": 4, "data": [2, 3, 4], "dataprocess": 0, "date": 4, "environ": 2, "exampl": 3, "file": 4, "guid": 5, "includ": 4, "input": 4, "instal": 6, "json": 4, "line": [1, 2, 3], "merg": 4, "modularis": 4, "multipl": 4, "off": 4, "option": 2, "pre": 3, "preprocesor": 2, "process": 4, "processor": [3, 4, 5, 7], "python": [0, 1, 3], "queri": 4, "refer": [2, 5], "schema": [2, 4, 7], "schemaprocess": 0, "scope": 4, "string": 4, "substitut": 4, "time": 4, "turn": 4, "usag": 1, "useag": 3, "user": 5, "valid": 4, "valu": 4, "variabl": [2, 4], "yaml": 5, "yamlprocessor": 0, "yp": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Basic Usages": [[1, null]], "Cast Value Variable Substitution": [[4, "cast-value-variable-substitution"]], "Command Line Reference": [[2, null]], "Command line": [[1, "command-line"]], "Command line useage": [[3, "command-line-useage"]], "Common Options": [[2, "common-options"]], "Data Pre-Processor": [[3, null]], "Data Processor": [[4, null]], "Environment Variables": [[2, "environment-variables"]], "Examples": [[3, "examples"]], "Installation": [[6, null]], "Modularisation / Include": [[4, "modularisation-include"]], "Modularisation / Include with Merge": [[4, "modularisation-include-with-merge"]], "Modularisation / Include with Query": [[4, "modularisation-include-with-query"]], "Multiple Input Files Concatenation": [[4, "multiple-input-files-concatenation"]], "Python": [[1, "python"]], "Python API": [[0, null]], "Python useage": [[3, "python-useage"]], "Schema Processor": [[7, null]], "String Value Date-Time Substitution": [[4, "string-value-date-time-substitution"]], "String Value Variable Substitution": [[4, "string-value-variable-substitution"]], "Turn Off Processing": [[4, "turn-off-processing"]], "User Guide And Reference": [[5, "user-guide-and-reference"]], "Validation with JSON Schema": [[4, "validation-with-json-schema"]], "Variable Substitution Include Scope": [[4, "variable-substitution-include-scope"]], "YAML Processor": [[5, null]], "yamlprocessor.dataprocess": [[0, "module-yamlprocessor.dataprocess"]], "yamlprocessor.schemaprocess": [[0, "module-yamlprocessor.schemaprocess"]], "yp-data": [[2, "yp-data"]], "yp-preprocesor": [[2, "yp-preprocesor"]], "yp-schema": [[2, "yp-schema"]]}, "docnames": ["api", "basic-usage", "cli", "data-preprocessor", "data-process", "index", "install", "schema-process"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "basic-usage.rst", "cli.rst", "data-preprocessor.rst", "data-process.rst", "index.rst", "install.rst", "schema-process.rst"], "indexentries": {"--define": [[2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-preprocessor-define", false]], "--help": [[2, "cmdoption-yp-help", false]], "--include": [[2, "cmdoption-yp-data-include", false]], "--no-environment": [[2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-preprocessor-no-environment", false]], "--no-process-include": [[2, "cmdoption-yp-data-no-process-include", false]], "--no-process-variable": [[2, "cmdoption-yp-data-no-process-variable", false]], "--out-filename": [[2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "--schema-prefix": [[2, "cmdoption-yp-data-schema-prefix", false]], "--time-format": [[2, "cmdoption-yp-data-time-format", false]], "--time-ref": [[2, "cmdoption-yp-data-time-ref", false]], "--unbound-placeholder": [[2, "cmdoption-yp-data-unbound-placeholder", false]], "--undefine": [[2, "cmdoption-yp-data-undefine", false]], "--version": [[2, "cmdoption-yp-version", false]], "-d": [[2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-preprocessor-define", false]], "-h": [[2, "cmdoption-yp-help", false]], "-i": [[2, "cmdoption-yp-data-include", false], [2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-preprocessor-no-environment", false]], "-o": [[2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "-u": [[2, "cmdoption-yp-data-undefine", false]], "-v": [[2, "cmdoption-yp-version", false]], "config-file": [[2, "cmdoption-yp-schema-arg-CONFIG-FILE", false]], "environment variable": [[2, "envvar-YP_INCLUDE_PATH", false], [2, "envvar-YP_SCHEMA_PREFIX", false], [2, "envvar-YP_TIME_FORMAT", false], [2, "envvar-YP_TIME_FORMAT_-NAME", false], [2, "envvar-YP_TIME_REF_VALUE", false], [2, "index-0", false], [2, "index-1", false], [2, "index-2", false], [2, "index-3", false], [2, "index-4", false]], "file-names": [[2, "cmdoption-yp-data-arg-file-names", false], [2, "cmdoption-yp-preprocessor-arg-file-names", false]], "name": [[2, "index-3", false]], "schema-file": [[2, "cmdoption-yp-schema-arg-SCHEMA-FILE", false]], "yp-* command line option": [[2, "cmdoption-yp-help", false], [2, "cmdoption-yp-version", false]], "yp-data command line option": [[2, "cmdoption-yp-data-arg-file-names", false], [2, "cmdoption-yp-data-define", false], [2, "cmdoption-yp-data-include", false], [2, "cmdoption-yp-data-no-environment", false], [2, "cmdoption-yp-data-no-process-include", false], [2, "cmdoption-yp-data-no-process-variable", false], [2, "cmdoption-yp-data-out-filename", false], [2, "cmdoption-yp-data-schema-prefix", false], [2, "cmdoption-yp-data-time-format", false], [2, "cmdoption-yp-data-time-ref", false], [2, "cmdoption-yp-data-unbound-placeholder", false], [2, "cmdoption-yp-data-undefine", false]], "yp-preprocessor command line option": [[2, "cmdoption-yp-preprocessor-arg-file-names", false], [2, "cmdoption-yp-preprocessor-define", false], [2, "cmdoption-yp-preprocessor-no-environment", false], [2, "cmdoption-yp-preprocessor-out-filename", false]], "yp-schema command line option": [[2, "cmdoption-yp-schema-arg-CONFIG-FILE", false], [2, "cmdoption-yp-schema-arg-SCHEMA-FILE", false]], "yp_include_path": [[2, "envvar-YP_INCLUDE_PATH", false], [2, "index-0", false]], "yp_schema_prefix": [[2, "envvar-YP_SCHEMA_PREFIX", false], [2, "index-1", false]], "yp_time_format": [[2, "envvar-YP_TIME_FORMAT", false], [2, "index-2", false]], "yp_time_format_": [[2, "envvar-YP_TIME_FORMAT_-NAME", false]], "yp_time_ref_value": [[2, "envvar-YP_TIME_REF_VALUE", false], [2, "index-4", false]]}, "objects": {"": [[2, 6, 1, "-", "YP_INCLUDE_PATH"], [2, 6, 1, "-", "YP_SCHEMA_PREFIX"], [2, 6, 1, "-", "YP_TIME_FORMAT"], [2, 6, 1, "envvar-YP_TIME_FORMAT_-NAME", "YP_TIME_FORMAT_<NAME>"], [2, 6, 1, "-", "YP_TIME_REF_VALUE"]], "yamlprocessor": [[0, 0, 0, "-", "dataprocess"], [0, 0, 0, "-", "schemaprocess"]], "yamlprocessor.dataprocess": [[0, 1, 1, "", "DataProcessor"], [0, 4, 1, "", "UnboundVariableError"], [0, 5, 1, "", "configure_basic_logging"], [0, 5, 1, "", "construct_yaml_timestamp"], [0, 5, 1, "", "get_represent_datetime"], [0, 5, 1, "", "strftime_with_colon_z"]], "yamlprocessor.dataprocess.DataProcessor": [[0, 3, 1, "", "get_filename"], [0, 3, 1, "", "load_file"], [0, 3, 1, "", "load_file_schema"], [0, 3, 1, "", "load_include_file"], [0, 3, 1, "", "log_settings"], [0, 3, 1, "", "process_data"], [0, 3, 1, "", "process_variable"], [0, 3, 1, "", "validate_data"]], "yamlprocessor.dataprocess.DataProcessor.": [[0, 2, 1, "", "INCLUDE_SCHEMA"], [0, 2, 1, "", "include_dict"], [0, 2, 1, "", "include_paths"], [0, 2, 1, "", "is_process_include"], [0, 2, 1, "", "is_process_variable"], [0, 2, 1, "", "schema_prefix"], [0, 2, 1, "", "time_formats"], [0, 2, 1, "", "time_now"], [0, 2, 1, "", "time_ref"], [0, 2, 1, "", "unbound_placeholder"], [0, 2, 1, "", "variable_map"]], "yamlprocessor.schemaprocess": [[0, 5, 1, "", "schema_process"]], "yp-*": [[2, 7, 1, "cmdoption-yp-help", "--help"], [2, 7, 1, "cmdoption-yp-version", "--version"], [2, 7, 1, "cmdoption-yp-version", "-V"], [2, 7, 1, "cmdoption-yp-help", "-h"]], "yp-data": [[2, 7, 1, "cmdoption-yp-data-define", "--define"], [2, 7, 1, "cmdoption-yp-data-include", "--include"], [2, 7, 1, "cmdoption-yp-data-no-environment", "--no-environment"], [2, 7, 1, "cmdoption-yp-data-no-process-include", "--no-process-include"], [2, 7, 1, "cmdoption-yp-data-no-process-variable", "--no-process-variable"], [2, 7, 1, "cmdoption-yp-data-out-filename", "--out-filename"], [2, 7, 1, "cmdoption-yp-data-schema-prefix", "--schema-prefix"], [2, 7, 1, "cmdoption-yp-data-time-format", "--time-format"], [2, 7, 1, "cmdoption-yp-data-time-ref", "--time-ref"], [2, 7, 1, "cmdoption-yp-data-unbound-placeholder", "--unbound-placeholder"], [2, 7, 1, "cmdoption-yp-data-undefine", "--undefine"], [2, 7, 1, "cmdoption-yp-data-define", "-D"], [2, 7, 1, "cmdoption-yp-data-include", "-I"], [2, 7, 1, "cmdoption-yp-data-undefine", "-U"], [2, 7, 1, "cmdoption-yp-data-no-environment", "-i"], [2, 7, 1, "cmdoption-yp-data-out-filename", "-o"], [2, 7, 1, "cmdoption-yp-data-arg-file-names", "file-names"]], "yp-preprocessor": [[2, 7, 1, "cmdoption-yp-preprocessor-define", "--define"], [2, 7, 1, "cmdoption-yp-preprocessor-no-environment", "--no-environment"], [2, 7, 1, "cmdoption-yp-preprocessor-out-filename", "--out-filename"], [2, 7, 1, "cmdoption-yp-preprocessor-define", "-D"], [2, 7, 1, "cmdoption-yp-preprocessor-no-environment", "-i"], [2, 7, 1, "cmdoption-yp-preprocessor-out-filename", "-o"], [2, 7, 1, "cmdoption-yp-preprocessor-arg-file-names", "file-names"]], "yp-schema": [[2, 7, 1, "cmdoption-yp-schema-arg-CONFIG-FILE", "CONFIG-FILE"], [2, 7, 1, "cmdoption-yp-schema-arg-SCHEMA-FILE", "SCHEMA-FILE"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["std", "envvar", "environment variable"], "7": ["std", "cmdoption", "program option"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:exception", "5": "py:function", "6": "std:envvar", "7": "std:cmdoption"}, "terms": {"": 4, "0": 4, "00": 4, "00z": 4, "01t00": 4, "01t10": 4, "01t12": 4, "01t18": 4, "02": 4, "05": 4, "08": 4, "1": [0, 4, 7], "11": 4, "11z": 4, "12": 4, "12y": 4, "14": 4, "18z": 4, "1dt12h": 4, "1m2d": 4, "2": [0, 4], "20": 0, "2022": 4, "2024": 4, "20241225t231111z": 4, "24t11": 4, "25": 4, "25t11": 4, "25t17": 4, "3": 4, "30": 4, "4": 4, "41": 4, "45": 4, "8601": 2, "A": 4, "And": [4, 7], "But": 4, "For": [0, 4, 7], "If": [0, 3, 4], "In": [0, 4, 7], "It": [3, 4, 5, 7], "Its": 7, "On": [4, 7], "The": [0, 2, 3, 4, 5, 7], "Then": 4, "These": 2, "To": [6, 7], "_": [3, 4], "_at_t0h": 4, "_at_xxx": 4, "_minus_xxx": 4, "_plus_xxx": 4, "abbr": 4, "abov": [4, 7], "absolut": 0, "accept": 0, "accord": 0, "achiev": 4, "activ": 6, "ad": [4, 7], "add": [0, 2, 4], "add_replacements_map": 3, "addit": [0, 4], "against": [0, 4], "all": [0, 4], "allow": [0, 5], "alreadi": 4, "also": [0, 2, 4], "alwai": [0, 4], "an": [0, 2, 3, 4, 5, 7], "anchor": 4, "ani": [0, 4], "api": [1, 5], "appear": 4, "append": 4, "appli": [2, 4], "applic": 0, "ar": [0, 2, 4, 7], "argument": [0, 4], "arrai": 7, "associ": [0, 3, 4], "assum": 4, "assumpt": 4, "attempt": [0, 4], "attribut": 4, "autom": 5, "avail": 4, "avatar": 4, "b": 4, "bad": 4, "base": 5, "basic": [0, 5], "befor": [0, 4], "begin": 4, "behaviour": 4, "being": 0, "bool": [0, 4], "boolean": 4, "both": [2, 4, 7], "break": [0, 5], "build": 4, "built": 4, "call": [4, 7], "can": [0, 3, 4, 5, 6, 7], "cannot": 4, "car": 4, "case": [0, 4], "cast": 5, "castl": 4, "cat": [3, 4], "caus": 4, "cd": 6, "chang": [4, 7], "check": 6, "class": 0, "cli": 0, "clone": 6, "code": [0, 4, 6], "colon": 2, "com": 6, "combin": 0, "command": [4, 5, 7], "common": [4, 5], "compat": 0, "compliant": 2, "compliment": 5, "compos": 0, "concaten": [0, 3, 5], "conda": 6, "config": [2, 7], "config_filenam": 0, "configur": [0, 2, 4, 7], "configure_basic_log": 0, "consid": [3, 4, 7], "construct_yaml_timestamp": 0, "constructor": 0, "contain": [0, 3, 4], "content": [0, 3, 4], "copi": 4, "correct": [3, 4], "correctli": 6, "correspond": 0, "creat": 6, "ctime": 4, "current": [0, 4, 5, 7], "customis": [0, 1], "d": [2, 4], "dai": 4, "data": [0, 1, 5, 7], "datapreprocessor": 3, "dataprocess": [1, 4, 5], "dataprocessor": [0, 1, 4], "date": [0, 2, 5], "datetim": 0, "dec": 4, "default": [0, 2, 4, 7], "defin": [0, 2, 4, 5], "delta": 4, "denot": 4, "describ": 7, "detail": [1, 2, 3], "dict": [0, 4], "dictonari": 0, "differ": 4, "dinosaur": 4, "dir": [2, 4], "direct_includ": 3, "directori": [0, 2, 4, 5, 6, 7], "do": [0, 2, 4, 7], "document": [0, 4], "doe": 4, "dog": [3, 4], "dolphin": 4, "dt": 4, "dto": 0, "dulok": 4, "dump": 0, "durat": 4, "e": [2, 4], "each": [0, 4], "earth": [3, 4, 7], "earthl": 4, "either": 0, "endor": 4, "entri": 7, "env": 6, "environ": [0, 4, 5], "equal": 0, "error": [0, 4], "etc": 4, "even": 4, "ewok": 4, "exact": 4, "exampl": [4, 5, 6, 7], "except": 0, "exist": [0, 4], "exit": 2, "expand": 0, "expect": [0, 2, 3], "export": 4, "express": 0, "fail": 2, "fals": 4, "field": 4, "file": [0, 1, 2, 3, 5, 7], "filenam": [0, 2, 7], "final": [0, 4], "find": [0, 4], "fine": 4, "first": 4, "float": 4, "folder": [2, 4, 5], "follow": [2, 3, 4, 5], "form": 4, "format": [0, 2, 3, 4], "frill": 0, "from": [0, 1, 3, 4, 5, 6], "ft": [0, 4], "function": [4, 5, 7], "g": [2, 4], "gaseou": 4, "get": 4, "get_filenam": 0, "get_represent_datetim": 0, "getenv": 0, "git": 6, "github": 6, "give": 4, "gmt": 4, "good": 4, "greet": 4, "h": [2, 4], "ha": [4, 6], "handl": 0, "handler": 0, "have": [0, 4, 7], "hello": [3, 4, 7], "help": [1, 2, 3], "hh": 4, "holder": 4, "home": 4, "hour": 4, "how": 4, "howev": [4, 7], "http": [4, 6], "human": [3, 4], "i": [0, 2, 3, 4, 5, 7], "implement": 4, "import": [0, 1, 3, 4], "in_file_nam": [0, 1], "in_filenam": 0, "includ": [0, 2, 3, 5, 7], "include_dict": [0, 4], "include_path": [0, 4], "include_schema": 0, "index": 5, "indic": 0, "individu": 4, "info": [0, 2], "initialis": [0, 4], "input": [0, 1, 2, 3, 5], "input_fil": 3, "insensit": 4, "insert": 4, "instal": 5, "instanc": [0, 1, 4], "instead": [2, 4], "instruct": [2, 4], "int": 4, "integ": 4, "intern": 6, "invok": 7, "involv": 4, "io": 0, "is_process_includ": [0, 4], "is_process_vari": [0, 4], "is_rocki": 4, "iso": 2, "item": [0, 2, 4, 7], "item_spe": 4, "item_vers": 4, "iter": 0, "its": 4, "jcsda": 6, "jmespath": [0, 4, 7], "json": [0, 2, 5, 7], "jupit": 4, "kei": [0, 2, 4], "keymap": 3, "keyword": 3, "languag": [0, 4], "lead": 4, "leav": [0, 2, 4], "let": 4, "level": 0, "like": [2, 4, 6, 7], "limit": 4, "line": [0, 4, 5, 7], "linux": 2, "list": [0, 1, 2, 3, 4, 5], "ll": [4, 7], "load": [0, 4], "load_fil": 0, "load_file_schema": 0, "load_include_fil": 0, "local": [0, 4], "locat": [0, 2, 3, 4, 7], "log": 0, "log_set": 0, "logic": 4, "look": [0, 3, 4, 7], "m": [4, 6], "mai": [0, 4, 7], "main": [4, 6], "manipul": 4, "map": [0, 2, 4], "mar": [4, 7], "martian": 4, "match": 4, "merg": 5, "messag": [0, 2], "method": 0, "miaow": 4, "minitem": 7, "minut": 4, "mm": 4, "modifi": 4, "modularis": [0, 2, 5], "monolith": 5, "month": 4, "more": [2, 4], "most": 0, "multipl": [0, 5], "must": [4, 7], "n": 6, "na": 4, "name": [0, 1, 2, 3, 4, 7], "natur": 4, "necessari": [0, 1, 4], "need": [4, 7], "nest": 4, "new": 4, "node": 0, "non": [0, 4], "none": 0, "normal": [0, 4], "note": [4, 7], "noth": 0, "notic": 7, "num2": 4, "num3": 4, "number": 4, "numer": 4, "nynmndtnhnmn": 4, "o": [0, 1, 2, 3, 4], "object": [0, 4, 7], "obvious": 7, "off": [0, 5], "one": 4, "oneof": 7, "onli": 4, "option": [0, 1, 3, 4, 5], "order": 4, "origin": [0, 2, 4], "other": [0, 4], "otherwis": 4, "out": [2, 3], "out_file_nam": [0, 1], "out_filenam": 0, "output": [0, 1, 2, 3, 4, 7], "output_fil": 3, "overrid": [2, 4], "own": 4, "pandora": 4, "paramet": 0, "parent": [0, 4], "parent_filenam": 0, "pars": [0, 3, 4], "parser": 0, "part": 4, "part1": 4, "part2": 4, "part3": 4, "pass": [3, 4], "path": [0, 2, 3, 4], "pip": 6, "place": [3, 4], "placehold": [2, 4], "planet": [3, 4], "platform": [2, 4], "point": [0, 3, 4], "popul": 4, "porsch": 4, "posit": 0, "possibl": 4, "pre": [2, 5], "preced": 4, "precis": 4, "prefix": [0, 2, 4], "preprocesor": 5, "preprocessor": [2, 3], "print": [0, 2], "process": [0, 2, 5], "process_data": [0, 1, 4], "process_vari": 0, "process_yaml": 3, "processor": [0, 1, 2], "project": 5, "properti": [4, 7], "provid": 5, "pypi": 6, "pytest": 6, "python": [4, 5], "python3": 6, "queri": 5, "rais": 0, "read": 4, "recognis": [0, 4], "ref": [2, 4, 7], "refer": [0, 1, 3, 4], "referenc": 7, "regardless": 4, "rel": [0, 2, 4], "relat": 7, "relev": [2, 4], "remov": 4, "repres": 0, "represent": 0, "requir": 7, "rest": 7, "result": [0, 3, 4, 7], "return": 0, "rocki": 4, "root": [0, 4, 7], "run": [3, 4, 6], "sai": 4, "sake": 4, "same": [2, 4], "saturn": 4, "save": 4, "scalar": 4, "schema": [0, 5], "schema_filenam": 0, "schema_loc": 0, "schema_prefix": [0, 4], "schema_process": 0, "schemaprocess": 5, "scheme": 4, "scope": [0, 5], "search": [0, 2, 4, 5], "see": [0, 1, 2, 3, 4], "select": [4, 5], "semi": 2, "separ": 2, "server": [0, 4], "set": [0, 2, 4, 5, 7], "shell": 4, "short": 0, "show": [2, 4], "similar": 4, "similarli": 4, "simpl": 4, "simpli": [3, 4], "sinc": 4, "singl": [4, 5], "so": [4, 7], "some": [4, 7], "someth": 4, "sourc": 6, "space": 4, "special": 7, "specifi": [0, 2, 3, 4], "speed": 4, "split": [0, 7], "stack": 0, "standard": 3, "start": [0, 4], "static": 0, "stderr": 0, "stdin": 2, "stdout": 2, "str": 0, "stream": 0, "strftime": [0, 4], "strftime_with_colon_z": 0, "string": [0, 2, 5, 7], "structur": [0, 4, 5], "sub": [0, 5, 7], "subschema": [5, 7], "subset": 4, "substitut": [0, 2, 5], "substract": 4, "success": 0, "suffix": 4, "sugar": 4, "suitabl": 0, "suppli": 7, "support": [0, 4, 7], "suppos": 4, "sweet": 4, "sweet_hom": 4, "syntax": [0, 2, 4, 7], "system": 4, "t": [0, 4], "t12h30m": 4, "take": [3, 4], "target": [3, 4, 7], "tell": [4, 7], "test": 6, "text": [0, 4], "them": 4, "therefor": 4, "thi": [3, 4, 5, 6, 7], "those": 4, "time": [0, 2, 5], "time_format": [0, 4], "time_now": 0, "time_ref": [0, 4], "togeth": [0, 4], "trail": 4, "true": [4, 7], "tupl": 0, "turn": [0, 5], "two": [0, 5], "txt": 4, "type": [1, 3, 4, 7], "u": [2, 4], "unbound": [0, 2, 4], "unbound_origin": 0, "unbound_placehold": [0, 4], "unboundvariableerror": 0, "unchang": [0, 2, 4], "undefin": [2, 4], "uniqueitem": 7, "unix": 2, "unmap": 2, "up": [5, 7], "updat": 4, "uri": [0, 4], "us": [0, 2, 4, 5, 6, 7], "usag": [0, 2, 4, 5], "useag": 5, "utc": [0, 4], "util": [4, 5], "v": 2, "valid": [0, 2, 5, 7], "validate_data": 0, "valu": [0, 2, 5], "valueerror": 4, "variabl": [0, 5], "variable_map": [0, 4], "venu": 4, "versa": 4, "version": [2, 4], "vi": 4, "via": [4, 5], "vice": 4, "want": 4, "we": [4, 7], "wed": 4, "were": 4, "what": 4, "whatev": 4, "when": 4, "where": [0, 4, 7], "which": [2, 4, 7], "whole": 4, "window": 2, "within": 4, "won": 4, "woof": 4, "work": [0, 4, 7], "world": 4, "world_nam": 4, "wrap": 0, "written": 3, "xxx": 4, "xyz": 4, "y": 4, "yaml": [0, 3, 4, 7], "yamlprocessor": [1, 3, 4, 5, 6], "ye": 4, "year": 4, "yield": [3, 4], "you": [4, 7], "your": 4, "yp": [1, 3, 4, 5, 7], "yp_include_path": [0, 2, 4], "yp_origin": [2, 4], "yp_schema_prefix": [0, 2, 4], "yp_time_": 0, "yp_time_format": [0, 2, 4], "yp_time_format_": [0, 2], "yp_time_format_abbr": 4, "yp_time_format_ctim": 4, "yp_time_now": 4, "yp_time_now_at_t0h0m0": 4, "yp_time_now_at_t0h0m0s_plus_t12h": 4, "yp_time_ref": 4, "yp_time_ref_at_1dt18h": 4, "yp_time_ref_format_ctim": 4, "yp_time_ref_minus_1d": 4, "yp_time_ref_plus_t12h_format_abbr": 4, "yp_time_ref_plus_t6h30m": 4, "yp_time_ref_valu": [2, 4], "z": [0, 4], "zone": 4}, "titles": ["Python API", "Basic Usages", "Command Line Reference", "Data Pre-Processor", "Data Processor", "YAML Processor", "Installation", "Schema Processor"], "titleterms": {"And": 5, "api": 0, "basic": 1, "cast": 4, "command": [1, 2, 3], "common": 2, "concaten": 4, "data": [2, 3, 4], "dataprocess": 0, "date": 4, "environ": 2, "exampl": 3, "file": 4, "guid": 5, "includ": 4, "input": 4, "instal": 6, "json": 4, "line": [1, 2, 3], "merg": 4, "modularis": 4, "multipl": 4, "off": 4, "option": 2, "pre": 3, "preprocesor": 2, "process": 4, "processor": [3, 4, 5, 7], "python": [0, 1, 3], "queri": 4, "refer": [2, 5], "schema": [2, 4, 7], "schemaprocess": 0, "scope": 4, "string": 4, "substitut": 4, "time": 4, "turn": 4, "usag": 1, "useag": 3, "user": 5, "valid": 4, "valu": 4, "variabl": [2, 4], "yaml": 5, "yamlprocessor": 0, "yp": 2}}) \ No newline at end of file