Deprecating import via 'peakrdl.uvm' namespace package. #14

SystemRDL · Jun 8, 2022 · c11ef1a · c11ef1a
1 parent 97e72e9
commit c11ef1a
Show file tree

Hide file tree

Showing 22 changed files with 118 additions and 114 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -59,7 +59,7 @@ jobs:
 
       - name: Run Lint
         run: |
-          pylint --rcfile test/pylint.rc peakrdl
+          pylint --rcfile test/pylint.rc peakrdl_uvm
 
 #-------------------------------------------------------------------------------
   build_sdist:

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,2 @@
-recursive-include peakrdl/uvm/templates *
-recursive-exclude test *
+recursive-include src/peakrdl_uvm/templates *
+recursive-exclude test *
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ to the exporter.
 ```python
 import sys
 from systemrdl import RDLCompiler, RDLCompileError
-from peakrdl.uvm import UVMExporter
+from peakrdl_uvm import UVMExporter
 
 rdlc = RDLCompiler()
 

diff --git a/peakrdl/uvm/__about__.py b/peakrdl/uvm/__about__.py
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
     long_description = fh.read()
 
 
-with open(os.path.join("peakrdl/uvm", "__about__.py"), encoding='utf-8') as f:
+with open(os.path.join("src/peakrdl_uvm", "__about__.py"), encoding='utf-8') as f:
     v_dict = {}
     exec(f.read(), v_dict)
     version = v_dict['__version__']
@@ -18,7 +18,11 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/SystemRDL/PeakRDL-uvm",
-    packages=['peakrdl.uvm'],
+    package_dir={'': 'src'},
+    packages=[
+        'peakrdl_uvm',
+        'peakrdl.uvm', # backwards compatibility shim
+    ],
     include_package_data=True,
     install_requires=[
         "systemrdl-compiler>=1.12.0",

diff --git a/src/peakrdl/uvm/__init__.py b/src/peakrdl/uvm/__init__.py
@@ -0,0 +1,20 @@
+import warnings
+
+# Load modules
+from peakrdl_uvm import __about__
+from peakrdl_uvm import exporter
+from peakrdl_uvm import pre_export_listener
+
+# hoist internal objects
+from peakrdl_uvm.__about__ import __version__
+from peakrdl_uvm.exporter import UVMExporter
+
+warnings.warn(
+"""
+================================================================================
+Importing via namespace package 'peakrdl.uvm' is deprecated and will be
+removed in the next release.
+Change your imports to load the package using 'peakrdl_uvm' instead.
+For more details, see: https://github.com/SystemRDL/PeakRDL/issues/4
+================================================================================
+""", DeprecationWarning, stacklevel=2)
diff --git a/src/peakrdl_uvm/__about__.py b/src/peakrdl_uvm/__about__.py
@@ -0,0 +1 @@
+__version__ = "2.1.0"
diff --git a/peakrdl/uvm/__init__.py → src/peakrdl_uvm/__init__.py b/peakrdl/uvm/__init__.py → src/peakrdl_uvm/__init__.py
diff --git a/peakrdl/uvm/exporter.py → src/peakrdl_uvm/exporter.py b/peakrdl/uvm/exporter.py → src/peakrdl_uvm/exporter.py
diff --git a/peakrdl/uvm/pre_export_listener.py → src/peakrdl_uvm/pre_export_listener.py b/peakrdl/uvm/pre_export_listener.py → src/peakrdl_uvm/pre_export_listener.py
diff --git a/peakrdl/uvm/templates/main.sv → src/peakrdl_uvm/templates/main.sv b/peakrdl/uvm/templates/main.sv → src/peakrdl_uvm/templates/main.sv
diff --git a/peakrdl/uvm/templates/top_include.svh → src/peakrdl_uvm/templates/top_include.svh b/peakrdl/uvm/templates/top_include.svh → src/peakrdl_uvm/templates/top_include.svh
diff --git a/peakrdl/uvm/templates/top_pkg.sv → src/peakrdl_uvm/templates/top_pkg.sv b/peakrdl/uvm/templates/top_pkg.sv → src/peakrdl_uvm/templates/top_pkg.sv
diff --git a/peakrdl/uvm/templates/utils.sv → src/peakrdl_uvm/templates/utils.sv b/peakrdl/uvm/templates/utils.sv → src/peakrdl_uvm/templates/utils.sv
diff --git a/peakrdl/uvm/templates/uvm_reg.sv → src/peakrdl_uvm/templates/uvm_reg.sv b/peakrdl/uvm/templates/uvm_reg.sv → src/peakrdl_uvm/templates/uvm_reg.sv
diff --git a/peakrdl/uvm/templates/uvm_reg_block-mem.sv → ...eakrdl_uvm/templates/uvm_reg_block-mem.sv b/peakrdl/uvm/templates/uvm_reg_block-mem.sv → ...eakrdl_uvm/templates/uvm_reg_block-mem.sv
diff --git a/peakrdl/uvm/templates/uvm_reg_block.sv → src/peakrdl_uvm/templates/uvm_reg_block.sv b/peakrdl/uvm/templates/uvm_reg_block.sv → src/peakrdl_uvm/templates/uvm_reg_block.sv
diff --git a/peakrdl/uvm/templates/uvm_vreg.sv → src/peakrdl_uvm/templates/uvm_vreg.sv b/peakrdl/uvm/templates/uvm_vreg.sv → src/peakrdl_uvm/templates/uvm_vreg.sv
diff --git a/test/generate_testcase_data.py b/test/generate_testcase_data.py
@@ -6,7 +6,7 @@
 import jinja2 as jj
 
 from systemrdl import RDLCompiler, AddrmapNode, RegfileNode, MemNode, RegNode, FieldNode
-from peakrdl.uvm import UVMExporter
+from peakrdl_uvm import UVMExporter
 
 #-------------------------------------------------------------------------------
 testcase_name = sys.argv[1]