chore: Fix linting checks

Author: tomasfarias

docs/conf.py

@@ -1,15 +1,4 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+"""Configuration file for the Sphinx documentation builder."""
 import os
 import sys
 

tests/conftest.py

@@ -582,6 +582,7 @@ def test_files(tmp_path_factory, dbt_project_file):
 
 
 def pytest_addoption(parser):
+    """Adds option to run integration tests with pytest."""
     parser.addoption(
         "--run-integration",
         action="store_true",
@@ -591,6 +592,7 @@ def pytest_addoption(parser):
 
 
 def pytest_collection_modifyitems(config, items):
+    """Allows skipping integration tests when flag missing."""
     if config.getoption("--run-integration"):
         return
 

tests/dags/test_dbt_dags.py

@@ -304,7 +304,6 @@ def target_connection_dag(
     generic_tests_files,
 ):
     """Create a testing DAG that utilizes Airflow connections."""
-
     with DAG(
         dag_id="target_conn_dbt_dag",
         start_date=DATA_INTERVAL_START,

tests/hooks/__init__.py

@@ -0,0 +1,4 @@
+"""This module contains all dbt hook tests.
+
+DbtHook tests can be found under the dbt submodule.
+"""

tests/hooks/dbt/__init__.py

@@ -0,0 +1 @@
+"""This module contains all DbtHook tests, one test suite per command."""

tests/hooks/dbt/test_dbt_compile.py

@@ -19,6 +19,7 @@ def test_dbt_compile_non_existent_model(
 
 @pytest.fixture(scope="function")
 def compile_dir(dbt_project_file):
+    """Return the path to a directory with dbt compiled files."""
     import shutil
 
     compile_dir = dbt_project_file.parent / "target"

tests/hooks/dbt/test_dbt_hook_base.py

@@ -73,13 +73,18 @@ def test_dbt_hook_get_remote_raises_not_implemented():
 
 
 class FakeRemote:
+    """A fake dbt remote that simply returns arguments used in mocking."""
+
     def download_dbt_profiles(self, *args, **kwargs):
+        """Fakes the download_dbt_profiles method."""
         return (args, kwargs)
 
     def upload_dbt_project(self, *args, **kwargs):
+        """Fakes the upload_dbt_project method."""
         return (args, kwargs)
 
     def download_dbt_project(self, *args, **kwargs):
+        """Fakes the download_dbt_project method."""
         return (args, kwargs)
 
 

tests/hooks/dbt/test_dbt_run.py

@@ -1,5 +1,4 @@
 """Unit test module for running dbt run with the DbtHook."""
-import os
 from pathlib import Path
 
 import pytest
@@ -119,7 +118,7 @@ def test_dbt_run_task_exclude_one_file(
 def test_dbt_run_fails_with_non_existent_project(hook, profiles_file, dbt_project_file):
     """Test what exception is raised when running from a fake project."""
     with pytest.raises(AirflowException):
-        result = hook.run_dbt_task(
+        hook.run_dbt_task(
             "run",
             project_dir="/home/fake/project",
             profiles_dir="/home/fake/profiles/",

tests/hooks/test_s3_hook.py

@@ -354,10 +354,10 @@ def test_upload_dbt_project_with_partial_replace(
     s3_bucket, s3_hook, tmpdir, test_files
 ):
     """Test pushing a dbt project to a S3 path with replace = False.
-    For this test we are looking for one file to be pushed while the rest are to be ignored
-    as they already exist and we are running with replace = False.
+
+    For this test we are looking for one file to be pushed while the rest are to be
+    ignored as they already exist and we are running with replace = False.
     """
-    prefix = f"s3://{s3_bucket}/project/"
     bucket = s3_hook.get_bucket(s3_bucket)
 
     last_modified_expected = {}
@@ -390,7 +390,7 @@ def test_upload_dbt_project_with_partial_replace(
     remote = DbtS3RemoteHook()
     with freezegun.freeze_time("2022-02-02"):
         # Attempt to push project a month after.
-        # Only one file should be pushed as the rest exist and we are passing replace = False.
+        # Only one file should be pushed as the rest exist and we using replace = False.
         remote.upload_dbt_project(
             project_dir, f"s3://{s3_bucket}/project/", replace=False
         )

tests/operators/__init__.py

@@ -0,0 +1 @@
+"""This module contains all dbt operator tests."""