From 64d4009d291632b18ffc6a8fe32f8b2a4c817033 Mon Sep 17 00:00:00 2001 From: Joachim Metz Date: Fri, 1 May 2026 20:16:47 +0200 Subject: [PATCH] Code clean up --- .pylintrc | 2 -- artifactsrc/__init__.py | 1 - artifactsrc/resource_file.py | 5 ++--- artifactsrc/volume_scanner.py | 7 +++---- docs/conf.py | 1 - pyproject.toml | 10 ++++------ run_tests.py | 1 - tests/__init__.py | 1 - tests/resource_file.py | 13 ++++++------- tests/test_lib.py | 5 ++--- tools/__init__.py | 1 - tools/check_artifacts.py | 1 - tools/generate_docs.py | 9 ++++----- utils/check_dependencies.py | 1 - utils/dependencies.py | 11 +++++------ 15 files changed, 26 insertions(+), 43 deletions(-) diff --git a/.pylintrc b/.pylintrc index 9d328c3..00ab168 100644 --- a/.pylintrc +++ b/.pylintrc @@ -460,7 +460,6 @@ disable=assignment-from-none, missing-param-doc, raise-missing-from, raw-checker-failed, - super-with-arguments, suppressed-message, too-few-public-methods, too-many-ancestors, @@ -477,7 +476,6 @@ disable=assignment-from-none, unsubscriptable-object, use-implicit-booleaness-not-comparison-to-string, use-implicit-booleaness-not-comparison-to-zero, - useless-object-inheritance, useless-suppression, use-symbolic-message-instead diff --git a/artifactsrc/__init__.py b/artifactsrc/__init__.py index 6e84fb9..9ca8285 100644 --- a/artifactsrc/__init__.py +++ b/artifactsrc/__init__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ForensicArtifacts.com Artifact Repository resources.""" __version__ = '20260411' diff --git a/artifactsrc/resource_file.py b/artifactsrc/resource_file.py index 4e5e76f..a9503d9 100644 --- a/artifactsrc/resource_file.py +++ b/artifactsrc/resource_file.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Windows Message Resource file.""" import logging @@ -7,7 +6,7 @@ import pywrc -class MessageResourceFile(object): +class MessageResourceFile: """Windows Message Resource file. Attributes: @@ -28,7 +27,7 @@ def __init__( preferred_language_identifier (Optional[int]): preferred language identifier (LCID). """ - super(MessageResourceFile, self).__init__() + super().__init__() self._ascii_codepage = ascii_codepage self._exe_file = pyexe.file() self._exe_file.set_ascii_codepage(self._ascii_codepage) diff --git a/artifactsrc/volume_scanner.py b/artifactsrc/volume_scanner.py index b1a32ef..b73e059 100644 --- a/artifactsrc/volume_scanner.py +++ b/artifactsrc/volume_scanner.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Volume scanner for artifact definitions.""" import logging @@ -23,7 +22,7 @@ from artifactsrc import resource_file -class CheckResults(object): +class CheckResults: """Check results. Attributes: @@ -33,7 +32,7 @@ class CheckResults(object): def __init__(self): """Initializes check results.""" - super(CheckResults, self).__init__() + super().__init__() self.data_formats = set() self.number_of_file_entries = 0 @@ -102,7 +101,7 @@ def __init__(self, artifacts_registry, mediator=None): mediator (Optional[dfvfs.VolumeScannerMediator]): a volume scanner mediator. """ - super(ArtifactDefinitionsVolumeScanner, self).__init__(mediator=mediator) + super().__init__(mediator=mediator) self._ascii_codepage = 'cp1252' self._artifacts_registry = artifacts_registry self._checks_definitions = None diff --git a/docs/conf.py b/docs/conf.py index 0fda04e..bcd2c2d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Sphinx build configuration file.""" import os diff --git a/pyproject.toml b/pyproject.toml index db9d7f2..cc8690a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "artifactsrc" -version = "20260411" +version = "20260501" description = "Digital Forensics Artifact knowledge base" maintainers = [ { name = "Joachim Metz", email = "joachim.metz@gmail.com" }, @@ -64,13 +64,11 @@ Documentation = "https://artifactsrc.readthedocs.io/en/latest" Homepage = "https://github.com/ForensicArtifacts/artifacts-kb" Repository = "https://github.com/ForensicArtifacts/artifacts-kb" +[tool.setuptools] +package-dir = {"artifactsrc" = "artifactsrc"} + [tool.setuptools.package-data] artifactsrc = [ "*.yaml", "data/*.yaml", ] - -[tool.setuptools.packages.find] -where = ["."] -include = ["artifactsrc"] -exclude = ["docs", "tests", "tests.*", "utils"] diff --git a/run_tests.py b/run_tests.py index 801a888..49164fd 100755 --- a/run_tests.py +++ b/run_tests.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Script to run the tests.""" from __future__ import print_function diff --git a/tests/__init__.py b/tests/__init__.py index 40a96af..e69de29 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -1 +0,0 @@ -# -*- coding: utf-8 -*- diff --git a/tests/resource_file.py b/tests/resource_file.py index 8e03e46..03338fa 100644 --- a/tests/resource_file.py +++ b/tests/resource_file.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Tests for the Windows Message Resource (WRC) file class.""" import unittest @@ -9,7 +8,7 @@ from tests import test_lib -class TestWrcResource(object): +class TestWrcResource: """Windows Resource Compiler (WRC) resource for testing. Attributes: @@ -18,7 +17,7 @@ class TestWrcResource(object): def __init__(self): """Initializes a resource.""" - super(TestWrcResource, self).__init__() + super().__init__() self.items = [] # pylint: disable=invalid-name @@ -43,7 +42,7 @@ def get_item_by_index(self, index): return self.items[index] -class TestWrcResourceItem(object): +class TestWrcResourceItem: """Windows Resource Compiler (WRC) resource item for testing. Attributes: @@ -57,7 +56,7 @@ def __init__(self, identifier): Args: identifier (int]): identifier. """ - super(TestWrcResourceItem, self).__init__() + super().__init__() self.identifier = identifier self.resource_data = None self.sub_items = [] @@ -92,7 +91,7 @@ def read(self): return self.resource_data -class TestWrcStream(object): +class TestWrcStream: """Windows Resource Compiler (WRC) stream for testing. Attributes: @@ -101,7 +100,7 @@ class TestWrcStream(object): def __init__(self): """Initializes a stream.""" - super(TestWrcStream, self).__init__() + super().__init__() self.resources = {} # pylint: disable=invalid-name diff --git a/tests/test_lib.py b/tests/test_lib.py index 601023f..c02a91a 100644 --- a/tests/test_lib.py +++ b/tests/test_lib.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Shared test case.""" import os @@ -50,12 +49,12 @@ def _SkipIfPathNotExists(self, path): raise unittest.SkipTest(f'missing test file: {filename:s}') -class TempDirectory(object): +class TempDirectory: """Class that implements a temporary directory.""" def __init__(self): """Initializes a temporary directory.""" - super(TempDirectory, self).__init__() + super().__init__() self.name = '' def __enter__(self): diff --git a/tools/__init__.py b/tools/__init__.py index 56fafa5..e5a0d9b 100644 --- a/tools/__init__.py +++ b/tools/__init__.py @@ -1,2 +1 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- diff --git a/tools/check_artifacts.py b/tools/check_artifacts.py index d5e2eac..00fb9e2 100755 --- a/tools/check_artifacts.py +++ b/tools/check_artifacts.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Script to check artifact definitions on a storage media image.""" import argparse diff --git a/tools/generate_docs.py b/tools/generate_docs.py index 255c6b7..b30ebdd 100755 --- a/tools/generate_docs.py +++ b/tools/generate_docs.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Script to generate artifact definition documentation.""" import argparse @@ -14,12 +13,12 @@ from artifacts import registry as artifacts_registry -class IndexRstOutputWriter(object): +class IndexRstOutputWriter: """Index.rst output writer.""" def __init__(self, path): """Initializes an index.rst output writer.""" - super(IndexRstOutputWriter, self).__init__() + super().__init__() self._file_object = None self._path = path @@ -55,14 +54,14 @@ def WriteArtifactDefinition(self, artifact_name): f' {artifact_name:s} <{artifact_name:s}>\n') -class MarkdownOutputWriter(object): +class MarkdownOutputWriter: """Markdown output writer.""" _URL_PREFIX = 'https://artifacts-kb.readthedocs.io/en/latest/sources/' def __init__(self, path): """Initializes a Markdown output writer.""" - super(MarkdownOutputWriter, self).__init__() + super().__init__() self._file_object = None self._path = path diff --git a/utils/check_dependencies.py b/utils/check_dependencies.py index 73c1ba4..97e95d3 100755 --- a/utils/check_dependencies.py +++ b/utils/check_dependencies.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Script to check for the availability and version of dependencies.""" import sys diff --git a/utils/dependencies.py b/utils/dependencies.py index 4767e85..c94b92e 100644 --- a/utils/dependencies.py +++ b/utils/dependencies.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Helper to check for availability and version of dependencies.""" import configparser @@ -6,7 +5,7 @@ import re -class DependencyDefinition(object): +class DependencyDefinition: """Dependency definition. Attributes: @@ -36,7 +35,7 @@ def __init__(self, name): Args: name (str): name of the dependency. """ - super(DependencyDefinition, self).__init__() + super().__init__() self.dpkg_name = None self.is_optional = False self.l2tbinaries_name = None @@ -52,7 +51,7 @@ def __init__(self, name): self.version_property = None -class DependencyDefinitionReader(object): +class DependencyDefinitionReader: """Dependency definition reader.""" _VALUE_NAMES = frozenset([ @@ -106,7 +105,7 @@ def Read(self, file_object): yield dependency_definition -class DependencyHelper(object): +class DependencyHelper: """Dependency helper. Attributes: @@ -127,7 +126,7 @@ def __init__( test_dependencies_file (Optional[str]): path to the test dependencies configuration file. """ - super(DependencyHelper, self).__init__() + super().__init__() self._test_dependencies = {} self.dependencies = {}