Add parser of "dim.json" file and type checker with pyright

.github/workflows/test.yml

@@ -55,7 +55,9 @@ jobs:
         run: poetry install --no-interaction --no-root --with test
 
       - name: Linting Python codes
-        run: poetry run flake8 dim
+        run: |
+          poetry run pflake8 dim
+          poetry run pyright --warnings
 
       - name: run quality check tests
         run: poetry run pytest

dim/__init__.py

@@ -2,3 +2,4 @@
 # -*- coding: utf-8 -*-
 
 from dim.__version__ import __version__  # noqa: F401
+from dim.locker.locker import Locker  # noqa: F401

dim/__version__.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

dim/locker/_dim_json.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from typing import Dict, List, Optional
+from dataclasses import dataclass, field
+from dataclasses_json import DataClassJsonMixin
+
+
+@dataclass
+class _DimJsonContent(DataClassJsonMixin):
+    """Dataclass to parse the contents of dim.json file.
+
+    Args:
+        name: dataset title
+        url (optional): URL to retrieve the dataset
+        catalogUrl (optional): URL if dataset is available in CKAN
+        catalogResourceId (optional): dataset ID if dataset is available in CKAN
+        headers (optional): headers of the dataset
+
+    Note:
+        URL of CKAN is https://www.geospatial.jp/ckan/
+    """
+    name: str
+    url: Optional[str] = field(default=None)
+    catalogUrl: Optional[str] = field(default=None)
+    catalogResourceId: Optional[str] = field(default=None)
+    postProcesses: List[str] = field(default_factory=list)
+    headers: Dict[str, str] = field(default_factory=dict)
+
+
+@dataclass
+class _DimJson(DataClassJsonMixin):
+    """Dataclass to parse dim.json file.
+
+    Args:
+        fileVersion: version number of dim.json file structure, fixed to '1.1' at this time.
+        contents: list of database definitions
+    """
+    fileVersion: str = field(init=False)
+    contents: List[_DimJsonContent] = field(default_factory=list)
+
+    def __post_init__(self):
+        self.fileVersion = "1.1"

dim/locker/locker.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+import json
+from pathlib import Path
+from typing import Any
+from typing_extensions import Self
+from dim.locker._dim_json import _DimJson
+
+
+class Locker(object):
+    """Class to parse dim.json and write dim-lock.json file.
+
+    Args:
+        directory: directory which has dim.json to parse
+        create_if_missing (optional): True (create {directory}/dim.json if not exist) or False (default)
+
+    Raises:
+        FileNotFoundError: {errors} is not "raise" and {directory}/dim.json does not exist
+    """
+
+    def __init__(self, directory: str, create_if_missing: bool = False) -> None:
+        self._dim_json_path = Path(directory) / "dim.json"
+        if self._dim_json_path.exists():
+            self._read_dim_json()
+        elif create_if_missing:
+            self._write_empty_dim_json()
+        else:
+            raise FileNotFoundError(f"dim.json not found in {directory=}")
+
+    def __eq__(self, other: Self) -> bool:
+        return self.defined == other.defined
+
+    @property
+    def defined(self) -> dict[str, Any]:
+        """Parameter values defined by dim.json file.
+        """
+        return self._dim_json.to_dict()
+
+    def _read_dim_json(self) -> None:
+        """Read {directory}/dim.json file.
+        """
+        self._dim_json_path.parent.mkdir(exist_ok=True)
+        with self._dim_json_path.open("r") as fh:
+            content = json.load(fh)
+        self._dim_json = _DimJson.from_dict(content)
+
+    def _write_empty_dim_json(self) -> None:
+        """Write empty {directory}/dim.json file.
+        """
+        self._dim_json = _DimJson()
+        with self._dim_json_path.open("w") as fh:
+            json.dump(self._dim_json.to_dict(), fh, indent=4)
+
+    def run(self) -> Self:
+        """Run locking and write dim-lock.json.
+
+        Raises:
+            NotImplementedError: implemented later
+        """
+        raise NotImplementedError

pyproject.toml

@@ -20,13 +20,16 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
+dataclasses-json = "^0.5.7"
+typing-extensions = "^4.4.0"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^7.1.3"
 pytest-cov = "^4.0.0"
 flake8 = "^5.0.4"
 autopep8 = "^1.7.0"
 pyproject-flake8 = "^5.0.4.post1"
+pyright = "^1.1.274"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
@@ -38,3 +41,6 @@ extend-ignore = ["E501"]
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 filterwarnings = ["error"]
+
+[tool.pyright]
+include = ["dim"]