tesorotools-python 0.0.0__py2.py3-none-any.whl

tesorotools/utils/template.py

@@ -0,0 +1,126 @@
+"""
+Please, read this to get used to (and understand) the jargon used in the code of this module.
+
+Custom utilities for reading `.yaml` files, specifically, report templates
+
+- A `.yaml` file is represented internally as a `MappingNode` *object*
+- A `MappingNode` has a `value` *attribute*, that is a **list of 2-tuples**
+- Each tuple on the list is composed by two `Node` *objects*.
+    - A `MappingNode` is a *subclass* of a `Node` by the way.
+    - Another subclass of of `Node` is `ScalarNode`, more about that later.
+- The first `Node` of the tuple is called *key node*.
+- The second `Node` of the tuple is called *value node*.
+
+Example:
+
+Given this yaml document snippet
+
+```yaml
+key1: "value1"
+key2: !custom_tag
+  subkey: "subvalue"
+```
+
+It will be represented as a `MappingNode` whose `value` attribute will be a list of length 2 like the following
+
+- (`key_node1`, `value_node1`)
+- (`key_node2`, `value_node2`)
+
+Let's analyze it:
+
+- `key_node1` is a `ScalarNode` object, which has a `value` attribute of "key1" and and *implicit* `tag` attribute indicating it is a string. `value_node1` is similar, but with a `value` of "value1"
+
+- `key_node2` is similar to the previously analyzed nodes, but `value_node2` is, instead of a `ScalarNode`, another `MappingNode`.
+    - This `MappingNode` object has an *explicit* and *custom* `tag` attribute called "!custom_tag". It is customary to name custom tags starting with "!".
+    - The `value` attribute is a list of length 1 containing a tuple of `ScalarNodes` as the previously analyzed.
+"""
+
+from collections.abc import Hashable
+from io import TextIOWrapper as _ReadStream
+from pathlib import Path
+from typing import Any
+
+import yaml
+from yaml.nodes import MappingNode, Node, ScalarNode
+
+# implicit tag for string `ScalarNode`
+STR_TAG = "tag:yaml.org,2002:str"
+
+type NodeContents = list[tuple[Node, Node]]
+
+
+def _to_mapping_node(scalar_node: ScalarNode) -> MappingNode:
+    return MappingNode(tag=scalar_node.tag, value=[])
+
+
+class TemplateLoader(yaml.FullLoader):
+    """This is a custom `.yaml` file loader to make our life easier when reading report templates."""
+
+    def __init__(self, stream: _ReadStream):
+        """Remember the path of the file it is reading"""
+        super().__init__(stream)
+        self._path: Path = Path(stream.name).parent
+
+    def construct_mapping(
+        self, node: MappingNode, deep: bool = False
+    ) -> dict[Hashable, Any]:
+        """
+        This function it is not meant to be called directly by us, it will usually be called indirectly by code such as `yaml.load(file, Loader=loader)`.
+
+        For each `MappingNode` with a custom tag in the `.yaml` file, insert an additional tuple in its `value` attribute with an "id" string `ScalarNode` as *key node* and the same value as its associated *key node*.
+
+        For example, `.yaml` file
+
+        ```yaml
+        key: !custom_tag
+            subkey: "subvalue"
+        ```
+
+        will be transformed to:
+
+        ```yaml
+        key: !custom_tag
+            id: key
+            subkey: "subvalue"
+        ```
+
+        Parameters
+        ----------
+        node : MappingNode
+            Current `MappingNode` being parsed.
+        deep : bool, optional
+            Controls if all the child nodes should be built recursively or only shallowly, by default False
+
+        Returns
+        -------
+        dict[Hashable, Any]
+            Result dictionary
+        """
+        mapping: dict[Hashable, Any] = {}
+        node_contents: NodeContents = node.value
+
+        for subkey_node, subvalue_node in node_contents:
+            subkey: str = self.construct_object(subkey_node, deep=deep)
+            if subvalue_node.tag.startswith("!"):
+                if isinstance(subvalue_node, ScalarNode):
+                    subvalue_node = _to_mapping_node(subvalue_node)
+                id_name = ScalarNode(tag=STR_TAG, value="id")
+                id_value = ScalarNode(tag=STR_TAG, value=str(subkey))
+                subcontents: NodeContents = subvalue_node.value
+                subcontents.insert(0, (id_name, id_value))
+            value = self.construct_object(subvalue_node, deep=deep)
+            mapping[subkey] = value
+
+            # artificial imports of other `.yaml` files
+            if subkey == "imports":
+                imports: NodeContents = subvalue_node.value
+                self.imports = {}
+                for asset_key_node, asset_path_node in imports:
+                    asset_key: str = self.construct_object(
+                        asset_key_node, deep=deep
+                    )
+                    asset_path: Path = Path(
+                        self.construct_object(asset_path_node, deep=deep)
+                    )
+                    self.imports[asset_key] = self._path / asset_path
+        return mapping

tesorotools_python-0.0.0.dist-info/METADATA

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: tesorotools-python
+Version: 0.0.0
+Requires-Dist: babel
+Requires-Dist: eikon
+Requires-Dist: matplotlib
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: psycopg2
+Requires-Dist: pyarrow
+Requires-Dist: python-docx
+Requires-Dist: pyyaml
+Requires-Dist: sqlalchemy

tesorotools_python-0.0.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+tesorotools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/convert.py,sha256=qk4N-AZpKlmTD9L9SG0E43jqW27DJTHTu_Y1wehvETQ,3334
+tesorotools/main.py,sha256=ZxDyqBD_0zlfcdTZp84UPxlK3_O-9xfexDjLJVu4L5U,1357
+tesorotools/artists/__init__.py,sha256=exObsPqXdP6IaRn4QPkLRXUN67iOPNXtDgDAOoMxJoA,105
+tesorotools/artists/barh_plot.py,sha256=3KkoT0DLkctzYNMV3Pz1EcAT9i29YGYSkTLTFNb3dv8,9461
+tesorotools/artists/line_plot.py,sha256=BqOHnmVB6fL0ElN_WDpvCzP0L7O2-mp6ULfHo3qwiCI,3405
+tesorotools/artists/table.py,sha256=CjyjWivn5YrNP5m8_eWi-ZA7R1ts3aIhATrYMEgTuOU,7651
+tesorotools/artists/type_curve.py,sha256=VGFCCyMVNwjliLK9usyw_nLC6emKcJYOSV1pmWJQNXk,6463
+tesorotools/data_sources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/data_sources/debug.py,sha256=fmUHt7f3dAd6qUBo5D_kTn__MgGC0hisdaC6sFXHKNg,877
+tesorotools/data_sources/eikon.py,sha256=YCAyT4152QFks9m1B0LktprQe7lu4DOjGLkeN0CWG5o,3724
+tesorotools/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/database/push.py,sha256=Y1ToNupMIdNfXcg20P0sFijXza05FUCB1OK53cPXYtU,1960
+tesorotools/dependencies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/dependencies/functions.py,sha256=URpIB2jQoPG4f15wmTWH5f5x855bAjg6ts2O5cWljEg,248
+tesorotools/dependencies/node.py,sha256=DSLbfagWc1KfYrUhIY5KTcFy7Q4nNF2B2qHfgihIKbo,879
+tesorotools/dependencies/resolution.py,sha256=Ctzzsm37YaJoyJQrbo9UcR0Sw6gw4xBnJOhTtAhLAbw,3660
+tesorotools/offsets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/offsets/offsets.py,sha256=h8hEoQ6KEsANlMqbCmSImdymllsjFgrBseKcB9gyMLQ,14068
+tesorotools/offsets/outliers.py,sha256=37enrVwungs7KrNE7FYiPd-Eo3-5d9OHFeNXy6X7URo,415
+tesorotools/render/__init__.py,sha256=XiuKC7mwvsXMTpPcInPaVnVdv2BzWwM-dcVY8dXhkjA,575
+tesorotools/render/headline.py,sha256=haKi1g2BvjrbLDMfsn6BaHJjGqPDmwlqH9e3pb9nzCE,1264
+tesorotools/render/introduction.py,sha256=uSeuOWiauLiX_hZYULFUiyw7JQwMHBIexr15-sW1ayA,1802
+tesorotools/render/report.py,sha256=rdbgeO1Ol6TM2mUkJeaAiJht_8Fcc9ZT5K_qbOXgj2Q,885
+tesorotools/render/content/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/render/content/content.py,sha256=m3USJXle5NctlQJs-d0tgSCvb-aNoCy2v7sZFqHZ1B8,409
+tesorotools/render/content/images.py,sha256=C0Tkrud17MqH_doenn5H-917kT6XCUdCmNek9CZkEXc,5040
+tesorotools/render/content/section.py,sha256=EugPBsb5mAWKRONAHQU-qCbKFQ419XU2vDJHQ0s_i3U,1682
+tesorotools/render/content/table.py,sha256=WFH1AdgS7mYdj4WAa3j9CNjisiHW6XGhJiqUnaX23a0,9420
+tesorotools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tesorotools/utils/config.py,sha256=TMD_6OB2RS2sjM17tYwFnOtcXZgIxs-Ec8FYA3Qokuc,1056
+tesorotools/utils/globals.py,sha256=gFhNjCjeih7NaNEb6yjgoJbkTSUuJu9Xw5-UDtCPAQA,287
+tesorotools/utils/matplotlib.py,sha256=tKidZIcDLKWgawIOJggWwVoaTMsrjw1WEJQouydSYbI,1197
+tesorotools/utils/series.py,sha256=eUEUOdzDfA7YbgO4o6KtxwJOL5cQYdqLjrdvuQ7Hqhc,1168
+tesorotools/utils/template.py,sha256=xpBVad28gG9ZLVwd9e0dTWsGsbujjmVcCPEW2mIKEJo,4917
+tesorotools_python-0.0.0.dist-info/METADATA,sha256=Ir3_5KhM8UiG1NuFYi39Qxg-KDj50jkzIXGraTv_L-0,298
+tesorotools_python-0.0.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+tesorotools_python-0.0.0.dist-info/RECORD,,

tesorotools_python-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any