snam 1.0.4__tar.gz

snam-1.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 pymlconf
+
+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.

snam-1.0.4/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: snam
+Version: 1.0.4
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+
+# snam
+
+Still Not A Markup!
+
+Another YAML parser and builder featured by:
+
+- Include other files.
+- Expand environment varibales.
+- Execute and use the shell commands standard output.
+- Merge/Melt mappings.
+
+
+## Install
+
+```bash
+pip install snam
+```
+
+## quickstart
+
+```python
+from snam import loads
+
+yamldoc = '''
+foo:
+  enabled: true
+  title: BAR
+  rate: .73
+  user: !env USER
+  greeting: !shell echo Hello
+
+fruites:
+  - cherry
+  - melon
+  - banana
+  - pineapple
+'''
+
+obj = loads(ymldoc)
+assert obj.foo.enabled
+assert obj.title == 'BAR'
+assert obj.rate == 0.73
+assert obj.fruites == ['cherry', 'melon', 'banana', 'pineapple']
+```
+
+## Tutorial
+
+### Parsing
+
+You may user `loads(str)` function to parse `YAML` string, and `load(file)` 
+to parse `file-like` object or filename. these functions return a 
+`snam.Meld` object. The `Meld` object is subclass of the Python's dictionary
+but in addtion you can access the members by `getattr`, `setattr` and 
+`delattr` operations.
+
+
+```python
+meld = loads('foo: bar')
+assert meld.foo == 'bar'
+```
+
+```python
+meld = load('foo.yml')
+```
+
+```python
+with open('foo.yml') as file:
+  meld = load(file)
+```
+
+### Merging/Melting
+
+Using the `|=` operator you may merge any other dictionary or `YAML-string` 
+into a `Meld`.
+
+```python
+meld |= '''
+  foo: bar
+  baz: 23
+'''
+```
+
+And also using the `<<=` you may load a file-like object or a filename into a
+`Meld` object.
+
+```python
+meld <<= 'foo.yml'
+```
+
+```python
+with open('foo.yml') as file:
+  meld <<= file
+```
+
+
+### Dump
+
+Use `snam.dumps(obj) -> str`, `snam.dump(obj, file)` and also 
+`meld >>= filename`.
+
+```python
+dumps(meld, indent=6, indentsize=2)
+dump(meld, 'foo.yml', indent=6, indentsize=2)
+
+with open('foo.yml', 'w') as file:
+  dump(meld, file, indent=6, indentsize=2)
+
+```
+
+```python
+meld >>= 'foo.yml'
+```
+
+```python
+with open('foo.yml', 'w') as file:
+  meld >>= file
+```
+
+## Contribution
+
+### Dependencies
+Install [python-makelib](https://github.com/pylover/python-makelib).
+
+### Virtualenv
+
+Create virtual environment:
+```bash
+make venv
+```
+
+Delete virtual environment:
+```bash
+make venv-delete
+```
+
+Activate the virtual environment:
+```bash
+source ./activate.sh
+```
+
+
+### Install (editable mode)
+Install this project as editable mode and all other development dependencies:
+```bash
+make env
+```
+
+
+### Tests
+Execute all tests:
+```bash
+make test
+```
+
+Execute specific test(s) using wildcard:
+```bash
+make test F=tests/test_db*
+make test F=tests/test_form.py::test_querystringform
+```
+
+*refer to* [pytest documentation](https://docs.pytest.org/en/7.1.x/how-to/usage.html#how-to-invoke-pytest)
+*for more info about invoking tests.*
+
+Execute tests and report coverage result:
+```bash
+make cover
+make cover F=tests/test_static.py
+make cover-html
+```
+
+
+# Lint
+```bash
+make lint
+```
+
+
+### Distribution
+Execute these commands to create `Python`'s standard distribution packages
+at `dist` directory:
+```bash
+make sdist
+make wheel
+```
+
+
+### Clean build directory
+Execute: 
+```bash
+make clean
+```
+to clean-up previous `dist/*` and `build/*` directories.
+
+
+### PyPI
+
+> **_WARNING:_** Do not do this if you'r not responsible as author and 
+> or maintainer of this project.
+
+Execute
+```bash
+make clean
+make pypi
+```
+to upload `sdists` and `wheel` packages on [PyPI](https://pypi.org).
+
+
+## Documentation
+
+```bash
+source activate.sh
+make doc
+make doclive
+make doctest
+```
+
+Or 
+
+```bash
+source activate.sh
+cd sphinx
+make doctest
+make html
+make livehtml
+```

snam-1.0.4/README.md

@@ -0,0 +1,225 @@
+# snam
+
+Still Not A Markup!
+
+Another YAML parser and builder featured by:
+
+- Include other files.
+- Expand environment varibales.
+- Execute and use the shell commands standard output.
+- Merge/Melt mappings.
+
+
+## Install
+
+```bash
+pip install snam
+```
+
+## quickstart
+
+```python
+from snam import loads
+
+yamldoc = '''
+foo:
+  enabled: true
+  title: BAR
+  rate: .73
+  user: !env USER
+  greeting: !shell echo Hello
+
+fruites:
+  - cherry
+  - melon
+  - banana
+  - pineapple
+'''
+
+obj = loads(ymldoc)
+assert obj.foo.enabled
+assert obj.title == 'BAR'
+assert obj.rate == 0.73
+assert obj.fruites == ['cherry', 'melon', 'banana', 'pineapple']
+```
+
+## Tutorial
+
+### Parsing
+
+You may user `loads(str)` function to parse `YAML` string, and `load(file)` 
+to parse `file-like` object or filename. these functions return a 
+`snam.Meld` object. The `Meld` object is subclass of the Python's dictionary
+but in addtion you can access the members by `getattr`, `setattr` and 
+`delattr` operations.
+
+
+```python
+meld = loads('foo: bar')
+assert meld.foo == 'bar'
+```
+
+```python
+meld = load('foo.yml')
+```
+
+```python
+with open('foo.yml') as file:
+  meld = load(file)
+```
+
+### Merging/Melting
+
+Using the `|=` operator you may merge any other dictionary or `YAML-string` 
+into a `Meld`.
+
+```python
+meld |= '''
+  foo: bar
+  baz: 23
+'''
+```
+
+And also using the `<<=` you may load a file-like object or a filename into a
+`Meld` object.
+
+```python
+meld <<= 'foo.yml'
+```
+
+```python
+with open('foo.yml') as file:
+  meld <<= file
+```
+
+
+### Dump
+
+Use `snam.dumps(obj) -> str`, `snam.dump(obj, file)` and also 
+`meld >>= filename`.
+
+```python
+dumps(meld, indent=6, indentsize=2)
+dump(meld, 'foo.yml', indent=6, indentsize=2)
+
+with open('foo.yml', 'w') as file:
+  dump(meld, file, indent=6, indentsize=2)
+
+```
+
+```python
+meld >>= 'foo.yml'
+```
+
+```python
+with open('foo.yml', 'w') as file:
+  meld >>= file
+```
+
+## Contribution
+
+### Dependencies
+Install [python-makelib](https://github.com/pylover/python-makelib).
+
+### Virtualenv
+
+Create virtual environment:
+```bash
+make venv
+```
+
+Delete virtual environment:
+```bash
+make venv-delete
+```
+
+Activate the virtual environment:
+```bash
+source ./activate.sh
+```
+
+
+### Install (editable mode)
+Install this project as editable mode and all other development dependencies:
+```bash
+make env
+```
+
+
+### Tests
+Execute all tests:
+```bash
+make test
+```
+
+Execute specific test(s) using wildcard:
+```bash
+make test F=tests/test_db*
+make test F=tests/test_form.py::test_querystringform
+```
+
+*refer to* [pytest documentation](https://docs.pytest.org/en/7.1.x/how-to/usage.html#how-to-invoke-pytest)
+*for more info about invoking tests.*
+
+Execute tests and report coverage result:
+```bash
+make cover
+make cover F=tests/test_static.py
+make cover-html
+```
+
+
+# Lint
+```bash
+make lint
+```
+
+
+### Distribution
+Execute these commands to create `Python`'s standard distribution packages
+at `dist` directory:
+```bash
+make sdist
+make wheel
+```
+
+
+### Clean build directory
+Execute: 
+```bash
+make clean
+```
+to clean-up previous `dist/*` and `build/*` directories.
+
+
+### PyPI
+
+> **_WARNING:_** Do not do this if you'r not responsible as author and 
+> or maintainer of this project.
+
+Execute
+```bash
+make clean
+make pypi
+```
+to upload `sdists` and `wheel` packages on [PyPI](https://pypi.org).
+
+
+## Documentation
+
+```bash
+source activate.sh
+make doc
+make doclive
+make doctest
+```
+
+Or 
+
+```bash
+source activate.sh
+cd sphinx
+make doctest
+make html
+make livehtml
+```

snam-1.0.4/setup.cfg

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

snam-1.0.4/setup.py

@@ -0,0 +1,38 @@
+# This file is generated by https://github.com:pylover/python-makelib
+import os.path
+import re
+
+from setuptools import setup, find_packages
+
+
+# reading package's version (same way sqlalchemy does)
+with open(
+    os.path.join(os.path.dirname(__file__), 'snam', '__init__.py')
+) as v_file:
+    package_version = \
+        re.compile('.*__version__ = \'(.*?)\'', re.S) \
+        .match(v_file.read()) \
+        .group(1)
+
+
+setup(
+    name='snam',
+    version=package_version,
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',  # This is important!
+    packages=find_packages(
+        where='.',
+        include=['snam'],
+        exclude=['tests']
+    ),
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        'Intended Audience :: Developers',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Programming Language :: Python :: 3.13',
+        'Topic :: Software Development :: Libraries'
+    ],
+)

snam-1.0.4/snam/__init__.py

@@ -0,0 +1,4 @@
+__version__ = '1.0.4'
+
+
+from .parser import Meld, Parser, loads, load, dumps, dump

snam-1.0.4/snam/errors.py

@@ -0,0 +1,34 @@
+import os
+
+
+class YConfException(Exception):
+    def __init__(self, tok, title, filename=None):
+        file = (filename if filename.startswith('/')
+                else os.path.relpath(filename)) if filename else '(stream)'
+        super().__init__(
+            f'{file}:{tok.line}:{tok.column}: {title}: {tok}'
+        )
+
+
+class InvalidTokenError(YConfException):
+    def __init__(self, tok, filename=None):
+        super().__init__(tok, 'Invalid token', filename)
+
+
+class ExpectedTokenError(YConfException):
+    def __init__(self, tok, expected, filename=None):
+        super().__init__(tok, f'Expected {expected}, found', filename)
+
+
+class UnknownTagError(YConfException):
+    def __init__(self, tok, filename=None):
+        super().__init__(tok, 'Unknown', filename)
+
+
+class IncludeMismatchError(YConfException):
+    def __init__(self, tok, expectedtype, giventype, filename=None):
+        super().__init__(
+            tok,
+            f'Trying to include `{giventype}` inside `{expectedtype}`',
+            filename
+        )