projectreport.analyzer.parsers.multi package

Submodules

projectreport.analyzer.parsers.multi.file module

class projectreport.analyzer.parsers.multi.file.MultiFileParser(path, file_names, file_parsers=None)[source]

Bases: FolderParser

__init__(path, file_names, file_parsers=None)[source]
Parameters:
  • path (str) – This should be the path of a folder, rather than a path to a file that the other parsers accept.

  • file_parsers (Optional[Dict[str, Parser]]) – Defaults to PARSER_DOC_FILES.

docstring()
Return type:

Optional[str]

classmethod matches_path(path, file_names)[source]
Return type:

bool

topics()
Return type:

Optional[Sequence[str]]

version()
Return type:

Optional[Version]

projectreport.analyzer.parsers.multi.main module

class projectreport.analyzer.parsers.multi.main.MainMultiParser(path, file_names, urls=None, parsers=None)[source]

Bases: Parser

The main parser that uses other parsers, both single- and multi- together to determine information about a folder.

__init__(path, file_names, urls=None, parsers=None)[source]
Parameters:
data_type: ClassVar[ParserDataType]
docstring()
Return type:

Optional[str]

license()
Return type:

Optional[License]

classmethod matches_path(path, file_names, urls=None)[source]
Return type:

bool

topics()
Return type:

Optional[Sequence[str]]

version()
Return type:

Optional[Version]