From 3dc312d0ada6dd16df663d63d13b77346fc0e748 Mon Sep 17 00:00:00 2001 From: "Jason M. Gates" Date: Tue, 9 Nov 2021 11:40:18 -0700 Subject: [PATCH] Switch `classes` to `AbstractMethod` --- doc/source/AbstractMethod.rst | 5 ++++ doc/source/ShellLogger.rst | 14 +++++++++++ doc/source/classes.rst | 23 ------------------- doc/source/index.rst | 2 +- .../{classes.py => AbstractMethod.py} | 0 src/shelllogger/StatsCollector.py | 2 +- src/shelllogger/Trace.py | 2 +- 7 files changed, 22 insertions(+), 26 deletions(-) create mode 100644 doc/source/AbstractMethod.rst delete mode 100644 doc/source/classes.rst rename src/shelllogger/{classes.py => AbstractMethod.py} (100%) diff --git a/doc/source/AbstractMethod.rst b/doc/source/AbstractMethod.rst new file mode 100644 index 0000000..4b7356b --- /dev/null +++ b/doc/source/AbstractMethod.rst @@ -0,0 +1,5 @@ +AbstractMethod Class Reference +============================== + +.. autoexception:: shelllogger.AbstractMethod.AbstractMethod + :noindex: diff --git a/doc/source/ShellLogger.rst b/doc/source/ShellLogger.rst index bc76f1d..6770efc 100644 --- a/doc/source/ShellLogger.rst +++ b/doc/source/ShellLogger.rst @@ -3,3 +3,17 @@ ShellLogger Class Reference .. autoclass:: shelllogger.ShellLogger :noindex: + +JSON Serialization +------------------ + +.. autoclass:: shelllogger.ShellLoggerDecoder + :noindex: + +.. todo:: + + Figure out why the documentation below is pulling in the docstring for the + base class as well. + +.. autoclass:: shelllogger.ShellLoggerEncoder + :noindex: diff --git a/doc/source/classes.rst b/doc/source/classes.rst deleted file mode 100644 index c6f2782..0000000 --- a/doc/source/classes.rst +++ /dev/null @@ -1,23 +0,0 @@ -Helper Classes -============== - -The following are a number of helper classes used by :class:`ShellLogger`. - -JSON Serialization ------------------- - -.. autoclass:: shelllogger.ShellLoggerDecoder - :noindex: - -.. todo:: - - Figure out why the documentation below is pulling in the docstring for the - base class as well. - -.. autoclass:: shelllogger.ShellLoggerEncoder - :noindex: - -AbstractMethod --------------- -.. autoexception:: shelllogger.classes.AbstractMethod - :noindex: diff --git a/doc/source/index.rst b/doc/source/index.rst index 13a0f73..d164288 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,7 +10,7 @@ shelllogger Shell StatsCollector Trace - classes + AbstractMethod util todo diff --git a/src/shelllogger/classes.py b/src/shelllogger/AbstractMethod.py similarity index 100% rename from src/shelllogger/classes.py rename to src/shelllogger/AbstractMethod.py diff --git a/src/shelllogger/StatsCollector.py b/src/shelllogger/StatsCollector.py index 1f2d9f9..adb1219 100644 --- a/src/shelllogger/StatsCollector.py +++ b/src/shelllogger/StatsCollector.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 from __future__ import annotations -from .classes import AbstractMethod +from .AbstractMethod import AbstractMethod from abc import abstractmethod from multiprocessing import Process from multiprocessing.managers import SyncManager diff --git a/src/shelllogger/Trace.py b/src/shelllogger/Trace.py index 000985a..c190935 100644 --- a/src/shelllogger/Trace.py +++ b/src/shelllogger/Trace.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 from __future__ import annotations -from .classes import AbstractMethod +from .AbstractMethod import AbstractMethod from abc import abstractmethod from pathlib import Path