Flutter Engine
The Flutter Engine
Static Public Member Functions | List of all members
tools.misc_utils.ReSearch Class Reference
Inheritance diagram for tools.misc_utils.ReSearch:

Static Public Member Functions

def search_within_stream (input_stream, pattern, default=None)
 
def search_within_string (input_string, pattern, default=None)
 

Detailed Description

A collection of static methods for regexing things.

Definition at line 13 of file misc_utils.py.

Member Function Documentation

◆ search_within_stream()

def tools.misc_utils.ReSearch.search_within_stream (   input_stream,
  pattern,
  default = None 
)
static
Search for regular expression in a file-like object.

Opens a file for reading and searches line by line for a match to
the regex and returns the parenthesized group named return for the
first match.  Does not search across newlines.

For example:
    pattern = '^root(:[^:]*){4}:(?P<return>[^:]*)'
    with open('/etc/passwd', 'r') as stream:
        return search_within_file(stream, pattern)
should return root's home directory (/root on my system).

Args:
    input_stream: file-like object to be read
    pattern: (string) to be passed to re.compile
    default: what to return if no match

Returns:
    A string or whatever default is

Definition at line 17 of file misc_utils.py.

17 def search_within_stream(input_stream, pattern, default=None):
18 """Search for regular expression in a file-like object.
19
20 Opens a file for reading and searches line by line for a match to
21 the regex and returns the parenthesized group named return for the
22 first match. Does not search across newlines.
23
24 For example:
25 pattern = '^root(:[^:]*){4}:(?P<return>[^:]*)'
26 with open('/etc/passwd', 'r') as stream:
27 return search_within_file(stream, pattern)
28 should return root's home directory (/root on my system).
29
30 Args:
31 input_stream: file-like object to be read
32 pattern: (string) to be passed to re.compile
33 default: what to return if no match
34
35 Returns:
36 A string or whatever default is
37 """
38 pattern_object = re.compile(pattern)
39 for line in input_stream:
40 match = pattern_object.search(line)
41 if match:
42 return match.group('return')
43 return default
44

◆ search_within_string()

def tools.misc_utils.ReSearch.search_within_string (   input_string,
  pattern,
  default = None 
)
static
Search for regular expression in a string.

Args:
    input_string: (string) to be searched
    pattern: (string) to be passed to re.compile
    default: what to return if no match

Returns:
    A string or whatever default is

Definition at line 46 of file misc_utils.py.

46 def search_within_string(input_string, pattern, default=None):
47 """Search for regular expression in a string.
48
49 Args:
50 input_string: (string) to be searched
51 pattern: (string) to be passed to re.compile
52 default: what to return if no match
53
54 Returns:
55 A string or whatever default is
56 """
57 match = re.search(pattern, input_string)
58 return match.group('return') if match else default
59

The documentation for this class was generated from the following file: