anoy 0.1.0__tar.gz

anoy-0.1.0/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2026 masaniki.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

anoy-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: anoy
+Version: 0.1.0
+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.0/README.md

@@ -0,0 +1,21 @@
+# fileの説明
+# 原文
+[Original README](docs/README_JP.md)
+
+## /docs
+documentを格納するdirecotry.
+
+## /src
+ここでmoduleを開発する。
+
+## testUnit
+単体testを行うdirectory。
+
+## testSystem
+結合testを行うdirectory。
+
+## sanbox.py
+pythonの挙動を確認する。
+
+
+

anoy-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+# 変数の詳細は<>の中に記述する。
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "anoy"
+version = "0.1.0"
+authors = [
+  { name="masaniki", email="masaniki.software@gmail.com" }
+]
+description = "This is a library that provides simple type checking for YAML."
+dependencies = ["PyYAML"]
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "Environment :: Console",
+  "Natural Language :: Japanese",
+  "Natural Language :: English",
+  "Topic :: Text Processing"
+]
+license = "MIT"
+license-files = ["LICENSE.txt"]
+keywords = ["text", "YAML", "CLI", "type", "check"]
+
+[project.scripts]
+anoy = "cli:main"
+
+[project.urls]
+Repository = "https://github.com/masaniki/annotation-yaml"
+Documentation = "https://github.com/masaniki/annotation-yaml/tree/master/docs"
+Issues = "https://github.com/masaniki/annotation-yaml/issues"

anoy-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

anoy-0.1.0/src/anoy.egg-info/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: anoy
+Version: 0.1.0
+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.0/src/anoy.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/anoyError.py
+src/cli.py
+src/dictTraversal.py
+src/anoy.egg-info/PKG-INFO
+src/anoy.egg-info/SOURCES.txt
+src/anoy.egg-info/dependency_links.txt
+src/anoy.egg-info/entry_points.txt
+src/anoy.egg-info/requires.txt
+src/anoy.egg-info/top_level.txt

anoy-0.1.0/src/anoy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

anoy-0.1.0/src/anoy.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+anoy = cli:main

anoy-0.1.0/src/anoy.egg-info/requires.txt

@@ -0,0 +1 @@
+PyYAML

anoy-0.1.0/src/anoy.egg-info/top_level.txt

@@ -0,0 +1,4 @@
+anoyError
+cli
+dictTraversal
+unused

anoy-0.1.0/src/anoyError.py

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

anoy-0.1.0/src/cli.py

@@ -0,0 +1,32 @@
+import sys
+from pathlib import Path
+import argparse
+import yaml
+
+from .dictTraversal import DictTraversal
+
+VERSION="v0.1.0"
+
+def main():
+    """
+    "@Summ": CLIを処理するmain関数。
+    "@Desc": 引数は標準入力から渡される。
+    """
+    parser=argparse.ArgumentParser(prog="PROG")
+    parser.add_argument("-v","--version", action="version", version=f"anoy {VERSION}")
+    parser.add_argument("config", type=str, default=None, help="Put in configuration yaml.")
+    parser.add_argument("anoy", type=str, default=None, help="Put in annotation yaml.")
+    args=parser.parse_args()
+    configPath=Path(args.config)
+    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)
+
+if(__name__=="__main__"):
+    main()
+

anoy-0.1.0/src/dictTraversal.py

@@ -0,0 +1,187 @@
+import yaml
+
+from .anoyError import AnnotationYamlError,ConfigurationYamlError,AnnotationYamlTypeError
+
+class DictTraversal():
+    """
+    @Summ: 辞書型の中身を探索するclass
+
+    @InsVars:
+        _configDict:
+            @Summ: configuration yamlの中身。
+            @Type: Dict
+        _configVisit:
+            @Summ: configuration yaml内のannotationKeyを使った否かを記録する変数。
+            @Desc: {annotationKey(str):訪れた⇒True(bool)}
+            @Type: Dict
+        _visitQueue:
+            @Summ: 探索queue
+            @Desc: BFSなのでFIFO。
+            @Type: List
+        _pathQueue:
+            @Summ: 探索する要素の相対pathを格納する。
+            @Desc:
+            - visitQueueと要素番号を共有する。
+            - []でroot要素を表す。
+            @Type: List
+    """
+    def __init__(self,configDict:dict):
+        """
+        @Summ: constructor.
+        """
+        self._configDict=configDict
+        self._visitQueue=[]
+        self._pathQueue=[]
+        self._configVisit={key:False for key in configDict.keys()}
+
+    def startBFS(self,anoyDict:dict):
+        """
+        @Summ: 幅優先探索を開始する関数。
+
+        @Desc:
+        - list型は単純に探索する。
+        - dict型は型確認しながら探索する。
+        - visitQueueには(key(str),value(any))のtupleを入れる。
+        - list型の時は、(key(int),value(any))になる。
+        @Args:
+            anoyDict:
+                @Summ: annotation yamlのdict型。
+        """
+        self._visitQueue=[(None,anoyDict)]
+        self._pathQueue=[[]]
+        while(True):
+            if(self._visitQueue==[]):
+                break
+            key,value=self._visitQueue.pop(0)
+            pathList=self._pathQueue.pop(0)
+            print(key,value)
+            print(pathList)
+            self.typeCheck(key,value,pathList)
+
+    def typeCheck(self,parentKey:str|None,childValue,path:list):
+        """
+        "@Summ": annoDict内を探索する関数。
+
+        "@Desc":
+        - 型確認は"!ParentKey"と"!ChildValue"の2つだ。
+        - annotationKeyが親でない時は、"!ParentKey"も"!ChildValue"も効力を発揮しないので無視。
+        - ただし、annoKeyがNoneの時は、"!ParentKey"が効力を発揮する場合がある。
+        - !ChildValueが無い時は何もしない。
+        - !ChildValueが無い時は、childValue=nullとして考える。
+        - valueがanoyDict型の時のみ、!ParentKeyの型確認が行われる。
+
+        "@Args":
+            parentKey:
+                "@Summ": 探索するdict型のkey。
+                "@Desc":
+                - nullは親要素が存在しないことを表す(つまりvalueがroot要素である)。
+                "@Type":
+                    Union:
+                    - Str
+                    - null
+            childValue:
+                "@Summ": 探索するdict型のvalue。
+                "@Type": Any
+            path:
+                @Summ: 今まで経由したkeyのlist。
+                @Type: List
+        "@Error":
+        - AnnotationYamlError
+        - AnnotationYamlTypeError
+        - ConfigurationYamlError
+        """
+        if(parentKey is None):
+            confChildVal=None    #confChild=Noneの時は型確認をしない。
+        elif(type(parentKey)!=str):
+            confChildVal=None
+        elif(parentKey[0]=="@"):
+            confChild=self._configDict.get(parentKey)
+            if(confChild is None):
+                raise ConfigurationYamlError(f"`{parentKey}` is not defined.")
+            confChildVal=confChild.get("!ChildValue")
+        else:
+            confChildVal=None
+        if(type(confChildVal)==dict):
+            #Enum型の型確認。
+            # config yaml側の型確認。
+            confKeyList=list(confChildVal.keys())
+            if(len(confKeyList)!=1 or confKeyList[0]!="Enum"):
+                raise ConfigurationYamlError(f"`{parentKey}` has invalid definition.")
+            confValueList=confChildVal["Enum"]
+            if(type(confValueList)!=list):
+                raise ConfigurationYamlError(f"`{parentKey}` has invalid definition.")
+            # annotaion yaml側の型確認。
+            for i in range(len(confValueList)):
+                if(childValue==confValueList[i]):
+                    return
+            raise AnnotationYamlTypeError("Enum",path)
+        elif(type(childValue)==bool):
+            if((confChildVal is None) or confChildVal=="Bool"):
+                return
+            else:
+                raise AnnotationYamlTypeError("Bool",path)
+        elif(type(childValue)==str):
+            if((confChildVal is None or confChildVal=="Str")):
+                return
+            else:
+                raise AnnotationYamlTypeError("Str",path)
+        elif(type(childValue)==int):
+            if((confChildVal is None) or confChildVal=="Int"):
+                return
+            else:
+                raise AnnotationYamlTypeError("Int",path)
+        elif(type(childValue)==float):
+            if((confChildVal is None) or confChildVal=="Float"):
+                return
+            else:
+                raise AnnotationYamlTypeError("Float",path)
+        elif(type(childValue)==list):
+            if((confChildVal is None) or confChildVal=="List"):
+                for i in range(len(childValue)):
+                    newPath=path+[i]
+                    self._visitQueue.append((i,childValue[i]))
+                    self._pathQueue.append(newPath)
+                return
+            else:
+                raise AnnotationYamlTypeError("List",path)
+        elif(type(childValue)==dict):
+            if(confChildVal is None):
+                for key,childValue in childValue.items():
+                    newPath=path+[key]
+                    self._visitQueue.append((key,childValue))
+                    self._pathQueue.append(newPath)
+                return
+            elif(confChildVal=="FreeDict"):
+                for key,childValue in childValue.items():
+                    newPath=path+[key]
+                    self._visitQueue.append((key,childValue))
+                    self._pathQueue.append(newPath)
+                    if(key[0]=="@"):
+                        raise AnnotationYamlTypeError("FreeDict",path)
+                return
+            elif(confChildVal=="AnnoDict"):
+                for key,childValue in childValue.items():
+                    newPath=path+[key]
+                    self._visitQueue.append((key,childValue))
+                    self._pathQueue.append(newPath)
+                    confParent=self._configDict[key].get("!ParentKey")
+                    if(key[0]!="@"):
+                        raise AnnotationYamlTypeError("AnnoDict",path)
+                    if(confParent is None):
+                        pass
+                    elif(parentKey not in confParent):
+                        raise AnnotationYamlTypeError("AnnoDict",path)
+                return
+        else:
+            raise AnnotationYamlError(f" invalid value is found at:\n    `{path}`.")
+
+if(__name__=="__main__"):
+    configPath=r"C:\Users\tomot\Backup\sourcecode\python\projects\annotation_yaml\tests\unit\case01\config01.yaml"
+    anoyPath=r"C:\Users\tomot\Backup\sourcecode\python\projects\annotation_yaml\tests\unit\case01\int_false.yaml"
+    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)
+    tree01=DictTraversal(configDict)
+    tree01.startBFS(anoyDict)
+