starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Remove useless griffe type/annotation warnings in upgrade.sh #11189

New Issue
Closed
opened 2025-12-29 21:41:42 +01:00 by adam · 6 comments
adam commented 2025-12-29 21:41:42 +01:00
Owner
Copy Link

Originally created by @markkuleinio on GitHub (May 16, 2025).

NetBox version

v4.3.1

Feature type

Change to existing functionality

Proposed functionality

I'm proposing ignoring the "No type or annotation" warnings from griffe (mkdocs build) outputs in upgrade.sh.

It can be done by replacing the current

COMMAND="mkdocs build"

with

COMMAND="mkdocs build 2> >(grep -v 'No type or annotation for parameter')"

Output of that section after the change:

Building documentation (mkdocs build 2> >(grep -v 'No type or annotation for parameter'))...
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /opt/netbox/netbox/project-static/docs
INFO    -  Documentation built in 10.11 seconds

(= there are no type/annotation warnings anymore)

AFAIK, there is no way to suppress those natively in griffe while still keeping the INFO level outputs. (In mkdocs build there is a "-q, --quiet: Silence warnings" option but it silences everything, not just warnings. Since the run takes that long, I believe the full mute is not feasible here.)

Alternatively, types or annotations could be added in the NetBox source files+parameters shown in the griffe warnings. This solution above could still be implemented as a fast solution while the type/annotation addition is in the works.

Use case

When running upgrade.sh, in the "Building documentation (mkdocs build)..." phase, there are 60+ lines of this kind of output:

WARNING - griffe: netbox/netbox/jobs.py:50: No type or annotation for parameter 'job'
WARNING - griffe: netbox/netbox/jobs.py:143: No type or annotation for parameter 'instance'
WARNING - griffe: netbox/netbox/jobs.py:144: No type or annotation for parameter 'schedule_at'
WARNING - griffe: netbox/netbox/jobs.py:145: No type or annotation for parameter 'interval'
...

It distracts the NetBox administrator running the upgrade.sh task when upgrading NetBox, and does not provide any meaningful or actionable outputs for the administrator.

Database changes

None

External dependencies

None (upgrade.sh already requires bash and grep, and the redirection syntax is working with bash)

Originally created by @markkuleinio on GitHub (May 16, 2025). ### NetBox version v4.3.1 ### Feature type Change to existing functionality ### Proposed functionality I'm proposing ignoring the "**No type or annotation**" warnings from `griffe` (`mkdocs build`) outputs in `upgrade.sh`. It can be done by replacing the current ``` COMMAND="mkdocs build" ``` with ``` COMMAND="mkdocs build 2> >(grep -v 'No type or annotation for parameter')" ``` Output of that section after the change: ``` Building documentation (mkdocs build 2> >(grep -v 'No type or annotation for parameter'))... INFO - Cleaning site directory INFO - Building documentation to directory: /opt/netbox/netbox/project-static/docs INFO - Documentation built in 10.11 seconds ``` (= there are no type/annotation warnings anymore) AFAIK, there is no way to suppress those natively in griffe while still keeping the INFO level outputs. (In `mkdocs build` there is a "-q, --quiet: Silence warnings" option but it silences everything, not just warnings. Since the run takes that long, I believe the full mute is not feasible here.) Alternatively, types or annotations could be added in the NetBox source files+parameters shown in the griffe warnings. This solution above could still be implemented as a fast solution while the type/annotation addition is in the works. ### Use case When running `upgrade.sh`, in the "Building documentation (mkdocs build)..." phase, there are 60+ lines of this kind of output: > WARNING - griffe: netbox/netbox/jobs.py:50: No type or annotation for parameter 'job' WARNING - griffe: netbox/netbox/jobs.py:143: No type or annotation for parameter 'instance' WARNING - griffe: netbox/netbox/jobs.py:144: No type or annotation for parameter 'schedule_at' WARNING - griffe: netbox/netbox/jobs.py:145: No type or annotation for parameter 'interval' ... It distracts the NetBox administrator running the `upgrade.sh` task when upgrading NetBox, and does not provide any meaningful or actionable outputs for the administrator. ### Database changes None ### External dependencies None (`upgrade.sh` already requires bash and grep, and the redirection syntax is working with bash)
adam added the type: housekeeping label 2025-12-29 21:41:42 +01:00
adam closed this issue 2025-12-29 21:41:42 +01:00
adam commented 2025-12-29 21:41:42 +01:00
Author
Owner
Copy Link

@mr1716 commented on GitHub (May 16, 2025):

The other option would be to add said information so the results dont show up. But not sure how that would be done nor if even worth it

@mr1716 commented on GitHub (May 16, 2025): The other option would be to add said information so the results dont show up. But not sure how that would be done nor if even worth it
adam commented 2025-12-29 21:41:43 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 16, 2025):

Simply suppressing the output is not a valid solution: The root cause must be identified and addressed. I'll mark this as open for a volunteer but please note that only a proper fix will be considered.

@jeremystretch commented on GitHub (May 16, 2025): Simply suppressing the output is not a valid solution: The root cause must be identified and addressed. I'll mark this as open for a volunteer but please note that only a proper fix will be considered.
adam commented 2025-12-29 21:41:43 +01:00
Author
Owner
Copy Link

@AlexandreLanglade commented on GitHub (May 17, 2025):

Hi

  1. If interested in it, I've found a 3 years old issue about ignoring unwanted warnings in the mkdocs project (here)

  2. About the cause here, that's what I suspect :

I take the first warning as the exemple WARNING - griffe: netbox/netbox/jobs.py:50: No type or annotation for parameter 'job'
but the cause should be identical for the 60 lines.

This is the current code's doc 'missing' type or annotation :
netbox/netbox/jobs.py

    def __init__(self, job):
        """
        Args:
            job: The specific `Job` this `JobRunner` is executing.
        """
        self.job = job

   Args:
       param1 (int): The first parameter.
       param2 (str): The second parameter.

⬇️​

   Args:
       job (Job): The specific `Job` this `JobRunner` is executing.

def surface_area_of_cube(edge_length: float):
   ...

⬇️​

def __init__(self, job: Job):
   ...
@AlexandreLanglade commented on GitHub (May 17, 2025): Hi 1) If interested in it, I've found a 3 years old issue about ignoring unwanted warnings in the mkdocs project ([here](https://github.com/mkdocstrings/mkdocstrings/issues/437)) 2) About the cause here, that's what I suspect : I take the first warning as the exemple `WARNING - griffe: netbox/netbox/jobs.py:50: No type or annotation for parameter 'job'` but the cause should be identical for the 60 lines. This is the current code's doc 'missing' type or annotation : [netbox/netbox/jobs.py](https://github.com/netbox-community/netbox/blob/v4.3.1/netbox/netbox/jobs.py#L48-L53) ```python def __init__(self, job): """ Args: job: The specific `Job` this `JobRunner` is executing. """ self.job = job ``` - Fix 1 : [Example Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) ``` Args: param1 (int): The first parameter. param2 (str): The second parameter. ``` ⬇️​ ``` Args: job (Job): The specific `Job` this `JobRunner` is executing. ``` - or Fix 2 : [type hints doc](https://docs.python.org/3/library/typing.html) ```python def surface_area_of_cube(edge_length: float): ... ``` ⬇️​ ```python def __init__(self, job: Job): ... ```
adam commented 2025-12-29 21:41:43 +01:00
Author
Owner
Copy Link

@mr1716 commented on GitHub (May 29, 2025):

Which way do we want to go with this? This should be a quicker fix if Fix 1 maybe? I could even try to document where the alerts are coming from so we can handle it?

@mr1716 commented on GitHub (May 29, 2025): Which way do we want to go with this? This should be a quicker fix if Fix 1 maybe? I could even try to document where the alerts are coming from so we can handle it?
adam commented 2025-12-29 21:41:44 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Aug 28, 2025):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Aug 28, 2025): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/main/CONTRIBUTING.md).
adam commented 2025-12-29 21:41:44 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 4, 2025):

I believe this was addressed under #20092.

@jeremystretch commented on GitHub (Sep 4, 2025): I believe this was addressed under #20092.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11189
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?