anoy 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

anoy-0.1.3.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: anoy
+Version: 0.1.3
+Summary: This is a library that provides simple type checking for YAML.
+Author-email: masaniki <masaniki.software@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/masaniki/annotation-yaml
+Project-URL: Documentation, https://github.com/masaniki/annotation-yaml/tree/master/docs
+Project-URL: Issues, https://github.com/masaniki/annotation-yaml/issues
+Keywords: text,YAML,CLI,type,check
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Natural Language :: Japanese
+Classifier: Natural Language :: English
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: PyYAML
+Dynamic: license-file
+
+# Index
+
+- **English Document**
+
+  English Document <- Here
+
+- **Japanese Document**
+
+  [Japanese Document](docs/README_JP.md)
+
+- **Annotation YAML(ANOY)**
+
+  A YAML file that allows type checking for Map types.
+
+  More about [ANOY](about_anoy.md)
+
+- **Configuration YAML(Config YAML)**
+
+  A YAML file that defines the data types usable in Annotation YAML.
+
+  More about [Config YAML](about_config.md)
+
+- **ANOY CLI**
+  
+  A CLI application that verifies whether Annotation YAML adheres to the data type defined in Configuration YAML.
+
+  More about [ANOY CLI](about_anoycli.md)
+
+# Introduction
+
+YAML maps often become nested and complex.
+
+And these requests have come up.
+
+- Detecting typos in map keys.
+- Verifying the data type of map values.
+- Ensuring the map's nested structure is appropriate.
+
+This library satisfies these requests.
+
+# Installing
+
+`pip install anoy`
+
+## Package Dependencies
+
+The following packages may not work properly if they are not installed:
+
+- [PyYAML](https://pypi.org/project/PyYAML/): Most popular YAML parser for Python.
+
+# Usage
+
+library_config.yaml
+
+```
+"@Books":
+  "@Summary": List the book titles.
+  "!ChildValue": FreeDict
+"@Author":
+  "@Summary": Author of the book.
+  "!ChildValue": Str
+"@PublishYear":
+  "@Summary": The year of the publishment.
+  "!ChildValue": Int
+"@Country":
+  "@Summary": The author's native language.
+  "!ChildValue": Str
+```
+
+valid_library.yaml:
+
+```
+"@Books":
+  "Alice's Adventures in Wonderland":
+    "@Author": Lewis Carroll
+    "@PublishYear": 1865
+    "@Country": UK
+  "The Little Prince":
+    "@Author": Antonie de Saint-Exupéry
+    "@PublishYear": 1945
+    "@Country": France
+  "Harry Potter":
+    "@Author": J.K.Rowling
+    "@PublishYear": 1997
+    "@Country": UK
+```
+
+Use the `anoy` command to verify data types.
+
+If data type issues are not found, it outputs nothing.
+
+```
+>>> anoy library_config.yaml library.yaml
+>>> 
+```
+
+If you mistyped `@Auther` as `@Auther`.
+
+invalid_library.yaml:
+
+```
+"@Books":
+  "Alice's Adventures in Wonderland":
+    "@Auther": Lewis Carroll
+    "@PublishYear": 1865
+    "@Country": UK
+  "The Little Prince":
+    "@Auther": Antonie de Saint-Exupéry
+    "@PublishYear": 1945
+    "@Country": France
+  "Harry Potter":
+    "@Auther": J.K.Rowling
+    "@PublishYear": 1997
+    "@Country": UK
+```
+
+When there is an issue with the annotation YAML, `anoy` outputs as follows.
+
+```
+>>> anoy library_config.yaml library.yaml
+>>> Traceback (most recent call last):
+    ... (omission) ...
+    src.anoyModule.anoyErrors.ConfigurationYamlError: `@Auther` is not defined.
+```
+# For Developpers
+
+## Testing
+
+This project uses `pytest`.
+
+If you want to test, put in following command.
+
+`pytest tests\unit\test_dictTraversal.py`

anoy-0.1.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+cli.py,sha256=MtIL8GzwIX4aAY-gSFQpQBNTrc7N6nAm3fNduRyLGsk,915
+anoy-0.1.3.dist-info/licenses/LICENSE.txt,sha256=nsHvySI1U7YZgAX4K3rJsWli_GfXy2syPI-MtGPwjlo,1062
+anoyModule/__init__.py,sha256=5IrwCaYeugSDOmdYH4DMHqqeIQw86-Vkn46s29JZSww,138
+anoyModule/anoyErrors.py,sha256=QvjhIVhSGMO5YMHxMmTw4LxtwwUWd4H8dxHDnbckawU,676
+anoyModule/dictTraversal.py,sha256=yovTO6BAtxh2WwWgzmLK23IDY8HBkdfbx2WJo4Dl9zY,9086
+anoy-0.1.3.dist-info/METADATA,sha256=ZOawgugs08QQMVK-S-sSycxQzXvoiRQ_r9CjNTNdOo0,3664
+anoy-0.1.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+anoy-0.1.3.dist-info/entry_points.txt,sha256=_lpL6R97giGseZcV0r5QwdX4zRwoZLzRHUxyBZl_iYI,34
+anoy-0.1.3.dist-info/top_level.txt,sha256=QExj2OlPPcJU_7B1gwNcL2iYOcgYJBpDZsUArRCaXJw,15
+anoy-0.1.3.dist-info/RECORD,,

anoy-0.1.3.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+anoyModule
+cli

anoyModule/__init__.py

@@ -0,0 +1,3 @@
+
+from .dictTraversal import DictTraversal
+from .anoyErrors import AnnotationYamlError, AnnotationYamlTypeError, ConfigurationYamlError

anoyError.py → anoyModule/anoyErrors.py

@@ -11,14 +11,14 @@ class AnnotationYamlTypeError(Exception):
   """
   @Summ: annotation yaml上のdata型のError。
   """
-  def __init__(self,type:str,path:list):
+  def __init__(self,fileName:str,type:str,path:list):
     super().__init__()
+    self.fileName=fileName
     self.type=type
     self.path=path
   
   def __str__(self):
-    return f"required {self.type} type at:\n    {self.path}"
-
+    return f"required {self.type} type at:\n    {self.fileName}: {self.path}"
 
 class ConfigurationYamlError(Exception):
   """

dictTraversal.py → anoyModule/dictTraversal.py

@@ -1,6 +1,7 @@
 import yaml
+from pathlib import Path
 
-from .anoyError import AnnotationYamlError,ConfigurationYamlError,AnnotationYamlTypeError
+from .anoyErrors import AnnotationYamlError,ConfigurationYamlError,AnnotationYamlTypeError
 
 class DictTraversal():
     """
@@ -24,6 +25,10 @@ class DictTraversal():
             - visitQueueと要素番号を共有する。
             - []でroot要素を表す。
             @Type: List
+        _curAnoy:
+            @Summ: 現在探索中のANOY file.
+            @ComeFrom: current ANOY.
+            @Type: Str
     """
     def __init__(self,configDict:dict):
         """
@@ -33,10 +38,37 @@ class DictTraversal():
         self._visitQueue=[]
         self._pathQueue=[]
         self._configVisit={key:False for key in configDict.keys()}
+        self._curAnoy=""
 
-    def startBFS(self,anoyDict:dict):
+
+    def dirDFS(self,anoyPath:Path):
+        """
+        @Summ: directory内を深さ優先探索する関数。
+
+        @Desc:
+        - fileならばYAMLかどうかを確認して、内部のdict型を探索する。
+        - directoryならば、子要素を再帰的に探索する。
+
+        @Args:
+          anoyPath:
+            @Summ: 探索するfileやdirectoryのpath名。
+            @Type: Path
+        """
+        if(anoyPath.is_file()):
+            suffix=anoyPath.suffix
+            if(suffix==".yaml" or suffix==".yml" or suffix==".anoy"):
+                with open(anoyPath, mode="r", encoding="utf-8") as f:
+                    anoyDict=yaml.safe_load(f)
+                self._curAnoy=anoyPath
+                self.dictBFS(anoyDict)
+        else:
+            for childPath in anoyPath.iterdir():
+                self.dirDFS(childPath)
+
+
+    def dictBFS(self,anoyDict:dict):
         """
-        @Summ: 幅優先探索を開始する関数。
+        @Summ: anoyDictの中を幅優先探索を開始する関数。
 
         @Desc:
         - list型は単純に探索する。
@@ -54,8 +86,8 @@ class DictTraversal():
                 break
             key,value=self._visitQueue.pop(0)
             pathList=self._pathQueue.pop(0)
-            print(key,value)
-            print(pathList)
+            # print(key,value)
+            # print(pathList)
             self.typeCheck(key,value,pathList)
 
     def typeCheck(self,parentKey:str|None,childValue,path:list):
@@ -114,27 +146,27 @@ class DictTraversal():
             for i in range(len(confValueList)):
                 if(childValue==confValueList[i]):
                     return
-            raise AnnotationYamlTypeError("Enum",path)
+            raise AnnotationYamlTypeError(str(self._curAnoy),"Enum",path)
         elif(type(childValue)==bool):
             if((confChildVal is None) or confChildVal=="Bool"):
                 return
             else:
-                raise AnnotationYamlTypeError("Bool",path)
+                raise AnnotationYamlTypeError(str(self._curAnoy),"Bool",path)
         elif(type(childValue)==str):
             if((confChildVal is None or confChildVal=="Str")):
                 return
             else:
-                raise AnnotationYamlTypeError("Str",path)
+                raise AnnotationYamlTypeError(str(self._curAnoy),type="Str",path=path)
         elif(type(childValue)==int):
             if((confChildVal is None) or confChildVal=="Int"):
                 return
             else:
-                raise AnnotationYamlTypeError("Int",path)
+                raise AnnotationYamlTypeError(str(self._curAnoy),"Int",path)
         elif(type(childValue)==float):
             if((confChildVal is None) or confChildVal=="Float"):
                 return
             else:
-                raise AnnotationYamlTypeError("Float",path)
+                raise AnnotationYamlTypeError(str(self._curAnoy),"Float",path)
         elif(type(childValue)==list):
             if((confChildVal is None) or confChildVal=="List"):
                 for i in range(len(childValue)):
@@ -143,7 +175,7 @@ class DictTraversal():
                     self._pathQueue.append(newPath)
                 return
             else:
-                raise AnnotationYamlTypeError("List",path)
+                raise AnnotationYamlTypeError(str(self._curAnoy),"List",path)
         elif(type(childValue)==dict):
             if(confChildVal is None):
                 for key,childValue in childValue.items():
@@ -157,7 +189,7 @@ class DictTraversal():
                     self._visitQueue.append((key,childValue))
                     self._pathQueue.append(newPath)
                     if(key[0]=="@"):
-                        raise AnnotationYamlTypeError("FreeDict",path)
+                        raise AnnotationYamlTypeError(str(self._curAnoy),"FreeDict",path)
                 return
             elif(confChildVal=="AnnoDict"):
                 for key,childValue in childValue.items():
@@ -166,14 +198,14 @@ class DictTraversal():
                     self._pathQueue.append(newPath)
                     confParent=self._configDict[key].get("!ParentKey")
                     if(key[0]!="@"):
-                        raise AnnotationYamlTypeError("AnnoDict",path)
+                        raise AnnotationYamlTypeError(str(self._curAnoy),"AnnoDict",path)
                     if(confParent is None):
                         pass
                     elif(parentKey not in confParent):
-                        raise AnnotationYamlTypeError("AnnoDict",path)
+                        raise AnnotationYamlTypeError(str(self._curAnoy),"AnnoDict",path)
                 return
         else:
-            raise AnnotationYamlError(f" invalid value is found at:\n    `{path}`.")
+            raise AnnotationYamlError(f" invalid value is found at:\n    {str(self._curAnoy)}: `{path}`.")
 
 if(__name__=="__main__"):
     configPath=r"C:\Users\tomot\Backup\sourcecode\python\projects\annotation_yaml\tests\unit\case01\config01.yaml"
@@ -183,5 +215,5 @@ if(__name__=="__main__"):
     with open(anoyPath,mode="r",encoding="utf-8") as f:
         anoyDict=yaml.safe_load(f)
     tree01=DictTraversal(configDict)
-    tree01.startBFS(anoyDict)
+    tree01.dictBFS(anoyDict)
 

cli.py

@@ -3,9 +3,9 @@ from pathlib import Path
 import argparse
 import yaml
 
-from dictTraversal import DictTraversal
+from anoyModule import DictTraversal
 
-VERSION="v0.1.1"
+VERSION="v0.1.3"
 
 def main():
     """
@@ -21,11 +21,9 @@ def main():
     anoyPath=Path(args.anoy)
     with open(configPath,mode="r",encoding="utf-8") as f:
         configDict=yaml.safe_load(f)
-    with open(anoyPath,mode="r",encoding="utf-8") as f:
-        anoyDict=yaml.safe_load(f)
-    print("loadEnd")
     tree01=DictTraversal(configDict)
-    tree01.startBFS(anoyDict)
+    # configのload終了。
+    tree01.dirDFS(anoyPath)
 
 if(__name__=="__main__"):
     main()

anoy-0.1.1.dist-info/METADATA

@@ -1,42 +0,0 @@
-Metadata-Version: 2.4
-Name: anoy
-Version: 0.1.1
-Summary: This is a library that provides simple type checking for YAML.
-Author-email: masaniki <masaniki.software@gmail.com>
-License-Expression: MIT
-Project-URL: Repository, https://github.com/masaniki/annotation-yaml
-Project-URL: Documentation, https://github.com/masaniki/annotation-yaml/tree/master/docs
-Project-URL: Issues, https://github.com/masaniki/annotation-yaml/issues
-Keywords: text,YAML,CLI,type,check
-Classifier: Development Status :: 1 - Planning
-Classifier: Environment :: Console
-Classifier: Natural Language :: Japanese
-Classifier: Natural Language :: English
-Classifier: Topic :: Text Processing
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: PyYAML
-Dynamic: license-file
-
-# fileの説明
-# 原文
-[Original README](docs/README_JP.md)
-
-## /docs
-documentを格納するdirecotry.
-
-## /src
-ここでmoduleを開発する。
-
-## testUnit
-単体testを行うdirectory。
-
-## testSystem
-結合testを行うdirectory。
-
-## sanbox.py
-pythonの挙動を確認する。
-
-
-

anoy-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-anoyError.py,sha256=4smZo02X8YOv407FRyc12ADXW8foNrFr0pv0pRoQUxo,620
-cli.py,sha256=1NdYRb7UFGEctKSRCyh5UOlxM3UGLwVequtkybgYZoA,1005
-dictTraversal.py,sha256=KI4YH_XwUmydF-29-kasUbkOLqc6fthBdEavYsc9H8I,7794
-anoy-0.1.1.dist-info/licenses/LICENSE.txt,sha256=nsHvySI1U7YZgAX4K3rJsWli_GfXy2syPI-MtGPwjlo,1062
-anoy-0.1.1.dist-info/METADATA,sha256=jk0XCGbGl8vmc35RN937a_On9DzAgPNeoN3vELjV3PA,1130
-anoy-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-anoy-0.1.1.dist-info/entry_points.txt,sha256=_lpL6R97giGseZcV0r5QwdX4zRwoZLzRHUxyBZl_iYI,34
-anoy-0.1.1.dist-info/top_level.txt,sha256=Ml0_35nDdV_uFyw0sUsvSho29qLH9ppoSOUQKuInsA4,28
-anoy-0.1.1.dist-info/RECORD,,

anoy-0.1.1.dist-info/top_level.txt

@@ -1,3 +0,0 @@
-anoyError
-cli
-dictTraversal