Skip to content

Commit

Permalink
Updated file headers.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Paebbels
Paebbels committed Feb 22, 2024
1 parent 7add249 commit eda36b9
Show file tree
Hide file tree
Showing 13 changed files with 265 additions and 26 deletions.
2 changes: 1 addition & 1 deletion pyEDAA/Reports/DocumentationCoverage/Python.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
# ==================================================================================================================== #
#
"""
**Abstract documentation coverage data model for Python code.**
**Abstract code documentation coverage data model for Python code.**
"""
from pathlib import Path
from typing import Optional as Nullable, Iterable, Dict, Union, Tuple, List
Expand Down
2 changes: 1 addition & 1 deletion pyEDAA/Reports/DocumentationCoverage/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""Abstraction of code documentation coverage."""
"""Abstraction of code documentation coverage data model."""
from enum import Flag
from typing import Optional as Nullable

Expand Down
18 changes: 10 additions & 8 deletions pyEDAA/Reports/Unittesting/JUnit.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,18 @@
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from enum import Flag

from datetime import datetime, timedelta
from pathlib import Path
from time import perf_counter_ns
from typing import Tuple, List, Dict, Optional as Nullable, Union
from xml.dom import minidom, Node
"""
Reader for JUnit unit testing summary files in XML format.
"""
from enum import Flag
from datetime import datetime, timedelta
from pathlib import Path
from time import perf_counter_ns
from typing import Tuple, Dict, Optional as Nullable, Union
from xml.dom import minidom, Node
from xml.dom.minidom import Element

from pyTooling.Decorators import export, readonly
from pyTooling.Decorators import export, readonly
from pyTooling.MetaClasses import ExtendedType

from pyEDAA.Reports.Unittesting import UnittestException, DuplicateTestsuiteException, DuplicateTestcaseException
Expand Down
8 changes: 4 additions & 4 deletions pyEDAA/Reports/Unittesting/OSVVM.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
# ==================================================================================================================== #
#
"""Reader for OSVVM test report summary files in YAML format."""
from pathlib import Path
from typing import Dict
from pathlib import Path
from typing import Dict

from ruamel.yaml import YAML
from pyTooling.Decorators import export
from ruamel.yaml import YAML

from . import Testsuite as Abstract_Testsuite, Testcase as Abstract_Testcase, Status
from pyEDAA.Reports.Unittesting import Testsuite as Abstract_Testsuite, Testcase as Abstract_Testcase, Status


@export
Expand Down
13 changes: 6 additions & 7 deletions pyEDAA/Reports/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,25 @@
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""Various report abstract data models and report format converters."""
"""
Various report abstract data models and report format converters.
"""
__author__ = "Patrick Lehmann"
__email__ = "Paebbels@gmail.com"
__copyright__ = "2021-2024, Electronic Design Automation Abstraction (EDA²)"
__license__ = "Apache License, Version 2.0"
__version__ = "0.1.0"
__version__ = "0.2.0"
__keywords__ = ["Reports", "Abstract Model", "Data Model", "Test Case", "Test Suite", "OSVVM", "YAML", "XML"]

from sys import version_info

from enum import Enum
from sys import version_info
from typing import List

from enum import Enum

from pyTooling.Decorators import export


@export
class ReportException(Exception):

# WORKAROUND: for Python <3.11
# Implementing a dummy method for Python versions before
__notes__: List[str]
Expand Down
30 changes: 30 additions & 0 deletions tests/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ==================================================================================================================== #
# _____ ____ _ _ ____ _ #
# _ __ _ _| ____| _ \ / \ / \ | _ \ ___ _ __ ___ _ __| |_ ___ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | |_) / _ \ '_ \ / _ \| '__| __/ __| #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ _| _ < __/ |_) | (_) | | | |_\__ \ #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)_| \_\___| .__/ \___/|_| \__|___/ #
# |_| |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2024-2024 Electronic Design Automation Abstraction (EDA²) #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
32 changes: 31 additions & 1 deletion tests/unit/DocumentationCoverage/DataModel.py
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,34 @@
from pathlib import Path
# ==================================================================================================================== #
# _____ ____ _ _ ____ _ #
# _ __ _ _| ____| _ \ / \ / \ | _ \ ___ _ __ ___ _ __| |_ ___ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | |_) / _ \ '_ \ / _ \| '__| __/ __| #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ _| _ < __/ |_) | (_) | | | |_\__ \ #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)_| \_\___| .__/ \___/|_| \__|___/ #
# |_| |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2024-2024 Electronic Design Automation Abstraction (EDA²) #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from pathlib import Path
from unittest import TestCase

from pyEDAA.Reports.DocumentationCoverage.Python import CoverageState, ClassCoverage, ModuleCoverage, PackageCoverage
Expand Down
30 changes: 30 additions & 0 deletions tests/unit/DocumentationCoverage/DocStrCoverage.py
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
# ==================================================================================================================== #
# _____ ____ _ _ ____ _ #
# _ __ _ _| ____| _ \ / \ / \ | _ \ ___ _ __ ___ _ __| |_ ___ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | |_) / _ \ '_ \ / _ \| '__| __/ __| #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ _| _ < __/ |_) | (_) | | | |_\__ \ #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)_| \_\___| .__/ \___/|_| \__|___/ #
# |_| |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2024-2024 Electronic Design Automation Abstraction (EDA²) #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from pathlib import Path
from unittest import TestCase

Expand Down
30 changes: 30 additions & 0 deletions tests/unit/DocumentationCoverage/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ==================================================================================================================== #
# _____ ____ _ _ ____ _ #
# _ __ _ _| ____| _ \ / \ / \ | _ \ ___ _ __ ___ _ __| |_ ___ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | |_) / _ \ '_ \ / _ \| '__| __/ __| #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ _| _ < __/ |_) | (_) | | | |_\__ \ #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)_| \_\___| .__/ \___/|_| \__|___/ #
# |_| |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²) #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
Loading

0 comments on commit eda36b9

Please sign in to comment.