Skip to content

best_practice_analyzer

This is currently just a POC. Handle all BPA related items.

You can call the BPA() class to download or specify your own BPA file. It is used with tabular_editor.py to run BPA. I did not want to re-invent the wheel, so just letting TE2 work it's magic.

BPA

Setting BPA Class for future work...

Source code in pytabular/best_practice_analyzer.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class BPA:
    """Setting BPA Class for future work..."""

    def __init__(self, file_path: str = "Default") -> None:
        """BPA class to be used with the TE2 class.

        You can create the BPA class without any arguments.
        This doesn't do much right now...
        BPA().location is where the file path is stored.

        Args:
            file_path (str, optional): See `Download_BPA_File()`. Defaults to "Default".
        """
        logger.debug(f"Initializing BPA Class:: {file_path}")
        if file_path == "Default":
            self.location: str = download_bpa_file()
        else:
            self.location: str = file_path
        pass

__init__(file_path='Default')

BPA class to be used with the TE2 class.

You can create the BPA class without any arguments. This doesn't do much right now... BPA().location is where the file path is stored.

Parameters:

Name Type Description Default
file_path str

See Download_BPA_File(). Defaults to "Default".

 'Default'
Source code in pytabular/best_practice_analyzer.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def __init__(self, file_path: str = "Default") -> None:
    """BPA class to be used with the TE2 class.

    You can create the BPA class without any arguments.
    This doesn't do much right now...
    BPA().location is where the file path is stored.

    Args:
        file_path (str, optional): See `Download_BPA_File()`. Defaults to "Default".
    """
    logger.debug(f"Initializing BPA Class:: {file_path}")
    if file_path == "Default":
        self.location: str = download_bpa_file()
    else:
        self.location: str = file_path
    pass

download_bpa_file(download_location='https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json', folder='Best_Practice_Analyzer', auto_remove=True)

Download a BPA file from local or web.

Runs a request.get() to retrieve the json file from web. Will return and store in directory. Will also register the removal of the new directory and file when exiting program.

Parameters:

Name Type Description Default
download_location str

Defaults to [BPA]'https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json'.

 'https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json'
folder str

New folder string. Defaults to 'Best_Practice_Analyzer'.

 'Best_Practice_Analyzer'
auto_remove bool

Auto Remove when script exits. Defaults to True.

 True

Returns:

Name Type Description
str str

File path for the newly downloaded BPA.
Source code in pytabular/best_practice_analyzer.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def download_bpa_file(
    download_location: str = (
        "https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json"  # noqa: E501
    ),
    folder: str = "Best_Practice_Analyzer",
    auto_remove=True,
) -> str:
    """Download a BPA file from local or web.

    Runs a request.get() to retrieve the json file from web.
    Will return and store in directory.
    Will also register the removal of the new directory and file when exiting program.

    Args:
            download_location (str, optional):  Defaults to
                    [BPA]'https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json'.
            folder (str, optional): New folder string.
                    Defaults to 'Best_Practice_Analyzer'.
            auto_remove (bool, optional): Auto Remove when script exits. Defaults to True.

    Returns:
            str: File path for the newly downloaded BPA.
    """
    logger.info(f"Downloading BPA from {download_location}")
    folder_location = os.path.join(os.getcwd(), folder)
    if os.path.exists(folder_location) is False:
        os.makedirs(folder_location)
    response = r.get(download_location)
    file_location = os.path.join(folder_location, download_location.split("/")[-1])
    with open(file_location, "w", encoding="utf-8") as bpa:
        json.dump(response.json(), bpa, ensure_ascii=False, indent=4)
    if auto_remove:
        logger.debug(f"Registering removal on termination... For {folder_location}")
        atexit.register(remove_folder_and_contents, folder_location)
    return file_location