chore: adopt the NAPALM driver standard #15

Merged

christianmanivong merged 5 commits from chore/driver-standard into main 2026-10-23 10:03:35 +00:00

Conversation 0 Commits 5 Files Changed 13

+495 -248

christianmanivong commented 2026-10-23 06:36:42 +00:00

Owner

Copy link

Copy source

Summary

napalm-netgear adopts the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard).
Epic: NAPALM/driver-standard#2.

The distribution is renamed to napalm-netgear-switches: napalm-netgear on PyPI belongs to another project. The import package napalm_netgear and the driver names netgear_smart / netgear_plus do not change.

Changes

• style: ruff format and ruff check --fix with the standard's rule set (E, F, I, UP, B, line length 100, Python 3.10). Mechanical.
• fix: a failed logout in the Netgear Plus close() logs at debug level (B110); justified nosec for the firmware CDN probe (B310: the URL is always https on the fixed _FW_CDN_BASE, model and version only fill the path) and the empty password field of get_users (B105, NAPALM's shape). A second TestGetLldpNeighbors class shadowed the first, whose two tests never ran; renamed, both run and pass.
• chore: distribution name napalm-netgear-switches with [tool.napalm-standard] package = "napalm_netgear"; CI in .gitea/workflows/ci.yml via the shared workflow, .github/ removed; Python >= 3.10, napalm-device-types>=4.21.1, SPDX license, LICENSE, py.typed, URLs on git.netork.io, dev extra, CHANGELOG.md; strict mypy with netgear_plus and netgear_smart exempt (139 errors), quality baseline, coverage floor 48 %.
• fix(deps): netaddr>=0.7.19; unfloored, the lowest job installs netaddr 0.3.1, which has no IPAddress.

Related Issue

Closes #14

Testing

Locally: 101 tests, coverage 48.23 %, ruff, mypy, bandit clean; napalm-standard check and ratchet clean; build + twine check --strict pass; the tests also pass at the declared floors (uv pip install --resolution lowest-direct, Python 3.10). Fixtures only.

## Summary napalm-netgear adopts the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard). Epic: NAPALM/driver-standard#2. The distribution is renamed to `napalm-netgear-switches`: `napalm-netgear` on PyPI belongs to another project. The import package `napalm_netgear` and the driver names `netgear_smart` / `netgear_plus` do not change. ## Changes - **style**: ruff format and `ruff check --fix` with the standard's rule set (E, F, I, UP, B, line length 100, Python 3.10). Mechanical. - **fix**: a failed logout in the Netgear Plus `close()` logs at debug level (B110); justified nosec for the firmware CDN probe (B310: the URL is always https on the fixed `_FW_CDN_BASE`, model and version only fill the path) and the empty `password` field of `get_users` (B105, NAPALM's shape). A second `TestGetLldpNeighbors` class shadowed the first, whose two tests never ran; renamed, both run and pass. - **chore**: distribution name `napalm-netgear-switches` with `[tool.napalm-standard] package = "napalm_netgear"`; CI in `.gitea/workflows/ci.yml` via the shared workflow, `.github/` removed; Python >= 3.10, `napalm-device-types>=4.21.1`, SPDX license, LICENSE, `py.typed`, URLs on git.netork.io, dev extra, CHANGELOG.md; strict mypy with `netgear_plus` and `netgear_smart` exempt (139 errors), quality baseline, coverage floor 48 %. - **fix(deps)**: `netaddr>=0.7.19`; unfloored, the lowest job installs netaddr 0.3.1, which has no `IPAddress`. ## Related Issue Closes #14 ## Testing Locally: 101 tests, coverage 48.23 %, ruff, mypy, bandit clean; `napalm-standard check` and `ratchet` clean; build + `twine check --strict` pass; the tests also pass at the declared floors (`uv pip install --resolution lowest-direct`, Python 3.10). Fixtures only.

christianmanivong added 3 commits 2026-10-23 06:36:42 +00:00

style: ruff format and the lint rules of the driver standard ... fa10d6617b

Mechanical: ruff format, and ruff check --fix with the rule set every NAPALM
driver uses (E, F, I, UP, B at line length 100, Python 3.10). What ruff
cannot fix comes in the next commit.

fix: what bandit and the remaining lint rules found ... 672bc04261

- Netgear Plus: a failed logout on close() now logs at debug level (B110),
  so a swallowed failure leaves a trace; the module gets its logger.
- nosec for the firmware CDN probe (B310): the URL is built on the fixed
  https base _FW_CDN_BASE, model and version only fill its path, so no
  file:// or custom scheme can reach urlopen.
- nosec for the empty password in get_users (B105): it is NAPALM's field,
  the CLI never shows a password; a false positive.
- The v7 LLDP table in a docstring loses one leading space per line to fit
  line length 100.
- tests: a second TestGetLldpNeighbors class shadowed the first, whose two
  tests never ran; the v7 one is now TestGetLldpNeighborsV7 and both run
  (and pass). raise ... from exc in the netmiko stand-in.

chore: adopt the NAPALM driver standard ... 10a3b1efbf

- The distribution is renamed to napalm-netgear-switches: napalm-netgear
  on PyPI belongs to another project. The import package napalm_netgear
  and the napalm.drivers entry points netgear_smart and netgear_plus stay;
  [tool.napalm-standard] package names the import package for the check.
  README install line and CHANGELOG say the new name.
- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow
  of NAPALM/driver-standard; .github/ is gone.
- requires-python >=3.10 (napalm-device-types needs it), floor
  napalm-device-types>=4.21.1, LICENSE file, py.typed, SPDX license string,
  links to git.netork.io, a dev extra with floors, CHANGELOG.md.
- mypy strict for the package; napalm_netgear.netgear_plus and
  napalm_netgear.netgear_smart are exempt for now (139 errors), recorded
  in the quality baseline with their long and complex functions and the
  2070-line netgear_smart module. Coverage floor 48 % (measured 48.23 %).

Closes #14

christianmanivong added 1 commit 2026-10-23 06:46:45 +00:00

fix(deps): a floor on netaddr the lowest CI job can use ... 0de16e0b79

Without one, uv's lowest-direct resolution installs netaddr 0.3.1, which
has no IPAddress, and every test module fails to import. 0.7.19 has
IPAddress, IPNetwork and AddrFormatError, and the tests pass at exactly
the declared floors on Python 3.10.

christianmanivong added 1 commit 2026-10-23 08:29:07 +00:00

chore(release): 0.6.0 d79391238f

christianmanivong merged commit a3e036a63a into main 2026-10-23 10:03:35 +00:00

christianmanivong deleted branch chore/driver-standard 2026-10-23 10:03:35 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is broken

bug

Something is broken

enhancement

New feature or request

tech-debt

Refactoring / cleanup / deferred debt

prio

P0

Road blocker: blocks other work, drop everything

prio

P1

Critical

prio

P2

Important and urgent

prio

P3

Important, not urgent

prio

P4

Neither important nor urgent

No labels

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

christianmanivong

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: NAPALM/napalm-netgear#15