Reorganization of the wrapper by apps #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

FBoissadier wants to merge 181 commits into N4S4:a_new_way from FBoissadier:feature/reorganization-by-app

.github/workflows/pre-commit-autoupdate.yml

-Original file line number
+Diff line change
@@ -0,0 +1,49 @@
+    name: pre-commit
+    permissions:
+      contents: write
+      pull-requests: write
+    concurrency:
+      group: pre-commit-${{ github.ref }}-autoupdate
+      cancel-in-progress: true
+    on:
+      schedule:
+        - cron: '0 3 * * 1'
+      workflow_dispatch:
+    jobs:
+      autoupdate:
+        if: github.ref == 'refs/heads/main'
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+          - name: Cache asdf
+            uses: actions/cache@v4
+            with:
+              path: |
+                ~/.asdf
+              key: ${{ runner.os }}-asdf-${{ hashFiles('.tool-versions') }}
+              restore-keys: |
+                ${{ runner.os }}-asdf-
+          - uses: asdf-vm/actions/install@v4
+          - name: Run pre-commit autoupdate
+            id: pre_commit_autoupdate
+            run: |
+              pre-commit autoupdate
+              if git diff --quiet ".pre-commit-config.yaml"; then
+                echo "No changes to commit"
+                echo "autoupdate=false" >> "$GITHUB_ENV"
+                exit 0
+              fi
+              echo "autoupdate=true" >> "$GITHUB_ENV"
+          - name: Create Pull Request
+            if: success() && steps.pre_commit_autoupdate.outcome == 'success' && env.autoupdate == 'true'
+            uses: peter-evans/create-pull-request@v7
+            with:
+              title: "chore(pre-commit): autoupdate hooks"
+              body: "Automated pre-commit autoupdate."
+              commit-message: "chore(pre-commit): autoupdate hooks"
+            env:
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pre-commit.yml

-Original file line number
+Diff line change
@@ -0,0 +1,28 @@
+    name: pre-commit
+    concurrency:
+      group: pre-commit-${{ github.ref }}
+      cancel-in-progress: true
+    on:
+      pull_request:
+      push:
+        branches: [main]
+    jobs:
+      validate:
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v4
+        - name: Cache asdf
+          uses: actions/cache@v4
+          with:
+            path: |
+              ~/.asdf
+            key: ${{ runner.os }}-asdf-${{ hashFiles('.tool-versions') }}
+            restore-keys: |
+              ${{ runner.os }}-asdf-
+        - uses: asdf-vm/actions/install@v4
+        - uses: pre-commit/action@v3.0.1
+    #      env:
+    #        SKIP: hook-id-to-skip

.github/workflows/test-deploy.yml

This file was deleted.

.github/workflows/test-docs.yml

-Original file line number
+Diff line change
@@ -0,0 +1,32 @@
+    name: test-docs
+    defaults:
+      run:
+        shell: bash
+    on:
+      pull_request:
+        branches:
+          - master
+    jobs:
+      generate:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+            with:
+              fetch-depth: 0
+          - name: Cache asdf
+            uses: actions/cache@v4
+            with:
+              path: |
+                ~/.asdf
+              key: ${{ runner.os }}-asdf-${{ hashFiles('.tool-versions') }}
+              restore-keys: |
+                ${{ runner.os }}-asdf-
+          - uses: asdf-vm/actions/install@v4
+          - name: Install Python dependencies
+            run: |
+              pip install --upgrade pip
+              pip install -r requirements.txt
+              pip install -r requirements-dev.txt
+          - run: task docs

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -401,4 +401,4 @@ FodyWeavers.xsd @@
     *.sln.iml
     # Test resources
-    tests/resources/config-test.json
+    tests/resources/config-test.json

.pre-commit-config.yaml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,11 +1,11 @@
  
    ci:

      skip: [ pytest ]

      skip: [pytest]

    default_language_version:

      python: python3.13

    default_install_hook_types: [ pre-commit, pre-push, commit-msg ]

    default_stages: [ pre-commit, pre-push, commit-msg ]

    default_install_hook_types: [pre-commit, pre-push, commit-msg]

    default_stages: [pre-commit, pre-push, commit-msg]

    repos:

      # general checks (see here: https://pre-commit.com/hooks.html)

    @@ -23,6 +23,7 @@ repos:
  
      - repo: https://github.com/numpy/numpydoc

        rev: v1.9.0

        stages: [ pre-commit ]

        hooks:

          - id: numpydoc-validation
      
          - id: numpydoc-validation

            stages: [pre-commit, manual]

            files: ^synology_api/

.tool-versions

-Original file line number
+Diff line change
@@ -1,5 +1,5 @@
     nodejs 18.18.0
-    python 3.9.6
+    python 3.13.5
     task 3.44.0
     shfmt 3.11.0
     shellcheck 0.10.0
@@ Expand Down @@

Taskfile.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,7 @@ tasks: @@
         dir: '{{.TASKFILE_DIR}}'
         cmds:
           - echo "Parsing the documentation files..."
-          - python3 docs_parser.py -a
+          - python3 docs_parser.py -a --exit-on-warning
       docs-build:
         desc: Build the documentation website
@@ Expand Down Expand Up / @@ -96,3 +96,17 @@ tasks: @@
         cmds:
           - echo "Validating numpydoc format..."
           - pre-commit run numpydoc-validation -a
+      numpydoc-lint:
+        desc: Lint the numpydoc format of the documentation
+        dir: '{{.TASKFILE_DIR}}'
+        cmds:
+          - echo "Linting numpydoc format..."
+          - pydocstringformatter -w ./synology_api/
+      numpydoc:
+        desc: Lint and validate the numpydoc format of the documentation
+        dir: '{{.TASKFILE_DIR}}'
+        cmds:
+          - task: numpydoc-lint
+          - task: numpydoc-validation

docs_parser.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -178,6 +178,9 @@ def init_parser() -> argparse.ArgumentParser: @@
         parser.add_argument('-e', '--excluded',
                             action='store_true',
                             help='Show a list of the excluded files to parse.')
+        parser.add_argument('--exit-on-warning',
+                            action='store_true',
+                            help='Exit if a warning is encountered.')
         return parser
@@ Expand Down Expand Up / @@ -388,13 +391,38 @@ def write(path: str, content: str): @@
             f.write(content)
+    class WarningCatcher:
+        def __init__(self):
+            self.warnings = []
+        def __call__(self, message, category, filename, lineno, file=None, line=None):
+            msg = warnings.formatwarning(message, category, filename, lineno, line)
+            self.warnings.append(msg)
+        def has_warnings(self):
+            return bool(self.warnings)
+        def print_warnings(self):
+            for w in self.warnings:
+                print(w, end='')
     def main():
         parser = init_parser()
         files, parse_api_list, parse_docs = validate_args(parser)
+        # Setup warning catcher
+        warning_catcher = WarningCatcher()
+        warnings.showwarning = warning_catcher
         # Generation for Getting Started/Supported APIs with all the APIs user per class.
         supported_apis = gen_supported_apis()
+        # Check if --exit-on-warning flag is set
+        exit_on_warning = any(arg in ('--exit-on-warning',) for arg in sys.argv)
+        any_warning = False
         for file_name in files:
             doc_content = ''
             file_path = join(PARSE_DIR, file_name)
@@ Expand Down Expand Up / @@ -427,10 +455,18 @@ def main(): @@
             if parse_docs:
                 write(DOCS_DIR + file_name.replace('.py', '.md'), doc_content)
             print('='*20)
+            if warning_catcher.has_warnings():
+                any_warning = True
+                # else: continue to process all files
         # Write to md files if the args were set
         if parse_api_list:
             write(API_LIST_FILE, supported_apis)
+        if any_warning and exit_on_warning:
+            sys.exit(1)
     if __name__ == "__main__":
         main()

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reorganization of the wrapper by apps #259

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Reorganization of the wrapper by apps #259

Are you sure you want to change the base?

Uh oh!

Reorganization of the wrapper by apps #259

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!