pg-data-yaml 0.0.0__tar.gz

pg_data_yaml-0.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2016, comagic
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pg_data_yaml-0.0.0/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: pg-data-yaml
+Version: 0.0.0
+Summary: Yaml data converter between DB and Repo
+Home-page: https://github.com/andruche/pg-data-yaml
+Author: Andrey Chernyakov
+License: BSD
+Project-URL: Documentation, https://github.com/andruche/pg-data-yaml/blob/master/README.md
+Project-URL: Bug Tracker, https://github.com/andruche/pg-data-yaml/issues
+Keywords: postgres,postgresql,yaml,reference-data
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml
+Requires-Dist: asyncpg<0.31.0,>=0.27.0
+Provides-Extra: dev
+Requires-Dist: flake8<6,>=5; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-flake8; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-sugar; extra == "dev"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+## pg-data-yaml — Yaml interface for reference tables in PostgreSQL
+
+Export, diff and sync rows of reference tables in PostgreSQL to YAML files in a repository.
+
+## installation
+
+```
+pip install pg-data-yaml
+```
+
+## which tables are included
+
+Table selection is configured with `--comment-label` or `--table-list-predicate`. One of these options is **required** for `export`, `diff` and `sync` (mutually exclusive).
+
+### `--comment-label LABEL`
+
+Include tables whose comment contains `LABEL`. Any label can be used, for example `global directory` or `env directory`.
+
+Optional clause in parentheses after the label is parsed from the comment (see [marking tables](#marking-tables) below).
+
+```
+pg_data_yaml export -d mydb --out-dir /tmp/refs --comment-label "global directory"
+```
+
+### `--table-list-predicate PREDICATE`
+
+Include tables matching a SQL predicate. Table comments are ignored; export always uses `select * from <schema>.<table> order by <primary key columns>`.
+
+The predicate is inserted into a query against `pg_catalog.pg_class` and `pg_catalog.pg_namespace`. Use `n.nspname` for schema name and `c.relname` for table name.
+
+Example — tables without tenant columns:
+
+```
+pg_data_yaml export -d mydb --out-dir /tmp/refs --table-list-predicate "
+not exists (
+    select 1
+      from information_schema.columns col
+     where col.table_schema = n.nspname
+       and col.table_name = c.relname
+       and col.column_name in ('app_id', 'customer_id', 'customerid')
+)"
+```
+
+Tables must have a primary key. Tables without a PK are skipped with a warning.
+
+## marking tables
+
+When using `--comment-label`, add a comment on the table (via `COMMENT ON TABLE`):
+
+```
+synchronized directory
+```
+
+With a custom label:
+
+```
+global directory
+```
+
+Optional clause in parentheses:
+
+- if it contains the word `select` — a full export query, for example:
+
+```
+synchronized directory(select id, name from my_schema.my_table order by name)
+```
+
+- otherwise — a `WHERE` filter inserted into the default template:
+
+```
+synchronized directory(not is_deleted)
+```
+
+→ `select * from <schema>.<table> where not is_deleted order by <primary key columns>`
+
+If parentheses are omitted, export uses:
+
+```
+select * from <schema>.<table> order by <primary key columns>
+```
+
+Exported file layout: `<out-dir>/<schema>/<table>.yaml`
+
+Each file is a YAML list of row mappings. Row and field order match the query result.
+
+## usage
+
+### export
+
+```
+usage: pg_data_yaml export [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                             (--comment-label LABEL | --table-list-predicate PREDICATE)
+                             --out-dir OUT_DIR [--clean]
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+                        database name to connect to
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --out-dir OUT_DIR     directory for exporting files
+  --clean               clean out_dir if not empty (env variable DATA_DIRECTORY_AUTOCLEAN=true)
+```
+
+### diff
+
+```
+usage: pg_data_yaml diff [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                           (--comment-label LABEL | --table-list-predicate PREDICATE)
+                           --source SOURCE
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --source SOURCE       directory or yaml file to compare with the database
+```
+
+### sync
+
+```
+usage: pg_data_yaml sync [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                           (--comment-label LABEL | --table-list-predicate PREDICATE)
+                           --source SOURCE [--dry-run] [--echo-queries] [-y]
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --source SOURCE       directory or yaml file to sync to the database
+  --dry-run             test run without real changes
+  --echo-queries        echo commands sent to server
+  -y, --yes             do not ask confirm
+```
+
+### merge-envs
+
+Move table files that are identical in all given environment directories into a shared base directory and remove them from the environment directories.
+
+```
+usage: pg_data_yaml merge-envs [--help] --source ENV_DIR [--source ENV_DIR ...] --out-dir OUT_DIR [--dry-run]
+
+options:
+  --help                show this help message and exit
+  --source ENV_DIR      environment directory (repeat for each env)
+  --out-dir OUT_DIR     base directory for common table files
+  --dry-run             show actions without changing files
+```
+
+Example layout after merge:
+
+```
+refs/
+  base/public/countries.yaml   # identical in all envs
+  dev/public/special.yaml      # env-specific
+  prod/public/special.yaml
+```
+
+## examples
+
+Comment label for synchronized reference data:
+
+```
+$ pg_data_yaml export -d my_database -h 127.0.0.1 -p 5432 -U postgres \
+    --out-dir /tmp/refs/ --comment-label "synchronized directory"
+```
+
+Comment label for per-environment data:
+
+```
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/base --comment-label "global directory"
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/dev --comment-label "env directory"
+```
+
+Predicate-based selection:
+
+```
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/ --table-list-predicate "
+not exists (
+    select 1 from information_schema.columns col
+     where col.table_schema = n.nspname
+       and col.table_name = c.relname
+       and col.column_name in ('app_id', 'customer_id', 'customerid')
+)"
+```
+
+Diff and sync use the same table selection options as export:
+
+```
+$ pg_data_yaml merge-envs --source /tmp/refs/dev --source /tmp/refs/prod --out-dir /tmp/refs/base
+$ pg_data_yaml diff -d my_database -h 127.0.0.1 -p 5432 -U postgres --source /tmp/refs/ --comment-label "global directory"
+$ pg_data_yaml sync -d my_database -h 127.0.0.1 -p 5432 -U postgres \
+    --source /tmp/refs/ --comment-label "synchronized directory"
+$ pg_data_yaml diff -d my_database -h 127.0.0.1 -p 5432 -U postgres --source /tmp/refs/public/countries.yaml
+```
+
+When syncing a directory, a missing yaml file for an included table is treated as an empty table (rows are deleted). When syncing a single file, only that table is compared and updated.

pg_data_yaml-0.0.0/README.md

@@ -0,0 +1,220 @@
+## pg-data-yaml — Yaml interface for reference tables in PostgreSQL
+
+Export, diff and sync rows of reference tables in PostgreSQL to YAML files in a repository.
+
+## installation
+
+```
+pip install pg-data-yaml
+```
+
+## which tables are included
+
+Table selection is configured with `--comment-label` or `--table-list-predicate`. One of these options is **required** for `export`, `diff` and `sync` (mutually exclusive).
+
+### `--comment-label LABEL`
+
+Include tables whose comment contains `LABEL`. Any label can be used, for example `global directory` or `env directory`.
+
+Optional clause in parentheses after the label is parsed from the comment (see [marking tables](#marking-tables) below).
+
+```
+pg_data_yaml export -d mydb --out-dir /tmp/refs --comment-label "global directory"
+```
+
+### `--table-list-predicate PREDICATE`
+
+Include tables matching a SQL predicate. Table comments are ignored; export always uses `select * from <schema>.<table> order by <primary key columns>`.
+
+The predicate is inserted into a query against `pg_catalog.pg_class` and `pg_catalog.pg_namespace`. Use `n.nspname` for schema name and `c.relname` for table name.
+
+Example — tables without tenant columns:
+
+```
+pg_data_yaml export -d mydb --out-dir /tmp/refs --table-list-predicate "
+not exists (
+    select 1
+      from information_schema.columns col
+     where col.table_schema = n.nspname
+       and col.table_name = c.relname
+       and col.column_name in ('app_id', 'customer_id', 'customerid')
+)"
+```
+
+Tables must have a primary key. Tables without a PK are skipped with a warning.
+
+## marking tables
+
+When using `--comment-label`, add a comment on the table (via `COMMENT ON TABLE`):
+
+```
+synchronized directory
+```
+
+With a custom label:
+
+```
+global directory
+```
+
+Optional clause in parentheses:
+
+- if it contains the word `select` — a full export query, for example:
+
+```
+synchronized directory(select id, name from my_schema.my_table order by name)
+```
+
+- otherwise — a `WHERE` filter inserted into the default template:
+
+```
+synchronized directory(not is_deleted)
+```
+
+→ `select * from <schema>.<table> where not is_deleted order by <primary key columns>`
+
+If parentheses are omitted, export uses:
+
+```
+select * from <schema>.<table> order by <primary key columns>
+```
+
+Exported file layout: `<out-dir>/<schema>/<table>.yaml`
+
+Each file is a YAML list of row mappings. Row and field order match the query result.
+
+## usage
+
+### export
+
+```
+usage: pg_data_yaml export [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                             (--comment-label LABEL | --table-list-predicate PREDICATE)
+                             --out-dir OUT_DIR [--clean]
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+                        database name to connect to
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --out-dir OUT_DIR     directory for exporting files
+  --clean               clean out_dir if not empty (env variable DATA_DIRECTORY_AUTOCLEAN=true)
+```
+
+### diff
+
+```
+usage: pg_data_yaml diff [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                           (--comment-label LABEL | --table-list-predicate PREDICATE)
+                           --source SOURCE
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --source SOURCE       directory or yaml file to compare with the database
+```
+
+### sync
+
+```
+usage: pg_data_yaml sync [--help] [-d DBNAME] [-h HOST] [-p PORT] [-U USER] [-W PASSWORD]
+                           (--comment-label LABEL | --table-list-predicate PREDICATE)
+                           --source SOURCE [--dry-run] [--echo-queries] [-y]
+
+options:
+  --help                show this help message and exit
+  -d DBNAME, --dbname DBNAME
+  -h HOST, --host HOST  database server host or socket directory
+  -p PORT, --port PORT  database server port
+  -U USER, --user USER  database user name
+  -W PASSWORD, --password PASSWORD
+                        database user password
+  --comment-label LABEL
+                        include tables whose comment contains LABEL
+  --table-list-predicate PREDICATE
+                        include tables matching SQL PREDICATE (comments ignored)
+  --source SOURCE       directory or yaml file to sync to the database
+  --dry-run             test run without real changes
+  --echo-queries        echo commands sent to server
+  -y, --yes             do not ask confirm
+```
+
+### merge-envs
+
+Move table files that are identical in all given environment directories into a shared base directory and remove them from the environment directories.
+
+```
+usage: pg_data_yaml merge-envs [--help] --source ENV_DIR [--source ENV_DIR ...] --out-dir OUT_DIR [--dry-run]
+
+options:
+  --help                show this help message and exit
+  --source ENV_DIR      environment directory (repeat for each env)
+  --out-dir OUT_DIR     base directory for common table files
+  --dry-run             show actions without changing files
+```
+
+Example layout after merge:
+
+```
+refs/
+  base/public/countries.yaml   # identical in all envs
+  dev/public/special.yaml      # env-specific
+  prod/public/special.yaml
+```
+
+## examples
+
+Comment label for synchronized reference data:
+
+```
+$ pg_data_yaml export -d my_database -h 127.0.0.1 -p 5432 -U postgres \
+    --out-dir /tmp/refs/ --comment-label "synchronized directory"
+```
+
+Comment label for per-environment data:
+
+```
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/base --comment-label "global directory"
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/dev --comment-label "env directory"
+```
+
+Predicate-based selection:
+
+```
+$ pg_data_yaml export -d my_database --out-dir /tmp/refs/ --table-list-predicate "
+not exists (
+    select 1 from information_schema.columns col
+     where col.table_schema = n.nspname
+       and col.table_name = c.relname
+       and col.column_name in ('app_id', 'customer_id', 'customerid')
+)"
+```
+
+Diff and sync use the same table selection options as export:
+
+```
+$ pg_data_yaml merge-envs --source /tmp/refs/dev --source /tmp/refs/prod --out-dir /tmp/refs/base
+$ pg_data_yaml diff -d my_database -h 127.0.0.1 -p 5432 -U postgres --source /tmp/refs/ --comment-label "global directory"
+$ pg_data_yaml sync -d my_database -h 127.0.0.1 -p 5432 -U postgres \
+    --source /tmp/refs/ --comment-label "synchronized directory"
+$ pg_data_yaml diff -d my_database -h 127.0.0.1 -p 5432 -U postgres --source /tmp/refs/public/countries.yaml
+```
+
+When syncing a directory, a missing yaml file for an included table is treated as an empty table (rows are deleted). When syncing a single file, only that table is compared and updated.

pg_data_yaml-0.0.0/pg_data_yaml/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.0'

pg_data_yaml-0.0.0/pg_data_yaml/analyze_envs.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+import argparse
+import os
+import sys
+
+import yaml
+
+from .paths import list_table_yaml_files
+
+
+class AnalyzeEnvs:
+    def __init__(self, args: argparse.Namespace):
+        self.args = args
+        self.sources = [os.path.abspath(path) for path in args.source]
+
+    def run(self) -> None:
+        self._validate()
+        synchronized_directories = open('/tmp/synchronized_directory.txt').read().split('\n')
+        env_files = [list_table_yaml_files(path) for path in self.sources]
+        all_paths = set.union(*[set(files) for files in env_files])
+        if not all_paths:
+            print('Nothing to analyze: no table files across environments')
+            return
+
+        for rel_path in sorted(all_paths):
+            lines = {}
+            postfix = ''
+            for env in self.sources:
+                file_path = os.path.join(env, rel_path)
+                if os.path.isfile(file_path):
+                    for line in yaml.safe_load(open(file_path)):
+                        line = str(line)
+                        lines[line] = lines.get(line, 0) + 1
+                else:
+                    postfix = '*'
+            identical_lines = sum(1 for count in lines.values() if count == len(self.sources))
+            table = self.path_to_table_name(rel_path)
+            sync_dir = "да" if table in synchronized_directories else ''
+            print(f'{table}\t{identical_lines}/{len(lines) - identical_lines}{postfix}\t{sync_dir}')
+
+    # def run_base(self) -> None:
+    #     synchronized_directories=open('/tmp/synchronized_directory.txt').read().split('\n')
+    #     env_files = [list_table_yaml_files(path) for path in self.sources]
+    #     all_paths = set.union(*[set(files) for files in env_files])
+    #     if not all_paths:
+    #         print('Nothing to analyze: no table files across environments')
+    #         return
+
+    #     for rel_path in sorted(all_paths):
+    #         env = self.sources[0]
+    #         file_path = os.path.join(env, rel_path)
+    #         lines_count = len(yaml.safe_load(open(file_path)))
+    #         table = self.path_to_table_name(rel_path)
+    #         sync_dir="да" if table in synchronized_directories else ''
+    #         print(f'{table}\t{lines_count}/0\t{sync_dir}')
+
+    def _validate(self) -> None:
+        if len(self.sources) < 2:
+            print('ERROR: specify at least two --source directories', file=sys.stderr)
+            sys.exit(1)
+
+        seen = set()
+        for path in self.sources:
+            if path in seen:
+                print(f'ERROR: duplicate source directory: {path}', file=sys.stderr)
+                sys.exit(1)
+            seen.add(path)
+            if not os.path.isdir(path):
+                print(f'ERROR: source directory not found: {path}', file=sys.stderr)
+                sys.exit(1)
+
+    @staticmethod
+    def path_to_table_name(path: str) -> str:
+        return '{}.{}'.format(*path[:-5].split('/'))

pg_data_yaml-0.0.0/pg_data_yaml/extractor.py

@@ -0,0 +1,46 @@
+import argparse
+import os
+
+from .formatter import Formatter
+from .pg import Pg
+from .registry import SyncTable, TableRegistry
+from .values import ordered_row
+
+
+class Extractor:
+    ROWS_LIMIT = 50000
+
+    def __init__(self, args: argparse.Namespace, pg: Pg):
+        self.args = args
+        self.pg = pg
+        self.registry = TableRegistry.from_args(pg, args)
+        self.formatter = Formatter()
+
+    async def export(self) -> None:
+        tables = await self.registry.load()
+        for sync_table in tables.values():
+            rows_count = await self.get_rows_count(sync_table)
+            if rows_count == self.ROWS_LIMIT:
+                print(f'Table {sync_table.table} has {rows_count} rows, skipping')
+                continue
+            rows = await self.fetch_rows(sync_table)
+            file_name = sync_table.file_path(self.args.out_dir)
+            os.makedirs(os.path.dirname(file_name), exist_ok=True)
+            self.formatter.dump(rows, file_name)
+
+    async def fetch_rows(self, sync_table: SyncTable) -> list[dict]:
+        rows = await self.pg.fetch(sync_table.select_query())
+        return [ordered_row(row) for row in rows]
+
+    async def get_rows_count(self, sync_table: SyncTable) -> list[dict]:
+        query = sync_table.select_query()
+        query = f'select count(*) from ({query} limit {self.ROWS_LIMIT}) as t'
+        rows = await self.pg.fetch(query)
+        return rows[0]['count']
+
+    async def get_tables_data(self) -> dict[tuple[str, str], list[dict]]:
+        tables = await self.registry.load()
+        return {
+            key: await self.fetch_rows(sync_table)
+            for key, sync_table in tables.items()
+        }

pg_data_yaml-0.0.0/pg_data_yaml/formatter.py

@@ -0,0 +1,49 @@
+import re
+from typing import Any
+
+import yaml
+
+_INTERVAL_STR_RE = re.compile(r'^-?(\d+ days? )?\d+:\d{2}:\d{2}$')
+
+
+class Formatter:
+    _representers_registered = False
+
+    def __init__(self):
+        self._register_representers()
+
+    @classmethod
+    def _register_representers(cls):
+        if cls._representers_registered:
+            return
+
+        def str_presenter(dumper, data):
+            if '\n' in data:
+                return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
+            if _INTERVAL_STR_RE.fullmatch(data):
+                return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='')
+            return dumper.represent_scalar('tag:yaml.org,2002:str', data)
+
+        yaml.add_representer(str, str_presenter)
+        cls._representers_registered = True
+
+    @staticmethod
+    def dump(data: Any, file_name: str = None):
+        Formatter._register_representers()
+        if data is None:
+            return ''
+        file = None
+        if file_name:
+            file = open(file_name, 'w')
+        return yaml.dump(
+            data,
+            file,
+            allow_unicode=True,
+            sort_keys=False,
+            width=float('inf'),
+        )
+
+    @staticmethod
+    def load(file_name: str) -> Any:
+        with open(file_name) as file:
+            return yaml.safe_load(file)