Merge branch 'main' into dependabot-pr

Author: mpenning

.github/dependabot.yml

@@ -1,5 +1,10 @@
 version: 2
 updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "monthly"
+  target-branch: dependabot-pr
 - package-ecosystem: pip
   directory: "/"
   schedule:

.github/workflows/tests.yml

@@ -48,37 +48,24 @@ jobs:
           python-version: '${{ matrix.python }}'
       - name: 'Display Python version'
         run: 'python -c ''import sys; print(sys.version)'''
-      - name: 'Install dependencies on macos and fix scrypt install with CFLAGS / LDFLAGS'
-        if: '${{ matrix.os == ''macos-latest'' }}'
-        run: |
-          true  ###############################################################
-          true  # install pip, pytest, and python packages
-          true  #     asterisk globbing is fragile, so don't use asterisk path
-          true  #     globs.  Just call out individual files, below.
-          true  ###############################################################
-          python -m pip install --upgrade pip
-          pip install -U pytest
-          true  ###############################################################
-          true  #     Install ourself
-          true  ###############################################################
-          true  # Fix macos scrypt imports manually because they throw errors otherwise
-          export CFLAGS="-I$(brew --prefix openssl)/include"
-          export LDFLAGS="-L$(brew --prefix openssl)/lib"
-          pip install -U .
-      - name: 'Install dependencies on Ubuntu Linux / Windows'
-        if: '${{ matrix.os != ''macos-latest'' }}'
+      - name: "Install the latest version of uv"
+        uses: "astral-sh/setup-uv@v6"
+        with:
+          version: "latest"
+      - name: 'Install dependencies on Ubuntu Linux / Windows / MacOS'
         run: |
           true  ###############################################################
-          true  # install pip, pytest, and python packages
-          true  #     asterisk globbing is fragile, so don't use asterisk path
-          true  #     globs.  Just call out individual files, below.
+          true  # install pip
+          true  #     asterisk globbing is fragile
           true  ###############################################################
           python -m pip install --upgrade pip
-          pip install -U pytest
           true  ###############################################################
-          true  #     Install ourself
+          true  #     Install all dependencies, including dev deps
+          true  #         then install ourself
+          true  #
+          true  #     Use --system to install to the test runner system python
           true  ###############################################################
-          pip install -U .
+          uv pip install --system -r pyproject.toml --extra dev .
       - name: 'Run pytest'
         run: |-
           true  ###############################################################

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: "pyupgrade"
         name: "Auto-standardize python syntax"
         args:
-          - "--py3-plus"
+          - "--py39-plus"
         language: "python"
         verbose: true
 

CHANGES.md

@@ -4,6 +4,80 @@
 - Summary:
     - Insert something here
 
+## Version: 0.8.29
+
+- Released: 2025-07-19
+- Summary:
+    - Migrate documentation from reStructuredText to markdown (myST flavor)
+    - Warn users of `CiscoPassword()` class against usage which will soon be deprecated
+
+## Version: 0.8.28
+
+- Released: 2025-07-12
+- Summary:
+    - Use a better random number generator to create the salt for Cisco Type 8 passwords (Type 9 scrypt passwords already use a better random number generator)
+
+## Version: 0.8.27
+
+- Released: 2025-07-12
+- Summary:
+    - Another attempt to silence SonarQube warnings about scrypt() r being too low.  It seems that Cisco IOS requires r=1
+
+## Version: 0.8.26
+
+- Released: 2025-07-12
+- Summary:
+    - Silence SonarQube warnings about scrypt() r being too low.  It seems that Cisco IOS requires r=1
+
+## Version: 0.8.25
+
+- Released: 2025-07-12
+- Summary:
+    - Add MacOS back into the test matrix
+
+## Version: 0.8.24
+
+- Released: 2025-07-12
+- Summary:
+    - Remove scrypt and cryptography imports
+
+## Version: 0.8.23
+
+- Released: 2025-07-12
+- Summary:
+    - Replace https://pypi.org/project/scrypt/ with `hashlib.scrypt()`
+
+## Version: 0.8.22
+
+- Released: 2025-07-04
+- Summary:
+    - attempting to retire use of passlib==1.7.4, which is now unmaintained.  [`libpass`][2] will be used instead...
+
+## Version: 0.8.21
+
+- Released: 2025-07-04
+- Summary:
+    - Add hypothesis `IPv4Obj()` and `IPv6Obj()` tests
+    - Remove unused sshd mock
+    - Remove tomlkit and tox as dev dependencies
+    - Update typeguard to the latest version
+    - Remove `requirements/` directory
+
+## Version: 0.8.20
+
+- Released: 2025-05-17
+- Summary:
+    - Add initial context-manager support to `CiscoConfParse()`
+    - Add initial context-manager support to `ConfigList()`
+    - Remove support for the `ConfigList().CiscoConfParse` attribute
+    - Implement `traitlets` on non-container objects instead of typeguard
+
+## Version: 0.8.19
+
+- Released: 2025-05-17
+- Summary:
+    - Make dev dependencies explicit
+
 ## Version: 0.8.18
 
 - Released: 2025-05-17
@@ -840,3 +914,4 @@
     - Start new project as `ciscoconfparse2` from the original `ciscoconfparse` version 1.9.51
 
 [1]: http://www.pennington.net/py/ciscoconfparse2/
+[2]: https://github.com/notypecheck/passlib

Makefile

@@ -49,6 +49,7 @@ install_build:
 cicd:
 	@echo "$(COL_CYAN)>> Use CI/CD to publish ciscoconfparse2 pypi artifacts$(COL_END)"
 	make clean
+	-git commit --all -m "chore: commit changes I forgot before running 'make cicd'"
 	# yamlfix doesn't understand pyproject.toml config
 	#     if used in pre-commit...
 	yamlfix .github/workflows/

README.md

@@ -137,7 +137,7 @@ complex queries about these relationships.
 
 In late 2023, I started a rewrite because [ciscoconfparse][64] is too large
 and has some defaults that I wish it didn't have.  I froze
-[ciscoconfparse][64] PYPI releases at [version 1.9.41][65]; there will be no
+[ciscoconfparse][64] PYPI releases at [version 1.9.52][65]; there will be no
 more [ciscoconfparse][64] PYPI releases.
 
 What do you do?  Upgrade to [ciscoconfparse2][17]!
@@ -151,7 +151,7 @@ Here's why, it:
 - Defaults `ignore_blank_lines=False` (this could be a breaking change for old scripts).
 - Is better at handling multiple-child-level configurations (such as IOS XR and JunOS)
 - Can search for parents and children using an *arbitrary list of ancestors*
-- Adds the concept of change commits; this is a config-modification safety feature that [ciscoconfparse][64] lacks
+- Adds the concept of change commits; this is a config-modification performance feature that [ciscoconfparse][64] lacks
 - Adds an `auto_commit` keyword, which defaults True
 - Documents much more of the API
 - Intentionally requires a different import statement to minimize confusion between the original and [ciscoconfparse2][17]
@@ -171,21 +171,21 @@ Here's why, it:
 
 - [Python 3](https://python.org/)
 - [attrs](https://github.com/python-attrs/attrs)
-- [passlib](https://github.com/glic3rinu/passlib)
-- [tomlkit](https://github.com/sdispater/tomlkit)
+- [libpass](https://github.com/notypecheck/passlib)
 - [dnspython](https://github.com/rthalley/dnspython)
 - [`hier_config`](https://github.com/netdevops/hier_config)
 - [`PyYAML`](https://github.com/yaml/pyyaml)
+- [`macaddress`](https://github.com/mentalisttraceur/python-macaddress)
 - [`pyparsing`](https://github.com/pyparsing/pyparsing)
-- [typeguard](https://github.com/agronholm/typeguard)
+- [`traitlets`](https://github.com/ipython/traitlets)
+- [`rich`](https://github.com/Textualize/rich)
+- [`typeguard`](https://github.com/agronholm/typeguard)
 - [loguru](https://github.com/Delgan/loguru)
 
 
 ## Pre-requisites
 
-[The ciscoconfparse2 python package][3] requires Python versions 3.7+.
-
-Type-hinting (work-in-progress) targets Python3.9+ due to the need for `tuple[str, ...]` hints.
+[The ciscoconfparse2 python package][3] requires Python versions 3.9+.
 
 ## What is the pythonic way of handling script credentials?
 
@@ -217,7 +217,7 @@ I will not. however, if it's truly a problem for your company, there are commerc
 
 [ciscoconfparse2][3] is licensed [GPLv3][21]
 
-- Copyright (C) 2023-2024 David Michael Pennington
+- Copyright (C) 2025 David Michael Pennington
 
 The word \"Cisco\" is a registered trademark of [Cisco Systems][27].
 
@@ -290,7 +290,7 @@ The word \"Cisco\" is a registered trademark of [Cisco Systems][27].
   [62]: https://sonarcloud.io/summary/new_code?id=mpenning_ciscoconfparse2
   [63]: https://docs.pytest.org/en/
   [64]: https://github.com/mpenning/ciscoconfparse
-  [65]: https://pypi.org/project/ciscoconfparse/1.9.41/
+  [65]: https://pypi.org/project/ciscoconfparse/1.9.52/
   [66]: https://raw.githubusercontent.com/mpenning/ciscoconfparse2/main/sphinx-doc/_static/ciscoconfparse_logo_bw_01.png
   [67]: http://www.pennington.net/py/ciscoconfparse2/cli.html
   [68]: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg

README_workflow.md

@@ -1 +1 @@
-__version__ = "0.8.18"
+__version__ = "0.8.29"

ciscoconfparse2/__about__.py

@@ -40,7 +40,6 @@
 from ciscoconfparse2.ccp_util import log_function_call
 from ciscoconfparse2.ccp_util import enforce_valid_types
 from ciscoconfparse2.ccp_util import fix_repeated_words
-from ciscoconfparse2.ccp_util import __ccp_re__
 from ciscoconfparse2.ccp_util import _get_ipv4
 from ciscoconfparse2.ccp_util import _get_ipv6
 from ciscoconfparse2.ccp_util import ip_factory

ciscoconfparse2/__init__.py

@@ -497,7 +497,7 @@ def verbose(self) -> str:
 
     # On BaseCfgLine()
     @property
-    def all_parents(self) -> List:
+    def all_parents(self) -> list:
         """
         :return: A sequence of all parent objects, not including this object
         :rtype: List[BaseCfgLine]
@@ -516,7 +516,7 @@ def all_parents(self) -> List:
 
     # On BaseCfgLine()
     @property
-    def all_children(self) -> List:
+    def all_children(self) -> list:
         """
         :return: A sequence of all child objects, not including this object
         :rtype: List[BaseCfgLine]
@@ -1112,7 +1112,7 @@ def strip(self, chars: str = None) -> str:
 
     # On BaseCfgLine()
     @logger.catch(reraise=True)
-    def split(self, sep: str = None, maxsplit: int = -1) -> List[str]:
+    def split(self, sep: str = None, maxsplit: int = -1) -> list[str]:
         """
         Split ``text`` in-place
 
@@ -1680,7 +1680,7 @@ def re_list_iter_typed(
         groupdict: dict = None,
         recurse: bool = True,
         debug: bool = False,
-    ) -> List[Any]:
+    ) -> list[Any]:
         r"""Use ``regex`` to search the children of
         :class:`~ciscoconfparse2.models_cisco.IOSCfgLine` text and return a list of the contents of
         objects matching the regular expression group, at the integer ``group`` index, cast as