dccQuantities 2.0.0.dev2__tar.gz → 2.1.0__tar.gz

dccquantities-2.1.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: dccQuantities
+Version: 2.1.0
+Summary: Python classes for working with DDC calibration data
+Author: Vanessa Stehr, Thomas Bruns
+Author-email: Benedikt Seeger <benedikt.seeger@ptb.de>, Jaime Gonzalez Gomez <jaime.gonzalez-gomez@ptb.de>
+License-Expression: LGPL-2.1-or-later
+Project-URL: Homepage, https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities
+Project-URL: Repository, https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities
+Project-URL: Documentation, https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.14,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dsiUnits~=3.1
+Requires-Dist: dccXMLJSONConv~=3.0.0.dev8
+Requires-Dist: metas_unclib
+Requires-Dist: numpy
+Requires-Dist: PyBackport; python_version < "3.11"
+Requires-Dist: pythonnet
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mike; extra == "docs"
+Requires-Dist: ruff; extra == "docs"
+Dynamic: license-file
+
+# dccQuantities
+
+`dccQuantities` is a Python library designed for users of PTB’s [Digital Calibration Certificates (DCC)](https://wiki.dcc.ptb.de/) in XML format. It provides an object‑oriented interface to parse, serialize, and manipulate calibration data with full support for uncertainties and units. Arithmetic works naturally on scalars, scalar‑vector mixes, and same‑length vectors element‑wise, preserving uncertainty propagation and metadata throughout.
+
+[![Latest Release](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/badges/release.svg)](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/releases)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/pipeline.svg)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/coverage.svg)
+[![Docs](https://img.shields.io/badge/Read_the_docs-blue)](https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/)
+
+---
+
+## Key Features
+
+- **DCC XML Parsing & Serialization**  
+  Import certificates from XML into Python objects and export back to XML, JSON, CSV, Excel, or pandas DataFrames.
+
+- **Uncertainty & Unit Awareness**  
+  All quantity objects wrap values as `ufloat` (via `metas_unclib`) and units via `dsi_unit`, ensuring correct propagation in calculations.
+
+- **Object‑Oriented Arithmetic**  
+  Standard operators (`+`, `-`, `*`, `/`, `**`) are overloaded on:
+  - **`DccQuantityType`**: single or tabulated quantities
+  - **`SiRealList`**, **`SiComplexList`**, **`SiHybrid`**: 1D/2D arrays
+
+- **Tables & Fancy Indexing**
+The classes `DccLongTable` and `DccFlatTable` transparently implement numpy like indexing on efficient table structures described in the [table document](doc/tabellen/tables-de.md). Fancy indexing is supported, return type are always new tables.
+---
+
+## Linux dependencies
+
+The package requires the Linux .NET library. For that reason, it is required to have installed the `mono` library:
+```
+sudo apt install mono-runtime
+```
+
+## Installation
+
+There are multiple ways to install the package.
+Read them all and choose the best one for your case:
+
+1. From PyPI (core functionality):
+```bash
+pip install dccQuantities
+```
+This will install the latest released changes at the 'main' branch.
+
+2. Installing unreleased changes:
+```bash
+pip install git+https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities.git@devel
+```
+Please consider that unreleased changes might be unstable and can break your code.
+
+3. Cloning the repository:
+```bash
+git clone https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities.git
+cd dccQuantities
+pip install -e .
+```
+This is the best option for developers.
+
+## Deploy local documentation
+
+It is possible to deploy and read the local documentation.
+To do so, it is required to clone the repository as stated at '2.' in the _Installation_ section.
+
+Once the repository is cloned and the current working directory is `dccQuantities/`, install the optional dependencies for documentation:
+````
+pip install .[docs]
+````
+
+Now you can deploy and open the documentation by running the following command at your terminal:
+```
+quantity-docs
+```
+
+## Under the Hood (Test‑Driven Behavior)
+
+The library’s design is guided by its test suite:
+
+1. **Core Parsing** (`tests/test_parser.py`): reads `<DccQuantityTable>` and `<DccQuantityType>` elements, building Python objects.
+2. **Naming** (`tests/test_dccName.py`): parses and normalizes `<DccLangName>` entries for multilingual support.
+3. **Quantity Discovery** (`tests/test_quantityTypeCollector.py`): auto‑registers data handlers via `AbstractQuantityTypeData` subclasses.
+4. **List Types** (`tests/test_SiRealList_*.py`): handles real, complex, and hybrid lists, including broadcasting and label merging.
+5. **Table Flattening** (`tests/test_tables.py`): cover the tables.
+6. **Round‑Trip Serialization** (`tests/test_serilizer.py`): ensures parse→serialize yields equivalent XML.
+7. **JSON Interchange** (`tests/test_dccQuantTabJSONDumpingAndLoadingFromFile.json`): lossless JSON dump/load.
+
+---
+
+## Contributing & Contact
+
+We welcome improvements, bug reports, and new features. To contribute:
+
+1. **Fork** the repository.  
+2. **Create** a feature branch.  
+3. **Add** tests for new functionality.  
+4. **Submit** a merge request.
+
+We highly encourage direct personal contact for design discussions or questions. Feel free to create Issues, even if you think your question/comment is not worth an issue, it is allways!
+
+Or reach out to the maintainer:
+- **Benedikt Seeger**: benedikt.seeger@ptb.de
+directly
+
+## License
+
+This project is licensed under the [LGPL‑2.1‑or‑later](LICENSE).
+

dccquantities-2.1.0/README.md

@@ -0,0 +1,108 @@
+# dccQuantities
+
+`dccQuantities` is a Python library designed for users of PTB’s [Digital Calibration Certificates (DCC)](https://wiki.dcc.ptb.de/) in XML format. It provides an object‑oriented interface to parse, serialize, and manipulate calibration data with full support for uncertainties and units. Arithmetic works naturally on scalars, scalar‑vector mixes, and same‑length vectors element‑wise, preserving uncertainty propagation and metadata throughout.
+
+[![Latest Release](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/badges/release.svg)](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/releases)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/pipeline.svg)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/coverage.svg)
+[![Docs](https://img.shields.io/badge/Read_the_docs-blue)](https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/)
+
+---
+
+## Key Features
+
+- **DCC XML Parsing & Serialization**  
+  Import certificates from XML into Python objects and export back to XML, JSON, CSV, Excel, or pandas DataFrames.
+
+- **Uncertainty & Unit Awareness**  
+  All quantity objects wrap values as `ufloat` (via `metas_unclib`) and units via `dsi_unit`, ensuring correct propagation in calculations.
+
+- **Object‑Oriented Arithmetic**  
+  Standard operators (`+`, `-`, `*`, `/`, `**`) are overloaded on:
+  - **`DccQuantityType`**: single or tabulated quantities
+  - **`SiRealList`**, **`SiComplexList`**, **`SiHybrid`**: 1D/2D arrays
+
+- **Tables & Fancy Indexing**
+The classes `DccLongTable` and `DccFlatTable` transparently implement numpy like indexing on efficient table structures described in the [table document](doc/tabellen/tables-de.md). Fancy indexing is supported, return type are always new tables.
+---
+
+## Linux dependencies
+
+The package requires the Linux .NET library. For that reason, it is required to have installed the `mono` library:
+```
+sudo apt install mono-runtime
+```
+
+## Installation
+
+There are multiple ways to install the package.
+Read them all and choose the best one for your case:
+
+1. From PyPI (core functionality):
+```bash
+pip install dccQuantities
+```
+This will install the latest released changes at the 'main' branch.
+
+2. Installing unreleased changes:
+```bash
+pip install git+https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities.git@devel
+```
+Please consider that unreleased changes might be unstable and can break your code.
+
+3. Cloning the repository:
+```bash
+git clone https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities.git
+cd dccQuantities
+pip install -e .
+```
+This is the best option for developers.
+
+## Deploy local documentation
+
+It is possible to deploy and read the local documentation.
+To do so, it is required to clone the repository as stated at '2.' in the _Installation_ section.
+
+Once the repository is cloned and the current working directory is `dccQuantities/`, install the optional dependencies for documentation:
+````
+pip install .[docs]
+````
+
+Now you can deploy and open the documentation by running the following command at your terminal:
+```
+quantity-docs
+```
+
+## Under the Hood (Test‑Driven Behavior)
+
+The library’s design is guided by its test suite:
+
+1. **Core Parsing** (`tests/test_parser.py`): reads `<DccQuantityTable>` and `<DccQuantityType>` elements, building Python objects.
+2. **Naming** (`tests/test_dccName.py`): parses and normalizes `<DccLangName>` entries for multilingual support.
+3. **Quantity Discovery** (`tests/test_quantityTypeCollector.py`): auto‑registers data handlers via `AbstractQuantityTypeData` subclasses.
+4. **List Types** (`tests/test_SiRealList_*.py`): handles real, complex, and hybrid lists, including broadcasting and label merging.
+5. **Table Flattening** (`tests/test_tables.py`): cover the tables.
+6. **Round‑Trip Serialization** (`tests/test_serilizer.py`): ensures parse→serialize yields equivalent XML.
+7. **JSON Interchange** (`tests/test_dccQuantTabJSONDumpingAndLoadingFromFile.json`): lossless JSON dump/load.
+
+---
+
+## Contributing & Contact
+
+We welcome improvements, bug reports, and new features. To contribute:
+
+1. **Fork** the repository.  
+2. **Create** a feature branch.  
+3. **Add** tests for new functionality.  
+4. **Submit** a merge request.
+
+We highly encourage direct personal contact for design discussions or questions. Feel free to create Issues, even if you think your question/comment is not worth an issue, it is allways!
+
+Or reach out to the maintainer:
+- **Benedikt Seeger**: benedikt.seeger@ptb.de
+directly
+
+## License
+
+This project is licensed under the [LGPL‑2.1‑or‑later](LICENSE).
+

dccquantities-2.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=77.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dccQuantities"
+description = "Python classes for working with DDC calibration data"
+dynamic = ["readme", "version"]
+requires-python = ">=3.9,<3.14"
+
+# SPDX license expression + point at your LICENSE file
+license = "LGPL-2.1-or-later"
+license-files = ["LICENSE"]
+
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: OS Independent",
+]
+
+authors = [
+  { name = "Benedikt Seeger", email = "benedikt.seeger@ptb.de" },
+  { name = "Jaime Gonzalez Gomez", email = "jaime.gonzalez-gomez@ptb.de" },
+  { name = "Vanessa Stehr" },
+  { name = "Thomas Bruns" },
+]
+dependencies = [
+  "dsiUnits~=3.1",
+  "dccXMLJSONConv~=3.0.0.dev8",
+  "metas_unclib",
+  "numpy",
+  "PyBackport ; python_version < '3.11'",
+  "pythonnet",
+]
+
+[project.urls]
+Homepage = "https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities"
+Repository = "https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities"
+Documentation = "https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/"
+
+[project.optional-dependencies]
+docs = ["mkdocs", "mkdocstrings-python", "mike", "ruff"]
+
+[tool.setuptools.dynamic]
+version = { attr = "dcc_quantities._version.__version__" }
+readme = { file = ["README.md"], content-type = "text/markdown" }
+
+[project.scripts]
+quantity-docs = "dcc_quantities._cli:deploy_local_docs"
+
+[tool.coverage.run]
+omit = ["_cli.py", "_version.py"]
+
+[tool.coverage.report]
+exclude_also = [
+    # Don't complain about missing debug-only code:
+    "def __repr__",
+]

dccquantities-2.1.0/src/dccQuantities.egg-info/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: dccQuantities
+Version: 2.1.0
+Summary: Python classes for working with DDC calibration data
+Author: Vanessa Stehr, Thomas Bruns
+Author-email: Benedikt Seeger <benedikt.seeger@ptb.de>, Jaime Gonzalez Gomez <jaime.gonzalez-gomez@ptb.de>
+License-Expression: LGPL-2.1-or-later
+Project-URL: Homepage, https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities
+Project-URL: Repository, https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities
+Project-URL: Documentation, https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.14,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dsiUnits~=3.1
+Requires-Dist: dccXMLJSONConv~=3.0.0.dev8
+Requires-Dist: metas_unclib
+Requires-Dist: numpy
+Requires-Dist: PyBackport; python_version < "3.11"
+Requires-Dist: pythonnet
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mike; extra == "docs"
+Requires-Dist: ruff; extra == "docs"
+Dynamic: license-file
+
+# dccQuantities
+
+`dccQuantities` is a Python library designed for users of PTB’s [Digital Calibration Certificates (DCC)](https://wiki.dcc.ptb.de/) in XML format. It provides an object‑oriented interface to parse, serialize, and manipulate calibration data with full support for uncertainties and units. Arithmetic works naturally on scalars, scalar‑vector mixes, and same‑length vectors element‑wise, preserving uncertainty propagation and metadata throughout.
+
+[![Latest Release](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/badges/release.svg)](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/-/releases)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/pipeline.svg)
+![pipeline status](https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/badges/main/coverage.svg)
+[![Docs](https://img.shields.io/badge/Read_the_docs-blue)](https://gitlab-pages.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities/)
+
+---
+
+## Key Features
+
+- **DCC XML Parsing & Serialization**  
+  Import certificates from XML into Python objects and export back to XML, JSON, CSV, Excel, or pandas DataFrames.
+
+- **Uncertainty & Unit Awareness**  
+  All quantity objects wrap values as `ufloat` (via `metas_unclib`) and units via `dsi_unit`, ensuring correct propagation in calculations.
+
+- **Object‑Oriented Arithmetic**  
+  Standard operators (`+`, `-`, `*`, `/`, `**`) are overloaded on:
+  - **`DccQuantityType`**: single or tabulated quantities
+  - **`SiRealList`**, **`SiComplexList`**, **`SiHybrid`**: 1D/2D arrays
+
+- **Tables & Fancy Indexing**
+The classes `DccLongTable` and `DccFlatTable` transparently implement numpy like indexing on efficient table structures described in the [table document](doc/tabellen/tables-de.md). Fancy indexing is supported, return type are always new tables.
+---
+
+## Linux dependencies
+
+The package requires the Linux .NET library. For that reason, it is required to have installed the `mono` library:
+```
+sudo apt install mono-runtime
+```
+
+## Installation
+
+There are multiple ways to install the package.
+Read them all and choose the best one for your case:
+
+1. From PyPI (core functionality):
+```bash
+pip install dccQuantities
+```
+This will install the latest released changes at the 'main' branch.
+
+2. Installing unreleased changes:
+```bash
+pip install git+https://gitlab1.ptb.de/digitaldynamicmeasurement/dcc-and-dsi/dccQuantities.git@devel
+```
+Please consider that unreleased changes might be unstable and can break your code.
+
+3. Cloning the repository:
+```bash
+git clone https://gitlab1.ptb.de/digitaldynamicmeasurement/dccQuantities.git
+cd dccQuantities
+pip install -e .
+```
+This is the best option for developers.
+
+## Deploy local documentation
+
+It is possible to deploy and read the local documentation.
+To do so, it is required to clone the repository as stated at '2.' in the _Installation_ section.
+
+Once the repository is cloned and the current working directory is `dccQuantities/`, install the optional dependencies for documentation:
+````
+pip install .[docs]
+````
+
+Now you can deploy and open the documentation by running the following command at your terminal:
+```
+quantity-docs
+```
+
+## Under the Hood (Test‑Driven Behavior)
+
+The library’s design is guided by its test suite:
+
+1. **Core Parsing** (`tests/test_parser.py`): reads `<DccQuantityTable>` and `<DccQuantityType>` elements, building Python objects.
+2. **Naming** (`tests/test_dccName.py`): parses and normalizes `<DccLangName>` entries for multilingual support.
+3. **Quantity Discovery** (`tests/test_quantityTypeCollector.py`): auto‑registers data handlers via `AbstractQuantityTypeData` subclasses.
+4. **List Types** (`tests/test_SiRealList_*.py`): handles real, complex, and hybrid lists, including broadcasting and label merging.
+5. **Table Flattening** (`tests/test_tables.py`): cover the tables.
+6. **Round‑Trip Serialization** (`tests/test_serilizer.py`): ensures parse→serialize yields equivalent XML.
+7. **JSON Interchange** (`tests/test_dccQuantTabJSONDumpingAndLoadingFromFile.json`): lossless JSON dump/load.
+
+---
+
+## Contributing & Contact
+
+We welcome improvements, bug reports, and new features. To contribute:
+
+1. **Fork** the repository.  
+2. **Create** a feature branch.  
+3. **Add** tests for new functionality.  
+4. **Submit** a merge request.
+
+We highly encourage direct personal contact for design discussions or questions. Feel free to create Issues, even if you think your question/comment is not worth an issue, it is allways!
+
+Or reach out to the maintainer:
+- **Benedikt Seeger**: benedikt.seeger@ptb.de
+directly
+
+## License
+
+This project is licensed under the [LGPL‑2.1‑or‑later](LICENSE).
+

dccquantities-2.1.0/src/dccQuantities.egg-info/SOURCES.txt

@@ -0,0 +1,54 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/dccQuantities.egg-info/PKG-INFO
+src/dccQuantities.egg-info/SOURCES.txt
+src/dccQuantities.egg-info/dependency_links.txt
+src/dccQuantities.egg-info/entry_points.txt
+src/dccQuantities.egg-info/requires.txt
+src/dccQuantities.egg-info/top_level.txt
+src/dcc_quantities/__init__.py
+src/dcc_quantities/_cli.py
+src/dcc_quantities/_config.py
+src/dcc_quantities/_helpers.py
+src/dcc_quantities/_version.py
+src/dcc_quantities/dcc_chars_xml_list.py
+src/dcc_quantities/dcc_lang_text.py
+src/dcc_quantities/dcc_math.py
+src/dcc_quantities/dcc_no_quantity.py
+src/dcc_quantities/dcc_quantity_parser.py
+src/dcc_quantities/dcc_quantity_table.py
+src/dcc_quantities/dcc_quantity_type.py
+src/dcc_quantities/dcc_rich_content_type.py
+src/dcc_quantities/exceptions.py
+src/dcc_quantities/parse_uncertainties.py
+src/dcc_quantities/_abc/__init__.py
+src/dcc_quantities/_abc/abstract_list_type.py
+src/dcc_quantities/_abc/abstract_quantity_type_data.py
+src/dcc_quantities/query/__init__.py
+src/dcc_quantities/query/_operators.py
+src/dcc_quantities/query/slices.py
+src/dcc_quantities/serializers/__init__.py
+src/dcc_quantities/serializers/_explicit_serializer_mixin.py
+src/dcc_quantities/serializers/_field_spec.py
+src/dcc_quantities/serializers/dcc_element_key.py
+src/dcc_quantities/serializers/dcc_element_parser.py
+src/dcc_quantities/serializers/dcc_json_encoder.py
+src/dcc_quantities/si_data/__init__.py
+src/dcc_quantities/si_data/_base_si_type.py
+src/dcc_quantities/si_data/si_data_type.py
+src/dcc_quantities/si_data/si_hybrid.py
+tests/test_dcc_chars_xml_list.py
+tests/test_dcc_no_quantity.py
+tests/test_dcc_text.py
+tests/test_generate_example_table_data.py
+tests/test_helpers.py
+tests/test_math.py
+tests/test_parser.py
+tests/test_quantity_type_collector.py
+tests/test_serilizer.py
+tests/test_si_real_list.py
+tests/test_si_real_list_parse_data.py
+tests/test_surface_flat_table_generation.py
+tests/test_tables.py

dccquantities-2.1.0/src/dccQuantities.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+quantity-docs = dcc_quantities._cli:deploy_local_docs

dccquantities-2.1.0/src/dccQuantities.egg-info/requires.txt

@@ -0,0 +1,14 @@
+dsiUnits~=3.1
+dccXMLJSONConv~=3.0.0.dev8
+metas_unclib
+numpy
+pythonnet
+
+[:python_version < "3.11"]
+PyBackport
+
+[docs]
+mkdocs
+mkdocstrings-python
+mike
+ruff

dccquantities-2.1.0/src/dccQuantities.egg-info/top_level.txt

@@ -0,0 +1 @@
+dcc_quantities

dccquantities-2.1.0/src/dcc_quantities/__init__.py

@@ -0,0 +1,19 @@
+"""DccQuantity package."""
+
+from dcc_quantities.dcc_lang_text import DccLangName
+from dcc_quantities.dcc_quantity_table import DccFlatTable, DccLongTable, DccQuantityTable
+from dcc_quantities.dcc_quantity_type import DccQuantityType
+from dcc_quantities.serializers.dcc_element_key import DccElementKey
+from dcc_quantities.serializers.dcc_element_parser import extract_dcc_elements
+from dcc_quantities.si_data import SiRealList
+
+__all__ = [
+    "DccElementKey",
+    "DccFlatTable",
+    "DccLangName",
+    "DccLongTable",
+    "DccQuantityTable",
+    "DccQuantityType",
+    "SiRealList",
+    "extract_dcc_elements",
+]

dccquantities-2.1.0/src/dcc_quantities/_abc/__init__.py

@@ -0,0 +1,4 @@
+from dcc_quantities._abc.abstract_list_type import AbstractListType
+from dcc_quantities._abc.abstract_quantity_type_data import AbstractQuantityTypeData
+
+__all__ = ["AbstractListType", "AbstractQuantityTypeData"]

dccquantities-2.1.0/src/dcc_quantities/_abc/abstract_list_type.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dcc_quantities._abc.abstract_quantity_type_data import AbstractQuantityTypeData
+
+
+class AbstractListType(AbstractQuantityTypeData):
+    def __init__(self, children: list[AbstractListType]):
+        super().__init__()
+        self.children = children
+
+    def to_json_dict(self) -> dict:
+        result = {}
+        for child in self.children:
+            child_json = child.to_json_dict()
+            for key, value in child_json.items():
+                result.setdefault(key, []).append(value)
+        return result
+
+    def __len__(self) -> int:
+        return len(self.children)

dccquantities-2.1.0/src/dcc_quantities/_abc/abstract_quantity_type_data.py

@@ -0,0 +1,27 @@
+from typing import Any, Iterator
+
+
+class AbstractQuantityTypeData:
+    def __init__(self):
+        self.data = "None"
+        self._sorted = None
+
+    def _iter_items(self) -> Iterator[tuple[str, Any]]:
+        """Iterator over all the class' items.
+
+        Iterates over all the non-empty (different to 'None') attributes or items contained within the class.
+        The items are returned as the attribute name and its value.
+        """
+        for k, v in vars(self).items():
+            if v is not None:
+                yield k, v
+
+    def __str__(self) -> str:
+        """String representation of the class' stored values."""
+        param_str = ", ".join(f"{key}: {value!s}" for key, value in self._iter_items())
+        if len(param_str) > 0:
+            param_str = " (" + param_str + ")"
+        return f"{self.data!s}{param_str}"
+
+    def __repr__(self) -> str:
+        return ", ".join(f"{key}={value!s}" for key, value in self._iter_items())

dccquantities-2.1.0/src/dcc_quantities/_cli.py

@@ -0,0 +1,32 @@
+"""Functions to be invoked from the command line interface."""
+
+import argparse
+import subprocess
+import webbrowser
+from pathlib import Path
+
+
+def deploy_local_docs():
+    """Deployment of local documentation.
+
+    The deployment consists of:
+        1. Searching if the document folder exists.
+        2. Creating the documentation files when the folder doesn't exist or when '--force' is provided.
+        3. Open the documentation on the default HTML viewer.
+    """
+    parser = argparse.ArgumentParser(
+        description="Deployment of local documentation at folder 'public/'. Make sure to have installed the "
+        "package as `pip install .[docs]`"
+    )
+    parser.add_argument("--force", action="store_true", help="Rebuilding the whole documentation.")
+    parser.add_argument("--no-show", action="store_true", help="Don't show the documentation once it is built.")
+    args = parser.parse_args()
+
+    docs_folder_path = Path("public")
+
+    if not docs_folder_path.exists() or args.force:
+        print("Building documentation...")
+        subprocess.run("mkdocs build", check=True)
+    if not args.no_show:
+        home_path = docs_folder_path / "index.html"
+        webbrowser.open(home_path)