docs: Update docstrings in all files except tests

All flake8-docstring errors have been cleared except for those coming
from test files since test files are not part of the documentation
pipeline. Eventually will work on them though just so that we can
eliminate the final ignore.

.flake8

@@ -1,12 +1,8 @@
 [flake8]
 max-line-length = 88
 docstring-convention = google
-# Will finish these later
-extend-ignore = D101,D107
+ignore = D107, W503
 per-file-ignores =
-    tests/*.py: D1,D2,D4
-    examples/*.py: D1,D2,D4
-    __version__.py: D100
     __init__.py: F401
 exclude =
     airflow
@@ -16,6 +12,7 @@ exclude =
     setup.py
     build
     dist
+    tests
     .venv
     .tox
     .mypy_cache

.pre-commit-config.yaml

@@ -10,6 +10,8 @@ repos:
     hooks:
       - id: flake8
         additional_dependencies: [flake8-docstrings]
+        args: ["--config", ".flake8"]
+        exclude: tests/
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.902

airflow_dbt_python/__version__.py

@@ -1,3 +1,4 @@
+"""The module's version information."""
 __author__ = "Tomás Farías Santana"
 __copyright__ = "Copyright 2021 Tomás Farías Santana"
 __title__ = "airflow-dbt-python"

airflow_dbt_python/hooks/dbt_s3.py

@@ -7,6 +7,12 @@
 
 
 class DbtS3Hook(S3Hook):
+    """Subclass of S3Hook with methods to pull dbt-related files.
+
+    A dbt hook should provide a method to pull a dbt profiles file (profiles.yml) and
+    all the files corresponding to a project.
+    """
+
     def get_dbt_profiles(
         self, s3_profiles_url: str, profiles_dir: Optional[str] = None
     ) -> Path:

examples/__init__.py

@@ -0,0 +1 @@
+"""Usage examples of airflow-dbt-python."""

examples/basic_dag.py

@@ -1,6 +1,4 @@
-"""
-Sample basic DAG which dbt runs a project
-"""
+"""Sample basic DAG which dbt runs a project."""
 import datetime as dt
 
 from airflow import DAG

examples/complete_dbt_workflow_dag.py

@@ -1,5 +1,6 @@
-"""
-Sample DAG showcasing a complete dbt workflow
+"""Sample DAG showcasing a complete dbt workflow.
+
+The complete workflow includes a sequence of source, seed, and several run commands.
 """
 import datetime as dt
 

examples/dbt_project_in_s3_dag.py

@@ -1,6 +1,4 @@
-"""
-Sample basic DAG which showcases a dbt project being pulled from S3
-"""
+"""Sample basic DAG which showcases a dbt project being pulled from S3."""
 import datetime as dt
 
 from airflow import DAG

examples/use_dbt_artifacts_dag.py

@@ -1,6 +1,4 @@
-"""
-Sample DAG to showcase pulling dbt artifacts from XCOM
-"""
+"""Sample DAG to showcase pulling dbt artifacts from XCOM."""
 import datetime as dt
 
 from airflow import DAG
@@ -10,9 +8,7 @@
 
 
 def process_dbt_artifacts(**context):
-    """
-    Report which model or models took the longest to compile and execute
-    """
+    """Report which model or models took the longest to compile and execute."""
     run_results = context["ti"].xcom_pull(
         key="run_results.json", task_ids="dbt_run_daily"
     )

tests/conftest.py

@@ -1,3 +1,8 @@
+"""Conftest file including setting common fixtures.
+
+Common fixtures include a connection to a postgres database, a set of sample model and
+ seed files, dbt configuration files, and temporary directories for everything.
+"""
 import boto3
 import pytest
 from dbt.version import __version__ as DBT_VERSION

tests/test_dbt_base.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtBaseOperator."""
 from pathlib import Path
 from unittest.mock import patch
 

tests/test_dbt_build.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtBuildOperator."""
 import json
 from unittest.mock import patch
 

tests/test_dbt_clean.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtCleanOperator."""
 from unittest.mock import patch
 
 from airflow_dbt_python.operators.dbt import DbtCleanOperator, DbtCompileOperator

tests/test_dbt_compile.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtCompileOperator."""
 from unittest.mock import patch
 
 from dbt.contracts.results import RunStatus

tests/test_dbt_debug.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtDebugOperator."""
 from unittest.mock import patch
 
 from dbt.version import __version__ as DBT_VERSION

tests/test_dbt_deps.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtDepsOperator."""
 from unittest.mock import patch
 
 import pytest

tests/test_dbt_list.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtListOperator."""
 from itertools import chain
 from unittest.mock import patch
 

tests/test_dbt_parse.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtParseOperator."""
 from pathlib import Path
 from unittest.mock import patch
 

tests/test_dbt_run.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtRunOperator."""
 import json
 from unittest.mock import patch
 

tests/test_dbt_run_operation.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtRunOperationOperator."""
 from unittest.mock import patch
 
 import pytest

tests/test_dbt_s3_hook.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtS3Hook."""
 import pytest
 
 try:

tests/test_dbt_seed.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtSeedOperator."""
 import json
 from unittest.mock import patch
 

tests/test_dbt_snapshot.py

@@ -1,9 +1,10 @@
+"""Unit test module for DbtSnapshotOperator."""
 from unittest.mock import patch
 
 import pytest
-from airflow import AirflowException
 from dbt.contracts.results import RunStatus
 
+from airflow import AirflowException
 from airflow_dbt_python.operators.dbt import DbtSnapshotOperator
 
 

tests/test_dbt_source.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtSourceOperator."""
 from pathlib import Path
 from unittest.mock import patch
 

tests/test_dbt_test.py

@@ -1,3 +1,4 @@
+"""Unit test module for DbtTestOperator."""
 from unittest.mock import patch
 
 import pytest