allconf 4.0.0__tar.gz

allconf-4.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Thordur Matthiasson
+Copyright (c) 2019-2024 CCP Games
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

allconf-4.0.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.1
+Name: allconf
+Version: 4.0.0
+Summary: Configuration file reader with some nifty bells and whistles added
+Author-email: Thordur Matthiasson <doddi79@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Thordur Matthiasson
+        Copyright (c) 2019-2024 CCP Games
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/doddi79/allconf
+Project-URL: Documentation, https://github.com/doddi79/allconf/blob/main/README.md
+Project-URL: Repository, https://github.com/doddi79/allconf.git
+Project-URL: Issues, https://github.com/doddi79/allconf/issues
+Project-URL: Changelog, https://github.com/doddi79/allconf/blob/main/CHANGELOG.md
+Keywords: config,configuration,json,yaml,tools,utils
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML<7,>=6.0.1
+Requires-Dist: batutils<3,>=2
+Provides-Extra: fidelius
+Requires-Dist: fidelius<2,>=1.0; extra == "fidelius"
+
+# AllConf the All-Knowing Config Reader
+
+Generic Configuration file reader/parser with a bunch of nifty extra 
+features, most notably:
+
+- File Inclusion & Extension
+- Internal variable reference parsing
+- Nested fault-tolerant fetching of non-existing values
+- Environment variable embedding
+- On-demand external secret credential embedding _(untested in this new fork thus far)_
+- Python script result embedding
+- Single-file rendering of parsed config file (via CLI)
+- Python dataclass stub generation (via CLI)
+- JSON, YAML & custom support
+- ...and more
+
+
+## Note
+
+This was forked from the [`alviss`](https://github.com/ccpgames/allconf) package
+in order to continue development and support. 
+
+## The TL;DR...
+
+Given this `my_cfg.yaml` config file example:
+
+```yaml
+app:
+  name: MyApp
+  environment: dev
+  log_level: INFO
+```
+
+This is how you load and use it with `allconf`:
+
+```python
+from allconf import quickloader
+
+cfg = quickloader.autoload('my_cfg.yaml')
+
+assert cfg.app.name == 'MyApp'
+assert cfg.app.environment == 'dev'
+assert cfg.app.log_level == 'INFO'
+```
+
+And that's basically it really!
+
+Read on for description of more features in order of "quality of life" impact 
+for you as a programmer _(as gauged by myself)_ and it goes more or less like this:
+
+1. File Inclusion & Extension
+2. Internal variable reference parsing
+3. Nested fault-tolerant fetching of non-existing values
+4. Environment variable embedding
+5. On-demand external secret credential embedding _(untested in this new fork thus far)_
+6. Python script result embedding
+7. Single-file rendering of parsed config file (via CLI)
+8. Python dataclass stub generation (via CLI)
+9. JSON, YAML & custom support
+
+...I'll document this later!
+
+Check out the (`_OLD_README.md`)[_OLD_README.md] file for the old documentation (which may or may not be up to date)!

allconf-4.0.0/README.md

@@ -0,0 +1,63 @@
+# AllConf the All-Knowing Config Reader
+
+Generic Configuration file reader/parser with a bunch of nifty extra 
+features, most notably:
+
+- File Inclusion & Extension
+- Internal variable reference parsing
+- Nested fault-tolerant fetching of non-existing values
+- Environment variable embedding
+- On-demand external secret credential embedding _(untested in this new fork thus far)_
+- Python script result embedding
+- Single-file rendering of parsed config file (via CLI)
+- Python dataclass stub generation (via CLI)
+- JSON, YAML & custom support
+- ...and more
+
+
+## Note
+
+This was forked from the [`alviss`](https://github.com/ccpgames/allconf) package
+in order to continue development and support. 
+
+## The TL;DR...
+
+Given this `my_cfg.yaml` config file example:
+
+```yaml
+app:
+  name: MyApp
+  environment: dev
+  log_level: INFO
+```
+
+This is how you load and use it with `allconf`:
+
+```python
+from allconf import quickloader
+
+cfg = quickloader.autoload('my_cfg.yaml')
+
+assert cfg.app.name == 'MyApp'
+assert cfg.app.environment == 'dev'
+assert cfg.app.log_level == 'INFO'
+```
+
+And that's basically it really!
+
+Read on for description of more features in order of "quality of life" impact 
+for you as a programmer _(as gauged by myself)_ and it goes more or less like this:
+
+1. File Inclusion & Extension
+2. Internal variable reference parsing
+3. Nested fault-tolerant fetching of non-existing values
+4. Environment variable embedding
+5. On-demand external secret credential embedding _(untested in this new fork thus far)_
+6. Python script result embedding
+7. Single-file rendering of parsed config file (via CLI)
+8. Python dataclass stub generation (via CLI)
+9. JSON, YAML & custom support
+
+...I'll document this later!
+
+Check out the (`_OLD_README.md`)[_OLD_README.md] file for the old documentation (which may or may not be up to date)!

allconf-4.0.0/allconf/__init__.py

@@ -0,0 +1,5 @@
+__version__ = '4.0.0'
+
+__author__ = 'Thordur Matthiasson <doddi79@gmail.com>'
+__license__ = 'MIT License'
+__copyright__ = 'Copyright 2024 -Thordur Matthiasson, Copyright 2019-2024 - CCP Games ehf'

allconf-4.0.0/allconf/cli/render/main.py

@@ -0,0 +1,66 @@
+import argparse
+
+from allconf import __version__ as version
+from allconf.renderers import SimpleStaticRenderer
+from allconf.structs.errors import *
+
+import sys
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Renders a single static config from an AllConf formatted file and '
+                                                 'its extends, includes and other expressions.',
+                                     epilog=f'AllConf version {version}')
+
+    parser.add_argument('file', help='The AllConf formatted config file to read, parse and render')
+    parser.add_argument('-o', '--output', help='File to write the results to (otherwise its just printed to stdout)',
+                        default='', nargs='?')
+    parser.add_argument('-f', '--force-overwrite', help='Overwrite existing output file if it exists',
+                        action='store_true')
+
+    loudness_group = parser.add_mutually_exclusive_group()
+    loudness_group.add_argument('-s', '--silent', action='store_true',
+                                help='Only outputs the resulting rendered config (and errors print to stderr)')
+    loudness_group.add_argument('-v', '--verbose', action="store_true",
+                                help='Spits out DEBUG level logs')
+
+    args = parser.parse_args()
+
+    if args.verbose:
+        import logging
+        logging.basicConfig(level=logging.DEBUG)
+
+    if not args.silent:
+        print(f'Reading and parsing file: {args.file}...')
+
+    try:
+        if args.output:
+            if not args.silent:
+                print(f'Writing output to: {args.output}...')
+
+            SimpleStaticRenderer().render_static_config_to_file(input_file=args.file,
+                                                                output_file=args.output,
+                                                                overwrite_existing=args.force_overwrite)
+
+        else:
+            if not args.silent:
+                print(f'Printing results:')
+                print(f'==================================================')
+            print(SimpleStaticRenderer().render_static_config_from_file(args.file))
+
+            if not args.silent:
+                print(f'==================================================')
+
+        if not args.silent:
+            print(f'Done!')
+
+    except AllConfError as e:
+        if not args.silent:
+            print(f'An error occurred: {e!r}')
+        else:
+            print(f'An error occurred: {e!r}', file=sys.stderr)
+        sys.exit(3)
+
+
+if __name__ == '__main__':
+    main()

allconf-4.0.0/allconf/cli/stubber/main.py

@@ -0,0 +1,74 @@
+import argparse
+
+from allconf import __version__ as version
+from allconf import stubber
+from allconf.structs.errors import *
+import sys
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Generates Python dataclass stubs based on the given allconf type descriptor file.',
+                                     epilog=f'AllConf version {version}')
+
+    parser.add_argument('file', help='The AllConf config type descriptor file to generate strubs from.')
+    parser.add_argument('-o', '--output', help='File to write the generated stub code to (otherwise its just printed to stdout)',
+                        default='', nargs='?')
+    parser.add_argument('-f', '--force-overwrite', help='Overwrite existing output file if it exists', action='store_true')
+    parser.add_argument('-n', '--class-name',
+                        help='The name of the resulting "final" stub class generated when outputting to a file (default is "AllConfConfigStub"). Set to "None" to skip generating the "final" class.',
+                        default='AllConfConfigStub')
+    parser.add_argument('-x', '--export-all', help='Make all stub class names public and export via __all__ when outputting to a file.',
+                        action='store_true')
+
+    loudness_group = parser.add_mutually_exclusive_group()
+    loudness_group.add_argument('-s', '--silent', action='store_true',
+                                help='Only outputs the resulting rendered code (and errors print to stderr)')
+    loudness_group.add_argument('-v', '--verbose', action="store_true",
+                                help='Spits out DEBUG level logs')
+
+    args = parser.parse_args()
+
+    if args.verbose:
+        import logging
+        logging.basicConfig(level=logging.DEBUG)
+
+    if not args.silent:
+        print(f'Reading and stubbing file: {args.file}...')
+
+    cls_name = 'AllConfConfigStub' if args.class_name is None else args.class_name
+    if cls_name.lower().strip() == 'none':
+        cls_name = ''
+
+    try:
+        if args.output:
+            if not args.silent:
+                print(f'Writing output to: {args.output}...')
+
+            stubber.SimpleStubMaker().render_stub_classes_to_file(input_file=args.file,
+                                                                  output_file=args.output,
+                                                                  overwrite_existing=args.force_overwrite,
+                                                                  is_private=not args.export_all,
+                                                                  class_name=cls_name)
+        else:
+            if not args.silent:
+                print(f'Printing results:')
+                print(f'==================================================')
+
+            print(stubber.SimpleStubMaker().render_stub_classes_from_descriptor_file(args.file, class_name=cls_name, is_private=not args.export_all))
+
+            if not args.silent:
+                print(f'==================================================')
+
+        if not args.silent:
+            print(f'Done!')
+
+    except AllConfError as e:
+        if not args.silent:
+            print(f'An error occurred: {e!r}')
+        else:
+            print(f'An error occurred: {e!r}', file=sys.stderr)
+        sys.exit(3)
+
+
+if __name__ == '__main__':
+    main()

allconf-4.0.0/allconf/loaders/__init__.py

@@ -0,0 +1,4 @@
+from .interface import *
+from .jsonfile import *
+from .yamlfile import *
+from .autoloader import *

allconf-4.0.0/allconf/loaders/autoloader.py

@@ -0,0 +1,93 @@
+__all__ = [
+    'autoload',
+    'guess_loader_class',
+    'raw_load',
+    'render_load',
+]
+
+import os
+
+from allconf.structs import *
+from .interface import *
+from .jsonfile import *
+from .yamlfile import *
+
+_EXTENSION_LOADER_MAP = {
+    '.json': JsonFileConfigLoader,
+    '.yaml': YamlFileConfigLoader,
+    '.yml': YamlFileConfigLoader,
+}
+
+
+def guess_loader_class(file_name: str) -> Type[IAllConfLoader]:
+    """Returns the most probable loader class based of the given file's extension.
+    """
+    ext = os.path.splitext(file_name)[-1]
+    loader = _EXTENSION_LOADER_MAP.get(ext, None)
+    if not loader:
+        raise AllConfUnknownFileTypeError(f'Dont know how to autoload file extension {ext}', file_name=file_name)
+    return loader
+
+
+def raw_load(file_name: str, skip_env_loading: bool = False, skip_fidelius: bool = False, skip_py_inject: bool = False, encoding: str = 'utf-8') -> Dict:
+    """Loads and parses the given config file and returns the "raw" results as a
+    simple python dictionary.
+
+    This is mostly intended for the testing and debugging of the configuration
+    files themselves if needed.
+
+    :param file_name: The file to load
+    :param skip_env_loading: Set to True to skip resolving environment variable tags
+    :param skip_fidelius: Set to True to skip resolving Fidelius tags
+    :param skip_py_inject: Set to True to skip injecting Python imported values
+    :param encoding: Encoding to use when reading the file (utf-8 by default)
+    :return: A dict with the results
+    """
+    loader = guess_loader_class(file_name)()
+    loader.load_file(file_name, no_env_load=skip_env_loading, no_fidelius=skip_fidelius,
+                     no_py_inject=skip_py_inject, encoding=encoding)
+    return loader.data
+
+
+def render_load(file_name: str, skip_env_loading: bool = True, skip_fidelius: bool = True, skip_py_inject: bool = True, encoding: str = 'utf-8') -> str:
+    """Loads and parses the given config file and returns the "render" results
+    as a str in the same format the original file used.
+
+    The main point of this method is to be able to load and parse an AllConf
+    configuration file, including all includes, extensions, internal references,
+    environment variables, Fidelius values etc. and render as a single
+    value/file of the same format.
+
+    As a use-case example, it was originally built in order to generate
+    Kubernetes YAML manifest files using AllConf' format to simplify the process
+    (i.e. includes, internal references, secret injection via Fidelius during
+    deployment and so on).
+
+    :param file_name: The file to load
+    :param skip_env_loading: Set to True to skip resolving environment variable
+                             tags
+    :param skip_fidelius: Set to True to skip resolving Fidelius tags
+    :param skip_py_inject: Set to True to skip injecting Python imported values
+    :param encoding: Encoding to use when reading the file (utf-8 by default)
+    :return: A string representation of the configuration data loaded, in the
+             same format as the target file if possible
+    """
+    loader = guess_loader_class(file_name)()
+    loader.load_file(file_name, no_env_load=skip_env_loading, no_fidelius=skip_fidelius, no_py_inject=skip_py_inject, encoding=encoding)
+    return loader.rendered
+
+
+def autoload(file_name: str, encoding: str = 'utf-8') -> BaseConfig:
+    """Loads and parses the given config file and returns as a `BaseConfig`
+    object.
+
+    :param file_name:
+    :type file_name:
+    :param encoding:
+    :type encoding:
+    :return:
+    :rtype:
+    """
+    loader = guess_loader_class(file_name)()
+    loader.load_file(file_name, encoding=encoding)
+    return BaseConfig(**raw_load(file_name))