chore: adopt the NAPALM driver standard #9

Merged

christianmanivong merged 4 commits from chore/driver-standard into main 2026-10-23 09:57:17 +00:00

Conversation 0 Commits 4 Files Changed 14

+491 -192

christianmanivong commented 2026-10-23 06:48:26 +00:00

Owner

Copy link

Copy source

Summary

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

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: the except Exception: pass in set_interface logs at debug level (B110), with a module logger; nosec with a reason for the empty password field of get_users (B105, now a named constant); two docstrings quoting device output keep their lines (noqa E501); a long docstring and message shortened or split; a test referenced the undefined SHOW_INTERFACE (now SHOW_INTERFACE_STATUS); raise ... from exc in a test.
• chore: CI in .gitea/workflows/ci.yml calling the shared workflow; .github/ removed with publish.yml and tests.yml (Trusted Publishing never worked from Gitea); requirements.txt removed, it only repeated the pyproject dependencies; SPDX license, LICENSE, CHANGELOG, py.typed, URLs on git.netork.io (README included); napalm-device-types >=4.21.1; netaddr >=0.7.10 as a true floor, without which the lowest job cannot import; strict mypy with tplink_jetstream exempt for now; coverage floor 36 %; quality baseline. The version stays 0.4.0; PyPI still has the old 0.1.1 until the first release by tag.

Related Issue

Closes #8

Testing

Locally: 45 tests, coverage 36.71 %, ruff, mypy, bandit clean; napalm-standard check and ratchet clean; build + twine check --strict pass. The lowest job's install (uv --resolution lowest-direct, Python 3.10) passes too. Fixtures only.

## Summary napalm-tplink-jetstream adopts the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard). Epic: NAPALM/driver-standard#2. ## 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**: the `except Exception: pass` in `set_interface` logs at debug level (B110), with a module logger; nosec with a reason for the empty `password` field of `get_users` (B105, now a named constant); two docstrings quoting device output keep their lines (noqa E501); a long docstring and message shortened or split; a test referenced the undefined `SHOW_INTERFACE` (now `SHOW_INTERFACE_STATUS`); `raise ... from exc` in a test. - **chore**: CI in `.gitea/workflows/ci.yml` calling the shared workflow; `.github/` removed with `publish.yml` and `tests.yml` (Trusted Publishing never worked from Gitea); `requirements.txt` removed, it only repeated the pyproject dependencies; SPDX license, LICENSE, CHANGELOG, `py.typed`, URLs on git.netork.io (README included); napalm-device-types >=4.21.1; netaddr >=0.7.10 as a true floor, without which the lowest job cannot import; strict mypy with `tplink_jetstream` exempt for now; coverage floor 36 %; quality baseline. The version stays 0.4.0; PyPI still has the old 0.1.1 until the first release by tag. ## Related Issue Closes #8 ## Testing Locally: 45 tests, coverage 36.71 %, ruff, mypy, bandit clean; `napalm-standard check` and `ratchet` clean; build + `twine check --strict` pass. The lowest job's install (`uv --resolution lowest-direct`, Python 3.10) passes too. Fixtures only.

christianmanivong added 3 commits 2026-10-23 06:48:26 +00:00

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

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 ... bef2f23ab2

- set_interface: the except Exception: pass around reading the old
  untagged VLANs now logs at debug level (B110), with a module logger.
- nosec for the empty password field of get_users (B105, now a named
  constant); a false positive.
- Two docstrings quoting tabular device output keep their lines (noqa
  E501); a long docstring and an error message are shortened or split;
  the unused duplex column is named _duplex.
- tests: a get_facts test named SHOW_INTERFACE, which does not exist; it
  is SHOW_INTERFACE_STATUS. raise ... from exc.

chore: adopt the NAPALM driver standard ... 4e171bff30

- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow
  of NAPALM/driver-standard. .github/ goes with publish.yml and tests.yml:
  PyPI Trusted Publishing never worked from Gitea.
- requirements.txt goes: it only repeated the pyproject dependencies, with
  an older napalm-device-types floor and without paramiko.
- LICENSE file (the README already pointed to it), CHANGELOG, py.typed,
  SPDX license string, links to git.netork.io (README included);
  napalm-device-types >=4.21.1, a dev extra with floors.
- netaddr gets a true floor (>=0.7.10): unbounded, the lowest job
  installed a version without IPAddress, which napalm imports.
- mypy strict for the package; napalm_tplink_jetstream.tplink_jetstream is
  exempt for now (96 errors), recorded in the quality baseline with its
  long functions and the 2000-line module. Coverage floor 36 % (measured
  36.71 %).

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

chore(release): 0.5.0 06c55fabbe

christianmanivong merged commit bb977f04b4 into main 2026-10-23 09:57:17 +00:00

christianmanivong deleted branch chore/driver-standard 2026-10-23 09:57:17 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

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-tplink-jetstream#9