Relax docstrings

.github/actions/check_docstrings/action.yml

@@ -0,0 +1,63 @@
+name: Check Docstrings
+inputs:
+    python-version:
+        description: 'The version of Python to use for the workflow.'
+        default: '3.10'
+        required: false
+        type: string
+    repository:
+        description: 'The repository to check the docstrings for.'
+        required: True
+        type: string
+    branch:
+        description: 'The branch to check the docstrings for.'
+        required: false
+        type: string
+        default: ''
+    package-name:
+        description: 'The name of the package to check the docstrings for.'
+        required: True
+        type: string
+    names-to-skip:
+        description: 'The names of the modules/classes/functions/methods to skip in the docstring check.'
+        required: false
+        type: string
+        default: ''
+
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Conda
+      uses: s-weigand/setup-conda@v1
+
+    - name: Setup Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Global Setup
+      run: |
+        pip install -U pip
+        pip install pytest-xdist
+        git config --global user.email "[email protected]"
+        git config --global user.name "CI Almighty"
+      shell: bash
+
+    - name: Checkout Repository to be tested
+      uses: actions/checkout@v2
+      with:
+          repository: ${{ inputs.repository }}
+          ref: ${{ inputs.branch }}
+
+    - name: Install package
+      run: pip install .
+      shell: bash
+
+    - name: Checkout Home Repository
+      uses: actions/checkout@v2
+      with:
+          repository: catalystneuro/.github
+
+    - name: Run docstring check
+      run: pytest tests/test_docstrings.py --package=${{ inputs.package-name }} --names-to-skip=${{ inputs.names-to-skip }}
+      shell: bash

.github/workflows/test_check_docstrings.yaml

@@ -0,0 +1,17 @@
+name: Call Check Docstrings
+on:
+  workflow_dispatch:
+
+jobs:
+  check-docstrings:
+    runs-on: ubuntu-latest
+    name: Check Docstrings
+    steps:
+      - id: check_docstrings
+        uses: catalystneuro/.github/.github/actions/check_docstrings@main
+        with:
+          python-version: '3.10'
+          repository: 'catalystneuro/roiextractors'
+          branch: 'main'
+          package-name: 'roiextractors'
+          names-to-skip: 'skipped_fn'

tests/conftest.py

@@ -4,10 +4,13 @@
 
 def pytest_addoption(parser):
     parser.addoption("--package", action="store")
+    parser.addoption("--names-to-skip", action="store", default="")
 
 def pytest_generate_tests(metafunc):
     package_name = metafunc.config.getoption("--package")
+    names_to_skip = metafunc.config.getoption("--names-to-skip")
+    names_to_skip = names_to_skip.split(",") if names_to_skip else []
     package = import_module(package_name)
-    objs = traverse_package(package, package_name)
+    objs = traverse_package(package, package_name, names_to_skip=names_to_skip)
     if "obj" in metafunc.fixturenames:
         metafunc.parametrize("obj", objs)

tests/traverse.py

@@ -55,7 +55,7 @@ def traverse_module(module: ModuleType, parent: str, names_to_skip: Optional[Lis
 
         if isinstance(object_, type) and object_.__module__.startswith(parent):  # class
             class_object = object_
-            class_functions = traverse_class(class_object=class_object, parent=parent)
+            class_functions = traverse_class(class_object=class_object, parent=parent, names_to_skip=names_to_skip)
             local_classes_and_functions.append(class_object)
             local_classes_and_functions.extend(class_functions)
 
@@ -97,13 +97,13 @@ def traverse_package(package: ModuleType, parent: str, names_to_skip: Optional[L
             and object_.__package__.startswith(parent)
         ):
             subpackage = object_
-            subpackage_members = traverse_package(package=subpackage, parent=parent)
+            subpackage_members = traverse_package(package=subpackage, parent=parent, names_to_skip=names_to_skip)
             local_packages_and_modules.append(subpackage)
             local_packages_and_modules.extend(subpackage_members)
 
         elif isinstance(object_, ModuleType) and object_.__package__.startswith(parent):
             module = object_
-            module_members = traverse_module(module=module, parent=parent)
+            module_members = traverse_module(module=module, parent=parent, names_to_skip=names_to_skip)
             local_packages_and_modules.append(module)
             local_packages_and_modules.extend(module_members)