refactor(parser): strategy pattern for documentation parsing (#812)

* refactor(parser): move function that creates parameter list

* refactor(parser): documentation parsing strategy

* refactor(parser): extract parsing of NumpyDoc into strategy

* refactor(parser): clean up structure

* refactor(parser): update API model

* refactor(parser): use injected documentation parser for class and function documentation

* refactor(parser): remove references to now outdated code

* refactor(parser): minor changes

* fix(parser): crash

* perf(parser): improve performance of numpydoc parser

* refactor(parser): further restructuring

* build: set mypy python version to 3.10

* build: set mypy python version to 3.10

* style: fix linter errors

* style: fix linter errors

* style: apply automatic fixes of linters

Co-authored-by: lars-reimann <[email protected]>

Author: lars-reimann

package-parser/.gitignore

@@ -25,6 +25,9 @@ dist/
 htmlcov/
 .coverage
 
+# Test __init__.py files
+tests/**/__init__.py
+
 # Output of this tool
 out/
 tmp/

package-parser/package_parser/cli/_run_annotations.py

@@ -1,10 +1,10 @@
 import json
 from pathlib import Path
 
-from package_parser.model.annotations import AnnotationStore
-from package_parser.model.api import API
-from package_parser.model.usages import UsageCountStore
 from package_parser.processing.annotations import generate_annotations
+from package_parser.processing.annotations.model import AnnotationStore
+from package_parser.processing.api.model import API
+from package_parser.processing.usages.model import UsageCountStore
 from package_parser.utils import ensure_file_exists
 
 

package-parser/package_parser/cli/_run_api.py

@@ -4,8 +4,8 @@
 
 from package_parser.cli._json_encoder import CustomEncoder
 from package_parser.cli._shared_constants import _API_KEY
-from package_parser.model.api import API
 from package_parser.processing.api import get_api
+from package_parser.processing.api.model import API
 from package_parser.processing.dependencies import get_dependencies
 from package_parser.utils import ensure_file_exists
 

package-parser/package_parser/model/__init__.py

@@ -1,6 +1,3 @@
-from package_parser.model.annotations import AnnotationStore
-from package_parser.model.api import API
-from package_parser.model.usages import UsageCountStore
 from package_parser.processing.annotations._generate_boundary_annotations import (
     _generate_boundary_annotations,
 )
@@ -16,6 +13,9 @@
 from package_parser.processing.annotations._usages_preprocessor import (
     _preprocess_usages,
 )
+from package_parser.processing.annotations.model import AnnotationStore
+from package_parser.processing.api.model import API
+from package_parser.processing.usages.model import UsageCountStore
 
 
 def generate_annotations(api: API, usages: UsageCountStore) -> AnnotationStore:

package-parser/package_parser/model/api/__init__.py

@@ -1,9 +1,9 @@
-from package_parser.model.annotations import (
+from package_parser.processing.annotations.model import (
     AnnotationStore,
     BoundaryAnnotation,
     Interval,
 )
-from package_parser.model.api import API
+from package_parser.processing.api.model import API
 
 from ._constants import autogen_author
 

package-parser/package_parser/processing/annotations/_generate_annotations.py

@@ -1,7 +1,11 @@
 import re
 
-from package_parser.model.annotations import AnnotationStore, EnumAnnotation, EnumPair
-from package_parser.model.api import API
+from package_parser.processing.annotations.model import (
+    AnnotationStore,
+    EnumAnnotation,
+    EnumPair,
+)
+from package_parser.processing.api.model import API
 
 from ._constants import autogen_author
 

package-parser/package_parser/processing/annotations/_generate_boundary_annotations.py

@@ -1,13 +1,13 @@
 from typing import Any, Optional
 
-from package_parser.model.annotations import (
+from package_parser.processing.annotations.model import (
     AnnotationStore,
     ConstantAnnotation,
     OptionalAnnotation,
     RequiredAnnotation,
 )
-from package_parser.model.api import API, Parameter
-from package_parser.model.usages import UsageCountStore
+from package_parser.processing.api.model import API, Parameter
+from package_parser.processing.usages.model import UsageCountStore
 
 from ._constants import autogen_author
 

package-parser/package_parser/processing/annotations/_generate_enum_annotations.py

@@ -1,6 +1,9 @@
-from package_parser.model.annotations import AnnotationStore, RemoveAnnotation
-from package_parser.model.api import API
-from package_parser.model.usages import UsageCountStore
+from package_parser.processing.annotations.model import (
+    AnnotationStore,
+    RemoveAnnotation,
+)
+from package_parser.processing.api.model import API
+from package_parser.processing.usages.model import UsageCountStore
 
 from ._constants import autogen_author