kapidox::preprocessing

kapidox.preprocessing Namespace Reference

Functions

def create_metainfo (path)
 
def expand_platform_all (dct, available_platforms)
 
def extract_product (metainfo, all_maintainers)
 
def parse_tree (rootdir)
 
def sort_metainfo (metalist, all_maintainers)
 

Variables

string PLATFORM_ALL = "All"
 
string PLATFORM_UNKNOWN = "UNKNOWN"
 

Detailed Description

Preprocessing of the needed information.

The module allow to walk through folders, read metainfo files and create products, subgroups and libraries representing the projects.

Function Documentation

def kapidox.preprocessing.create_metainfo (   path,
  Optional,
  Dict,
  str,
  Any 
)

Look for a metadata.yaml file and create a dictionary out it.

Parameters
path(string) the current path to search.
Returns
A dictionary containing all the parsed information, or None if it did not fulfill some conditions.

Definition at line 72 of file preprocessing.py.

def kapidox.preprocessing.expand_platform_all (   dct,
  available_platforms 
)

If one of the keys of dct is PLATFORM_ALL (or PLATFORM_UNKNOWN), remove it and add entries for all available platforms to dct.

Parameters
dct(dictionary) dictionary to expand
available_platforms(list of string) name of platforms

Definition at line 47 of file preprocessing.py.

def kapidox.preprocessing.extract_product (   metainfo,
  all_maintainers 
)

Extract a product from a metainfo dictionary.

Parameters
metainfo(dict) metainfo created by the create_metainfo() function.
all_maintainer(dict of dict) all possible maintainers
Returns
A Product or None if the metainfo does not describe a product.

Definition at line 267 of file preprocessing.py.

def kapidox.preprocessing.parse_tree (   rootdir)

Recursively call create_metainfo() in subdirs of rootdir.

Parameters
rootdir(string) Top level directory containing the libraries.
Returns
A list of metainfo dictionary (see create_metainfo()).

Definition at line 176 of file preprocessing.py.

def kapidox.preprocessing.sort_metainfo (   metalist,
  all_maintainers 
)

Extract the structure (Product/Subproduct/Library) from the metainfo list.

Parameters
metalist(list of dict) lists of the metainfo extracted in parse_tree().
all_maintainers(dict of dict) all possible maintainers.
Returns
A list of Products, a list of groups (which are products containing several libraries), a list of Libraries and the available platforms.

Definition at line 213 of file preprocessing.py.

This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Dec 6 2021 22:48:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.