Check the entire code base for compliance with DOC String standard

.github/workflows/pull-request.yml

@@ -221,3 +221,21 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
           GITHUB_REPOSITORY: ${{ github.repository }}
+
+  Docstring-Compliance:
+    name: Check Docstring Compliance
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Run docstring compliance check
+        run: python .github/workflows/scripts/check_docstrings.py 

.github/workflows/scripts/check_docstrings.py

@@ -0,0 +1,92 @@
+import os
+import re
+import sys
+from docstring_parser import parse
+
+def validate_docstring(file_path):
+    """
+    Validate docstrings in a file for compliance with the Google style guide.
+
+    Args:
+        file_path (str): Path to the Python file to validate.
+
+    Returns:
+        list: List of violations found in the file, with details about the issue and corrective action.
+    """
+    violations = []
+    with open(file_path, 'r') as f:
+        lines = f.readlines()
+
+    for i, line in enumerate(lines):
+        if re.match(r'^\\s*def ', line):
+            func_name = line.strip()
+            docstring_start = i + 1
+            while docstring_start < len(lines) and lines[docstring_start].strip() == '':
+                docstring_start += 1
+
+            if docstring_start < len(lines) and lines[docstring_start].strip().startswith('\"\"\"'):
+                docstring_end = docstring_start + 1
+                while docstring_end < len(lines) and not lines[docstring_end].strip().endswith('\"\"\"'):
+                    docstring_end += 1
+
+                docstring = '\\n'.join(lines[docstring_start:docstring_end + 1])
+                try:
+                    parsed = parse(docstring)
+                    # Check for Raises section
+                    if not parsed.raises:
+                        violations.append((
+                            i + 1,
+                            func_name,
+                            "Missing 'Raises' section",
+                            "Add a 'Raises' section detailing the exceptions this function may raise."
+                        ))
+                    if not parsed.params:
+                        violations.append((
+                            i + 1,
+                            func_name,
+                            "Missing 'Args' section",
+                            "Add an 'Args' section listing the arguments this function accepts, their types, and descriptions."
+                        ))
+                except Exception as e:
+                    violations.append((
+                        i + 1,
+                        func_name,
+                        "Docstring parsing error",
+                        f"Ensure the docstring is properly formatted: {e}"
+                    ))
+            else:
+                violations.append((
+                    i + 1,
+                    func_name,
+                    "Missing docstring",
+                    "Add a Google-style docstring to describe this function."
+                ))
+    return violations
+
+
+def check_directory(directory):
+    """Check all Python files in a directory for docstring compliance."""
+    all_violations = {}
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if file.endswith('.py'):
+                file_path = os.path.join(root, file)
+                violations = validate_docstring(file_path)
+                if violations:
+                    all_violations[file_path] = violations
+    return all_violations
+
+def main():
+    directory = sys.argv[1] if len(sys.argv) > 1 else '.'
+    violations = check_directory(directory)
+    if violations:
+        print("Docstring violations found:")
+        for file, issues in violations.items():
+            for line, func, issue in issues:
+                print(f"{file}:{line}: {func}: {issue}")
+        sys.exit(1)
+    else:
+        print("All docstrings are compliant.")
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -28,5 +28,8 @@ graphql_server==3.0.0b5
 mock
 pytest
 
+# Docstring Parser
+docstring_parser
+
 # Other
 more-itertools