StatisticsVisitor Class Reference

Public Member Functions
def	__init__ (self)
def	read_rst_file (self, Path path)
def	walk_directory (self, Path path)

Public Attributes
	statistics
	statistics object

Static Public Attributes
dict	regexes
	Dictionary keys must match attributes of Statistics class.

Detailed Description

Statistics visitor class

Definition at line 42 of file online_book_statistics.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Initialize class

Definition at line 57 of file online_book_statistics.py.

    def __init__(self):
        """Initialize class"""
        
        self.statistics = Statistics()
 

Member Function Documentation

read_rst_file()

def read_rst_file	(		self,
		Path	path
	)

Read rst file

Definition at line 62 of file online_book_statistics.py.

    def read_rst_file(self, path: Path):
        """Read rst file"""
        text = path.read_text()
        self.statistics.characters += len(text)
        for line in text.split("\n"):
            for key, regex in self.regexes.items():
                if regex.findall(line):
                    setattr(
                        self.statistics, key, getattr(self.statistics, key) + 1
                    )
 

walk_directory()

def walk_directory	(		self,
		Path	path
	)

Loop over all directories in the path

Definition at line 73 of file online_book_statistics.py.

    def walk_directory(self, path: Path):
        """Loop over all directories in the path"""
        print(f"Walking {path}")
        for root, _, files in os.walk(path):
            for file in files:
                path = Path(root) / file
                if path.suffix == ".rst":
                    self.read_rst_file(path)
 
 

Member Data Documentation

regexes

dict regexes

static

Initial value:

=  dict(
        code_inclusions=re.compile("(code-block\\s*::)|(literalinclude\\s*::)"),
        hints=re.compile(":class:.*hint"),
        solutions=re.compile(":class:.*solution"),
        exercises=re.compile(":class:.*exercise"),
        overview_boxes=re.compile(":class:.*overview"),
        key_points=re.compile(":class:.*key-points"),
        figures=re.compile("figure\\s*::")
    )

Dictionary keys must match attributes of Statistics class.

Definition at line 47 of file online_book_statistics.py.

statistics

statistics

statistics object

Definition at line 60 of file online_book_statistics.py.

---

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

• online_book/online_book_statistics.py