pySVModel 0.4.1__tar.gz → 0.5.1__tar.gz

{pySVModel-0.4.1 → pysvmodel-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pySVModel
-Version: 0.4.1
+Version: 0.5.1
 Summary: An abstract SystemVerilog language model (incl. Verilog).
 Home-page: https://GitHub.com/edaa-org/pySVModel
 Author: Patrick Lehmann
@@ -18,17 +18,54 @@ Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Software Development :: Compilers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Development Status :: 3 - Alpha
-Requires-Python: >=3.7
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pyTooling~=8.0
 Provides-Extra: doc
+Requires-Dist: sphinx_reports~=0.7; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "doc"
+Requires-Dist: pyTooling~=8.0; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: sphinx_autodoc_typehints~=2.5; extra == "doc"
+Requires-Dist: sphinx_rtd_theme~=3.0.0; extra == "doc"
+Requires-Dist: sphinx_design~=0.6.1; extra == "doc"
+Requires-Dist: docutils~=0.21; extra == "doc"
+Requires-Dist: sphinx~=8.1; extra == "doc"
+Provides-Extra: test
+Requires-Dist: lxml~=5.3; extra == "test"
+Requires-Dist: Coverage~=7.6; extra == "test"
+Requires-Dist: pyTooling~=8.0; extra == "test"
+Requires-Dist: pytest-cov~=6.0; extra == "test"
+Requires-Dist: typing_extensions~=4.12; extra == "test"
+Requires-Dist: mypy~=1.13; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
 Provides-Extra: all
-License-File: LICENSE.md
+Requires-Dist: sphinx_reports~=0.7; extra == "all"
+Requires-Dist: lxml~=5.3; extra == "all"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "all"
+Requires-Dist: Coverage~=7.6; extra == "all"
+Requires-Dist: pyTooling~=8.0; extra == "all"
+Requires-Dist: autoapi>=2.0.1; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
+Requires-Dist: sphinx_autodoc_typehints~=2.5; extra == "all"
+Requires-Dist: pytest-cov~=6.0; extra == "all"
+Requires-Dist: typing_extensions~=4.12; extra == "all"
+Requires-Dist: sphinx_rtd_theme~=3.0.0; extra == "all"
+Requires-Dist: mypy~=1.13; extra == "all"
+Requires-Dist: pytest~=8.3; extra == "all"
+Requires-Dist: sphinx_design~=0.6.1; extra == "all"
+Requires-Dist: docutils~=0.21; extra == "all"
+Requires-Dist: sphinx~=8.1; extra == "all"
 
 <p align="center">
   <a title="edaa-org.github.io/pySVModel" href="https://edaa-org.github.io/pySVModel"><img height="80px" src="doc/_static/logo.svg"/></a>

{pySVModel-0.4.1 → pysvmodel-0.5.1}/pySVModel/__init__.py

@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2023 Patrick Lehmann - Boetzingen, Germany                                                            #
+# Copyright 2021-2024 Patrick Lehmann - Boetzingen, Germany                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -31,8 +31,16 @@
 """
 An abstract SystemVerilog language model.
 
-:copyright: Copyright 2021-2023 Patrick Lehmann - Bötzingen, Germany
-:license: Apache License, Version 2.0
+This package provides a unified abstract language model for SystemVerilog. Projects reading from source files can derive
+own classes and implement additional logic to create a concrete language model for their tools.
+
+Projects consuming pre-processed SystemVerilog data can build higher level features and services on such a model, while
+supporting multiple frontends.
+
+.. admonition:: Copyright Information
+
+   :copyright: Copyright 2021-2024 Patrick Lehmann - Bötzingen, Germany
+   :license: Apache License, Version 2.0
 """
 from enum   import unique, Enum
 from typing import Dict, Union
@@ -42,26 +50,34 @@ from pyTooling.Decorators import export
 
 __author__ =    "Patrick Lehmann"
 __email__ =     "Paebbels@gmail.com"
-__copyright__ = "2021-2023, Patrick Lehmann"
+__copyright__ = "2021-2024, Patrick Lehmann"
 __license__ =   "Apache License, Version 2.0"
-__version__ =   "0.4.1"
+__version__ =   "0.5.1"
 
 
 @export
 @unique
 class SystemVerilogVersion(Enum):
-	Any =                  -1
+	"""
+	An enumeration for all possible version numbers for (System)Verilog.
+
+	A version can be given as integer or string and is represented as a unified
+	enumeration value.
 
-	Verilog95 =            95
-	Verilog2001 =           1
-	Verilog2005 =           5
+	This enumeration supports compare operators.
+	"""
+	Any =                  -1  #: Any
 
-	SystemVerilog2005 =  2005
-	SystemVerilog2009 =  2009
-	SystemVerilog2012 =  2012
-	SystemVerilog2017 =  2017
+	Verilog95 =            95  #: Verilog-1995
+	Verilog2001 =           1  #: Verilog-2001
+	Verilog2005 =           5  #: Verilog-2005
 
-	Latest =            10000
+	SystemVerilog2005 =  2005  #: SystemVerilog-2005
+	SystemVerilog2009 =  2009  #: SystemVerilog-2009
+	SystemVerilog2012 =  2012  #: SystemVerilog-2012
+	SystemVerilog2017 =  2017  #: SystemVerilog-2017
+
+	Latest =            10000  #: Latest Systemverilog (2017)
 
 	__VERSION_MAPPINGS__: Dict[Union[int, str], Enum] = {
 		-1:       Any,
@@ -96,7 +112,7 @@ class SystemVerilogVersion(Enum):
 		"2012":   SystemVerilog2012,
 		"2017":   SystemVerilog2017,
 		"Latest": Latest
-	}
+	}  #: Dictionary of (System)Verilog year codes variants as integer and strings for mapping to unique enum values.
 
 	def __init__(self, *_):
 		"""Patch the embedded MAP dictionary"""
@@ -106,6 +122,13 @@ class SystemVerilogVersion(Enum):
 
 	@classmethod
 	def Parse(cls, value: Union[int, str]) -> "SystemVerilogVersion":
+		"""
+		Parses a (System)Verilog year code as integer or string to an enum value.
+
+		:param value:       (System)Verilog year code.
+		:returns:           Enumeration value.
+		:raises ValueError: If the year code is not recognized.
+		"""
 		try:
 			return cls.__VERSION_MAPPINGS__[value]
 		except KeyError:

{pySVModel-0.4.1 → pysvmodel-0.5.1}/pySVModel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pySVModel
-Version: 0.4.1
+Version: 0.5.1
 Summary: An abstract SystemVerilog language model (incl. Verilog).
 Home-page: https://GitHub.com/edaa-org/pySVModel
 Author: Patrick Lehmann
@@ -18,17 +18,54 @@ Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Software Development :: Compilers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Development Status :: 3 - Alpha
-Requires-Python: >=3.7
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pyTooling~=8.0
 Provides-Extra: doc
+Requires-Dist: sphinx_reports~=0.7; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "doc"
+Requires-Dist: pyTooling~=8.0; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: sphinx_autodoc_typehints~=2.5; extra == "doc"
+Requires-Dist: sphinx_rtd_theme~=3.0.0; extra == "doc"
+Requires-Dist: sphinx_design~=0.6.1; extra == "doc"
+Requires-Dist: docutils~=0.21; extra == "doc"
+Requires-Dist: sphinx~=8.1; extra == "doc"
+Provides-Extra: test
+Requires-Dist: lxml~=5.3; extra == "test"
+Requires-Dist: Coverage~=7.6; extra == "test"
+Requires-Dist: pyTooling~=8.0; extra == "test"
+Requires-Dist: pytest-cov~=6.0; extra == "test"
+Requires-Dist: typing_extensions~=4.12; extra == "test"
+Requires-Dist: mypy~=1.13; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
 Provides-Extra: all
-License-File: LICENSE.md
+Requires-Dist: sphinx_reports~=0.7; extra == "all"
+Requires-Dist: lxml~=5.3; extra == "all"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "all"
+Requires-Dist: Coverage~=7.6; extra == "all"
+Requires-Dist: pyTooling~=8.0; extra == "all"
+Requires-Dist: autoapi>=2.0.1; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
+Requires-Dist: sphinx_autodoc_typehints~=2.5; extra == "all"
+Requires-Dist: pytest-cov~=6.0; extra == "all"
+Requires-Dist: typing_extensions~=4.12; extra == "all"
+Requires-Dist: sphinx_rtd_theme~=3.0.0; extra == "all"
+Requires-Dist: mypy~=1.13; extra == "all"
+Requires-Dist: pytest~=8.3; extra == "all"
+Requires-Dist: sphinx_design~=0.6.1; extra == "all"
+Requires-Dist: docutils~=0.21; extra == "all"
+Requires-Dist: sphinx~=8.1; extra == "all"
 
 <p align="center">
   <a title="edaa-org.github.io/pySVModel" href="https://edaa-org.github.io/pySVModel"><img height="80px" src="doc/_static/logo.svg"/></a>

pysvmodel-0.5.1/pySVModel.egg-info/requires.txt

@@ -0,0 +1,42 @@
+pyTooling~=8.0
+
+[all]
+sphinx_reports~=0.7
+lxml~=5.3
+sphinxcontrib-mermaid~=1.0
+Coverage~=7.6
+pyTooling~=8.0
+autoapi>=2.0.1
+sphinx-copybutton>=0.5.2
+docutils_stubs~=0.0.22
+sphinx_autodoc_typehints~=2.5
+pytest-cov~=6.0
+typing_extensions~=4.12
+sphinx_rtd_theme~=3.0.0
+mypy~=1.13
+pytest~=8.3
+sphinx_design~=0.6.1
+docutils~=0.21
+sphinx~=8.1
+
+[doc]
+sphinx_reports~=0.7
+sphinxcontrib-mermaid~=1.0
+pyTooling~=8.0
+autoapi>=2.0.1
+sphinx-copybutton>=0.5.2
+docutils_stubs~=0.0.22
+sphinx_autodoc_typehints~=2.5
+sphinx_rtd_theme~=3.0.0
+sphinx_design~=0.6.1
+docutils~=0.21
+sphinx~=8.1
+
+[test]
+lxml~=5.3
+Coverage~=7.6
+pyTooling~=8.0
+pytest-cov~=6.0
+typing_extensions~=4.12
+mypy~=1.13
+pytest~=8.3

{pySVModel-0.4.1 → pysvmodel-0.5.1}/pyproject.toml

@@ -1,8 +1,8 @@
 [build-system]
 requires = [
-  "setuptools >= 68.0.0",
-  "wheel >= 0.40.0",
-  "pyTooling >= 5.0.0"
+  "setuptools ~= 75.4",
+  "wheel ~= 0.45",
+  "pyTooling ~= 8.0"
 ]
 build-backend = "setuptools.build_meta"
 
@@ -10,15 +10,18 @@ build-backend = "setuptools.build_meta"
 line-length = 120
 
 [tool.mypy]
-python_version = "3.11"
-namespace_packages = true
-
+files = ["pySVModel"]
+python_version = "3.13"
+#ignore_missing_imports = true
+strict = true
 pretty = true
 show_error_context = true
-
+show_error_codes = true
+namespace_packages = true
 html_report = "report/typing"
 
 [tool.pytest.ini_options]
+addopts = "--tb=native"
 # Don't set 'python_classes = *' otherwise, pytest doesn't search for classes
 # derived from unittest.Testcase
 python_files = "*"
@@ -27,13 +30,28 @@ filterwarnings = [
 	"error::DeprecationWarning",
 	"error::PendingDeprecationWarning"
 ]
+junit_logging = "all"
+
+[tool.interrogate]
+color = true
+verbose = 1             # possible values: 0 (minimal output), 1 (-v), 2 (-vv)
+fail-under = 59
+exclude = [
+	"build",
+	"dist",
+	"doc",
+	"tests",
+	"setup.py"
+]
+ignore-setters = true
 
 [tool.coverage.run]
 branch = true
+relative_files = true
 omit = [
 	"*site-packages*",
 	"setup.py",
-	"tests/*"
+	"tests/unit/*"
 ]
 
 [tool.coverage.report]
@@ -47,9 +65,12 @@ omit = [
 	"tests/*"
 ]
 
+[tool.coverage.xml]
+output = "report/coverage/coverage.xml"
+
+[tool.coverage.json]
+output = "report/coverage/coverage.json"
+
 [tool.coverage.html]
 directory = "report/coverage/html"
 title="Code Coverage of pySVModel"
-
-[tool.coverage.xml]
-output = "report/coverage/coverage.xml"

{pySVModel-0.4.1 → pysvmodel-0.5.1}/setup.py

@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2023 Patrick Lehmann - Boetzingen, Germany                                                            #
+# Copyright 2021-2024 Patrick Lehmann - Boetzingen, Germany                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -29,6 +29,8 @@
 # ==================================================================================================================== #
 #
 """Package installer for 'An abstract System Verilog language model'."""
+from setuptools          import setup
+
 from pathlib             import Path
 from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub, DEFAULT_CLASSIFIERS
 
@@ -37,7 +39,7 @@ packageName =            "pySVModel"
 packageDirectory =       packageName
 packageInformationFile = Path(f"{packageDirectory}/__init__.py")
 
-DescribePythonPackageHostedOnGitHub(
+setup(**DescribePythonPackageHostedOnGitHub(
 	packageName=packageName,
 	description="An abstract SystemVerilog language model (incl. Verilog).",
 	gitHubNamespace=gitHubNamespace,
@@ -48,5 +50,8 @@ DescribePythonPackageHostedOnGitHub(
 		"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
 		"Topic :: Software Development :: Code Generators",
 		"Topic :: Software Development :: Compilers"
-	]
-)
+	],
+	dataFiles={
+		packageName: ["py.typed"]
+	}
+))

pySVModel-0.4.1/pySVModel.egg-info/requires.txt

@@ -1,17 +0,0 @@
-pyTooling>=5.0.0
-
-[all]
-sphinx_autodoc_typehints>=1.19.5
-sphinx>=5.3.0
-sphinx_fontawesome>=0.0.6
-sphinxcontrib-mermaid>=0.7.1
-pyTooling>=5.0.0
-autoapi>=2.0.1
-
-[doc]
-sphinx_autodoc_typehints>=1.19.5
-sphinx>=5.3.0
-sphinx_fontawesome>=0.0.6
-sphinxcontrib-mermaid>=0.7.1
-pyTooling>=5.0.0
-autoapi>=2.0.1