yini-parser 0.1.0a1__tar.gz

yini_parser-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yini_parser-0.1.0a1/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: yini-parser
+Version: 0.1.0a1
+Summary: Official Python parser for YINI, an INI-inspired, indentation-insensitive configuration format with clear nested sections and explicit structure.
+Author: YINI-lang project
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://yini-lang.org?utm_campaign=yini_parser_python&utm_content=pyproject
+Project-URL: Repository, https://github.com/YINI-lang/yini-parser-python
+Project-URL: Specification, https://yini-lang.org/refs/specification?utm_campaign=yini_parser_python&utm_content=pyproject
+Project-URL: Issues, https://github.com/YINI-lang/yini-parser-python/issues
+Keywords: yini,configuration,config,parser,ini,antlr
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: antlr4-python3-runtime==4.13.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.13; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# yini-parser-python
+
+The official Python parser for **YINI** (by the YINI-lang project) — a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, comments, and predictable parsing.  
+
+> **Status:** Alpha. This parser is intended for early testing and integration. The public API and edge-case behavior may still change before `1.0.0`.
+
+---
+
+## Quick Start
+
+```yini
+// A small, practical YINI config.
+
+// The App section starts here
+^ App
+name = "Demo App"
+version = 1.2
+features = ["search", "logs"]
+debug = false    // on/off, yes/no would work too
+pageSize = 25
+
+    // Another section (sub-section of App)
+    ^^ Server
+    host = "localhost"
+    port = 8080    # Can comment with # too
+    useTLS = off
+```
+
+```python
+from yini_parser import load
+
+data = load("sample/basic.yini")
+print(data["App"]["name"])  # Outputs: Demo App
+```
+
+Use `load(...)` to parse a file and `loads(...)` to parse a string.
+
+See the [YINI specification and documentation](https://yini-lang.org/refs/specification?utm_source=github&utm_medium=referral&utm_campaign=yini_parser_python&utm_content=readme).
+
+---
+
+## Installation
+
+From PyPI, once published:
+
+```bash
+pip install yini-parser
+```
+
+For local development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+or, if using the project Taskfile:
+
+```bash
+task install-dev
+```
+
+---
+
+## Tests
+
+The `tests/` directory contains a focused implementation-local test suite, including:
+- Tests for the public API.
+- Key semantic tests.
+- Smoke/golden tests.
+- Parser behavior tests for comments, values, sections, strict mode, conflicts, inline objects, and string concatenation.
+
+Run the test suite with:
+
+```bash
+python -m pytest -v
+```
+
+or, if using the project Taskfile:
+
+```bash
+task test
+```
+
+---
+
+**^YINI ≡**  
+> YINI is a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, and predictable parsing.
+> 
+> It has a formal specification and a defined grammar.
+
+[yini-lang.org](https://yini-lang.org/?utm_source=github&utm_medium=referral&utm_campaign=yini_parser_python&utm_content=readme_footer) · [YINI-lang on GitHub](https://github.com/YINI-lang)  

yini_parser-0.1.0a1/README.md

@@ -0,0 +1,91 @@
+# yini-parser-python
+
+The official Python parser for **YINI** (by the YINI-lang project) — a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, comments, and predictable parsing.  
+
+> **Status:** Alpha. This parser is intended for early testing and integration. The public API and edge-case behavior may still change before `1.0.0`.
+
+---
+
+## Quick Start
+
+```yini
+// A small, practical YINI config.
+
+// The App section starts here
+^ App
+name = "Demo App"
+version = 1.2
+features = ["search", "logs"]
+debug = false    // on/off, yes/no would work too
+pageSize = 25
+
+    // Another section (sub-section of App)
+    ^^ Server
+    host = "localhost"
+    port = 8080    # Can comment with # too
+    useTLS = off
+```
+
+```python
+from yini_parser import load
+
+data = load("sample/basic.yini")
+print(data["App"]["name"])  # Outputs: Demo App
+```
+
+Use `load(...)` to parse a file and `loads(...)` to parse a string.
+
+See the [YINI specification and documentation](https://yini-lang.org/refs/specification?utm_source=github&utm_medium=referral&utm_campaign=yini_parser_python&utm_content=readme).
+
+---
+
+## Installation
+
+From PyPI, once published:
+
+```bash
+pip install yini-parser
+```
+
+For local development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+or, if using the project Taskfile:
+
+```bash
+task install-dev
+```
+
+---
+
+## Tests
+
+The `tests/` directory contains a focused implementation-local test suite, including:
+- Tests for the public API.
+- Key semantic tests.
+- Smoke/golden tests.
+- Parser behavior tests for comments, values, sections, strict mode, conflicts, inline objects, and string concatenation.
+
+Run the test suite with:
+
+```bash
+python -m pytest -v
+```
+
+or, if using the project Taskfile:
+
+```bash
+task test
+```
+
+---
+
+**^YINI ≡**  
+> YINI is a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, and predictable parsing.
+> 
+> It has a formal specification and a defined grammar.
+
+[yini-lang.org](https://yini-lang.org/?utm_source=github&utm_medium=referral&utm_campaign=yini_parser_python&utm_content=readme_footer) · [YINI-lang on GitHub](https://github.com/YINI-lang)  

yini_parser-0.1.0a1/pyproject.toml

@@ -0,0 +1,73 @@
+[project]
+name = "yini-parser"
+version = "0.1.0a1"
+description = "Official Python parser for YINI, an INI-inspired, indentation-insensitive configuration format with clear nested sections and explicit structure."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+  { name = "YINI-lang project" }
+]
+keywords = [
+  "yini",
+  "configuration",
+  "config",
+  "parser",
+  "ini",
+  "antlr"
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Text Processing :: Markup",
+  "Typing :: Typed"
+]
+dependencies = [
+  "antlr4-python3-runtime==4.13.2",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8",
+  "ruff>=0.8",
+  "mypy>=1.13",
+  "build>=1.2",
+  "twine>=5",
+]
+
+[project.urls]
+Homepage = "https://yini-lang.org?utm_campaign=yini_parser_python&utm_content=pyproject"
+Repository = "https://github.com/YINI-lang/yini-parser-python"
+Specification = "https://yini-lang.org/refs/specification?utm_campaign=yini_parser_python&utm_content=pyproject"
+Issues = "https://github.com/YINI-lang/yini-parser-python/issues"
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.ruff]
+exclude = [
+  "src/yini_parser/grammar/generated",
+]
+
+[tool.mypy]
+mypy_path = "src"
+packages = ["yini_parser"]
+exclude = [
+  "src/yini_parser/grammar/generated/.*",
+]
+ignore_missing_imports = true
+explicit_package_bases = true

yini_parser-0.1.0a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yini_parser-0.1.0a1/src/yini_parser/__init__.py

@@ -0,0 +1,14 @@
+# src/yini_parser/__init__.py
+"""Public API for the yini_parser package."""
+
+from .api import YiniParseError, load, loads
+
+"""
+So users can write:
+from yini_parser import load, loads, YiniParseError
+
+Instead:
+from yini_parser.api import load, loads, YiniParseError
+"""
+
+__all__ = ["YiniParseError", "load", "loads"]

yini_parser-0.1.0a1/src/yini_parser/api/__init__.py

@@ -0,0 +1,13 @@
+# src/yini_parser/api/__init__.py
+"""Public API helpers for parsing YINI documents."""
+
+from .errors import YiniParseError
+from .warnings import YiniParseWarning
+from .load import load, loads
+
+__all__ = [
+    "load",
+    "loads",
+    "YiniParseError",
+    "YiniParseWarning",
+]

yini_parser-0.1.0a1/src/yini_parser/api/errors.py

@@ -0,0 +1,15 @@
+# src/yini_parser/api/errors.py
+
+class YiniParseError(Exception):
+    def __init__(self, message: str, line: int | None = None, column: int | None = None):
+        super().__init__(message)
+        self.message = message
+        self.line = line
+        self.column = column
+
+    def __str__(self) -> str:
+        if self.line is not None and self.column is not None:
+            return f"{self.message} (line {self.line}, column {self.column})"
+        if self.line is not None:
+            return f"{self.message} (line {self.line})"
+        return self.message

yini_parser-0.1.0a1/src/yini_parser/api/load.py

@@ -0,0 +1,55 @@
+# src/yini_parser/api/load.py
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from antlr4 import CommonTokenStream, FileStream, InputStream
+
+from yini_parser.api.errors import YiniParseError
+
+from ..core.yini_builder_visitor import YiniBuilderVisitor
+from ..grammar.generated.YiniLexer import YiniLexer
+from ..grammar.generated.YiniParser import YiniParser
+
+
+def loads(text: str, strict: bool=False) -> dict[str, Any]:
+    """
+    Parse YINI text and return the resulting Python dictionary.
+    """
+
+    input_stream = InputStream(text)
+    return _parse_input_stream(input_stream, strict=strict)
+
+
+def load(path: str, strict: bool=False) -> dict[str, Any]:
+    """
+    Parse a YINI file from disk and return the resulting Python dictionary.
+    """
+
+    file_path = Path(path)
+    input_stream = FileStream(str(file_path), encoding="utf-8")
+    return _parse_input_stream(input_stream, strict=strict)
+
+
+def _parse_input_stream(
+        input_stream: InputStream | FileStream,
+        strict: bool
+    ) -> dict[str, Any]:
+    lexer = YiniLexer(input_stream)
+    stream = CommonTokenStream(lexer)
+    parser = YiniParser(stream)
+
+    tree = parser.yini()
+
+    if parser.getNumberOfSyntaxErrors() > 0:
+#        raise ValueError(f"Failed to parse YINI input: {parser.getNumberOfSyntaxErrors()} syntax error(s).")
+        raise YiniParseError(f"Failed to parse YINI input: {parser.getNumberOfSyntaxErrors()} syntax error(s).")
+    
+    visitor = YiniBuilderVisitor(strict=strict)
+    result = visitor.visit(tree)
+
+    if not isinstance(result, dict):
+        raise TypeError(f"Expected parsed result to be a dict, got {type(result).__name__}.")
+
+    return result

yini_parser-0.1.0a1/src/yini_parser/api/warnings.py

@@ -0,0 +1,53 @@
+# src/yini_parser/api/warnings.py
+
+from __future__ import annotations
+
+
+class YiniParseWarning(Warning):
+    """
+    Warning raised for non-fatal YINI parse issues.
+
+    A YiniParseWarning represents a problem that was detected while parsing,
+    but which does not prevent a result from being produced.
+
+    Typical examples:
+    - Duplicate keys ignored in lenient mode.
+    - Duplicate sections ignored in lenient mode.
+    - Key/section name collisions handled by lenient-mode policy.
+    """
+
+    def __init__(
+        self,
+        message: str,
+        line: int | None = None,
+        column: int | None = None,
+        code: str | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.message = message
+        self.line = line
+        self.column = column
+        self.code = code
+
+    def __str__(self) -> str:
+        location = self._format_location()
+
+        if self.code is not None and location is not None:
+            return f"{self.message} [{self.code}] {location}"
+
+        if self.code is not None:
+            return f"{self.message} [{self.code}]"
+
+        if location is not None:
+            return f"{self.message} {location}"
+
+        return self.message
+
+    def _format_location(self) -> str | None:
+        if self.line is not None and self.column is not None:
+            return f"(line {self.line}, column {self.column})"
+
+        if self.line is not None:
+            return f"(line {self.line})"
+
+        return None

yini_parser-0.1.0a1/src/yini_parser/core/__init__.py

@@ -0,0 +1 @@
+# This file marks this directory as a Python package so it can be imported (as a package/module).