Changes to use docformatter (log2timeline#4795)

joachimmetz · Jan 28, 2024 · 321cca3 · 321cca3
1 parent 7c98809
commit 321cca3
Show file tree

Hide file tree

Showing 75 changed files with 193 additions and 174 deletions.
diff --git a/.github/workflows/test_docs.yml b/.github/workflows/test_docs.yml
@@ -36,7 +36,7 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libssl-dev libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
+        apt-get install -y build-essential git libffi-dev libssl-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
     - name: Install tox
       run: |
         python3 -m pip install tox

diff --git a/.github/workflows/test_tox.yml b/.github/workflows/test_tox.yml
@@ -46,7 +46,7 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libssl-dev libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
+        apt-get install -y build-essential git libffi-dev libssl-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
     - name: Install tox
       run: |
         python3 -m pip install tox
@@ -82,7 +82,7 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libssl-dev libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
+        apt-get install -y build-essential git libffi-dev libssl-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
     - name: Install tox
       run: |
         python3 -m pip install tox
@@ -120,7 +120,7 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libssl-dev libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
+        apt-get install -y build-essential git libffi-dev libssl-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libesedb-python3 libevt-python3 libevtx-python3 libewf-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwsi-python3 liblnk-python3 libluksde-python3 libmodi-python3 libmsiecf-python3 libolecf-python3 libphdi-python3 libqcow-python3 libregf-python3 libscca-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-acstore python3-artifacts python3-bencode python3-certifi python3-cffi-backend python3-chardet python3-dateutil python3-defusedxml python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-fakeredis python3-flor python3-future python3-idna python3-lz4 python3-mock python3-opensearch python3-pefile python3-pip python3-psutil python3-pyparsing python3-pytsk3 python3-redis python3-requests python3-setuptools python3-six python3-tz python3-urllib3 python3-xattr python3-xlsxwriter python3-yaml python3-yara python3-zmq python3-zstd
     - name: Install tox
       run: |
         python3 -m pip install tox

diff --git a/config/dpkg/changelog b/config/dpkg/changelog
@@ -1,5 +1,5 @@
-plaso (20240114-1) unstable; urgency=low
+plaso (20240128-1) unstable; urgency=low
 
   * Auto-generated
 
- -- Log2Timeline maintainers <[email protected]>  Sun, 14 Jan 2024 06:47:49 +0100
+ -- Log2Timeline maintainers <[email protected]>  Sun, 28 Jan 2024 18:10:35 +0100
diff --git a/docs/conf.py b/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
 

diff --git a/plaso/__init__.py b/plaso/__init__.py
@@ -6,4 +6,4 @@
 of log2timeline.
 """
 
-__version__ = '20240114'
+__version__ = '20240128'
diff --git a/plaso/analysis/bloom.py b/plaso/analysis/bloom.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Analysis plugin to look up file hashes in bloom database."""
 
-import flor
+import flor  # pylint: disable=import-error
 
 from plaso.analysis import hash_tagging
 from plaso.analysis import logger
@@ -114,7 +114,7 @@ def _QueryHash(self, digest, bloom_filter):
     return value_to_test in bloom_filter
 
   def SetBloomDatabasePath(self, bloom_database_path):
-    """Set the path to the bloom file containing hash
+    """Set the path to the bloom file containing hash.
 
     Args:
       bloom_database_path (str): Path to the bloom file

diff --git a/plaso/analysis/unique_domains_visited.py b/plaso/analysis/unique_domains_visited.py
@@ -11,8 +11,8 @@ class UniqueDomainsVisitedPlugin(interface.AnalysisPlugin):
   """A plugin to generate a list all domains visited.
 
   This plugin will extract domains from browser history events extracted by
-  Plaso. The list produced can be used to quickly determine if there has been
-  a visit to a site of interest, for example, a known phishing site.
+  Plaso. The list produced can be used to quickly determine if there has been a
+  visit to a site of interest, for example, a known phishing site.
   """
 
   NAME = 'unique_domains_visited'

diff --git a/plaso/analysis/virustotal.py b/plaso/analysis/virustotal.py
@@ -133,7 +133,7 @@ def SetAPIKey(self, api_key):
     self._api_key = api_key
 
   def TestConnection(self):
-    """Tests the connection to VirusTotal
+    """Tests the connection to VirusTotal.
 
     Returns:
       bool: True if VirusTotal is reachable.

diff --git a/plaso/analyzers/hashers/sha1.py b/plaso/analyzers/hashers/sha1.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""The SHA-1 Hasher implementation"""
+"""The SHA-1 Hasher implementation."""
 
 import hashlib
 

diff --git a/plaso/analyzers/hashers/sha256.py b/plaso/analyzers/hashers/sha256.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""The SHA-256 Hasher implementation"""
+"""The SHA-256 Hasher implementation."""
 
 import hashlib
 

diff --git a/plaso/analyzers/hashing_analyzer.py b/plaso/analyzers/hashing_analyzer.py
@@ -13,7 +13,8 @@ class HashingAnalyzer(interface.BaseAnalyzer):
   """This class contains code for calculating file hashes of input files.
 
   In Plaso, hashers are classes that map arbitrarily sized file content to a
-  fixed size value. See: https://en.wikipedia.org/wiki/Hash_function
+  fixed size value. See:
+  https://en.wikipedia.org/wiki/Hash_function
   """
 
   NAME = 'hashing'

diff --git a/plaso/analyzers/interface.py b/plaso/analyzers/interface.py
@@ -20,7 +20,7 @@ class BaseAnalyzer(object):
 
   @abc.abstractmethod
   def Analyze(self, data):
-    """Analyzes a block of data, updating the state of the analyzer
+    """Analyzes a block of data, updating the state of the analyzer.
 
     Args:
       data(bytes): block of data to process.

diff --git a/plaso/cli/pinfo_tool.py b/plaso/cli/pinfo_tool.py
@@ -766,7 +766,7 @@ def _PrintEventLabelsCounter(
           table_view.Write(self._output_writer)
 
   def _PrintParsersCounter(self, parsers_counter, session_identifier=None):
-    """Prints the parsers counter
+    """Prints the parsers counter.
 
     Args:
       parsers_counter (collections.Counter): number of events per parser or

diff --git a/plaso/cli/psort_tool.py b/plaso/cli/psort_tool.py
@@ -243,7 +243,7 @@ def _ParseProcessingOptions(self, options):
     self._worker_timeout = worker_timeout
 
   def AddProcessingOptions(self, argument_group):
-    """Adds processing options to the argument group
+    """Adds processing options to the argument group.
 
     Args:
       argument_group (argparse._ArgumentGroup): argparse argument group.

diff --git a/plaso/containers/artifacts.py b/plaso/containers/artifacts.py
@@ -150,7 +150,7 @@ def __init__(self, family=None, product=None, version=None):
 
   @property
   def version_tuple(self):
-    """tuple[int]: version tuple or None if version is not set or invalid."""
+    """Tuple[int]: version tuple or None if version is not set or invalid."""
     try:
       # pylint: disable=consider-using-generator
       return tuple([int(digit, 10) for digit in self.version.split('.')])

diff --git a/plaso/containers/event_sources.py b/plaso/containers/event_sources.py
@@ -53,8 +53,8 @@ def __lt__(self, other):
 class FileEntryEventSource(EventSource):
   """File entry event source.
 
-  The file entry event source is an event source that represents a file
-  within a file system.
+  The file entry event source is an event source that represents a file within a
+  file system.
   """
   DATA_TYPE = 'file_entry'
 

diff --git a/plaso/engine/engine.py b/plaso/engine/engine.py
@@ -293,13 +293,11 @@ def GetSourceFileSystem(self, file_system_path_spec, resolver_context=None):
       resolver_context (dfvfs.Context): resolver context.
 
     Returns:
-      tuple: containing:
-
-        dfvfs.FileSystem: file system
-        path.PathSpec: mount point path specification. The mount point path
-            specification refers to either a directory or a volume on a storage
-            media device or image. It is needed by the dfVFS file system
-            to indicate the base location of the file system.
+      tuple[dfvfs.FileSystem, path.PathSpec]: file system and mount point path
+          specification. The mount point path specification refers to either a
+          directory or a volume on a storage media device or image. It is
+          needed by the dfVFS file system to indicate the base location of the
+          file system.
 
     Raises:
       RuntimeError: if source file system path specification is not set.

diff --git a/plaso/engine/knowledge_base.py b/plaso/engine/knowledge_base.py
@@ -3,8 +3,8 @@
 
 The knowledge base is filled by user provided input and the pre-processing
 phase. It is intended to provide successive phases, like the parsing and
-analysis phases, with essential information like the time zone and codepage
-of the source data.
+analysis phases, with essential information like the time zone and codepage of
+the source data.
 """
 
 import codecs

diff --git a/plaso/engine/path_filters.py b/plaso/engine/path_filters.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """Path filters.
 
-Path filters are specified in filter files and are used during collection
-to include or exclude file system paths.
+Path filters are specified in filter files and are used during collection to
+include or exclude file system paths.
 """
 
 from dfvfs.helpers import file_system_searcher

diff --git a/plaso/filters/path_filter.py b/plaso/filters/path_filter.py
@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 """A scan tree-based path filter implementation.
 
-The scan tree is a tree based on multiple paths that contains the path
-segments per node. The most significant path segment is at the root and
-therefore compared first. More information can be found here:
+The scan tree is a tree based on multiple paths that contains the path segments
+per node. The most significant path segment is at the root and therefore
+compared first. More information can be found here:
 https://github.com/libyal/libsigscan/wiki/Internals#scanning-tree-based-signature-scanning
 
 The scan tree is used in the filter to filter provided paths.
@@ -97,9 +97,8 @@ def ToDebugString(self):
 class _PathSegmentWeights(object):
   """Path segment weights.
 
-  The path segment weights are used to determine the most significant
-  path segment per index. The path segment weights are used to construct
-  a scan tree.
+  The path segment weights are used to determine the most significant path
+  segment per index. The path segment weights are used to construct a scan tree.
   """
 
   def __init__(self):
@@ -582,7 +581,7 @@ def __init__(self, path_segment_index):
 
   @property
   def path_segments(self):
-    """list[str]: path segments."""
+    """List[str]: path segments."""
     return self._path_segments.keys()
 
   def AddPathSegment(self, path_segment, scan_object):  # pylint: disable=missing-type-doc

diff --git a/plaso/formatters/interface.py b/plaso/formatters/interface.py
@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
 """This file contains the event formatters interface classes.
 
-The l2t_csv and other formats are dependent on a message field,
-referred to as description_long and description_short in l2t_csv.
+The l2t_csv and other formats are dependent on a message field, referred to as
+description_long and description_short in l2t_csv.
 
 Plaso no longer stores these field explicitly.
 
-A formatter, with a format string definition, is used to convert
-the event object values into a formatted string that is similar
-to the description_long and description_short field.
+A formatter, with a format string definition, is used to convert the event
+object values into a formatted string that is similar to the description_long
+and description_short field.
 """
 
 import abc