Stop bundling configobj

CHANGES.rst

@@ -2,6 +2,9 @@
 ==================
 
 - Update style and linting checking [#103]
+- Fix regex issue in internal configobj [#108]
+- Remove bundled ``configobj`` package in favor of the ``configobj`` package
+  bundled into ``astropy``. [#122]
 
 0.5.1 (2023-10-02)
 ==================
@@ -11,7 +14,6 @@
 - Move ``strun`` to entrypoints [#101]
 - Deprecate ``preserve_comments`` fix spec parsing for inline comments with
   a closing parenthesis [#107]
-- Fix regex issue in internal configobj [#108]
 
 0.5.0 (2023-04-19)
 ==================

pyproject.toml

@@ -73,9 +73,6 @@ addopts = [
     "-ra",
     "--color=yes"
 ]
-norecursedirs = [
-    'src/stpipe/extern',
-]
 testpaths = [
     'tests',
 ]
@@ -96,7 +93,6 @@ src = [
 line-length = 88
 extend-exclude = [
     'docs',
-    'src/stpipe/extern',
     'scripts/strun',
 ]
 
@@ -156,14 +152,10 @@ force-exclude = '''
     | \.git
     | \.pytest_cache
     | \.tox
-    | src/stpipe/extern
   )/
 )
 '''
 
-[tool.flynt]
-exclude = ["src/stpipe/extern/*"]
-
 [tool.codespell]
 skip="*.pdf,*.fits,*.asdf,.tox,build,./tags,.git,docs/_build"
 # ignore-words-list="""

src/stpipe/config_parser.py

@@ -10,17 +10,17 @@
 
 from asdf import ValidationError as AsdfValidationError
 from asdf import open as asdf_open
-
-from . import utilities
-from .config import StepConfig
-from .datamodel import AbstractDataModel
-from .extern.configobj.configobj import (
+from astropy.extern.configobj.configobj import (
     ConfigObj,
     Section,
     flatten_errors,
     get_extra_values,
 )
-from .extern.configobj.validate import ValidateError, Validator, VdtTypeError
+from astropy.extern.configobj.validate import ValidateError, Validator, VdtTypeError
+
+from . import utilities
+from .config import StepConfig
+from .datamodel import AbstractDataModel
 from .utilities import _not_set
 
 # Configure logger
@@ -70,9 +70,9 @@
             path = os.path.join(root_dir, path)
 
         path = os.path.abspath(path)
         dir_ = os.path.dirname(path)
         if dir_ and not os.path.exists(dir_):
             os.makedirs(dir_)
 
         return path
 
@@ -84,7 +84,7 @@
     if isinstance(value, AbstractDataModel):
         return value
 
     raise VdtTypeError(value)
 
 
 def _is_string_or_datamodel(value):
@@ -94,10 +94,10 @@
     if isinstance(value, AbstractDataModel):
         return value
 
     if isinstance(value, str):
         return value
 
     raise VdtTypeError(value)
 
 
 def load_config_file(config_file):
@@ -361,7 +361,7 @@
                         config[key] = spec[key]
                         continue
 
                     err = "missing"
 
                 messages.append(f"Config parameter {section_string!r}: {err}")
 

src/stpipe/extern/__init__.py

@@ -1,8 +0,0 @@
-"""
-This package contains python package(s) that are bundled with jwst but are
-external to jwst, and hence are developed in a separate source tree.
-
-Currently the bundled external dependencies are:
-
-.. _ConfigObj: https://github.com/DiffSK/configobj
-"""

src/stpipe/extern/configobj.py

@@ -0,0 +1,20 @@
+import inspect
+import sys
+import warnings
+
+from astropy.extern import configobj
+
+# Add submodules to system modules so they are available under the same path
+for mod in inspect.getmembers(configobj, inspect.ismodule):
+    # add as a local variable
+    locals()[mod[0]] = mod[1]
+    # Add the submodule to the system modules so it can be imported
+    sys.modules[f"stpipe.extern.configobj.{mod[0]}"] = mod[1]
+
+
+warnings.warn(
+    "stpipe.extern.configobj is deprecated in favor of astropy.extern.configobj, "
+    "please use that instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)