GreppedOut class

class glorifiedgrep.out.GreppedOut(data)

Thre GreppedOut class is generally used to capture the output of code analysis methods and offers various helper attributes and properties.

Returns:
Return type:object
__init__(data)

Initialize self. See help(type(self)) for accurate signature.

count

A count of the number of items either in the array or dict that is returned. This is a property.

Returns:Count of items
Return type:int
exclude_file(path: str) → glorifiedgrep.out.GreppedOut

Exclude matches from the files which partially matches the path argument. This method can be chained for multiple file paths.

Returns:GreppedOut object
Return type:GreppedOut
files

Get a set of file names where matches were found

Returns:Set of filenames
Return type:set
in_file(path: str) → glorifiedgrep.out.GreppedOut

Only include matches from the files which partially matches the path argument. This method can be chained for multiple file paths.

Returns:GreppedOut object
Return type:GreppedOut
matches

Get only the code matches in an array

Returns:List of matches
Return type:list