Modernization: Convert to new implicit standard for classes

examples/dae/ReactionKinetics.py

@@ -28,7 +28,7 @@
 solver = pyo.SolverFactory('ipopt')
 
 
-class Reaction(object):
+class Reaction:
     """A simple class to hold the stoichiometry of a single reaction
 
     Reaction data is stored in two dictionaries:
@@ -84,7 +84,7 @@ def _parseTerm(self, x):
         return coef, species.strip()
 
 
-class ReactionNetwork(object):
+class ReactionNetwork:
     """A simple object to hold sets of reactions."""
 
     def __init__(self):

examples/pyomo/p-median/solver1.py

@@ -17,7 +17,7 @@
 
 
 @plugin_factory(pyo.SolverFactory)
-class MySolver(object):
+class MySolver:
     alias('greedy')
 
     # Declare that this is an IOptSolver plugin

examples/pyomo/p-median/solver2.py

@@ -18,7 +18,7 @@
 
 
 @plugin_factory
-class MySolver(object):
+class MySolver:
     alias('random')
 
     # Declare that this is an IOptSolver plugin

pyomo/common/autoslots.py

@@ -276,7 +276,7 @@ def encode_as_none(encode, val):
         else:
             return val
 
-    class Mixin(object):
+    class Mixin:
         """Mixin class to configure a class hierarchy to use AutoSlots
 
         Inheriting from this class will set up the automatic generation

pyomo/common/config.py

@@ -204,7 +204,7 @@ def NonNegativeFloat(val):
     return ans
 
 
-class In(object):
+class In:
     """In(domain, cast=None)
     Domain validation class admitting a Container of possible values
 
@@ -268,7 +268,7 @@ def domain_name(self):
             return f'In{_dn}'
 
 
-class InEnum(object):
+class InEnum:
     """Domain validation class admitting an enum value/name.
 
     This will admit any value that is in the specified Enum, including
@@ -301,7 +301,7 @@ def domain_name(self):
         return f'InEnum[{_domain_name(self._domain)}]'
 
 
-class IsInstance(object):
+class IsInstance:
     """
     Domain validator for type checking.
 
@@ -365,7 +365,7 @@ def domain_name(self):
         return f"IsInstance[{', '.join(class_names)}]"
 
 
-class ListOf(object):
+class ListOf:
     """Domain validator for lists of a specified type
 
     Parameters
@@ -411,7 +411,7 @@ def domain_name(self):
         return f'ListOf[{_dn}]'
 
 
-class Module(object):
+class Module:
     """Domain validator for modules.
 
     Modules can be specified as module objects, by module name,
@@ -485,7 +485,7 @@ def __call__(self, module_id):
         return import_file(path)
 
 
-class Path(object):
+class Path:
     """
     Domain validator for a
     :py:term:`path-like object <path-like object>`.
@@ -594,7 +594,7 @@ def __call__(self, data):
             return [super(PathList, self).__call__(data)]
 
 
-class DynamicImplicitDomain(object):
+class DynamicImplicitDomain:
     """Implicit domain that can return a custom domain based on the key.
 
     This provides a mechanism for managing plugin-like systems, where
@@ -810,7 +810,7 @@ def from_enum_or_string(cls, arg):
 
 .. doctest::
 
-    >>> class Base(object):
+    >>> class Base:
     ...     CONFIG = ConfigDict()
     ...     CONFIG.declare('filename', ConfigValue(
     ...         default='input.txt',
@@ -854,7 +854,7 @@ class will still create ``c`` instances that only have the single
 
 .. doctest::
 
-    >>> class Solver(object):
+    >>> class Solver:
     ...     CONFIG = ConfigDict()
     ...     CONFIG.declare('iterlim', ConfigValue(
     ...         default=10,
@@ -1211,7 +1211,7 @@ def _value2yaml(prefix, value, obj):
     return _str.rstrip()
 
 
-class _UnpickleableDomain(object):
+class _UnpickleableDomain:
     def __init__(self, obj):
         self._type = type(obj).__name__
         self._name = obj.name(True)
@@ -1410,7 +1410,7 @@ def _item_body_cb(self, indent, obj):
     return types.MethodType(_item_body_cb, formatter)
 
 
-class ConfigFormatter(object):
+class ConfigFormatter:
     def _initialize(self, indent_spacing, width, visibility):
         self.out = io.StringIO()
         self.indent_spacing = indent_spacing
@@ -1565,7 +1565,7 @@ def add_docstring_list(docstring, configdict, indent_by=4):
     )
 
 
-class document_kwargs_from_configdict(object):
+class document_kwargs_from_configdict:
     """Decorator to append the documentation of a ConfigDict to the docstring
 
     This adds the documentation of the specified :py:class:`ConfigDict`
@@ -1600,7 +1600,7 @@ class document_kwargs_from_configdict(object):
     >>> from pyomo.common.config import (
     ...     ConfigDict, ConfigValue, document_kwargs_from_configdict
     ... )
-    >>> class MyClass(object):
+    >>> class MyClass:
     ...     CONFIG = ConfigDict()
     ...     CONFIG.declare('iterlim', ConfigValue(
     ...         default=3000,
@@ -1676,7 +1676,7 @@ def __call__(self, fcn):
         return fcn
 
 
-class UninitializedMixin(object):
+class UninitializedMixin:
     """Mixin class to support delayed data initialization.
 
     This mixin can be used to create a derived Config class that hides
@@ -1743,7 +1743,7 @@ def _data(self, value):
         self._data = value
 
 
-class ConfigBase(object):
+class ConfigBase:
     # Note: __getstate__ relies on this field ordering.  Do not change.
     __slots__ = (
         '_parent',
@@ -1763,7 +1763,7 @@ class ConfigBase(object):
     # we can tell if an argument is provided (and we can't use None as
     # None is a valid user-specified argument).  Making it a class helps
     # when Config objects are pickled.
-    class NoArgument(object):
+    class NoArgument:
         pass
 
     def __init__(
@@ -2293,7 +2293,7 @@ def _setter(self, value):
             self._data = _data
 
 
-class MarkImmutable(object):
+class MarkImmutable:
     """
     Mark instances of ConfigValue as immutable.
 

pyomo/common/dependencies.py

@@ -31,7 +31,7 @@
 SUPPRESS_DEPENDENCY_WARNINGS = False
 
 
-class ModuleUnavailable(object):
+class ModuleUnavailable:
     """Mock object that raises :py:class:`.DeferredImportError` upon attribute access
 
     This object is returned by :py:func:`attempt_import()` in lieu of
@@ -129,7 +129,7 @@ def generate_import_warning(self, logger='pyomo.common'):
         self.log_import_warning(logger)
 
 
-class DeferredImportModule(object):
+class DeferredImportModule:
     """Mock module object to support the deferred import of a module.
 
     This object is returned by :py:func:`attempt_import()` in lieu of
@@ -281,7 +281,7 @@ def __new__(cls, *args, **kwargs):
     return UnavailableBase
 
 
-class _DeferredImportIndicatorBase(object):
+class _DeferredImportIndicatorBase:
     def __and__(self, other):
         return _DeferredAnd(self, other)
 
@@ -857,7 +857,7 @@ def declare_deferred_modules_as_importable(globals_dict):
     return declare_modules_as_importable(globals_dict).__exit__(None, None, None)
 
 
-class declare_modules_as_importable(object):
+class declare_modules_as_importable:
     """Make all :py:class:`ModuleType` and :py:class:`DeferredImportModules`
     importable through the ``globals_dict`` context.
 

pyomo/common/deprecation.py

@@ -469,7 +469,7 @@ class RenamedClass(type):
     Examples
     --------
     >>> from pyomo.common.deprecation import RenamedClass
-    >>> class NewClass(object):
+    >>> class NewClass:
     ...     pass
     >>> class OldClass(metaclass=RenamedClass):
     ...     __renamed__new_class__ = NewClass

pyomo/common/download.py

@@ -38,7 +38,7 @@
 DownloadFactory = pyomo.common.Factory('library downloaders')
 
 
-class FileDownloader(object):
+class FileDownloader:
     _os_version = None
 
     def __init__(self, insecure=False, cacert=None):

pyomo/common/env.py

@@ -99,7 +99,7 @@ def _load_dll(name, timeout=10):
 _load_dll.pool = None
 
 
-class _RestorableEnvironInterface(object):
+class _RestorableEnvironInterface:
     """Interface to track environment changes and restore state"""
 
     def __init__(self, dll):
@@ -160,7 +160,7 @@ def __delitem__(self, key):
             self.dll.putenv_s(key, b'')
 
 
-class _OSEnviron(object):
+class _OSEnviron:
     """Helper class to proxy a "DLL-like" interface to os.environ"""
 
     _libname = 'os.environ'
@@ -205,7 +205,7 @@ def wputenv_s(self, key, val):
         os.environ[key] = val
 
 
-class _MsvcrtDLL(object):
+class _MsvcrtDLL:
     """Helper class to manage the interface with the MSVCRT runtime"""
 
     def __init__(self, name):
@@ -280,7 +280,7 @@ def get_env_dict(self):
         return ans
 
 
-class _Win32DLL(object):
+class _Win32DLL:
     """Helper class to manage the interface with the Win32 runtime"""
 
     def __init__(self, name):
@@ -381,7 +381,7 @@ def get_env_dict(self):
         return ans
 
 
-class CtypesEnviron(object):
+class CtypesEnviron:
     """A context manager for managing environment variables
 
     This class provides a simplified interface for consistently setting

pyomo/common/factory.py

@@ -17,7 +17,7 @@
 #  ___________________________________________________________________________
 
 
-class Factory(object):
+class Factory:
     """
     A class that is used to define a factory for objects.
 

pyomo/common/fileutils.py

@@ -505,7 +505,7 @@ def import_file(path, clear_cache=False, infer_package=True, module_name=None):
     return module
 
 
-class PathData(object):
+class PathData:
     """An object for storing and managing a :py:class:`PathManager` path"""
 
     def __init__(self, manager, name):
@@ -610,7 +610,7 @@ def executable(self, value):
         self.set_path(value)
 
 
-class PathManager(object):
+class PathManager:
     """The PathManager defines a registry class for path locations
 
     The :py:class:`PathManager` defines a class very similar to the

pyomo/common/formatting.py

@@ -196,7 +196,7 @@ def tabular_writer(ostream, prefix, data, header, row_generator):
             )
 
 
-class StreamIndenter(object):
+class StreamIndenter:
     """
     Mock-up of a file-like object that wraps another file-like object
     and indents all data using the specified string before passing it to

pyomo/common/gc_manager.py

@@ -20,7 +20,7 @@
 from pyomo.common.multithread import MultiThreadWrapper
 
 
-class __PauseGCCompanion(object):
+class __PauseGCCompanion:
     def __init__(self):
         self._stack_depth = 0
 
@@ -41,7 +41,7 @@ def __init__(self):
 # the GC will be re-enabled (if it was not initially disabled).  It is
 # safe to nest instances of PauseGC That is, you don't have to worry
 # if an outer function/method has its own instance of PauseGC.
-class PauseGC(object):
+class PauseGC:
     __slots__ = ("reenable_gc", "stack_pointer")
 
     def __init__(self):

pyomo/common/log.py

@@ -237,7 +237,7 @@ def emit(self, record):
             self.stream = orig
 
 
-class Preformatted(object):
+class Preformatted:
     __slots__ = ('msg',)
 
     def __init__(self, msg):
@@ -250,7 +250,7 @@ def __repr__(self):
         return f'Preformatted({self.msg!r})'
 
 
-class _GlobalLogFilter(object):
+class _GlobalLogFilter:
     def __init__(self):
         self.logger = logging.getLogger()
 
@@ -292,7 +292,7 @@ def __init__(self, base='', stream=None, level=logging.NOTSET, verbosity=None):
         self.setFormatter(LegacyPyomoFormatter(base=base, verbosity=verbosity))
 
 
-class LoggingIntercept(object):
+class LoggingIntercept:
     r"""Context manager for intercepting messages sent to a log stream
 
     This class is designed to enable easy testing of log messages.
@@ -461,7 +461,7 @@ def redirect_streams(self, redirects):
                 yield _LastResortRedirector(redirects[fd].original_fd)
 
 
-class _StreamRedirector(object):
+class _StreamRedirector:
     def __init__(self, handler, fd):
         self.handler = handler
         self.fd = fd
@@ -488,7 +488,7 @@ def __exit__(self, et, ev, tb):
             self.handler.stream = self.orig_stream
 
 
-class _LastResortRedirector(object):
+class _LastResortRedirector:
     def __init__(self, fd):
         self.fd = fd
         self.local_fd = None