Skip to content

Commit

Permalink
Update variable names
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenning committed Nov 17, 2023
1 parent 3320278 commit 0a90408
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions ciscoconfparse/ciscoconfparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -3262,14 +3262,14 @@ def replace_all_children(

# This method is on CiscoConfParse()
@logger.catch(reraise=True)
def re_search_children(self, regex, recurse=False):
"""Use ``regex`` to search for root parents in the config with text matching regex. If `recurse` is False, only root parent objects are returned. A list of matching objects is returned.
def re_search_children(self, regexspec, recurse=False):
"""Use ``regexspec`` to search for root parents in the config with text matching regex. If `recurse` is False, only root parent objects are returned. A list of matching objects is returned.
This method is very similar to :func:`~ciscoconfparse.CiscoConfParse.find_objects` (when `recurse` is True); however it was written in response to the use-case described in `Github Issue #156 <https://github.com/mpenning/ciscoconfparse/issues/156>`_.
Parameters
----------
regex : str
regexspec : str
A string or python regular expression, which should be matched.
recurse : bool
Set True if you want to search all objects, and not just the root parents
Expand All @@ -3283,22 +3283,22 @@ def re_search_children(self, regex, recurse=False):
## I implemented this method in response to Github issue #156
if recurse is False:
# Only return the matching oldest ancestor objects...
return [obj for obj in self.find_objects(regex) if (obj.parent is obj)]
return [obj for obj in self.find_objects(regexspec) if (obj.parent is obj)]
else:
# Return any matching object
return [obj for obj in self.find_objects(regex)]
return [obj for obj in self.find_objects(regexspec)]

# This method is on CiscoConfParse()
@logger.catch(reraise=True)
def re_match_iter_typed(
self,
regex,
regexspec,
group=1,
result_type=str,
default="",
untyped_default=False,
):
r"""Use ``regex`` to search the root parents in the config
r"""Use ``regexspec`` to search the root parents in the config
and return the contents of the regular expression group, at the
integer ``group`` index, cast as ``result_type``; if there is no
match, ``default`` is returned.
Expand All @@ -3310,16 +3310,15 @@ def re_match_iter_typed(
Parameters
----------
:regex : str
regexspec : str
A string or python compiled regular expression, which should be matched. This regular expression should contain parenthesis, which bound a match group.
:group : int
group : int
An integer which specifies the desired regex group to be returned. ``group`` defaults to 1.
:result_type : type
result_type : type
A type (typically one of: ``str``, ``int``, ``float``, or :class:`~ccp_util.IPv4Obj`). All returned values are cast as ``result_type``, which defaults to ``str``.
:default : any
default : any
The default value to be returned, if there is no match. The default is an empty string.
:untyped_default : bool
untyped_default : bool
Set True if you don't want the default value to be typed
Returns
Expand Down Expand Up @@ -3388,7 +3387,7 @@ def re_match_iter_typed(
if cobj.parent is not cobj:
continue

mm = re.search(regex, cobj.text)
mm = re.search(regexspec, cobj.text)
if mm is not None:
return result_type(mm.group(group))
## Ref Github issue #121
Expand Down

0 comments on commit 0a90408

Please sign in to comment.