move repeat doc config to conf

dill/__init__.py

@@ -11,10 +11,10 @@
     from .__info__ import __version__, __author__, __doc__, __license__
 except: # pragma: no cover
     import os
-    import sys 
+    import sys
     parent = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))
     sys.path.append(parent)
-    # get distribution meta info 
+    # get distribution meta info
     from version import (__version__, __author__,
                          get_license_text, get_readme_as_rst)
     __license__ = get_license_text(os.path.join(parent, 'LICENSE'))
@@ -24,9 +24,9 @@
 
 
 from ._dill import (
-    Pickler, Unpickler,
-    check, copy, dump, dumps, load, loads, pickle, pickles, register,
-    DEFAULT_PROTOCOL, HIGHEST_PROTOCOL, CONTENTS_FMODE, FILE_FMODE, HANDLE_FMODE,
+    dump, dumps, load, loads, copy,
+    Pickler, Unpickler, register, pickle, pickles, check,
+    DEFAULT_PROTOCOL, HIGHEST_PROTOCOL, HANDLE_FMODE, CONTENTS_FMODE, FILE_FMODE,
     PickleError, PickleWarning, PicklingError, PicklingWarning, UnpicklingError,
     UnpicklingWarning,
 )
@@ -42,8 +42,6 @@
 # make sure "trace" is turned off
 logger.trace(False)
 
-from importlib import reload
-
 objects = {}
 # local import of dill._objects
 #from . import _objects
@@ -68,6 +66,7 @@ def load_types(pickleable=True, unpickleable=True):
     Returns:
         None
     """
+    from importlib import reload
     # local import of dill.objects
     from . import _objects
     if pickleable:

dill/session.py

@@ -16,6 +16,7 @@
 ]
 
 import re
+import os
 import sys
 import warnings
 
@@ -128,7 +129,7 @@ def _restore_modules(unpickler, main_module):
 
 #NOTE: 06/03/15 renamed main_module to main
 def dump_module(
-    filename = str(TEMPDIR/'session.pkl'),
+    filename: Union[str, os.PathLike] = None,
     module: Optional[Union[ModuleType, str]] = None,
     refimported: bool = False,
     **kwds
@@ -141,7 +142,8 @@ def dump_module(
     module can then be restored with the function :py:func:`load_module`.
 
     Parameters:
-        filename: a path-like object or a writable stream.
+        filename: a path-like object or a writable stream. If `None`
+            (the default), write to a named file in a temporary directory.
         module: a module object or the name of an importable module. If `None`
             (the default), :py:mod:`__main__` is saved.
         refimported: if `True`, all objects identified as having been imported
@@ -223,6 +225,8 @@ def dump_module(
     if hasattr(filename, 'write'):
         file = filename
     else:
+        if filename is None:
+            filename = str(TEMPDIR/'session.pkl')
         file = open(filename, 'wb')
     try:
         pickler = Pickler(file, protocol, **kwds)
@@ -242,7 +246,7 @@ def dump_module(
     return
 
 # Backward compatibility.
-def dump_session(filename=str(TEMPDIR/'session.pkl'), main=None, byref=False, **kwds):
+def dump_session(filename=None, main=None, byref=False, **kwds):
     warnings.warn("dump_session() has been renamed dump_module()", PendingDeprecationWarning)
     dump_module(filename, module=main, refimported=byref, **kwds)
 dump_session.__doc__ = dump_module.__doc__
@@ -307,7 +311,7 @@ def _identify_module(file, main=None):
         raise UnpicklingError("unable to identify main module") from error
 
 def load_module(
-    filename = str(TEMPDIR/'session.pkl'),
+    filename: Union[str, os.PathLike] = None,
     module: Optional[Union[ModuleType, str]] = None,
     **kwds
 ) -> Optional[ModuleType]:
@@ -325,7 +329,8 @@ def load_module(
     and returned.
 
     Parameters:
-        filename: a path-like object or a readable stream.
+        filename: a path-like object or a readable stream. If `None`
+            (the default), read from a named file in a temporary directory.
         module: a module object or the name of an importable module;
             the module name and kind (i.e. imported or non-imported) must
             match the name and kind of the module stored at ``filename``.
@@ -419,6 +424,8 @@ def load_module(
     if hasattr(filename, 'read'):
         file = filename
     else:
+        if filename is None:
+            filename = str(TEMPDIR/'session.pkl')
         file = open(filename, 'rb')
     try:
         file = _make_peekable(file)
@@ -484,13 +491,13 @@ def load_module(
         return main
 
 # Backward compatibility.
-def load_session(filename=str(TEMPDIR/'session.pkl'), main=None, **kwds):
+def load_session(filename=None, main=None, **kwds):
     warnings.warn("load_session() has been renamed load_module().", PendingDeprecationWarning)
     load_module(filename, module=main, **kwds)
 load_session.__doc__ = load_module.__doc__
 
 def load_module_asdict(
-    filename = str(TEMPDIR/'session.pkl'),
+    filename: Union[str, os.PathLike] = None,
     update: bool = False,
     **kwds
 ) -> dict:
@@ -505,7 +512,8 @@ def load_module_asdict(
     the loaded module is stored in the ``__session__`` attribute.
 
     Parameters:
-        filename: a path-like object or a readable stream
+        filename: a path-like object or a readable stream. If `None`
+            (the default), read from a named file in a temporary directory.
         update: if `True`, initialize the dictionary with the current state
             of the module prior to loading the state stored at filename.
         **kwds: extra keyword arguments passed to :py:class:`Unpickler()`
@@ -549,6 +557,8 @@ def load_module_asdict(
     if hasattr(filename, 'read'):
         file = filename
     else:
+        if filename is None:
+            filename = str(TEMPDIR/'session.pkl')
         file = open(filename, 'rb')
     try:
         file = _make_peekable(file)

docs/source/conf.py

@@ -66,8 +66,26 @@
 # extension config
 github_project_url = "https://github.com/uqfoundation/dill"
 autoclass_content = 'both'
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'private-members': True,
+    'special-members': True,
+    'show-inheritance': True,
+    'imported-members': True,
+    'exclude-members': (
+        '__dict__,'
+        '__slots__,'
+        '__weakref__,'
+        '__module__,'
+        '_abc_impl,'
+        '__init__,'
+        '__annotations__,'
+        '__dataclass_fields__,'
+    )
+}
 autodoc_typehints = 'description'
-napoleon_include_init_with_doc = True
+autodoc_typehints_format = 'short'
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 napoleon_use_ivar = True
@@ -87,7 +105,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/dill.rst

@@ -5,95 +5,46 @@ detect module
 -------------
 
 .. automodule:: dill.detect
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members: ismethod, isfunction, istraceback, isframe, iscode, parent, reference, at, parents, children
+..  :exclude-members: +ismethod, isfunction, istraceback, isframe, iscode, parent, reference, at, parents, children
 
 logger module
 -------------
 
 .. automodule:: dill.logger
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 objtypes module
 ---------------
 
 .. automodule:: dill.objtypes
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 pointers module
 ---------------
 
 .. automodule:: dill.pointers
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 session module
----------------
+--------------
 
 .. automodule:: dill.session
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members: dump_session, load_session
+..  :exclude-members: +dump_session, load_session
 
 settings module
 ---------------
 
 .. automodule:: dill.settings
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 source module
 -------------
 
 .. automodule:: dill.source
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 temp module
 -----------
 
 .. automodule:: dill.temp
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
-
+..  :exclude-members: +

docs/source/index.rst

@@ -4,12 +4,7 @@ dill package documentation
 ==========================
 
 .. automodule:: dill
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
+..  :exclude-members: +
 
 .. toctree::
     :maxdepth: 2

docs/source/scripts.rst

@@ -5,10 +5,10 @@ get_objgraph script
 -------------------
 
 .. automodule:: _get_objgraph
-    :members:
+..  :exclude-members: +
 
 undill script
 --------------------
 
 .. automodule:: _undill
-    :members:
+..  :exclude-members: +