Changes to use docformatter (#61)

Author: joachimmetz

acstore/__init__.py

@@ -5,4 +5,4 @@
 to read and write plaso storage files.
 """
 
-__version__ = '20240121'
+__version__ = '20240128'

acstore/containers/interface.py

@@ -49,12 +49,12 @@ def CopyToString(self):
 class AttributeContainer(object):
   """The attribute container interface.
 
-  This is the base class for those object that exists primarily as
-  a container of attributes with basic accessors and mutators.
+  This is the base class for those object that exists primarily as a container
+  of attributes with basic accessors and mutators.
 
-  The CONTAINER_TYPE class attribute contains a string that identifies
-  the container type, for example the container type "event" identifiers
-  an event object.
+  The CONTAINER_TYPE class attribute contains a string that identifies the
+  container type, for example the container type "event" identifiers an event
+  object.
 
   Attributes are public class members of a serializable type. Protected and
   private class members are not to be serialized, with the exception of those

acstore/fake_store.py

@@ -22,9 +22,9 @@ def __init__(self):
   def _RaiseIfNotReadable(self):
     """Raises if the store is not readable.
 
-     Raises:
-       OSError: if the store cannot be read from.
-       IOError: if the store cannot be read from.
+    Raises:
+      OSError: if the store cannot be read from.
+      IOError: if the store cannot be read from.
     """
     if not self._is_open:
       raise IOError('Unable to read from closed storage writer.')

acstore/interface.py

@@ -82,18 +82,18 @@ def _GetAttributeContainerSchema(self, container_type):
   def _RaiseIfNotReadable(self):
     """Raises if the store is not readable.
 
-     Raises:
-       OSError: if the store cannot be read from.
-       IOError: if the store cannot be read from.
+    Raises:
+      OSError: if the store cannot be read from.
+      IOError: if the store cannot be read from.
     """
 
   @abc.abstractmethod
   def _RaiseIfNotWritable(self):
     """Raises if the store is not writable.
 
-     Raises:
-       OSError: if the store cannot be written to.
-       IOError: if the store cannot be written to.
+    Raises:
+      OSError: if the store cannot be written to.
+      IOError: if the store cannot be written to.
     """
 
   def _SetAttributeContainerNextSequenceNumber(

acstore/sqlite_store.py

@@ -563,9 +563,9 @@ def _HasTable(self, table_name):
   def _RaiseIfNotReadable(self):
     """Raises if the attribute container store is not readable.
 
-     Raises:
-      IOError: when the attribute container store is closed.
-      OSError: when the attribute container store is closed.
+    Raises:
+     IOError: when the attribute container store is closed.
+     OSError: when the attribute container store is closed.
     """
     if not self._is_open:
       raise IOError('Unable to read from closed attribute container store.')

config/dpkg/changelog

@@ -1,5 +1,5 @@
-acstore (20240121-1) unstable; urgency=low
+acstore (20240128-1) unstable; urgency=low
 
   * Auto-generated
 
- -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Sun, 21 Jan 2024 08:55:35 +0100
+ -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Sun, 28 Jan 2024 14:31:51 +0100

docs/conf.py

@@ -52,6 +52,7 @@
 # docstrings.
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = True
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 

pyproject.toml

@@ -1,3 +1,10 @@
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.docformatter]
+black = false
+non-cap = ["dfDateTime", "dfImageTools", "dfVFS", "dfWinReg", "dtFabric"]
+non-strict = false
+wrap-summaries = 80
+wrap-descriptions = 80

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = acstore
-version = 20240121
+version = 20240128
 description = Attribute Container Storage (ACStore).
 long_description = ACStore, or Attribute Container Storage, provides a stand-alone implementation to read and write attribute container storage files.
 long_description_content_type = text/plain

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py3{7,8,9,10,11,12},coverage,docs,lint,wheel
+envlist = py3{7,8,9,10,11,12},coverage,docformatter,docs,lint,wheel
 
 [testenv]
 allowlist_externals = ./run_tests.py
@@ -25,6 +25,13 @@ commands =
   coverage: coverage xml
   wheel: python -m build --no-isolation --wheel
 
+[testenv:docformatter]
+usedevelop = True
+deps =
+  docformatter
+commands =
+  docformatter --in-place --recursive acstore tests
+
 [testenv:docs]
 usedevelop = True
 deps =
@@ -45,10 +52,14 @@ setenv =
 deps =
   -rrequirements.txt
   -rtest_requirements.txt
+  docformatter
   pylint >= 3.0.0, < 3.1.0
+  setuptools
   yamllint >= 1.26.0
 commands =
+  docformatter --version
   pylint --version
   yamllint -v
+  docformatter --check --diff --recursive acstore setup.py tests
   pylint --rcfile=.pylintrc acstore setup.py tests
   yamllint -c .yamllint.yaml test_data

utils/update_release.sh

@@ -25,7 +25,7 @@ acstore (${VERSION}-1) unstable; urgency=low
 EOT
 
 # Regenerate the API documentation.
-tox -edocs
+tox -edocformatter,docs
 
 exit ${EXIT_SUCCESS};